Bump version to 0.7.0

e469dcd32c Add test with funded wallet (Steve Myers)

Pull request description:

  This PR adds an example test using the `bdk` test funded wallet.  The example test makes sure the `bdk-ffi` `TxBuilder` is able to drain a single wallet UTXO to a single address.  More tests can be added as we need them in future PRs.

  Required to complete #141

Top commit has no ACKs.

Tree-SHA512: 780e8cf5b3d3091f3322113f017c5b5524b30a3ac9e18910539c51042740d2809535a947b8d56012076ac5e9ad1abcf707ceaf17651457ea327a0b522fcc1002

.gitignore

@@ -14,3 +14,4 @@ testdb
 xcuserdata
 .lsp
 .clj-kondo
+.idea/

CHANGELOG.md

@@ -6,6 +6,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [v0.7.0]
+
+- Update BDK to version 0.19.0
+  - fixes sqlite-db issue causing wrong balance
+  - adds experimental taproot descriptor and PSBT support
+- APIs Removed 
+  - `Wallet.get_new_address()`, returned String, [#137] 
+  - `Wallet.get_last_unused_address()`, returned String [#137]
+- APIs Added
+  - `Wallet.get_address(AddressIndex)`, returns `AddressInfo` [#137]
+- APIs Changed
+  - `Wallet.sign(PartiallySignedBitcoinTransaction)` now returns a bool, true if finalized [#161]
+
+[#137]: https://github.com/bitcoindevkit/bdk-ffi/pull/137
+[#161]: https://github.com/bitcoindevkit/bdk-ffi/pull/161
+
 ## [v0.6.0]
 
 - Update BDK to version 0.18.0
@@ -43,7 +59,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [v0.2.0]
 
-[unreleased]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.6.0...HEAD
+[unreleased]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.7.0...HEAD
+[v0.7.0]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.6.0...v0.7.0
 [v0.6.0]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.5.0...v0.6.0
 [v0.5.0]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.4.0...v0.5.0
 [v0.4.0]: https://github.com/bitcoindevkit/bdk-ffi/compare/v0.3.1...v0.4.0

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bdk-ffi"
-version = "0.6.0"
+version = "0.7.0"
 authors = ["Steve Myers <steve@notmandatory.org>", "Sudarsan Balaji <sudarsan.balaji@artfuldev.com>"]
 edition = "2018"
 
@@ -14,7 +14,7 @@ crate-type = ["staticlib", "cdylib"]
 name = "bdkffi"
 
 [dependencies]
-bdk = { version = "0.18", features = ["all-keys", "use-esplora-ureq", "sqlite-bundled"] }
+bdk = { version = "0.19", features = ["all-keys", "use-esplora-ureq", "sqlite-bundled"] }
 
 uniffi_macros = { version = "0.16.0", features = ["builtin-bindgen"] }
 uniffi = { version = "0.16.0", features = ["builtin-bindgen"] }

src/bdk.udl

@@ -1,6 +1,7 @@
 namespace bdk {
   [Throws=BdkError]
   ExtendedKeyInfo generate_extended_key(Network network, WordCount word_count, string? password);
+
   [Throws=BdkError]
   ExtendedKeyInfo restore_extended_key(Network network, string mnemonic, string? password);
 };
@@ -49,6 +50,16 @@ enum BdkError {
   "Rusqlite",
 };
 
+dictionary AddressInfo {
+  u32 index;
+  string address;
+};
+
+enum AddressIndex {
+  "New",
+  "LastUnused",
+};
+
 enum Network {
   "Bitcoin",
   "Testnet",
@@ -73,15 +84,15 @@ interface DatabaseConfig {
 };
 
 dictionary TransactionDetails {
-    u64? fee;
-    u64 received;
-    u64 sent;
-    string txid;
+  u64? fee;
+  u64 received;
+  u64 sent;
+  string txid;
 };
 
 dictionary BlockTime {
-    u32 height;
-    u64 timestamp;
+  u32 height;
+  u64 timestamp;
 };
 
 [Enum]
@@ -90,6 +101,20 @@ interface Transaction {
   Confirmed(TransactionDetails details, BlockTime confirmation);
 };
 
+dictionary ExtendedKeyInfo {
+  string mnemonic;
+  string xprv;
+  string fingerprint;
+};
+
+enum WordCount {
+  "Words12",
+  "Words15",
+  "Words18",
+  "Words21",
+  "Words24",
+};
+
 dictionary ElectrumConfig {
   string url;
   string? socks5;
@@ -115,6 +140,7 @@ interface BlockchainConfig {
 interface Blockchain {
   [Throws=BdkError]
   constructor(BlockchainConfig config);
+
   [Throws=BdkError]
   void broadcast([ByRef] PartiallySignedBitcoinTransaction psbt);
 };
@@ -126,15 +152,21 @@ callback interface Progress {
 interface Wallet {
   [Throws=BdkError]
   constructor(string descriptor, string? change_descriptor, Network network, DatabaseConfig database_config);
-  string get_new_address();
-  string get_last_unused_address();
+
+  [Throws=BdkError]
+  AddressInfo get_address(AddressIndex address_index);
+
   [Throws=BdkError]
   u64 get_balance();
+
   [Throws=BdkError]
-  void sign([ByRef] PartiallySignedBitcoinTransaction psbt);
+  boolean sign([ByRef] PartiallySignedBitcoinTransaction psbt);
+
   [Throws=BdkError]
   sequence<Transaction> get_transactions();
+
   Network get_network();
+
   [Throws=BdkError]
   void sync([ByRef] Blockchain blockchain, Progress? progress);
 };
@@ -142,41 +174,40 @@ interface Wallet {
 interface PartiallySignedBitcoinTransaction {
   [Throws=BdkError]
   constructor(string psbt_base64);
+
   string serialize();
+
   string txid();
 };
 
 interface TxBuilder {
   constructor();
+
   TxBuilder add_recipient(string address, u64 amount);
+
   TxBuilder fee_rate(float sat_per_vbyte);
+
   TxBuilder drain_wallet();
+
   TxBuilder drain_to(string address);
+
   TxBuilder enable_rbf();
+
   TxBuilder enable_rbf_with_sequence(u32 nsequence);
+
   [Throws=BdkError]
   PartiallySignedBitcoinTransaction finish([ByRef] Wallet wallet);
 };
 
 interface BumpFeeTxBuilder {
   constructor(string txid, float new_fee_rate);
+
   BumpFeeTxBuilder allow_shrinking(string address);
+
   BumpFeeTxBuilder enable_rbf();
+
   BumpFeeTxBuilder enable_rbf_with_sequence(u32 nsequence);
+
   [Throws=BdkError]
   PartiallySignedBitcoinTransaction finish([ByRef] Wallet wallet);
 };
-
-dictionary ExtendedKeyInfo {
-  string mnemonic;
-  string xprv;
-  string fingerprint;
-};
-
-enum WordCount {
-  "Words12",
-  "Words15",
-  "Words18",
-  "Words21",
-  "Words24",
-};

src/lib.rs

@@ -12,11 +12,12 @@ use bdk::database::{AnyDatabaseConfig, ConfigurableDatabase};
 use bdk::keys::bip39::{Language, Mnemonic, WordCount};
 use bdk::keys::{DerivableKey, ExtendedKey, GeneratableKey, GeneratedKey};
 use bdk::miniscript::BareCtx;
-use bdk::wallet::AddressIndex;
+use bdk::wallet::AddressIndex as BdkAddressIndex;
+use bdk::wallet::AddressInfo as BdkAddressInfo;
 use bdk::{
     BlockTime, Error, FeeRate, SignOptions, SyncOptions as BdkSyncOptions, Wallet as BdkWallet,
 };
-use std::convert::TryFrom;
+use std::convert::{From, TryFrom};
 use std::fmt;
 use std::ops::Deref;
 use std::str::FromStr;
@@ -26,6 +27,34 @@ uniffi_macros::include_scaffolding!("bdk");
 
 type BdkError = Error;
 
+pub struct AddressInfo {
+    pub index: u32,
+    pub address: String,
+}
+
+impl From<BdkAddressInfo> for AddressInfo {
+    fn from(x: bdk::wallet::AddressInfo) -> AddressInfo {
+        AddressInfo {
+            index: x.index,
+            address: x.address.to_string(),
+        }
+    }
+}
+
+pub enum AddressIndex {
+    New,
+    LastUnused,
+}
+
+impl From<AddressIndex> for BdkAddressIndex {
+    fn from(x: AddressIndex) -> BdkAddressIndex {
+        match x {
+            AddressIndex::New => BdkAddressIndex::New,
+            AddressIndex::LastUnused => BdkAddressIndex::LastUnused,
+        }
+    }
+}
+
 pub enum DatabaseConfig {
     Memory,
     Sled { config: SledDbConfiguration },
@@ -235,36 +264,19 @@ impl Wallet {
         self.get_wallet().sync(blockchain.deref(), bdk_sync_opts)
     }
 
-    fn get_new_address(&self) -> String {
+    fn get_address(&self, address_index: AddressIndex) -> Result<AddressInfo, BdkError> {
         self.get_wallet()
-            .get_address(AddressIndex::New)
-            .unwrap()
-            .address
-            .to_string()
-    }
-
-    fn get_last_unused_address(&self) -> String {
-        self.get_wallet()
-            .get_address(AddressIndex::LastUnused)
-            .unwrap()
-            .address
-            .to_string()
+            .get_address(address_index.into())
+            .map(AddressInfo::from)
     }
 
     fn get_balance(&self) -> Result<u64, Error> {
         self.get_wallet().get_balance()
     }
 
-    fn sign(&self, psbt: &PartiallySignedBitcoinTransaction) -> Result<(), Error> {
+    fn sign(&self, psbt: &PartiallySignedBitcoinTransaction) -> Result<bool, Error> {
         let mut psbt = psbt.internal.lock().unwrap();
-        let finalized = self.get_wallet().sign(&mut psbt, SignOptions::default())?;
-        match finalized {
-            true => Ok(()),
-            false => Err(BdkError::Generic(format!(
-                "transaction signing not finalized {:?}",
-                psbt
-            ))),
-        }
+        self.get_wallet().sign(&mut psbt, SignOptions::default())
     }
 
     fn get_transactions(&self) -> Result<Vec<Transaction>, Error> {
@@ -319,12 +331,13 @@ fn to_script_pubkey(address: &str) -> Result<Script, BdkError> {
         .map_err(|e| BdkError::Generic(e.to_string()))
 }
 
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 enum RbfValue {
     Default,
     Value(u32),
 }
 
+#[derive(Clone, Debug)]
 struct TxBuilder {
     recipients: Vec<(String, u64)>,
     fee_rate: Option<f32>,
@@ -349,60 +362,42 @@ impl TxBuilder {
         recipients.append(&mut vec![(recipient, amount)]);
         Arc::new(TxBuilder {
             recipients,
-            fee_rate: self.fee_rate,
-            drain_wallet: self.drain_wallet,
-            drain_to: self.drain_to.clone(),
-            rbf: self.rbf.clone(),
+            ..self.clone()
         })
     }
 
     fn fee_rate(&self, sat_per_vb: f32) -> Arc<Self> {
         Arc::new(TxBuilder {
-            recipients: self.recipients.to_vec(),
             fee_rate: Some(sat_per_vb),
-            drain_wallet: self.drain_wallet,
-            drain_to: self.drain_to.clone(),
-            rbf: self.rbf.clone(),
+            ..self.clone()
         })
     }
 
     fn drain_wallet(&self) -> Arc<Self> {
         Arc::new(TxBuilder {
-            recipients: self.recipients.to_vec(),
-            fee_rate: self.fee_rate,
             drain_wallet: true,
-            drain_to: self.drain_to.clone(),
-            rbf: self.rbf.clone(),
+            ..self.clone()
         })
     }
 
     fn drain_to(&self, address: String) -> Arc<Self> {
         Arc::new(TxBuilder {
-            recipients: self.recipients.to_vec(),
-            fee_rate: self.fee_rate,
-            drain_wallet: self.drain_wallet,
             drain_to: Some(address),
-            rbf: self.rbf.clone(),
+            ..self.clone()
         })
     }
 
     fn enable_rbf(&self) -> Arc<Self> {
         Arc::new(TxBuilder {
-            recipients: self.recipients.to_vec(),
-            fee_rate: self.fee_rate,
-            drain_wallet: self.drain_wallet,
-            drain_to: self.drain_to.clone(),
             rbf: Some(RbfValue::Default),
+            ..self.clone()
         })
     }
 
     fn enable_rbf_with_sequence(&self, nsequence: u32) -> Arc<Self> {
         Arc::new(TxBuilder {
-            recipients: self.recipients.to_vec(),
-            fee_rate: self.fee_rate,
-            drain_wallet: self.drain_wallet,
-            drain_to: self.drain_to.clone(),
             rbf: Some(RbfValue::Value(nsequence)),
+            ..self.clone()
         })
     }
 
@@ -440,6 +435,7 @@ impl TxBuilder {
     }
 }
 
+#[derive(Clone)]
 struct BumpFeeTxBuilder {
     txid: String,
     fee_rate: f32,
@@ -459,28 +455,22 @@ impl BumpFeeTxBuilder {
 
     fn allow_shrinking(&self, address: String) -> Arc<Self> {
         Arc::new(Self {
-            txid: self.txid.clone(),
-            fee_rate: self.fee_rate,
             allow_shrinking: Some(address),
-            rbf: self.rbf.clone(),
+            ..self.clone()
         })
     }
 
     fn enable_rbf(&self) -> Arc<Self> {
         Arc::new(Self {
-            txid: self.txid.clone(),
-            fee_rate: self.fee_rate,
-            allow_shrinking: self.allow_shrinking.clone(),
             rbf: Some(RbfValue::Default),
+            ..self.clone()
         })
     }
 
     fn enable_rbf_with_sequence(&self, nsequence: u32) -> Arc<Self> {
         Arc::new(Self {
-            txid: self.txid.clone(),
-            fee_rate: self.fee_rate,
-            allow_shrinking: self.allow_shrinking.clone(),
             rbf: Some(RbfValue::Value(nsequence)),
+            ..self.clone()
         })
     }
 
@@ -515,3 +505,70 @@ impl BumpFeeTxBuilder {
 }
 
 uniffi::deps::static_assertions::assert_impl_all!(Wallet: Sync, Send);
+
+// The goal of these tests to to ensure `bdk-ffi` intermediate code correctly calls `bdk` APIs.
+// These tests should not be used to verify `bdk` behavior that is already tested in the `bdk`
+// crate.
+#[cfg(test)]
+mod test {
+    use crate::{TxBuilder, Wallet};
+    use bdk::bitcoin::Address;
+    use bdk::bitcoin::Network::Testnet;
+    use bdk::wallet::get_funded_wallet;
+    use std::str::FromStr;
+    use std::sync::Mutex;
+
+    #[test]
+    fn test_drain_wallet() {
+        let test_wpkh = "wpkh(cVpPVruEDdmutPzisEsYvtST1usBR3ntr8pXSyt6D2YYqXRyPcFW)";
+        let (funded_wallet, _, _) = get_funded_wallet(test_wpkh);
+        let test_wallet = Wallet {
+            wallet_mutex: Mutex::new(funded_wallet),
+        };
+        let drain_to_address = "tb1ql7w62elx9ucw4pj5lgw4l028hmuw80sndtntxt".to_string();
+        let tx_builder = TxBuilder::new()
+            .drain_wallet()
+            .drain_to(drain_to_address.clone());
+        //dbg!(&tx_builder);
+        assert_eq!(tx_builder.drain_wallet, true);
+        assert_eq!(tx_builder.drain_to, Some(drain_to_address));
+
+        let psbt = tx_builder.finish(&test_wallet).unwrap();
+        let psbt = psbt.internal.lock().unwrap().clone();
+
+        // confirm one input with 50,000 sats
+        assert_eq!(psbt.inputs.len(), 1);
+        let input_value = psbt
+            .inputs
+            .get(0)
+            .cloned()
+            .unwrap()
+            .non_witness_utxo
+            .unwrap()
+            .output
+            .get(0)
+            .unwrap()
+            .value;
+        assert_eq!(input_value, 50_000 as u64);
+
+        // confirm one output to correct address with all sats - fee
+        assert_eq!(psbt.outputs.len(), 1);
+        let output_address = Address::from_script(
+            &psbt
+                .unsigned_tx
+                .output
+                .get(0)
+                .cloned()
+                .unwrap()
+                .script_pubkey,
+            Testnet,
+        )
+        .unwrap();
+        assert_eq!(
+            output_address,
+            Address::from_str("tb1ql7w62elx9ucw4pj5lgw4l028hmuw80sndtntxt").unwrap()
+        );
+        let output_value = psbt.unsigned_tx.output.get(0).cloned().unwrap().value;
+        assert_eq!(output_value, 49_890 as u64); // input - fee
+    }
+}