feat: convert between FFI/Rust changesets

Author: rustaceanrob

bdk-ffi/src/bdk.udl

@@ -304,10 +304,6 @@ interface FullScanScriptInspector {
   void inspect(KeychainKind keychain, u32 index, Script script);
 };
 
-/// A changeset for [`Wallet`].
-[Remote]
-interface ChangeSet {};
-
 // ------------------------------------------------------------------------
 // bdk_wallet crate - wallet module
 // ------------------------------------------------------------------------

bdk-ffi/src/bitcoin.rs

@@ -72,13 +72,22 @@ impl From<OutPoint> for BdkOutPoint {
     }
 }
 
-/// An [`OutPoint`] suitable as a key in a hash map.
+/// An [`OutPoint`] used as a key in a hash map.
+///
+/// Due to limitations in generating the foreign language bindings, we cannot use [`OutPoint`] as a
+/// key for hash maps.
 #[derive(Debug, PartialEq, Eq, std::hash::Hash, uniffi::Object)]
 #[uniffi::export(Debug, Eq, Hash)]
 pub struct HashableOutPoint(pub(crate) OutPoint);
 
 #[uniffi::export]
 impl HashableOutPoint {
+    /// Create a key for a key-value store from an [`OutPoint`]
+    #[uniffi::constructor]
+    pub fn from_outpoint(outpoint: OutPoint) -> Self {
+        Self(outpoint)
+    }
+
     /// Get the internal [`OutPoint`]
     pub fn outpoint(&self) -> OutPoint {
         self.0.clone()

bdk-ffi/src/lib.rs

@@ -43,7 +43,6 @@ use crate::types::SyncScriptInspector;
 
 use bdk_wallet::bitcoin::Network;
 use bdk_wallet::keys::bip39::WordCount;
-use bdk_wallet::ChangeSet;
 use bdk_wallet::KeychainKind;
 
 uniffi::include_scaffolding!("bdk");

bdk-ffi/src/types.rs

@@ -2,6 +2,7 @@ use crate::bitcoin::{
     Address, Amount, BlockHash, DescriptorId, HashableOutPoint, OutPoint, Script, Transaction,
     TxOut, Txid,
 };
+use crate::descriptor::Descriptor;
 use crate::error::{CreateTxError, RequestBuilderError};
 
 use bdk_core::bitcoin::absolute::LockTime as BdkLockTime;
@@ -902,3 +903,69 @@ impl From<TxGraphChangeSet> for bdk_wallet::chain::tx_graph::ChangeSet<BdkConfir
         }
     }
 }
+
+#[derive(Debug, Clone, uniffi::Record)]
+pub struct ChangeSet {
+    pub descriptor: Option<Arc<Descriptor>>,
+    pub change_descriptor: Option<Arc<Descriptor>>,
+    pub network: Option<bdk_wallet::bitcoin::Network>,
+    pub local_chain: LocalChainChangeSet,
+    pub tx_graph: TxGraphChangeSet,
+    pub indexer: IndexerChangeSet,
+}
+
+impl From<ChangeSet> for bdk_wallet::ChangeSet {
+    fn from(value: ChangeSet) -> Self {
+        let descriptor = value.descriptor.map(|d| {
+            let str_repr = d.to_string();
+            str_repr.parse::<bdk_wallet::miniscript::Descriptor<bdk_wallet::miniscript::DescriptorPublicKey>>().unwrap()
+        });
+        let change_descriptor = value.change_descriptor.map(|d| {
+            let str_repr = d.to_string();
+            str_repr.parse::<bdk_wallet::miniscript::Descriptor<bdk_wallet::miniscript::DescriptorPublicKey>>().unwrap()
+        });
+        let network = value.network;
+        let local_chain = value.local_chain.into();
+        let tx_graph = value.tx_graph.into();
+        let indexer = value.indexer.into();
+        Self {
+            descriptor,
+            change_descriptor,
+            network,
+            local_chain,
+            tx_graph,
+            indexer,
+        }
+    }
+}
+
+impl From<bdk_wallet::ChangeSet> for ChangeSet {
+    fn from(value: bdk_wallet::ChangeSet) -> Self {
+        let descriptor = value.descriptor.map(|d| {
+            Arc::new(Descriptor {
+                extended_descriptor: d,
+                key_map: BTreeMap::new(),
+            })
+        });
+        let change_descriptor = value
+            .change_descriptor
+            .map(|d| {
+            Arc::new(Descriptor {
+                extended_descriptor: d,
+                key_map: BTreeMap::new(),
+            })
+        });
+        let network = value.network;
+        let local_chain = value.local_chain.into();
+        let tx_graph = value.tx_graph.into();
+        let indexer = value.indexer.into();
+        Self {
+            descriptor,
+            change_descriptor,
+            network,
+            local_chain,
+            tx_graph,
+            indexer,
+        }
+    }
+}

bdk-ffi/tests/bindings/test.kts

@@ -4,7 +4,6 @@
  */
 
 import org.bitcoindevkit.bitcoin.Network
-import org.bitcoindevkit.Condition
 
 // A type from bitcoin-ffi
 val network = Network.TESTNET

bdk-ffi/tests/bindings/test.py

@@ -1,4 +1,3 @@
-from bdkpython import Condition
 from bdkpython.bitcoin import Network
 
 import unittest