chore: update for bdk_wallet 3.1.0 API changes

    - bump bdk_wallet to 3.1.0
    - replace Network with NetworkKind
    - replace TxBuilder::include_output_redeem_witness_script with TxBuilder::add_global_xpubs

Author: aagbotemi

Cargo.lock

@@ -12,7 +12,7 @@ readme = "README.md"
 license = "MIT"
 
 [dependencies]
-bdk_wallet = { version = "2.4.0", features = ["rusqlite", "keys-bip39", "compiler", "std"] }
+bdk_wallet = { version = "3.1.0", features = ["rusqlite", "keys-bip39", "compiler", "std"] }
 clap = { version = "4.6", features = ["derive","env"] }
 clap_complete = "4.6"
 dirs = {  version = "6.0.0" }
@@ -32,8 +32,8 @@ tap = "1.0.1"
 bdk_bitcoind_rpc = { version = "0.22.0", features = ["std"], optional = true }
 bdk_electrum = { version = "0.24.0", optional = true }
 bdk_esplora = { version = "0.22.2", features = ["async-https", "tokio"], optional = true }
-bdk_kyoto = { version = "0.15.4", optional = true }
-bdk_redb = { version = "0.1.1", optional = true }
+bdk_kyoto = { version = "0.17.0", optional = true }
+bdk_redb = { version = "0.2.0", optional = true }
 bdk_sp = { version = "0.1.0", optional = true, git = "https://github.com/bitcoindevkit/bdk-sp", tag = "v0.1.0" }
 shlex = {  version = "1.3.0", optional = true }
 payjoin = { version = "0.25.0", features = ["v1", "v2", "io", "_test-utils"], optional = true}

Cargo.toml

@@ -23,10 +23,7 @@ use {
 };
 
 #[cfg(feature = "cbf")]
-use {
-    crate::utils::trace_logger,
-    bdk_kyoto::{BuilderExt, LightClient},
-};
+use {crate::utils::trace_logger, bdk_kyoto::BuilderExt};
 
 #[cfg(any(
     feature = "electrum",
@@ -101,14 +98,10 @@ impl BlockchainClient {
             #[cfg(feature = "cbf")]
             Self::KyotoClient { client } => {
                 let txid = tx.compute_txid();
-                let wtxid = client
-                    .requester
-                    .broadcast_random(tx.clone())
-                    .await
-                    .map_err(|_| {
-                        tracing::warn!("Broadcast was unsuccessful");
-                        Error::Generic("Transaction broadcast timed out after 30 seconds".into())
-                    })?;
+                let wtxid = client.requester.submit_package(tx).await.map_err(|_| {
+                    tracing::warn!("Broadcast was unsuccessful");
+                    Error::Generic("Transaction broadcast timed out after 30 seconds".into())
+                })?;
                 tracing::info!("Successfully broadcast WTXID: {wtxid}");
                 Ok(txid)
             }
@@ -205,7 +198,8 @@ impl BlockchainClient {
 #[cfg(feature = "cbf")]
 pub struct KyotoClientHandle {
     pub requester: bdk_kyoto::Requester,
-    pub update_subscriber: tokio::sync::Mutex<bdk_kyoto::UpdateSubscriber>,
+    pub update_subscriber:
+        tokio::sync::Mutex<bdk_kyoto::UpdateSubscriber<bdk_kyoto::wallets::Single>>,
 }
 
 #[cfg(any(
@@ -267,21 +261,16 @@ pub(crate) fn new_blockchain_client(
                 .data_dir(&_datadir)
                 .build_with_wallet(_wallet, scan_type)?;
 
-            let LightClient {
-                requester,
-                info_subscriber,
-                warning_subscriber,
-                update_subscriber,
-                node,
-            } = light_client;
+            let (client, logging, update_subscriber) = light_client.subscribe();
+            // `start()` spawns the node's run loop on a tokio task internally.
+            let requester = client.start().requester();
 
             let subscriber = tracing_subscriber::FmtSubscriber::new();
             let _ = tracing::subscriber::set_global_default(subscriber);
 
-            tokio::task::spawn(async move { node.run().await });
-            tokio::task::spawn(
-                async move { trace_logger(info_subscriber, warning_subscriber).await },
-            );
+            tokio::task::spawn(async move {
+                trace_logger(logging.info_subscriber, logging.warning_subscriber).await
+            });
 
             BlockchainClient::KyotoClient {
                 client: Box::new(KyotoClientHandle {

src/client.rs

@@ -127,7 +127,7 @@ impl AsyncAppCommand<AppContext<OfflineOperations<'_>>> for CreateDnsTxCommand {
             tx_builder.set_exact_sequence(Sequence::MAX);
         }
         if self.offline_signer {
-            tx_builder.include_output_redeem_witness_script();
+            tx_builder.add_global_xpubs();
         }
         if let Some(fee_rate) = self.fee_rate
             && let Some(fee_rate) = FeeRate::from_sat_per_vb(fee_rate as u64)

src/handlers/dns/mod.rs

@@ -56,7 +56,7 @@ impl AppCommand<AppContext<Init>> for GenerateKeyCommand {
                 .map_err(|_| Error::Generic("Mnemonic generation error".to_string()))?;
         let mnemonic = mnemonic.into_key();
         let xkey: ExtendedKey = (mnemonic.clone(), self.password.clone()).into_extended_key()?;
-        let xprv = xkey.into_xprv(ctx.network).ok_or_else(|| {
+        let xprv = xkey.into_xprv(ctx.network.into()).ok_or_else(|| {
             Error::Generic("Privatekey info not found (should not happen)".to_string())
         })?;
         let fingerprint = xprv.fingerprint(&secp);
@@ -139,7 +139,7 @@ impl AppCommand<AppContext<Init>> for RestoreKeyCommand {
 
         let mnemonic = Mnemonic::parse_in(Language::English, &self.mnemonic)?;
         let xkey: ExtendedKey = (mnemonic.clone(), &self.password).0.into_extended_key()?;
-        let xprv = xkey.into_xprv(ctx.network).ok_or_else(|| {
+        let xprv = xkey.into_xprv(ctx.network.into()).ok_or_else(|| {
             Error::Generic("Privatekey info not found (should not happen)".to_string())
         })?;
         let fingerprint = xprv.fingerprint(&secp);

src/handlers/key.rs

@@ -32,7 +32,7 @@ use {
 use {
     crate::utils::parse_signature_format,
     crate::utils::types::MessageResult,
-    bdk_message_signer::{MessageSigner, MessageProof},
+    bdk_message_signer::{MessageProof, MessageSigner},
 };
 
 impl OfflineWalletSubCommand {
@@ -269,7 +269,7 @@ impl AppCommand<AppContext<OfflineOperations<'_>>> for CreateTxCommand {
         }
 
         if self.offline_signer {
-            tx_builder.include_output_redeem_witness_script();
+            tx_builder.add_global_xpubs();
         }
 
         if let Some(fee_rate) = self.fee_rate
@@ -424,7 +424,7 @@ impl AppCommand<AppContext<OfflineOperations<'_>>> for CreateSpTxCommand {
         tx_builder.set_exact_sequence(Sequence::MAX);
 
         if self.offline_signer {
-            tx_builder.include_output_redeem_witness_script();
+            tx_builder.add_global_xpubs();
         }
 
         if let Some(fee_rate) = self.fee_rate
@@ -586,7 +586,7 @@ impl AppCommand<AppContext<OfflineOperations<'_>>> for BumpFeeCommand {
         }
 
         if self.offline_signer {
-            tx_builder.include_output_redeem_witness_script();
+            tx_builder.add_global_xpubs();
         }
 
         if let Some(utxos) = &self.utxos {

src/handlers/offline.rs

@@ -1,8 +1,8 @@
 use crate::{commands::WalletOpts, config::WalletConfig, error::BDKCliError as Error};
-#[cfg(feature = "message_signer")]
-use bdk_message_signer::SignatureFormat;
 #[cfg(feature = "cbf")]
 use bdk_kyoto::{Info, Receiver, UnboundedReceiver, Warning};
+#[cfg(feature = "message_signer")]
+use bdk_message_signer::SignatureFormat;
 #[cfg(feature = "silent-payments")]
 use bdk_sp::encoding::SilentPaymentCode;
 use bdk_wallet::bitcoin::{Address, Network, OutPoint, ScriptBuf};
@@ -12,7 +12,7 @@ use bdk_wallet::bitcoin::{Address, Network, OutPoint, ScriptBuf};
     feature = "cbf",
     feature = "rpc"
 ))]
-use bdk_wallet::{bitcoin::Psbt, event::WalletEvent};
+use bdk_wallet::{WalletEvent, bitcoin::Psbt};
 
 use crate::commands::OfflineWalletSubCommand;
 use std::{

src/utils/common.rs

@@ -61,10 +61,10 @@ fn generate_private_descriptors(
     let fingerprint = xprv.fingerprint(&secp);
 
     let (external_desc, external_keymap, _) = match desc_type.to_lowercase().as_str() {
-        "pkh" => Bip44(xprv, KeychainKind::External).build(network)?,
-        "sh" => Bip49(xprv, KeychainKind::External).build(network)?,
-        "wpkh" | "wsh" => Bip84(xprv, KeychainKind::External).build(network)?,
-        "tr" => Bip86(xprv, KeychainKind::External).build(network)?,
+        "pkh" => Bip44(xprv, KeychainKind::External).build(network.into())?,
+        "sh" => Bip49(xprv, KeychainKind::External).build(network.into())?,
+        "wpkh" | "wsh" => Bip84(xprv, KeychainKind::External).build(network.into())?,
+        "tr" => Bip86(xprv, KeychainKind::External).build(network.into())?,
         _ => {
             return Err(Error::Generic(format!(
                 "Unsupported descriptor type: {desc_type}"
@@ -73,10 +73,10 @@ fn generate_private_descriptors(
     };
 
     let (internal_desc, internal_keymap, _) = match desc_type.to_lowercase().as_str() {
-        "pkh" => Bip44(xprv, KeychainKind::Internal).build(network)?,
-        "sh" => Bip49(xprv, KeychainKind::Internal).build(network)?,
-        "wpkh" | "wsh" => Bip84(xprv, KeychainKind::Internal).build(network)?,
-        "tr" => Bip86(xprv, KeychainKind::Internal).build(network)?,
+        "pkh" => Bip44(xprv, KeychainKind::Internal).build(network.into())?,
+        "sh" => Bip49(xprv, KeychainKind::Internal).build(network.into())?,
+        "wpkh" | "wsh" => Bip84(xprv, KeychainKind::Internal).build(network.into())?,
+        "tr" => Bip86(xprv, KeychainKind::Internal).build(network.into())?,
         _ => {
             return Err(Error::Generic(format!(
                 "Unsupported descriptor type: {desc_type}"

src/utils/descriptors.rs

@@ -151,7 +151,7 @@ mod test_offline {
         .stderr(predicate::str::contains("Invalid"));
     }
 
-    #[cfg(feature = "bip322")]
+    #[cfg(feature = "message_signer")]
     #[test]
     fn test_sign_message_and_verify_message() {
         let (cli, mut cmd_init) = setup_wallet_config();
@@ -216,7 +216,7 @@ mod test_offline {
         .stdout(predicate::str::contains("\"valid\": true"));
     }
 
-    #[cfg(feature = "bip322")]
+    #[cfg(feature = "message_signer")]
     #[test]
     fn test_verify_message_rejects_tampered_message() {
         let (cli, mut cmd_init) = setup_wallet_config();