refactor: use macros for AddressInfo, TxStatus, ScriptAmount, SentAndReceived, KeychainAndIndex

Author: rustaceanrob

bdk-ffi/src/bdk.udl

@@ -272,18 +272,6 @@ interface TransactionError {
 
 typedef enum KeychainKind;
 
-/// A derived address and the index it was found at.
-dictionary AddressInfo {
-  /// Child index of this address
-  u32 index;
-
-  /// Address
-  Address address;
-
-  /// Type of keychain
-  KeychainKind keychain;
-};
-
 /// An unspent output owned by a [`Wallet`].
 dictionary LocalOutput {
   /// Reference to a transaction output
@@ -558,27 +546,7 @@ interface Descriptor {
 // bdk-ffi-defined types
 // ------------------------------------------------------------------------
 
-dictionary ScriptAmount {
-  Script script;
-  Amount amount;
-};
-
-dictionary SentAndReceivedValues {
-    Amount sent;
-    Amount received;
-};
-
-dictionary KeychainAndIndex {
-    KeychainKind keychain;
-    u32 index;
-};
-
-dictionary TxStatus {
-    boolean confirmed;
-    u32? block_height;
-    string? block_hash;
-    u64? block_time;
-};
+typedef dictionary TxStatus;
 
 dictionary Tx {
     string txid;
@@ -607,8 +575,6 @@ typedef interface Address;
 
 typedef dictionary Header;
 
-typedef interface Transaction;
-
 typedef interface Psbt;
 
 dictionary TxIn {
@@ -629,8 +595,6 @@ enum Network {
   "Testnet4",
 };
 
-typedef interface Amount;
-
 typedef interface FeeRate;
 
 dictionary OutPoint {

bdk-ffi/src/lib.rs

@@ -11,12 +11,9 @@ mod tx_builder;
 mod types;
 mod wallet;
 
-use crate::bitcoin::Address;
-use crate::bitcoin::Amount;
 use crate::bitcoin::FeeRate;
 use crate::bitcoin::OutPoint;
 use crate::bitcoin::Script;
-use crate::bitcoin::Transaction;
 use crate::bitcoin::TxIn;
 use crate::bitcoin::TxOut;
 use crate::descriptor::Descriptor;
@@ -42,21 +39,17 @@ use crate::keys::DerivationPath;
 use crate::keys::DescriptorPublicKey;
 use crate::keys::DescriptorSecretKey;
 use crate::keys::Mnemonic;
-use crate::types::AddressInfo;
 use crate::types::ChainPosition;
 use crate::types::Condition;
 use crate::types::FullScanRequest;
 use crate::types::FullScanRequestBuilder;
 use crate::types::FullScanScriptInspector;
-use crate::types::KeychainAndIndex;
 use crate::types::LocalOutput;
 use crate::types::LockTime;
 use crate::types::PkOrF;
 use crate::types::Policy;
 use crate::types::Satisfaction;
 use crate::types::SatisfiableItem;
-use crate::types::ScriptAmount;
-use crate::types::SentAndReceivedValues;
 use crate::types::SignOptions;
 use crate::types::SyncRequest;
 use crate::types::SyncRequestBuilder;

bdk-ffi/src/types.rs

@@ -119,14 +119,23 @@ impl From<BdkCanonicalTx<'_, Arc<BdkTransaction>, BdkConfirmationBlockTime>> for
     }
 }
 
+/// A bitcoin script and associated amount.
+#[derive(uniffi::Record)]
 pub struct ScriptAmount {
+    /// The underlying script.
     pub script: Arc<Script>,
+    /// The amount owned by the script.
     pub amount: Arc<Amount>,
 }
 
+/// A derived address and the index it was found at.
+#[derive(uniffi::Record)]
 pub struct AddressInfo {
+    /// Child index of this address
     pub index: u32,
+    /// The address
     pub address: Arc<Address>,
+    /// Type of keychain
     pub keychain: KeychainKind,
 }
 
@@ -289,13 +298,21 @@ impl FullScanRequestBuilder {
 #[derive(uniffi::Object)]
 pub struct Update(pub(crate) BdkUpdate);
 
+/// The total value sent and received.
+#[derive(uniffi::Record)]
 pub struct SentAndReceivedValues {
+    /// Amount sent in the transaction.
     pub sent: Arc<Amount>,
+    /// The amount received in the transaction, possibly as a change output(s).
     pub received: Arc<Amount>,
 }
 
+/// The keychain kind and the index in that keychain.
+#[derive(uniffi::Record)]
 pub struct KeychainAndIndex {
+    /// Type of keychains.
     pub keychain: KeychainKind,
+    /// The index in the keychain.
     pub index: u32,
 }
 
@@ -586,11 +603,16 @@ impl From<SignOptions> for BdkSignOptions {
     }
 }
 
-#[derive(Debug)]
+/// Transaction confirmation metadata.
+#[derive(uniffi::Record, Debug)]
 pub struct TxStatus {
+    /// Is the transaction in a block.
     pub confirmed: bool,
+    /// Height of the block this transaction was included.
     pub block_height: Option<u32>,
+    /// Hash of the block.
     pub block_hash: Option<String>,
+    /// The time shown in the block, not necessarily the same time as when the block was found.
     pub block_time: Option<u64>,
 }