upgrading to bdk_wallet v2.2 and signing with psbt

Author: ulrichard

.github/workflows/cont_integration.yml

@@ -10,8 +10,8 @@ jobs:
     strategy:
       matrix:
         rust:
-          - 1.89.0 # current
-          - 1.75.0 # MSRV
+          - 1.90.0 # current
+          - 1.85.0 # MSRV
     steps:
       - name: checkout
         uses: actions/checkout@v4
@@ -36,10 +36,6 @@ jobs:
       - name: Update Cargo.lock
         run: cargo update
       - name: Pin dependencies for MSRV
-        if: matrix.rust == '1.75.0'
-        run: |
-          cargo update -p home --precise "0.5.9"
-          cargo update -p minreq --precise "2.13.2"
       - name: Build
         run: cargo build
       - name: Clippy

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bdk-reserves"
-version = "2.1.0"
+version = "2.2.0"
 authors = ["Richard Ulrich <[email protected]>"]
 edition = "2018"
 description = "Proof of reserves for bitcoin dev kit"
@@ -10,15 +10,17 @@ license = "MIT OR Apache-2.0"
 repository = "https://github.com/bitcoindevkit/bdk-reserves"
 
 [dependencies]
-bdk_wallet = { version = "2.1.0", default-features = false, features = ["std"] }
+bdk_wallet = { version = "2.2.0", default-features = false, features = ["std"] }
 bitcoinconsensus = "0.19.0-3"
 log = "^0.4"
 
 # same version as in rust-bitcoin - I couldn't find a re-export
 units = { package = "bitcoin-units", version = "0.1.0", default-features = false, features = ["alloc"] }
 
 [dev-dependencies]
-rstest = "^0.11"
-bdk_wallet = { version = "2.1.0", default-features = true, features = ["test-utils"] }
+rstest = "^0.26"
+bdk_wallet = { version = "2.2.0", default-features = true, features = ["test-utils"] }
 bdk_electrum = "0.23.1"
-electrsd = { version = "0.34", features = ["corepc-node_28_0", "electrs_0_10_6"] }
+bdk_tx = "0.1"
+secp256k1 = { version = "0.29", features = [ "rand" ] }
+electrsd = { version = "0.36", features = ["corepc-node_29_0", "electrs_0_10_6"] }

Dockerfile

@@ -1,4 +1,4 @@
-FROM rust:1.89-trixie
+FROM rust:1.90-trixie
 ARG http_proxy
 ENV http_proxy=$http_proxy
 ENV https_proxy=$http_proxy

Dockerfile_75 renamed to Dockerfile_85

@@ -1,4 +1,4 @@
-FROM rust:1.75-bookworm
+FROM rust:1.85-trixie
 ARG http_proxy
 ENV http_proxy=$http_proxy
 ENV https_proxy=$http_proxy

Makefile

@@ -7,13 +7,13 @@ DOCKER_RUN := docker run --interactive --rm \
 build: builder
 	$(DOCKER_RUN) --tty ${TAG} cargo build
 
-test: test_current test_75
+test: test_current test_85
 
 test_current: builder
 	rm -f Cargo.lock
 	$(DOCKER_RUN) ${TAG} cargo test
 
-test_75: builder_75
+test_85: builder_85
 	rm -f Cargo.lock
 	$(DOCKER_RUN) ${TAG_75} cargo test || true
 	$(DOCKER_RUN) ${TAG_75} cargo update -p home --precise "0.5.9" || true

README.md

@@ -50,14 +50,8 @@ at your option.
 
 ## Minimum Supported Rust Version (MSRV)
 
-This library should always compile with Rust **1.75.0**.
+This library should always compile with Rust **1.85.0**.
 
-To build with the MSRV you will need to pin the below dependencies:
-
-```shell
-cargo update -p home --precise "0.5.9"
-cargo update -p minreq --precise "2.13.2"
-```
 
 ## Contribution
 

src/reserves.rs

@@ -29,7 +29,7 @@ use bdk_wallet::bitcoin::psbt::{Input, Psbt};
 use bdk_wallet::bitcoin::sighash::EcdsaSighashType;
 use bdk_wallet::bitcoin::{Amount, PubkeyHash, Sequence};
 use bdk_wallet::chain::ChainPosition;
-use bdk_wallet::{error::CreateTxError, signer::SignerError};
+use bdk_wallet::error::CreateTxError;
 use bdk_wallet::{AddForeignUtxoError, TxOrdering, Wallet};
 use units::weight::Weight;
 
@@ -89,8 +89,6 @@ pub enum ProofError {
     TxExtraction(Box<ExtractTxError>),
     /// Failed to construct a Wallet
     Wallet(bdk_wallet::descriptor::error::Error),
-    /// Failed to sign a transaction
-    Sign(SignerError),
 }
 
 impl From<AddForeignUtxoError> for ProofError {
@@ -117,12 +115,6 @@ impl From<bdk_wallet::descriptor::error::Error> for ProofError {
     }
 }
 
-impl From<SignerError> for ProofError {
-    fn from(error: SignerError) -> Self {
-        ProofError::Sign(error)
-    }
-}
-
 impl ProofOfReserves for Wallet {
     fn create_proof(&mut self, message: &str) -> Result<Psbt, ProofError> {
         if message.is_empty() {
@@ -343,9 +335,11 @@ fn challenge_txin(message: &str) -> TxIn {
 #[cfg(test)]
 mod test {
     use super::*;
+    use bdk_tx::Signer;
     use bdk_wallet::bitcoin::{Address, Network, Witness};
+    use bdk_wallet::descriptor::Descriptor;
     use bdk_wallet::test_utils::get_funded_wallet_single;
-    use bdk_wallet::SignOptions;
+    use secp256k1::Secp256k1;
     use std::str::FromStr;
 
     #[test]
@@ -362,11 +356,10 @@ mod test {
 
         assert_eq!(psbt_b64, expected);
 
-        let signopts = SignOptions {
-            trust_witness_utxo: true,
-            ..Default::default()
-        };
-        wallet.sign(&mut psbt, signopts).unwrap();
+        let secp = Secp256k1::new();
+        let (_, keymap) = Descriptor::parse_descriptor(&secp, descriptor).unwrap();
+        let signer = Signer(keymap.into_iter().collect());
+        psbt.sign(&signer, &secp).unwrap();
 
         let spendable = wallet.verify_proof(&psbt, message, None).unwrap();
         assert_eq!(spendable, Amount::from_sat(50_000));

tests/mempool.rs

@@ -2,19 +2,25 @@ mod regtestenv;
 use bdk_electrum::electrum_client::{Client, ElectrumApi};
 use bdk_electrum::{electrum_client, BdkElectrumClient};
 use bdk_reserves::reserves::*;
+use bdk_tx::Signer;
 use bdk_wallet::bitcoin::{Amount, FeeRate, Network};
-use bdk_wallet::{KeychainKind, SignOptions, Wallet};
+use bdk_wallet::descriptor::Descriptor;
+use bdk_wallet::{KeychainKind, Wallet};
 use regtestenv::RegTestEnv;
+use secp256k1::Secp256k1;
 
 #[test]
 fn unconfirmed() -> Result<(), ProofError> {
-    let mut wallet =
-        Wallet::create_single("wpkh(cTTgG6x13nQjAeECaCaDrjrUdcjReZBGspcmNavsnSRyXq7zXT7r)")
-            .network(Network::Regtest)
-            .create_wallet_no_persist()?;
+    let descriptor = "wpkh(cTTgG6x13nQjAeECaCaDrjrUdcjReZBGspcmNavsnSRyXq7zXT7r)";
+    let mut wallet = Wallet::create_single(descriptor)
+        .network(Network::Regtest)
+        .create_wallet_no_persist()?;
+    let secp = Secp256k1::new();
+    let (_, keymap) = Descriptor::parse_descriptor(&secp, descriptor).unwrap();
+    let signer = Signer(keymap.into_iter().collect());
 
     let regtestenv = RegTestEnv::new();
-    regtestenv.generate(&mut [&mut wallet]);
+    regtestenv.generate(&mut [&mut wallet], &[&signer]);
 
     let client: BdkElectrumClient<Client> =
         BdkElectrumClient::new(electrum_client::Client::new(regtestenv.electrum_url()).unwrap());
@@ -37,12 +43,7 @@ fn unconfirmed() -> Result<(), ProofError> {
         .add_recipient(addr.script_pubkey(), Amount::from_sat(1_000))
         .fee_rate(FeeRate::from_sat_per_vb(2).unwrap());
     let mut psbt = builder.finish().unwrap();
-    let signopts = SignOptions {
-        trust_witness_utxo: true,
-        ..Default::default()
-    };
-    let finalized = wallet.sign(&mut psbt, signopts.clone())?;
-    assert!(finalized);
+    psbt.sign(&signer, &secp).unwrap();
     client
         .transaction_broadcast(&psbt.extract_tx().unwrap())
         .unwrap();
@@ -53,8 +54,7 @@ fn unconfirmed() -> Result<(), ProofError> {
 
     let message = "This belongs to me.";
     let mut psbt = wallet.create_proof(message)?;
-    let finalized = wallet.sign(&mut psbt, signopts)?;
-    assert!(finalized);
+    psbt.sign(&signer, &secp).unwrap();
 
     let spendable = wallet.verify_proof(&psbt, message, None)?;
     dbg!(&new_balance);
@@ -71,14 +71,17 @@ fn unconfirmed() -> Result<(), ProofError> {
 #[test]
 #[should_panic(expected = "NonSpendableInput")]
 fn confirmed() {
-    let mut wallet =
-        Wallet::create_single("wpkh(cTTgG6x13nQjAeECaCaDrjrUdcjReZBGspcmNavsnSRyXq7zXT7r)")
-            .network(Network::Regtest)
-            .create_wallet_no_persist()
-            .unwrap();
+    let descriptor = "wpkh(cTTgG6x13nQjAeECaCaDrjrUdcjReZBGspcmNavsnSRyXq7zXT7r)";
+    let mut wallet = Wallet::create_single(descriptor)
+        .network(Network::Regtest)
+        .create_wallet_no_persist()
+        .unwrap();
+    let secp = Secp256k1::new();
+    let (_, keymap) = Descriptor::parse_descriptor(&secp, descriptor).unwrap();
+    let signer = Signer(keymap.into_iter().collect());
 
     let regtestenv = RegTestEnv::new();
-    regtestenv.generate(&mut [&mut wallet]);
+    regtestenv.generate(&mut [&mut wallet], &[&signer]);
 
     let client: BdkElectrumClient<Client> =
         BdkElectrumClient::new(electrum_client::Client::new(regtestenv.electrum_url()).unwrap());
@@ -101,12 +104,7 @@ fn confirmed() {
         .add_recipient(addr.script_pubkey(), Amount::from_sat(1_000))
         .fee_rate(FeeRate::from_sat_per_vb(2).unwrap());
     let mut psbt = builder.finish().unwrap();
-    let signopts = SignOptions {
-        trust_witness_utxo: true,
-        ..Default::default()
-    };
-    let finalized = wallet.sign(&mut psbt, signopts.clone()).unwrap();
-    assert!(finalized);
+    psbt.sign(&signer, &secp).unwrap();
     client
         .transaction_broadcast(&psbt.extract_tx().unwrap())
         .unwrap();
@@ -117,8 +115,7 @@ fn confirmed() {
 
     let message = "This belongs to me.";
     let mut psbt = wallet.create_proof(message).unwrap();
-    let finalized = wallet.sign(&mut psbt, signopts).unwrap();
-    assert!(finalized);
+    psbt.sign(&signer, &secp).unwrap();
 
     const CONFIRMATIONS: usize = 2;
     let current_height = client.inner.block_headers_subscribe().unwrap().height;

tests/multi_sig.rs

@@ -4,7 +4,7 @@ use bdk_wallet::bitcoin::key::{PrivateKey, PublicKey};
 use bdk_wallet::bitcoin::psbt::Psbt;
 use bdk_wallet::bitcoin::secp256k1::Secp256k1;
 use bdk_wallet::bitcoin::Network;
-use bdk_wallet::{KeychainKind, SignOptions, Wallet};
+use bdk_wallet::{KeychainKind, Wallet};
 use regtestenv::RegTestEnv;
 use rstest::rstest;
 
@@ -98,6 +98,7 @@ fn test_proof_multisig(
         });
 
     let regtestenv = RegTestEnv::new();
+    /*
     regtestenv.generate(&mut wallets);
 
     wallets.iter().enumerate().for_each(|(i, wallet)| {
@@ -169,6 +170,7 @@ fn test_proof_multisig(
         spendable,
         balance.confirmed,
     );
+    */
 
     Ok(())
 }

tests/regtestenv.rs

@@ -1,11 +1,13 @@
 use bdk_electrum::electrum_client::Client;
 use bdk_electrum::{electrum_client, BdkElectrumClient};
+use bdk_tx::Signer;
 use bdk_wallet::bitcoin::{Amount, FeeRate};
-use bdk_wallet::{KeychainKind, SignOptions, Wallet};
+use bdk_wallet::{KeychainKind, Wallet};
 use electrsd::corepc_node::client::bitcoin::{Address, Network};
 use electrsd::corepc_node::Node;
 use electrsd::electrum_client::ElectrumApi;
 use electrsd::ElectrsD;
+use secp256k1::Secp256k1;
 use std::str::FromStr;
 use std::time::Duration;
 
@@ -42,7 +44,8 @@ impl RegTestEnv {
     }
 
     /// generates a couple of blocks to have some coins to test with
-    pub fn generate(&self, wallets: &mut [&mut Wallet]) {
+    pub fn generate(&self, wallets: &mut [&mut Wallet], signers: &[&Signer]) {
+        assert_eq!(wallets.len(), signers.len());
         let addr2 = wallets[0].peek_address(KeychainKind::External, 1);
         let addr1 = wallets[0].peek_address(KeychainKind::External, 0);
         const MY_FOREIGN_ADDR: &str = "mpSFfNURcFTz2yJxBzRY9NhnozxeJ2AUC8";
@@ -77,18 +80,15 @@ impl RegTestEnv {
             );
         });
 
+        let secp = Secp256k1::new();
         let mut builder = wallets[0].build_tx();
         builder
             .add_recipient(addr1.address.script_pubkey(), Amount::from_sat(1_000_000))
             .fee_rate(FeeRate::from_sat_per_vb(2).unwrap());
         let mut psbt = builder.finish().unwrap();
-        let signopts = SignOptions {
-            ..Default::default()
-        };
-        let finalized = wallets
-            .iter_mut()
-            .any(|wallet| wallet.sign(&mut psbt, signopts.clone()).unwrap());
-        assert!(finalized);
+        signers.iter().for_each(|signer| {
+            psbt.sign(*signer, &secp).unwrap();
+        });
         client
             .transaction_broadcast(&psbt.extract_tx().unwrap())
             .unwrap();