Expose Address payload and network properties

Author: notmandatory

bdk-ffi/src/bdk.udl

@@ -405,9 +405,42 @@ interface Address {
   [Throws=BdkError]
   constructor(string address);
 
+  Payload payload();
+
+  Network network();
+
   Script script_pubkey();
 };
 
+[Enum]
+interface Payload {
+  PubkeyHash(sequence<u8> pubkey_hash);
+
+  ScriptHash(sequence<u8> script_hash);
+
+  WitnessProgram(WitnessVersion version, sequence<u8> program);
+};
+
+enum WitnessVersion {
+  "V0",
+  "V1",
+  "V2",
+  "V3",
+  "V4",
+  "V5",
+  "V6",
+  "V7",
+  "V8",
+  "V9",
+  "V10",
+  "V11",
+  "V12",
+  "V13",
+  "V14",
+  "V15",
+  "V16"
+};
+
 interface Script {
   constructor(sequence<u8> raw_output_script);
 };

bdk-ffi/src/lib.rs

@@ -17,6 +17,7 @@ use crate::wallet::{BumpFeeTxBuilder, TxBuilder, Wallet};
 use bdk::bitcoin::blockdata::script::Script as BdkScript;
 use bdk::bitcoin::consensus::Decodable;
 use bdk::bitcoin::psbt::serialize::Serialize;
+use bdk::bitcoin::util::address::{Payload as BdkPayload, WitnessVersion};
 use bdk::bitcoin::{
     Address as BdkAddress, Network, OutPoint as BdkOutPoint, Transaction as BdkTransaction, Txid,
 };
@@ -268,13 +269,48 @@ impl Address {
             .map_err(|e| BdkError::Generic(e.to_string()))
     }
 
+    fn payload(&self) -> Payload {
+        match &self.address.payload.clone() {
+            BdkPayload::PubkeyHash(pubkey_hash) => Payload::PubkeyHash {
+                pubkey_hash: pubkey_hash.to_vec(),
+            },
+            BdkPayload::ScriptHash(script_hash) => Payload::ScriptHash {
+                script_hash: script_hash.to_vec(),
+            },
+            BdkPayload::WitnessProgram { version, program } => Payload::WitnessProgram {
+                version: *version,
+                program: program.clone(),
+            },
+        }
+    }
+
+    fn network(&self) -> Network {
+        self.address.network
+    }
+
     fn script_pubkey(&self) -> Arc<Script> {
         Arc::new(Script {
             script: self.address.script_pubkey(),
         })
     }
 }
 
+/// The method used to produce an address.
+#[derive(Debug)]
+pub enum Payload {
+    /// P2PKH address.
+    PubkeyHash { pubkey_hash: Vec<u8> },
+    /// P2SH address.
+    ScriptHash { script_hash: Vec<u8> },
+    /// Segwit address.
+    WitnessProgram {
+        /// The witness program version.
+        version: WitnessVersion,
+        /// The witness program.
+        program: Vec<u8>,
+    },
+}
+
 /// A Bitcoin script.
 #[derive(Clone, Debug, PartialEq, Eq)]
 pub struct Script {
@@ -308,8 +344,12 @@ uniffi::deps::static_assertions::assert_impl_all!(Wallet: Sync, Send);
 // crate.
 #[cfg(test)]
 mod test {
+    use assert_matches::assert_matches;
     use super::Transaction;
     use bdk::bitcoin::hashes::hex::FromHex;
+    use bdk::bitcoin::util::address::WitnessVersion;
+    use crate::{Address, Payload};
+    use crate::Network::Regtest;
 
     // Verify that bdk-ffi Transaction can be created from valid bytes and serialized back into the same bytes.
     #[test]
@@ -319,4 +359,16 @@ mod test {
         let serialized_tx_to_bytes = new_tx_from_bytes.serialize();
         assert_eq!(test_tx_bytes, serialized_tx_to_bytes);
     }
+
+    // Verify that bdk-ffi Address.payload includes expected WitnessProgram variant, version and program bytes.
+    #[test]
+    fn test_address_witness_program() {
+        let address = Address::new("bcrt1qqjn9gky9mkrm3c28e5e87t5akd3twg6xezp0tv".to_string()).unwrap();
+        let payload = address.payload();
+        assert_matches!(payload, Payload::WitnessProgram { version, program } => {
+            assert_eq!(version,WitnessVersion::V0);
+            assert_eq!(program, Vec::from_hex("04a6545885dd87b8e147cd327f2e9db362b72346").unwrap());
+        });
+        assert_eq!(address.network(), Regtest);
+    }
 }