Skip to content

Stub in tentative electrum 1.7 protocol additions. #690

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 1 commit into from
Apr 11, 2026
Merged

Stub in tentative electrum 1.7 protocol additions. #690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions Makefile.am
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,9 @@ src_libbitcoin_server_la_SOURCES = \
src/protocols/electrum/protocol_electrum_fees.cpp \
src/protocols/electrum/protocol_electrum_headers.cpp \
src/protocols/electrum/protocol_electrum_mempool.cpp \
src/protocols/electrum/protocol_electrum_outputs.cpp \
src/protocols/electrum/protocol_electrum_scripthash.cpp \
src/protocols/electrum/protocol_electrum_scripts.cpp \
src/protocols/electrum/protocol_electrum_server.cpp \
src/protocols/electrum/protocol_electrum_transactions.cpp \
src/protocols/electrum/protocol_electrum_version.cpp \
Expand Down Expand Up @@ -101,7 +103,9 @@ test_libbitcoin_server_test_SOURCES = \
test/protocols/electrum/electrum_fees.cpp \
test/protocols/electrum/electrum_headers.cpp \
test/protocols/electrum/electrum_mempool.cpp \
test/protocols/electrum/electrum_outputs.cpp \
test/protocols/electrum/electrum_scripthash.cpp \
test/protocols/electrum/electrum_scripts.cpp \
test/protocols/electrum/electrum_server.cpp \
test/protocols/electrum/electrum_transactions.cpp \
test/protocols/electrum/electrum_version.cpp \
Expand Down
2 changes: 2 additions & 0 deletions builds/msvc/vs2022/libbitcoin-server-test/libbitcoin-server-test.vcxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,9 @@
<ClCompile Include="..\..\..\..\test\protocols\electrum\electrum_fees.cpp" />
<ClCompile Include="..\..\..\..\test\protocols\electrum\electrum_headers.cpp" />
<ClCompile Include="..\..\..\..\test\protocols\electrum\electrum_mempool.cpp" />
<ClCompile Include="..\..\..\..\test\protocols\electrum\electrum_outputs.cpp" />
<ClCompile Include="..\..\..\..\test\protocols\electrum\electrum_scripthash.cpp" />
<ClCompile Include="..\..\..\..\test\protocols\electrum\electrum_scripts.cpp" />
<ClCompile Include="..\..\..\..\test\protocols\electrum\electrum_server.cpp" />
<ClCompile Include="..\..\..\..\test\protocols\electrum\electrum_transactions.cpp" />
<ClCompile Include="..\..\..\..\test\protocols\electrum\electrum_version.cpp">
Expand Down
6 changes: 6 additions & 0 deletions builds/msvc/vs2022/libbitcoin-server-test/libbitcoin-server-test.vcxproj.filters
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,15 @@
<ClCompile Include="..\..\..\..\test\protocols\electrum\electrum_mempool.cpp">
<Filter>src\protocols\electrum</Filter>
</ClCompile>
<ClCompile Include="..\..\..\..\test\protocols\electrum\electrum_outputs.cpp">
<Filter>src\protocols\electrum</Filter>
</ClCompile>
<ClCompile Include="..\..\..\..\test\protocols\electrum\electrum_scripthash.cpp">
<Filter>src\protocols\electrum</Filter>
</ClCompile>
<ClCompile Include="..\..\..\..\test\protocols\electrum\electrum_scripts.cpp">
<Filter>src\protocols\electrum</Filter>
</ClCompile>
<ClCompile Include="..\..\..\..\test\protocols\electrum\electrum_server.cpp">
<Filter>src\protocols\electrum</Filter>
</ClCompile>
Expand Down
2 changes: 2 additions & 0 deletions builds/msvc/vs2022/libbitcoin-server/libbitcoin-server.vcxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,9 @@
<ClCompile Include="..\..\..\..\src\protocols\electrum\protocol_electrum_fees.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\electrum\protocol_electrum_headers.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\electrum\protocol_electrum_mempool.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\electrum\protocol_electrum_outputs.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\electrum\protocol_electrum_scripthash.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\electrum\protocol_electrum_scripts.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\electrum\protocol_electrum_server.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\electrum\protocol_electrum_transactions.cpp" />
<ClCompile Include="..\..\..\..\src\protocols\electrum\protocol_electrum_version.cpp" />
Expand Down
6 changes: 6 additions & 0 deletions builds/msvc/vs2022/libbitcoin-server/libbitcoin-server.vcxproj.filters
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,15 @@
<ClCompile Include="..\..\..\..\src\protocols\electrum\protocol_electrum_mempool.cpp">
<Filter>src\protocols\electrum</Filter>
</ClCompile>
<ClCompile Include="..\..\..\..\src\protocols\electrum\protocol_electrum_outputs.cpp">
<Filter>src\protocols\electrum</Filter>
</ClCompile>
<ClCompile Include="..\..\..\..\src\protocols\electrum\protocol_electrum_scripthash.cpp">
<Filter>src\protocols\electrum</Filter>
</ClCompile>
<ClCompile Include="..\..\..\..\src\protocols\electrum\protocol_electrum_scripts.cpp">
<Filter>src\protocols\electrum</Filter>
</ClCompile>
<ClCompile Include="..\..\..\..\src\protocols\electrum\protocol_electrum_server.cpp">
<Filter>src\protocols\electrum</Filter>
</ClCompile>
Expand Down
80 changes: 51 additions & 29 deletions include/bitcoin/server/interfaces/electrum.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@ struct electrum_methods
method<"blockchain.relayfee">{},

method<"blockchain.utxo.get_address", string_t, number_t>{ "tx_hash", "index" },
method<"blockchain.outpoint.get_status", string_t, number_t, optional<""_t>>{ "tx_hash", "txout_idx", "spk_hint" },
method<"blockchain.outpoint.subscribe", string_t, number_t, optional<""_t>>{ "tx_hash", "txout_idx", "spk_hint" },
method<"blockchain.outpoint.unsubscribe", string_t, number_t>{ "tx_hash", "txout_idx" },

method<"blockchain.address.get_balance", string_t>{ "address" },
method<"blockchain.address.get_history", string_t>{ "address" },
method<"blockchain.address.get_mempool", string_t>{ "address" },
Expand All @@ -56,6 +60,13 @@ struct electrum_methods
method<"blockchain.scripthash.subscribe", string_t>{ "scripthash" },
method<"blockchain.scripthash.unsubscribe", string_t>{ "scripthash" },

method<"blockchain.scriptpubkey.get_balance", string_t>{ "scriptpubkey" },
method<"blockchain.scriptpubkey.get_history", string_t>{ "scriptpubkey" },
method<"blockchain.scriptpubkey.get_mempool", string_t>{ "scriptpubkey" },
method<"blockchain.scriptpubkey.listunspent", string_t>{ "scriptpubkey" },
method<"blockchain.scriptpubkey.subscribe", string_t>{ "scriptpubkey" },
method<"blockchain.scriptpubkey.unsubscribe", string_t>{ "scriptpubkey" },

method<"blockchain.transaction.broadcast", string_t>{ "raw_tx" },
method<"blockchain.transaction.broadcast_package", value_t, optional<false>>{ "raw_txs", "verbose" },
method<"blockchain.transaction.get", string_t, boolean_t>{ "tx_hash", "verbose" },
Expand Down Expand Up @@ -93,35 +104,46 @@ struct electrum_methods
using blockchain_relay_fee = at<7>;

using blockchain_utxo_get_address = at<8>;
using blockchain_address_get_balance = at<9>;
using blockchain_address_get_history = at<10>;
using blockchain_address_get_mempool = at<11>;
using blockchain_address_list_unspent = at<12>;
using blockchain_address_subscribe = at<13>;

using blockchain_scripthash_get_balance = at<14>;
using blockchain_scripthash_get_history = at<15>;
using blockchain_scripthash_get_mempool = at<16>;
using blockchain_scripthash_list_unspent = at<17>;
using blockchain_scripthash_subscribe = at<18>;
using blockchain_scripthash_unsubscribe = at<19>;

using blockchain_transaction_broadcast = at<20>;
using blockchain_transaction_broadcast_package = at<21>;
using blockchain_transaction_get = at<22>;
using blockchain_transaction_get_merkle = at<23>;
using blockchain_transaction_id_from_position = at<24>;

using server_add_peer = at<25>;
using server_banner = at<26>;
using server_donation_address = at<27>;
using server_features = at<28>;
using server_peers_subscribe = at<29>;
using server_ping = at<30>;
using server_version = at<31>;

using mempool_get_fee_histogram = at<32>;
using mempool_get_info = at<33>;
using blockchain_outpoint_get_status = at<9>;
using blockchain_outpoint_subscribe = at<10>;
using blockchain_outpoint_unsubscribe = at<11>;

using blockchain_address_get_balance = at<12>;
using blockchain_address_get_history = at<13>;
using blockchain_address_get_mempool = at<14>;
using blockchain_address_list_unspent = at<15>;
using blockchain_address_subscribe = at<16>;

using blockchain_scripthash_get_balance = at<17>;
using blockchain_scripthash_get_history = at<18>;
using blockchain_scripthash_get_mempool = at<19>;
using blockchain_scripthash_list_unspent = at<20>;
using blockchain_scripthash_subscribe = at<21>;
using blockchain_scripthash_unsubscribe = at<22>;

using blockchain_scriptpubkey_get_balance = at<23>;
using blockchain_scriptpubkey_get_history = at<24>;
using blockchain_scriptpubkey_get_mempool = at<25>;
using blockchain_scriptpubkey_list_unspent = at<26>;
using blockchain_scriptpubkey_subscribe = at<27>;
using blockchain_scriptpubkey_unsubscribe = at<28>;

using blockchain_transaction_broadcast = at<29>;
using blockchain_transaction_broadcast_package = at<30>;
using blockchain_transaction_get = at<31>;
using blockchain_transaction_get_merkle = at<32>;
using blockchain_transaction_id_from_position = at<33>;

using server_add_peer = at<34>;
using server_banner = at<35>;
using server_donation_address = at<36>;
using server_features = at<37>;
using server_peers_subscribe = at<38>;
using server_ping = at<39>;
using server_version = at<40>;

using mempool_get_fee_histogram = at<41>;
using mempool_get_info = at<42>;
};

} // namespace interface
Expand Down
40 changes: 39 additions & 1 deletion include/bitcoin/server/protocols/protocol_electrum.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,23 @@ class BCS_API protocol_electrum
void handle_blockchain_relay_fee(const code& ec,
rpc_interface::blockchain_relay_fee) NOEXCEPT;

/// Handlers (addresses).
/// Handlers (outputs).
void handle_blockchain_utxo_get_address(const code& ec,
rpc_interface::blockchain_utxo_get_address,
const std::string& tx_hash, double index) NOEXCEPT;
void handle_blockchain_outpoint_get_status(const code& ec,
rpc_interface::blockchain_outpoint_get_status,
const std::string& tx_hash, double index,
const std::string& spk_hint) NOEXCEPT;
void handle_blockchain_outpoint_subscribe(const code& ec,
rpc_interface::blockchain_outpoint_subscribe,
const std::string& tx_hash, double index,
const std::string& spk_hint) NOEXCEPT;
void handle_blockchain_outpoint_unsubscribe(const code& ec,
rpc_interface::blockchain_outpoint_unsubscribe,
const std::string& tx_hash, double index) NOEXCEPT;

/// Handlers (addresses).
void handle_blockchain_address_get_balance(const code& ec,
rpc_interface::blockchain_address_get_balance,
const std::string& address) NOEXCEPT;
Expand Down Expand Up @@ -127,6 +140,26 @@ class BCS_API protocol_electrum
rpc_interface::blockchain_scripthash_unsubscribe,
const std::string& scripthash) NOEXCEPT;

/// Handlers (scriptpubkey).
void handle_blockchain_scriptpubkey_get_balance(const code& ec,
rpc_interface::blockchain_scriptpubkey_get_balance,
const std::string& scriptpubkey) NOEXCEPT;
void handle_blockchain_scriptpubkey_get_history(const code& ec,
rpc_interface::blockchain_scriptpubkey_get_history,
const std::string& scriptpubkey) NOEXCEPT;
void handle_blockchain_scriptpubkey_get_mempool(const code& ec,
rpc_interface::blockchain_scriptpubkey_get_mempool,
const std::string& scriptpubkey) NOEXCEPT;
void handle_blockchain_scriptpubkey_list_unspent(const code& ec,
rpc_interface::blockchain_scriptpubkey_list_unspent,
const std::string& scriptpubkey) NOEXCEPT;
void handle_blockchain_scriptpubkey_subscribe(const code& ec,
rpc_interface::blockchain_scriptpubkey_subscribe,
const std::string& scriptpubkey) NOEXCEPT;
void handle_blockchain_scriptpubkey_unsubscribe(const code& ec,
rpc_interface::blockchain_scriptpubkey_unsubscribe,
const std::string& scriptpubkey) NOEXCEPT;

/// Handlers (transactions).
void handle_blockchain_transaction_broadcast(const code& ec,
rpc_interface::blockchain_transaction_broadcast,
Expand Down Expand Up @@ -202,7 +235,10 @@ class BCS_API protocol_electrum

void do_height(node::header_t link) NOEXCEPT;
void do_header(node::header_t link) NOEXCEPT;
void do_outpoint(node::header_t link) NOEXCEPT;
void do_address(node::address_t link) NOEXCEPT;
void do_scripthash(node::address_t link) NOEXCEPT;
void do_scriptpubkey(node::address_t link) NOEXCEPT;

/// Utilities.
/// -----------------------------------------------------------------------
Expand Down Expand Up @@ -251,8 +287,10 @@ class BCS_API protocol_electrum
std::atomic_bool stopping_{};
std::atomic_bool subscribed_height_{};
std::atomic_bool subscribed_header_{};
std::atomic_bool subscribed_outpoint_{};
std::atomic_bool subscribed_address_{};
std::atomic_bool subscribed_scripthash_{};
std::atomic_bool subscribed_scriptpubkey_{};

// This is mostly thread safe, and used in a thread safe manner.
const channel_t::ptr channel_;
Expand Down
78 changes: 75 additions & 3 deletions src/protocols/electrum/protocol_electrum.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,13 @@ void protocol_electrum::start() NOEXCEPT
SUBSCRIBE_RPC(handle_blockchain_estimate_fee, _1, _2, _3, _4);
SUBSCRIBE_RPC(handle_blockchain_relay_fee, _1, _2);

// Address methods.
// Output methods.
SUBSCRIBE_RPC(handle_blockchain_utxo_get_address, _1, _2, _3, _4);
SUBSCRIBE_RPC(handle_blockchain_outpoint_get_status, _1, _2, _3, _4, _5);
SUBSCRIBE_RPC(handle_blockchain_outpoint_subscribe, _1, _2, _3, _4, _5);
SUBSCRIBE_RPC(handle_blockchain_outpoint_unsubscribe, _1, _2, _3, _4);

// Address methods.
SUBSCRIBE_RPC(handle_blockchain_address_get_balance, _1, _2, _3);
SUBSCRIBE_RPC(handle_blockchain_address_get_history, _1, _2, _3);
SUBSCRIBE_RPC(handle_blockchain_address_get_mempool, _1, _2, _3);
Expand All @@ -80,6 +85,14 @@ void protocol_electrum::start() NOEXCEPT
SUBSCRIBE_RPC(handle_blockchain_scripthash_subscribe, _1, _2, _3);
SUBSCRIBE_RPC(handle_blockchain_scripthash_unsubscribe, _1, _2, _3);

// Scriptpubkey methods.
SUBSCRIBE_RPC(handle_blockchain_scriptpubkey_get_balance, _1, _2, _3);
SUBSCRIBE_RPC(handle_blockchain_scriptpubkey_get_history, _1, _2, _3);
SUBSCRIBE_RPC(handle_blockchain_scriptpubkey_get_mempool, _1, _2, _3);
SUBSCRIBE_RPC(handle_blockchain_scriptpubkey_list_unspent, _1, _2, _3);
SUBSCRIBE_RPC(handle_blockchain_scriptpubkey_subscribe, _1, _2, _3);
SUBSCRIBE_RPC(handle_blockchain_scriptpubkey_unsubscribe, _1, _2, _3);

// Transaction methods.
SUBSCRIBE_RPC(handle_blockchain_transaction_broadcast, _1, _2, _3);
SUBSCRIBE_RPC(handle_blockchain_transaction_broadcast_package, _1, _2, _3, _4);
Expand Down Expand Up @@ -144,11 +157,29 @@ bool protocol_electrum::handle_event(const code&, node::chase event_,
case node::chase::spent:
case node::chase::received:
{
if (subscribed_outpoint_.load(relaxed))
{
BC_ASSERT(std::holds_alternative<node::address_t>(value));
POST(do_outpoint, std::get<node::address_t>(value));
}

if (subscribed_address_.load(relaxed))
{
BC_ASSERT(std::holds_alternative<node::address_t>(value));
POST(do_address, std::get<node::address_t>(value));
}

if (subscribed_scripthash_.load(relaxed))
{
BC_ASSERT(std::holds_alternative<node::address_t>(value));
POST(do_scripthash, std::get<node::address_t>(value));
}

if (subscribed_scriptpubkey_.load(relaxed))
{
BC_ASSERT(std::holds_alternative<node::address_t>(value));
POST(do_scriptpubkey, std::get<node::address_t>(value));
}
}
default:
{
Expand Down Expand Up @@ -205,6 +236,19 @@ void protocol_electrum::do_header(node::header_t link) NOEXCEPT
}, 64, BIND(complete, _1));
}

// Notifier for blockchain_outpoint_subscribe events.
void protocol_electrum::do_outpoint(node::address_t) NOEXCEPT
{
chain::point point{};

// TODO: compute and return outpont status from a store query.
send_notification("blockchain.outpoint.subscribe", array_t
{
array_t{ encode_hash(point.hash()), point.index() },
object_t{}
}, 128, BIND(handle_send, _1));
}

// This struct is small and stack allocated (208 bytes).
// Writer holds stream ref to status and midstate via accumulator.
// Writer flush rewrites status via stream and resets accumulator.
Expand All @@ -218,7 +262,6 @@ struct midstate
};

// Notifier for blockchain_address_subscribe events.
// Notifier for blockchain_scripthash_unsubscribe events.
void protocol_electrum::do_address(node::address_t ) NOEXCEPT
{
std::string status_hash{};
Expand All @@ -229,13 +272,42 @@ void protocol_electrum::do_address(node::address_t ) NOEXCEPT

// EXAMPLE
// script_hash is a payment address for address.
////send_notification("blockchain.address.subscribe", array_t
send_notification("blockchain.address.subscribe", array_t
{
script_hash,
status_hash
}, 128, BIND(handle_send, _1));
}

// Notifier for blockchain_scripthash_subscribe events.
void protocol_electrum::do_scripthash(node::address_t) NOEXCEPT
{
std::string status_hash{};
std::string script_hash{};

// EXAMPLE
// script_hash is a payment address for address.
send_notification("blockchain.scripthash.subscribe", array_t
{
script_hash,
status_hash
}, 128, BIND(handle_send, _1));
}

// Notifier for blockchain_scriptpubkey_subscribe events.
void protocol_electrum::do_scriptpubkey(node::address_t) NOEXCEPT
{
std::string status_hash{};
std::string script_hash{};

// EXAMPLE
// script_hash is a payment address for address.
send_notification("blockchain.scriptpubkey.subscribe", array_t
{
script_hash,
status_hash
}, 128, BIND(handle_send, _1));
}

} // namespace server
} // namespace libbitcoin
Loading