Skip to content

Move electrum version method into its own handshake protocol. #949

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
evoskuil merged 6 commits into from
Jan 1, 2026
Merged

Move electrum version method into its own handshake protocol. #949

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e1c80c8
Split out electrum and sv1 channels.
evoskuil Dec 31, 2025
881a40a
Remove sv1 acronym (naming style).
evoskuil Dec 31, 2025
deea877
Move electrum version method into its own handshake protocol.
evoskuil Dec 31, 2025
6ff9b02
Add missing template keywords.
evoskuil Jan 1, 2026
41d193b
Use network.user_agent setting for electrum server name.
evoskuil Jan 1, 2026
e0f227a
Move electrum_version to an enum for shared usage.
evoskuil Jan 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ src_libbitcoin_node_la_SOURCES = \
src/protocols/protocol_block_out_106.cpp \
src/protocols/protocol_block_out_70012.cpp \
src/protocols/protocol_electrum.cpp \
src/protocols/protocol_electrum_version.cpp \
src/protocols/protocol_explore.cpp \
src/protocols/protocol_filter_out_70015.cpp \
src/protocols/protocol_header_in_31800.cpp \
Expand Down Expand Up @@ -183,10 +184,11 @@ include_bitcoin_node_HEADERS = \
include_bitcoin_node_channelsdir = ${includedir}/bitcoin/node/channels
include_bitcoin_node_channels_HEADERS = \
include/bitcoin/node/channels/channel.hpp \
include/bitcoin/node/channels/channel_electrum.hpp \
include/bitcoin/node/channels/channel_http.hpp \
include/bitcoin/node/channels/channel_peer.hpp \
include/bitcoin/node/channels/channel_rpc.hpp \
include/bitcoin/node/channels/channel_sv2.hpp \
include/bitcoin/node/channels/channel_stratum_v1.hpp \
include/bitcoin/node/channels/channel_stratum_v2.hpp \
include/bitcoin/node/channels/channel_ws.hpp \
include/bitcoin/node/channels/channels.hpp

Expand Down Expand Up @@ -224,6 +226,7 @@ include_bitcoin_node_parsersdir = ${includedir}/bitcoin/node/parsers
include_bitcoin_node_parsers_HEADERS = \
include/bitcoin/node/parsers/bitcoind_query.hpp \
include/bitcoin/node/parsers/bitcoind_target.hpp \
include/bitcoin/node/parsers/electrum_version.hpp \
include/bitcoin/node/parsers/explore_query.hpp \
include/bitcoin/node/parsers/explore_target.hpp \
include/bitcoin/node/parsers/parsers.hpp
Expand All @@ -238,6 +241,7 @@ include_bitcoin_node_protocols_HEADERS = \
include/bitcoin/node/protocols/protocol_block_out_106.hpp \
include/bitcoin/node/protocols/protocol_block_out_70012.hpp \
include/bitcoin/node/protocols/protocol_electrum.hpp \
include/bitcoin/node/protocols/protocol_electrum_version.hpp \
include/bitcoin/node/protocols/protocol_explore.hpp \
include/bitcoin/node/protocols/protocol_filter_out_70015.hpp \
include/bitcoin/node/protocols/protocol_header_in_31800.hpp \
Expand All @@ -260,6 +264,7 @@ include_bitcoin_node_protocols_HEADERS = \
include_bitcoin_node_sessionsdir = ${includedir}/bitcoin/node/sessions
include_bitcoin_node_sessions_HEADERS = \
include/bitcoin/node/sessions/session.hpp \
include/bitcoin/node/sessions/session_handshake.hpp \
include/bitcoin/node/sessions/session_inbound.hpp \
include/bitcoin/node/sessions/session_manual.hpp \
include/bitcoin/node/sessions/session_outbound.hpp \
Expand Down
1 change: 1 addition & 0 deletions builds/cmake/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,7 @@ add_library( ${CANONICAL_LIB_NAME}
"../../src/protocols/protocol_block_out_106.cpp"
"../../src/protocols/protocol_block_out_70012.cpp"
"../../src/protocols/protocol_electrum.cpp"
"../../src/protocols/protocol_electrum_version.cpp"
"../../src/protocols/protocol_explore.cpp"
"../../src/protocols/protocol_filter_out_70015.cpp"
"../../src/protocols/protocol_header_in_31800.cpp"
Expand Down
9 changes: 7 additions & 2 deletions builds/msvc/vs2022/libbitcoin-node/libbitcoin-node.vcxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,7 @@
<ClCompile Include="..\..\..\..\src\protocols\protocol_block_out_106.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\protocol_block_out_70012.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\protocol_electrum.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\protocol_electrum_version.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\protocol_explore.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\protocol_filter_out_70015.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\protocol_header_in_31800.cpp" />
Expand All @@ -175,10 +176,11 @@
<ClInclude Include="..\..\..\..\include\bitcoin\node\block_arena.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\block_memory.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_electrum.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_http.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_peer.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_rpc.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_sv2.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_stratum_v1.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_stratum_v2.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_ws.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channels.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\chase.hpp" />
Expand Down Expand Up @@ -210,6 +212,7 @@
<ClInclude Include="..\..\..\..\include\bitcoin\node\parser.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\parsers\bitcoind_query.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\parsers\bitcoind_target.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\parsers\electrum_version.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\parsers\explore_query.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\parsers\explore_target.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\parsers\parsers.hpp" />
Expand All @@ -221,6 +224,7 @@
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_block_out_106.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_block_out_70012.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_electrum.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_electrum_version.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_explore.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_filter_out_70015.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_header_in_31800.hpp" />
Expand All @@ -240,6 +244,7 @@
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_web.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocols.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\sessions\session.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\sessions\session_handshake.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\sessions\session_inbound.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\sessions\session_manual.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\sessions\session_outbound.hpp" />
Expand Down
19 changes: 17 additions & 2 deletions builds/msvc/vs2022/libbitcoin-node/libbitcoin-node.vcxproj.filters
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,9 @@
<ClCompile Include="..\..\..\..\src\protocols\protocol_electrum.cpp">
<Filter>src\protocols</Filter>
</ClCompile>
<ClCompile Include="..\..\..\..\src\protocols\protocol_electrum_version.cpp">
<Filter>src\protocols</Filter>
</ClCompile>
<ClCompile Include="..\..\..\..\src\protocols\protocol_explore.cpp">
<Filter>src\protocols</Filter>
</ClCompile>
Expand Down Expand Up @@ -221,16 +224,19 @@
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel.hpp">
<Filter>include\bitcoin\node\channels</Filter>
</ClInclude>
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_electrum.hpp">
<Filter>include\bitcoin\node\channels</Filter>
</ClInclude>
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_http.hpp">
<Filter>include\bitcoin\node\channels</Filter>
</ClInclude>
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_peer.hpp">
<Filter>include\bitcoin\node\channels</Filter>
</ClInclude>
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_rpc.hpp">
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_stratum_v1.hpp">
<Filter>include\bitcoin\node\channels</Filter>
</ClInclude>
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_sv2.hpp">
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_stratum_v2.hpp">
<Filter>include\bitcoin\node\channels</Filter>
</ClInclude>
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_ws.hpp">
Expand Down Expand Up @@ -326,6 +332,9 @@
<ClInclude Include="..\..\..\..\include\bitcoin\node\parsers\bitcoind_target.hpp">
<Filter>include\bitcoin\node\parsers</Filter>
</ClInclude>
<ClInclude Include="..\..\..\..\include\bitcoin\node\parsers\electrum_version.hpp">
<Filter>include\bitcoin\node\parsers</Filter>
</ClInclude>
<ClInclude Include="..\..\..\..\include\bitcoin\node\parsers\explore_query.hpp">
<Filter>include\bitcoin\node\parsers</Filter>
</ClInclude>
Expand Down Expand Up @@ -359,6 +368,9 @@
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_electrum.hpp">
<Filter>include\bitcoin\node\protocols</Filter>
</ClInclude>
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_electrum_version.hpp">
<Filter>include\bitcoin\node\protocols</Filter>
</ClInclude>
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_explore.hpp">
<Filter>include\bitcoin\node\protocols</Filter>
</ClInclude>
Expand Down Expand Up @@ -416,6 +428,9 @@
<ClInclude Include="..\..\..\..\include\bitcoin\node\sessions\session.hpp">
<Filter>include\bitcoin\node\sessions</Filter>
</ClInclude>
<ClInclude Include="..\..\..\..\include\bitcoin\node\sessions\session_handshake.hpp">
<Filter>include\bitcoin\node\sessions</Filter>
</ClInclude>
<ClInclude Include="..\..\..\..\include\bitcoin\node\sessions\session_inbound.hpp">
<Filter>include\bitcoin\node\sessions</Filter>
</ClInclude>
Expand Down
8 changes: 6 additions & 2 deletions include/bitcoin/node.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,11 @@
#include <bitcoin/node/settings.hpp>
#include <bitcoin/node/version.hpp>
#include <bitcoin/node/channels/channel.hpp>
#include <bitcoin/node/channels/channel_electrum.hpp>
#include <bitcoin/node/channels/channel_http.hpp>
#include <bitcoin/node/channels/channel_peer.hpp>
#include <bitcoin/node/channels/channel_rpc.hpp>
#include <bitcoin/node/channels/channel_sv2.hpp>
#include <bitcoin/node/channels/channel_stratum_v1.hpp>
#include <bitcoin/node/channels/channel_stratum_v2.hpp>
#include <bitcoin/node/channels/channel_ws.hpp>
#include <bitcoin/node/channels/channels.hpp>
#include <bitcoin/node/chasers/chaser.hpp>
Expand All @@ -56,6 +57,7 @@
#include <bitcoin/node/interfaces/types.hpp>
#include <bitcoin/node/parsers/bitcoind_query.hpp>
#include <bitcoin/node/parsers/bitcoind_target.hpp>
#include <bitcoin/node/parsers/electrum_version.hpp>
#include <bitcoin/node/parsers/explore_query.hpp>
#include <bitcoin/node/parsers/explore_target.hpp>
#include <bitcoin/node/parsers/parsers.hpp>
Expand All @@ -67,6 +69,7 @@
#include <bitcoin/node/protocols/protocol_block_out_106.hpp>
#include <bitcoin/node/protocols/protocol_block_out_70012.hpp>
#include <bitcoin/node/protocols/protocol_electrum.hpp>
#include <bitcoin/node/protocols/protocol_electrum_version.hpp>
#include <bitcoin/node/protocols/protocol_explore.hpp>
#include <bitcoin/node/protocols/protocol_filter_out_70015.hpp>
#include <bitcoin/node/protocols/protocol_header_in_31800.hpp>
Expand All @@ -86,6 +89,7 @@
#include <bitcoin/node/protocols/protocol_web.hpp>
#include <bitcoin/node/protocols/protocols.hpp>
#include <bitcoin/node/sessions/session.hpp>
#include <bitcoin/node/sessions/session_handshake.hpp>
#include <bitcoin/node/sessions/session_inbound.hpp>
#include <bitcoin/node/sessions/session_manual.hpp>
#include <bitcoin/node/sessions/session_outbound.hpp>
Expand Down
59 changes: 59 additions & 0 deletions include/bitcoin/node/channels/channel_electrum.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
/**
* Copyright (c) 2011-2025 libbitcoin developers (see AUTHORS)
*
* This file is part of libbitcoin.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBBITCOIN_NODE_CHANNELS_CHANNEL_ELECTRUM_HPP
#define LIBBITCOIN_NODE_CHANNELS_CHANNEL_ELECTRUM_HPP

#include <memory>
#include <bitcoin/node/channels/channel.hpp>
#include <bitcoin/node/configuration.hpp>
#include <bitcoin/node/define.hpp>
#include <bitcoin/node/interfaces/interfaces.hpp>

namespace libbitcoin {
namespace node {

// TODO: strip extraneous args before electrum version dispatch.
// TODO: move version_ and name_ members into channel with set/get.
// TODO: move to electrum version method to handshake protocol.
/// Channel for electrum channels (non-http json-rpc).
class BCN_API channel_electrum
: public node::channel,
public network::channel_rpc<interface::electrum>,
protected network::tracker<channel_electrum>
{
public:
typedef std::shared_ptr<channel_electrum> ptr;
using interface_t = interface::electrum;
using options_t = typename network::channel_rpc<interface_t>::options_t;

inline channel_electrum(const network::logger& log,
const network::socket::ptr& socket, uint64_t identifier,
const node::configuration& config, const options_t& options) NOEXCEPT
: node::channel(log, socket, identifier, config),
network::channel_rpc<interface::electrum>(log, socket, identifier,
config.network, options),
network::tracker<channel_electrum>(log)
{
}
};

} // namespace node
} // namespace libbitcoin

#endif
25 changes: 13 additions & 12 deletions ...ude/bitcoin/node/channels/channel_rpc.hpp → ...coin/node/channels/channel_stratum_v1.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,35 +16,36 @@
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBBITCOIN_NODE_CHANNELS_CHANNEL_RPC_HPP
#define LIBBITCOIN_NODE_CHANNELS_CHANNEL_RPC_HPP
#ifndef LIBBITCOIN_NODE_CHANNELS_CHANNEL_STRATUM_V1_HPP
#define LIBBITCOIN_NODE_CHANNELS_CHANNEL_STRATUM_V1_HPP

#include <memory>
#include <bitcoin/node/channels/channel.hpp>
#include <bitcoin/node/configuration.hpp>
#include <bitcoin/node/define.hpp>
#include <bitcoin/node/interfaces/interfaces.hpp>

namespace libbitcoin {
namespace node {

/// Channel for electrum and stratum v1 channels (non-http json-rpc).
template <typename Interface>
class BCN_API channel_rpc
/// Channel for stratum v1 channels (non-http json-rpc).
class BCN_API channel_stratum_v1
: public node::channel,
public network::channel_rpc<Interface>,
protected network::tracker<channel_rpc<Interface>>
public network::channel_rpc<interface::stratum_v1>,
protected network::tracker<channel_stratum_v1>
{
public:
typedef std::shared_ptr<channel_rpc> ptr;
using options_t = typename network::channel_rpc<Interface>::options_t;
typedef std::shared_ptr<channel_stratum_v1> ptr;
using interface_t = interface::stratum_v1;
using options_t = typename network::channel_rpc<interface_t>::options_t;

inline channel_rpc(const network::logger& log,
inline channel_stratum_v1(const network::logger& log,
const network::socket::ptr& socket, uint64_t identifier,
const node::configuration& config, const options_t& options) NOEXCEPT
: node::channel(log, socket, identifier, config),
network::channel_rpc<Interface>(log, socket, identifier,
network::channel_rpc<interface::stratum_v1>(log, socket, identifier,
config.network, options),
network::tracker<channel_rpc>(log)
network::tracker<channel_stratum_v1>(log)
{
}
};
Expand Down
14 changes: 7 additions & 7 deletions ...ude/bitcoin/node/channels/channel_sv2.hpp → ...coin/node/channels/channel_stratum_v2.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBBITCOIN_NODE_CHANNELS_CHANNEL_SV2_HPP
#define LIBBITCOIN_NODE_CHANNELS_CHANNEL_SV2_HPP
#ifndef LIBBITCOIN_NODE_CHANNELS_CHANNEL_STRATUM_V2_HPP
#define LIBBITCOIN_NODE_CHANNELS_CHANNEL_STRATUM_V2_HPP

#include <memory>
#include <bitcoin/node/channels/channel.hpp>
Expand All @@ -28,20 +28,20 @@ namespace libbitcoin {
namespace node {

/// Channel for stratum v2 (custom protocol, not implemented).
class BCN_API channel_sv2
class BCN_API channel_stratum_v2
: public node::channel,
public network::channel,
protected network::tracker<channel_sv2>
protected network::tracker<channel_stratum_v2>
{
public:
typedef std::shared_ptr<channel_sv2> ptr;
typedef std::shared_ptr<channel_stratum_v2> ptr;

inline channel_sv2(const network::logger& log,
inline channel_stratum_v2(const network::logger& log,
const network::socket::ptr& socket, uint64_t identifier,
const node::configuration& config, const options_t& options) NOEXCEPT
: node::channel(log, socket, identifier, config),
network::channel(log, socket, identifier, config.network, options),
network::tracker<channel_sv2>(log)
network::tracker<channel_stratum_v2>(log)
{
}
};
Expand Down
5 changes: 3 additions & 2 deletions include/bitcoin/node/channels/channels.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,11 @@
#define LIBBITCOIN_NODE_CHANNELS_CHANNELS_HPP

#include <bitcoin/node/channels/channel.hpp>
#include <bitcoin/node/channels/channel_electrum.hpp>
#include <bitcoin/node/channels/channel_http.hpp>
#include <bitcoin/node/channels/channel_peer.hpp>
#include <bitcoin/node/channels/channel_rpc.hpp>
#include <bitcoin/node/channels/channel_sv2.hpp>
#include <bitcoin/node/channels/channel_stratum_v1.hpp>
#include <bitcoin/node/channels/channel_stratum_v2.hpp>
#include <bitcoin/node/channels/channel_ws.hpp>

#endif
Expand Down
Loading
Loading