Stub in electrum and stratum_v1 protocol handlers.

evoskuil · evoskuil · commit 4c9831def0ae · 2025-12-29T20:20:52.000-05:00
diff --git a/Makefile.am b/Makefile.am
@@ -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 \
@@ -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 \
diff --git a/builds/cmake/CMakeLists.txt b/builds/cmake/CMakeLists.txt
@@ -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"
@@ -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"
diff --git a/builds/msvc/vs2022/libbitcoin-node/libbitcoin-node.vcxproj b/builds/msvc/vs2022/libbitcoin-node/libbitcoin-node.vcxproj
@@ -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" />
@@ -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" />
diff --git a/builds/msvc/vs2022/libbitcoin-node/libbitcoin-node.vcxproj.filters b/builds/msvc/vs2022/libbitcoin-node/libbitcoin-node.vcxproj.filters
@@ -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>
@@ -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>
diff --git a/include/bitcoin/node/interfaces/electrum.hpp b/include/bitcoin/node/interfaces/electrum.hpp
@@ -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
diff --git a/include/bitcoin/node/protocols/protocol_electrum.hpp b/include/bitcoin/node/protocols/protocol_electrum.hpp
@@ -34,20 +34,24 @@ class BCN_API 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<interface::electrum>(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<interface::electrum>::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
diff --git a/include/bitcoin/node/protocols/protocol_stratum_v1.hpp b/include/bitcoin/node/protocols/protocol_stratum_v1.hpp
@@ -33,20 +33,22 @@ class BCN_API 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<interface::stratum_v1>(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<interface::stratum_v1>::start();
-    }
+    void start() NOEXCEPT override;
+
+protected:
+    /// Handlers.
+    bool handle_mining_extranonce_subscribe(const code& ec,
+        rpc_interface::mining_extranonce_subscribe) NOEXCEPT;
 };
 
 } // namespace node
diff --git a/include/bitcoin/node/protocols/protocol_stratum_v2.hpp b/include/bitcoin/node/protocols/protocol_stratum_v2.hpp
@@ -44,7 +44,7 @@ class BCN_API protocol_stratum_v2
     {
     }
 
-    /// Public start is required.
+    // TODO: subscribe to and handle messages.
     inline void start() NOEXCEPT override
     {
         network::protocol::start();
diff --git a/src/protocols/protocol_bitcoind_rest.cpp b/src/protocols/protocol_bitcoind_rest.cpp
@@ -44,8 +44,6 @@ BC_PUSH_WARNING(NO_VALUE_OR_CONST_REF_SHARED_PTR)
 
 void protocol_bitcoind_rest::start() NOEXCEPT
 {
-    using namespace std::placeholders;
-
     BC_ASSERT(stranded());
 
     if (started())
diff --git a/src/protocols/protocol_bitcoind_rpc.cpp b/src/protocols/protocol_bitcoind_rpc.cpp
@@ -42,8 +42,6 @@ BC_PUSH_WARNING(NO_VALUE_OR_CONST_REF_SHARED_PTR)
 
 void protocol_bitcoind_rpc::start() NOEXCEPT
 {
-    using namespace std::placeholders;
-
     BC_ASSERT(stranded());
 
     if (started())
diff --git a/src/protocols/protocol_electrum.cpp b/src/protocols/protocol_electrum.cpp
@@ -0,0 +1,70 @@
+/**
+ * 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/>.
+ */
+#include <bitcoin/node/protocols/protocol_electrum.hpp>
+
+namespace libbitcoin {
+namespace node {
+
+#define CLASS protocol_electrum
+#define SUBSCRIBE_RPC(...) SUBSCRIBE_CHANNEL(void, __VA_ARGS__)
+
+using namespace std::placeholders;
+
+BC_PUSH_WARNING(NO_THROW_IN_NOEXCEPT)
+BC_PUSH_WARNING(SMART_PTR_NOT_NEEDED)
+BC_PUSH_WARNING(NO_VALUE_OR_CONST_REF_SHARED_PTR)
+
+// Start.
+// ----------------------------------------------------------------------------
+
+void protocol_electrum::start() NOEXCEPT
+{
+    BC_ASSERT(stranded());
+
+    if (started())
+        return;
+
+    SUBSCRIBE_RPC(handle_blockchain_headers_subscribe, _1, _2);
+    SUBSCRIBE_RPC(handle_blockchain_relayfee, _1, _2);
+    node::protocol_rpc<rpc_interface>::start();
+}
+
+// Handlers.
+// ----------------------------------------------------------------------------
+
+bool protocol_electrum::handle_blockchain_headers_subscribe(const code& ec,
+    rpc_interface::blockchain_headers_subscribe) NOEXCEPT
+{
+    // TODO:
+    return !ec;
+}
+
+bool protocol_electrum::handle_blockchain_relayfee(const code& ec,
+    rpc_interface::blockchain_relayfee) NOEXCEPT
+{
+    // TODO:
+    return !ec;
+}
+
+BC_POP_WARNING()
+BC_POP_WARNING()
+BC_POP_WARNING()
+
+} // namespace node
+} // namespace libbitcoin
diff --git a/src/protocols/protocol_stratum_v1.cpp b/src/protocols/protocol_stratum_v1.cpp
@@ -0,0 +1,62 @@
+/**
+ * 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/>.
+ */
+#include <bitcoin/node/protocols/protocol_stratum_v1.hpp>
+
+namespace libbitcoin {
+namespace node {
+
+#define CLASS protocol_stratum_v1
+#define SUBSCRIBE_RPC(...) SUBSCRIBE_CHANNEL(void, __VA_ARGS__)
+
+using namespace std::placeholders;
+
+BC_PUSH_WARNING(NO_THROW_IN_NOEXCEPT)
+BC_PUSH_WARNING(SMART_PTR_NOT_NEEDED)
+BC_PUSH_WARNING(NO_VALUE_OR_CONST_REF_SHARED_PTR)
+
+// Start.
+// ----------------------------------------------------------------------------
+
+void protocol_stratum_v1::start() NOEXCEPT
+{
+    BC_ASSERT(stranded());
+
+    if (started())
+        return;
+
+    SUBSCRIBE_RPC(handle_mining_extranonce_subscribe, _1, _2);
+    node::protocol_rpc<rpc_interface>::start();
+}
+
+// Handlers.
+// ----------------------------------------------------------------------------
+
+bool protocol_stratum_v1::handle_mining_extranonce_subscribe(const code& ec,
+    rpc_interface::mining_extranonce_subscribe) NOEXCEPT
+{
+    // TODO:
+    return !ec;
+}
+
+BC_POP_WARNING()
+BC_POP_WARNING()
+BC_POP_WARNING()
+
+} // namespace node
+} // namespace libbitcoin

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ class BCN_API protocol_stratum_v2`
`44`	`44`	`{`
`45`	`45`	`}`
`46`	`46`
`47`		`- /// Public start is required.`
	`47`	`+ // TODO: subscribe to and handle messages.`
`48`	`48`	`inline void start() NOEXCEPT override`
`49`	`49`	`{`
`50`	`50`	`network::protocol::start();`
Original file line number	Diff line number	Diff line change
`@@ -44,8 +44,6 @@ BC_PUSH_WARNING(NO_VALUE_OR_CONST_REF_SHARED_PTR)`
`44`	`44`
`45`	`45`	`void protocol_bitcoind_rest::start() NOEXCEPT`
`46`	`46`	`{`
`47`		`- using namespace std::placeholders;`
`48`		`-`
`49`	`47`	`BC_ASSERT(stranded());`
`50`	`48`
`51`	`49`	`if (started())`
Original file line number	Diff line number	Diff line change
`@@ -42,8 +42,6 @@ BC_PUSH_WARNING(NO_VALUE_OR_CONST_REF_SHARED_PTR)`
`42`	`42`
`43`	`43`	`void protocol_bitcoind_rpc::start() NOEXCEPT`
`44`	`44`	`{`
`45`		`- using namespace std::placeholders;`
`46`		`-`
`47`	`45`	`BC_ASSERT(stranded());`
`48`	`46`
`49`	`47`	`if (started())`