From bedbd54fae9223e28d79e1f9b828d5abf7d89339 Mon Sep 17 00:00:00 2001 From: Dave Hrycyszyn Date: Tue, 25 Jun 2024 13:07:07 +0100 Subject: [PATCH] Some docs as to current problems with the bare `bdk` wallet crate. --- side-node/src/clients/btc_electrum_client.rs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/side-node/src/clients/btc_electrum_client.rs b/side-node/src/clients/btc_electrum_client.rs index ddb1271..52167c2 100644 --- a/side-node/src/clients/btc_electrum_client.rs +++ b/side-node/src/clients/btc_electrum_client.rs @@ -9,6 +9,15 @@ use bdk::wallet::AddressInfo; use bdk::{blockchain::ElectrumBlockchain, electrum_client, SyncOptions}; use bdk::{FeeRate, KeychainKind, SignOptions, TransactionDetails, Wallet}; +/// Run the Bitcoin wallet example +/// +/// This is a bdk example that uses the Electrum client to interact with the Bitcoin network. +/// Electrum is a light client that connects to a server to get information about the Bitcoin network. +/// The BDK itself does not have the ability to connect to e.g. esplora servers. As the Blockstream Electrum Signet +/// server does not appear to be picking up transactions properly at the moment, I've shifted over to using +/// the (more complex) `bdk_wallet` crate and the esplora client there (see the other RPC client). +/// +/// Note:the types below are all completely different than the types in `bdk_wallet`. pub async fn run() -> Result<(), anyhow::Error> { let dave = utils::home(&"dave".to_string()); let sammy = utils::home(&"sammy".to_string());