RPC chain example

.gitignore

@@ -4,4 +4,5 @@ Cargo.lock
 out.perf-folded
 perf.data
 rust-perf.svg
+
 .bdk_example_db

Cargo.toml

@@ -5,6 +5,7 @@ members = [
     "bdk_cli_lib",
     "bdk_esplora_example",
     "bdk_electrum_example",
+    "bdk_rpc_example",
     "bdk_tmp_plan",
     "bdk_coin_select"
 ]

bdk_chain/src/spk_txout_index.rs

@@ -65,7 +65,7 @@ impl<I: Clone + Ord> SpkTxOutIndex<I> {
     ///
     /// [`ForEachTxout`]: crate::ForEachTxout
     pub fn scan(&mut self, txouts: &impl ForEachTxout) {
-        txouts.for_each_txout(&mut |(op, txout)| self.scan_txout(op, txout))
+        txouts.for_each_txout(&mut |(op, txout)| self.scan_txout(op, txout));
     }
 
     /// Scan a single `TxOut` for a matching script pubkey

bdk_cli_lib/Cargo.toml

@@ -15,3 +15,5 @@ anyhow = "1"
 serde = { version = "1", features = ["derive"] }
 thiserror = "1.0.37"
 serde_json = { version = "^1.0" }
+log = "^0.4"
+env_logger = "0.7"

bdk_cli_lib/src/lib.rs

@@ -19,12 +19,13 @@ use bdk_chain::{
 use bdk_coin_select::{coin_select_bnb, CoinSelector, CoinSelectorOpt, WeightedValue};
 pub use clap;
 use clap::{Parser, Subcommand};
+pub use log;
 use std::{cmp::Reverse, collections::HashMap, fmt::Debug, path::PathBuf, time::Duration};
 
 #[derive(Parser)]
 #[clap(author, version, about, long_about = None)]
 #[clap(propagate_version = true)]
-pub struct Args<C: clap::Subcommand> {
+pub struct Args<A: clap::Args, C: clap::Subcommand> {
     #[clap(env = "DESCRIPTOR")]
     pub descriptor: String,
     #[clap(env = "CHANGE_DESCRIPTOR")]
@@ -39,6 +40,9 @@ pub struct Args<C: clap::Subcommand> {
     #[clap(env = "BDK_CP_LIMIT", long, default_value = "20")]
     pub cp_limit: usize,
 
+    #[clap(flatten)]
+    pub chain_args: A,
+
     #[clap(subcommand)]
     pub command: Commands<C>,
 }
@@ -509,8 +513,8 @@ where
     Ok(())
 }
 
-pub fn init<C: clap::Subcommand, P>() -> anyhow::Result<(
-    Args<C>,
+pub fn init<A: clap::Args, C: clap::Subcommand, P>() -> anyhow::Result<(
+    Args<A, C>,
     KeyMap,
     KeychainTracker<Keychain, P>,
     KeychainStore<Keychain, P>,
@@ -519,7 +523,7 @@ where
     P: sparse_chain::ChainPosition,
     KeychainChangeSet<Keychain, P>: serde::Serialize + serde::de::DeserializeOwned,
 {
-    let args = Args::<C>::parse();
+    let args = Args::<A, C>::parse();
     let secp = Secp256k1::default();
     let (descriptor, mut keymap) =
         Descriptor::<DescriptorPublicKey>::parse_descriptor(&secp, &args.descriptor)?;

bdk_electrum_example/src/main.rs

@@ -2,13 +2,16 @@ mod electrum;
 use bdk_chain::{bitcoin::Network, keychain::KeychainChangeSet};
 use bdk_cli::{
     anyhow::{self, Context},
-    clap::{self, Parser, Subcommand},
+    clap::{self, Args, Parser, Subcommand},
 };
 use electrum::ElectrumClient;
 use std::{fmt::Debug, io, io::Write};
 
 use electrum_client::{Client, ConfigBuilder, ElectrumApi};
 
+#[derive(Args, Debug, Clone)]
+struct ElectrumArgs {}
+
 #[derive(Subcommand, Debug, Clone)]
 enum ElectrumCommands {
     /// Scans the addresses in the wallet using esplora API.
@@ -43,7 +46,7 @@ pub struct ScanOption {
 }
 
 fn main() -> anyhow::Result<()> {
-    let (args, keymap, mut tracker, mut db) = bdk_cli::init::<ElectrumCommands, _>()?;
+    let (args, keymap, mut tracker, mut db) = bdk_cli::init::<ElectrumArgs, ElectrumCommands, _>()?;
 
     let electrum_url = match args.network {
         Network::Bitcoin => "ssl://electrum.blockstream.info:50002",

bdk_esplora_example/src/main.rs

@@ -7,9 +7,15 @@ use std::io::{self, Write};
 const DEFAULT_PARALLEL_REQUESTS: u8 = 5;
 use bdk_cli::{
     anyhow::{self, Context},
-    clap::{self, Subcommand},
+    clap::{self, Args, Subcommand},
 };
 
+#[derive(Args, Debug, Clone)]
+struct EsploraUrlArgs {
+    #[clap(env = "ESPLORA_URL", long)]
+    url: Option<String>,
+}
+
 #[derive(Subcommand, Debug, Clone)]
 enum EsploraCommands {
     /// Scans the addresses in the wallet using esplora API.
@@ -33,12 +39,17 @@ enum EsploraCommands {
 }
 
 fn main() -> anyhow::Result<()> {
-    let (args, keymap, mut keychain_tracker, mut db) = bdk_cli::init::<EsploraCommands, _>()?;
-    let esplora_url = match args.network {
-        Network::Bitcoin => "https://mempool.space/api",
-        Network::Testnet => "https://mempool.space/testnet/api",
-        Network::Regtest => "http://localhost:3000",
-        Network::Signet => "https://mempool.space/signet/api",
+    let (args, keymap, mut keychain_tracker, mut db) =
+        bdk_cli::init::<EsploraUrlArgs, EsploraCommands, _>()?;
+
+    let esplora_url = match &args.chain_args.url {
+        Some(url) => url.as_str(),
+        None => match args.network {
+            Network::Bitcoin => "https://mempool.space/api",
+            Network::Testnet => "https://mempool.space/testnet/api",
+            Network::Regtest => "http://localhost:3000",
+            Network::Signet => "https://mempool.space/signet/api",
+        },
     };
 
     let client = Client::new(esplora_url, DEFAULT_PARALLEL_REQUESTS)?;

bdk_rpc_example/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "bdk_rpc_example"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+# BDK Core
+bdk_chain = { path = "../bdk_chain", features = ["serde"] }
+bdk_cli = { path = "../bdk_cli_lib"}
+
+# Rpc
+bitcoincore-rpc = "0.16.0"
+
+# Helpers
+ctrlc = "3.2.4"