Skip to content

Stub in electrum and stratum_v1 protocol handlers. #944

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 3 commits into from
Dec 30, 2025
Merged

Stub in electrum and stratum_v1 protocol handlers. #944

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2c3af5b
Remove channel_tcp and stub in channel_sv2.
evoskuil Dec 29, 2025
161c714
Change channel_rpc/protocol_rpc to template on Interface.
evoskuil Dec 29, 2025
4c9831d
Stub in electrum and stratum_v1 protocol handlers.
evoskuil Dec 30, 2025
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
5 changes: 3 additions & 2 deletions Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ src_libbitcoin_node_la_SOURCES = \
src/protocols/protocol_block_in_31800.cpp \
src/protocols/protocol_block_out_106.cpp \
src/protocols/protocol_block_out_70012.cpp \
src/protocols/protocol_electrum.cpp \
src/protocols/protocol_explore.cpp \
src/protocols/protocol_filter_out_70015.cpp \
src/protocols/protocol_header_in_31800.cpp \
Expand All @@ -75,6 +76,7 @@ src_libbitcoin_node_la_SOURCES = \
src/protocols/protocol_observer.cpp \
src/protocols/protocol_peer.cpp \
src/protocols/protocol_performer.cpp \
src/protocols/protocol_stratum_v1.cpp \
src/protocols/protocol_transaction_in_106.cpp \
src/protocols/protocol_transaction_out_106.cpp \
src/sessions/session.cpp \
Expand Down Expand Up @@ -184,7 +186,7 @@ include_bitcoin_node_channels_HEADERS = \
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_tcp.hpp \
include/bitcoin/node/channels/channel_sv2.hpp \
include/bitcoin/node/channels/channel_ws.hpp \
include/bitcoin/node/channels/channels.hpp

Expand Down Expand Up @@ -250,7 +252,6 @@ include_bitcoin_node_protocols_HEADERS = \
include/bitcoin/node/protocols/protocol_rpc.hpp \
include/bitcoin/node/protocols/protocol_stratum_v1.hpp \
include/bitcoin/node/protocols/protocol_stratum_v2.hpp \
include/bitcoin/node/protocols/protocol_tcp.hpp \
include/bitcoin/node/protocols/protocol_transaction_in_106.hpp \
include/bitcoin/node/protocols/protocol_transaction_out_106.hpp \
include/bitcoin/node/protocols/protocol_web.hpp \
Expand Down
2 changes: 2 additions & 0 deletions builds/cmake/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,7 @@ add_library( ${CANONICAL_LIB_NAME}
"../../src/protocols/protocol_block_in_31800.cpp"
"../../src/protocols/protocol_block_out_106.cpp"
"../../src/protocols/protocol_block_out_70012.cpp"
"../../src/protocols/protocol_electrum.cpp"
"../../src/protocols/protocol_explore.cpp"
"../../src/protocols/protocol_filter_out_70015.cpp"
"../../src/protocols/protocol_header_in_31800.cpp"
Expand All @@ -287,6 +288,7 @@ add_library( ${CANONICAL_LIB_NAME}
"../../src/protocols/protocol_observer.cpp"
"../../src/protocols/protocol_peer.cpp"
"../../src/protocols/protocol_performer.cpp"
"../../src/protocols/protocol_stratum_v1.cpp"
"../../src/protocols/protocol_transaction_in_106.cpp"
"../../src/protocols/protocol_transaction_out_106.cpp"
"../../src/sessions/session.cpp"
Expand Down
5 changes: 3 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 @@ -149,6 +149,7 @@
<ClCompile Include="..\..\..\..\src\protocols\protocol_block_in_31800.cpp" />
<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_explore.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\protocol_filter_out_70015.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\protocol_header_in_31800.cpp" />
Expand All @@ -160,6 +161,7 @@
<ClCompile Include="..\..\..\..\src\protocols\protocol_observer.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\protocol_peer.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\protocol_performer.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\protocol_stratum_v1.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\protocol_transaction_in_106.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\protocol_transaction_out_106.cpp" />
<ClCompile Include="..\..\..\..\src\sessions\session.cpp" />
Expand All @@ -176,7 +178,7 @@
<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_tcp.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_sv2.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 @@ -233,7 +235,6 @@
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_rpc.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_stratum_v1.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_stratum_v2.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_tcp.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_transaction_in_106.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_transaction_out_106.hpp" />
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_web.hpp" />
Expand Down
11 changes: 7 additions & 4 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 @@ -147,6 +147,9 @@
<ClCompile Include="..\..\..\..\src\protocols\protocol_block_out_70012.cpp">
<Filter>src\protocols</Filter>
</ClCompile>
<ClCompile Include="..\..\..\..\src\protocols\protocol_electrum.cpp">
<Filter>src\protocols</Filter>
</ClCompile>
<ClCompile Include="..\..\..\..\src\protocols\protocol_explore.cpp">
<Filter>src\protocols</Filter>
</ClCompile>
Expand Down Expand Up @@ -180,6 +183,9 @@
<ClCompile Include="..\..\..\..\src\protocols\protocol_performer.cpp">
<Filter>src\protocols</Filter>
</ClCompile>
<ClCompile Include="..\..\..\..\src\protocols\protocol_stratum_v1.cpp">
<Filter>src\protocols</Filter>
</ClCompile>
<ClCompile Include="..\..\..\..\src\protocols\protocol_transaction_in_106.cpp">
<Filter>src\protocols</Filter>
</ClCompile>
Expand Down Expand Up @@ -224,7 +230,7 @@
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_rpc.hpp">
<Filter>include\bitcoin\node\channels</Filter>
</ClInclude>
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_tcp.hpp">
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_sv2.hpp">
<Filter>include\bitcoin\node\channels</Filter>
</ClInclude>
<ClInclude Include="..\..\..\..\include\bitcoin\node\channels\channel_ws.hpp">
Expand Down Expand Up @@ -395,9 +401,6 @@
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_stratum_v2.hpp">
<Filter>include\bitcoin\node\protocols</Filter>
</ClInclude>
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_tcp.hpp">
<Filter>include\bitcoin\node\protocols</Filter>
</ClInclude>
<ClInclude Include="..\..\..\..\include\bitcoin\node\protocols\protocol_transaction_in_106.hpp">
<Filter>include\bitcoin\node\protocols</Filter>
</ClInclude>
Expand Down
3 changes: 1 addition & 2 deletions include/bitcoin/node.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
#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_tcp.hpp>
#include <bitcoin/node/channels/channel_sv2.hpp>
#include <bitcoin/node/channels/channel_ws.hpp>
#include <bitcoin/node/channels/channels.hpp>
#include <bitcoin/node/chasers/chaser.hpp>
Expand Down Expand Up @@ -81,7 +81,6 @@
#include <bitcoin/node/protocols/protocol_rpc.hpp>
#include <bitcoin/node/protocols/protocol_stratum_v1.hpp>
#include <bitcoin/node/protocols/protocol_stratum_v2.hpp>
#include <bitcoin/node/protocols/protocol_tcp.hpp>
#include <bitcoin/node/protocols/protocol_transaction_in_106.hpp>
#include <bitcoin/node/protocols/protocol_transaction_out_106.hpp>
#include <bitcoin/node/protocols/protocol_web.hpp>
Expand Down
9 changes: 6 additions & 3 deletions include/bitcoin/node/channels/channel_rpc.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,19 +28,22 @@ namespace libbitcoin {
namespace node {

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

inline channel_rpc(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(log, socket, identifier, config.network, options),
network::channel_rpc<Interface>(log, socket, identifier,
config.network, options),
network::tracker<channel_rpc>(log)
{
}
Expand Down
17 changes: 8 additions & 9 deletions ...ude/bitcoin/node/channels/channel_tcp.hpp → ...ude/bitcoin/node/channels/channel_sv2.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_TCP_HPP
#define LIBBITCOIN_NODE_CHANNELS_CHANNEL_TCP_HPP
#ifndef LIBBITCOIN_NODE_CHANNELS_CHANNEL_SV2_HPP
#define LIBBITCOIN_NODE_CHANNELS_CHANNEL_SV2_HPP

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

/// Abstract base TCP channel state for the node.
/// This is a placeholder for stratum v2 (any unimplemented).
class BCN_API channel_tcp
/// Channel for stratum v2 (custom protocol, not implemented).
class BCN_API channel_sv2
: public node::channel,
public network::channel,
protected network::tracker<channel_tcp>
protected network::tracker<channel_sv2>
{
public:
typedef std::shared_ptr<channel_tcp> ptr;
typedef std::shared_ptr<channel_sv2> ptr;

inline channel_tcp(const network::logger& log,
inline channel_sv2(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_tcp>(log)
network::tracker<channel_sv2>(log)
{
}
};
Expand Down
2 changes: 1 addition & 1 deletion include/bitcoin/node/channels/channels.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
#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_tcp.hpp>
#include <bitcoin/node/channels/channel_sv2.hpp>
#include <bitcoin/node/channels/channel_ws.hpp>

#endif
Expand Down
2 changes: 0 additions & 2 deletions include/bitcoin/node/interfaces/electrum.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,6 @@ struct electrum_methods
using server_peers_subscribe = at<19>;
using server_ping = at<20>;
using server_version = at<21>;

////using subscribers = unsubscriber<external_t<decltype(methods)>>;
};

} // namespace interface
Expand Down
19 changes: 12 additions & 7 deletions include/bitcoin/node/protocols/protocol_electrum.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,31 +22,36 @@
#include <memory>
#include <bitcoin/node/channels/channels.hpp>
#include <bitcoin/node/define.hpp>
#include <bitcoin/node/interfaces/interfaces.hpp>
#include <bitcoin/node/protocols/protocol_rpc.hpp>

namespace libbitcoin {
namespace node {

class BCN_API protocol_electrum
: public node::protocol_rpc,
: public node::protocol_rpc<interface::electrum>,
protected network::tracker<protocol_electrum>
{
public:
typedef std::shared_ptr<protocol_electrum> ptr;
using rpc_interface = interface::electrum;

inline protocol_electrum(const auto& session,
const network::channel::ptr& channel,
const options_t& options) NOEXCEPT
: node::protocol_rpc(session, channel, options),
: node::protocol_rpc<rpc_interface>(session, channel, options),
network::tracker<protocol_electrum>(session->log)
{
}

/// Public start is required.
inline void start() NOEXCEPT override
{
node::protocol_rpc::start();
}
void start() NOEXCEPT override;

protected:
/// Handlers.
bool handle_blockchain_headers_subscribe(const code& ec,
rpc_interface::blockchain_headers_subscribe) NOEXCEPT;
bool handle_blockchain_relayfee(const code& ec,
rpc_interface::blockchain_relayfee) NOEXCEPT;
};

} // namespace node
Expand Down
11 changes: 5 additions & 6 deletions include/bitcoin/node/protocols/protocol_rpc.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,25 @@
#include <bitcoin/node/define.hpp>
#include <bitcoin/node/protocols/protocol.hpp>

// Only session.hpp.
#include <bitcoin/node/sessions/session.hpp>

namespace libbitcoin {
namespace node {

/// Abstract base for RPC protocols, thread safe.
template <typename Interface>
class BCN_API protocol_rpc
: public node::protocol,
public network::protocol_rpc
public network::protocol_rpc<Interface>
{
public:
using channel_t = node::channel_rpc;
using channel_t = node::channel_rpc<Interface>;
using options_t = channel_t::options_t;

protected:
inline protocol_rpc(const auto& session,
const network::channel::ptr& channel,
const options_t& options) NOEXCEPT
: node::protocol(session, channel),
network::protocol_rpc(session, channel, options)
network::protocol_rpc<Interface>(session, channel, options)
{
}
};
Expand Down
17 changes: 10 additions & 7 deletions include/bitcoin/node/protocols/protocol_stratum_v1.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,31 +21,34 @@

#include <memory>
#include <bitcoin/node/define.hpp>
#include <bitcoin/node/interfaces/interfaces.hpp>
#include <bitcoin/node/protocols/protocol_rpc.hpp>

namespace libbitcoin {
namespace node {

class BCN_API protocol_stratum_v1
: public node::protocol_rpc,
: public node::protocol_rpc<interface::stratum_v1>,
protected network::tracker<protocol_stratum_v1>
{
public:
typedef std::shared_ptr<protocol_stratum_v1> ptr;
using rpc_interface = interface::stratum_v1;

inline protocol_stratum_v1(const auto& session,
const network::channel::ptr& channel,
const options_t& options) NOEXCEPT
: node::protocol_rpc(session, channel, options),
: node::protocol_rpc<rpc_interface>(session, channel, options),
network::tracker<protocol_stratum_v1>(session->log)
{
}

/// Public start is required.
inline void start() NOEXCEPT override
{
node::protocol_rpc::start();
}
void start() NOEXCEPT override;

protected:
/// Handlers.
bool handle_mining_extranonce_subscribe(const code& ec,
rpc_interface::mining_extranonce_subscribe) NOEXCEPT;
};

} // namespace node
Expand Down
22 changes: 10 additions & 12 deletions include/bitcoin/node/protocols/protocol_stratum_v2.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,37 +20,35 @@
#define LIBBITCOIN_NODE_PROTOCOLS_PROTOCOL_STRATUM_V2_HPP

#include <memory>
#include <bitcoin/node/channels/channels.hpp>
#include <bitcoin/node/define.hpp>
#include <bitcoin/node/protocols/protocol_tcp.hpp>
#include <bitcoin/node/protocols/protocol.hpp>

namespace libbitcoin {
namespace node {

class BCN_API protocol_stratum_v2
: public node::protocol_tcp,
: public node::protocol,
public network::protocol,
protected network::tracker<protocol_stratum_v2>
{
public:
typedef std::shared_ptr<protocol_stratum_v2> ptr;
using channel_t = node::channel_sv2;

inline protocol_stratum_v2(const auto& session,
const network::channel::ptr& channel,
const options_t& options) NOEXCEPT
: node::protocol_tcp(session, channel, options),
////options_(options),
const network::channel::ptr& channel, const options_t&) NOEXCEPT
: node::protocol(session, channel),
network::protocol(session, channel),
network::tracker<protocol_stratum_v2>(session->log)
{
}

/// Public start is required.
// TODO: subscribe to and handle messages.
inline void start() NOEXCEPT override
{
node::protocol_tcp::start();
network::protocol::start();
}

private:
// This is thread safe.
////const options_t& options_;
};

} // namespace node
Expand Down
Loading
Loading