refactor: Change path type to DerivationPath

Author: ItoroD

bdk-ffi/src/bitcoin.rs

@@ -3,6 +3,8 @@ use crate::error::{
     PsbtParseError, TransactionError,
 };
 use crate::error::{ParseAmountError, PsbtFinalizeError};
+use crate::keys::DerivationPath;
+
 use crate::{impl_from_core_type, impl_hash_like, impl_into_core_type};
 use std::collections::HashMap;
 
@@ -502,31 +504,35 @@ impl Display for Transaction {
     }
 }
 
-#[derive(Clone, Debug, uniffi::Record)]
+#[derive(Clone, Debug)]
+#[derive(uniffi::Record)]
 pub struct TapScriptEntry {
     /// script (reuse existing `Script` FFI type)
     pub script: Arc<Script>,
     /// leaf version
     pub leaf_version: u8,
 }
 
-#[derive(Clone, Debug, uniffi::Record, Hash, Eq, PartialEq)]
+#[derive(Clone, Debug)]
+#[derive(uniffi::Record)]
 pub struct TapKeyOrigin {
     /// leaf hashes as hex strings
     pub tap_leaf_hashes: Vec<String>,
     /// key source
     pub key_source: KeySource,
 }
 
-#[derive(Clone, Debug, uniffi::Record, Hash, Eq, PartialEq)]
+#[derive(Clone, Debug)]
+#[derive(uniffi::Record)]
 pub struct KeySource {
     /// A fingerprint
     pub fingerprint: String,
     /// A BIP-32 derivation path.
-    pub path: String,
+    pub path: Arc<DerivationPath>,
 }
 
-#[derive(Clone, Debug, uniffi::Record, Hash, Eq, PartialEq)]
+#[derive(Clone, Debug, Hash, Eq, PartialEq)]
+#[derive(uniffi::Record)]
 pub struct Key {
     /// The type of this PSBT key.
     pub type_value: u8,
@@ -535,7 +541,8 @@ pub struct Key {
     pub key: Vec<u8>,
 }
 
-#[derive(Clone, Debug, uniffi::Record, Hash, Eq, PartialEq)]
+#[derive(Clone, Debug, Hash, Eq, PartialEq)]
+#[derive(uniffi::Record)]
 pub struct ProprietaryKey {
     /// Proprietary type prefix used for grouping together keys under some
     /// application and avoid namespace collision
@@ -546,7 +553,8 @@ pub struct ProprietaryKey {
     pub key: Vec<u8>,
 }
 
-#[derive(Clone, Debug, uniffi::Record, Hash, Eq, PartialEq)]
+#[derive(Clone, Debug, Hash, Eq, PartialEq)]
+#[derive(uniffi::Record)]
 pub struct ControlBlock {
     /// The internal key.
     pub internal_key: Vec<u8>,
@@ -558,7 +566,8 @@ pub struct ControlBlock {
     pub leaf_version: u8,
 }
 
-#[derive(Clone, Debug, uniffi::Record, Hash, Eq, PartialEq)]
+#[derive(Clone, Debug, Hash, Eq, PartialEq)]
+#[derive(uniffi::Record)]
 pub struct TapScriptSigKey {
     /// An x-only public key, used for verification of Taproot signatures and serialized according to BIP-340.
     pub xonly_pubkey: String,
@@ -568,7 +577,8 @@ pub struct TapScriptSigKey {
 }
 
 /// A key-value map for an input of the corresponding index in the unsigned transaction.
-#[derive(Clone, Debug, uniffi::Record)]
+#[derive(Clone, Debug)]
+#[derive(uniffi::Record)]
 pub struct Input {
     /// The non-witness transaction this input spends from. Should only be
     /// `Option::Some` for inputs which spend non-segwit outputs or
@@ -655,7 +665,7 @@ impl From<&BdkInput> for Input {
                         pk.to_string(),
                         KeySource {
                             fingerprint: fingerprint.to_string(),
-                            path: deriv_path.to_string(),
+                            path: Arc::new(deriv_path.clone().into()),
                         },
                     )
                 })
@@ -723,7 +733,7 @@ impl From<&BdkInput> for Input {
                         tap_leaf_hashes: v.0.iter().map(|h| h.to_string()).collect(),
                         key_source: KeySource {
                             fingerprint: v.1 .0.to_string(),
-                            path: v.1 .1.to_string(),
+                            path: Arc::new(v.1 .1.clone().into()),
                         },
                     };
                     (key, value)

bdk-ffi/src/keys.rs

@@ -65,7 +65,8 @@ impl Display for Mnemonic {
 }
 
 /// A BIP-32 derivation path.
-#[derive(Clone, Debug, Hash, Eq, PartialEq, uniffi::Object)]
+#[derive(Clone, Debug, uniffi::Object)]
+#[uniffi::export(Display)]
 pub struct DerivationPath(pub(crate) BdkDerivationPath);
 
 #[uniffi::export]

bdk-ffi/src/tests/bitcoin.rs

@@ -442,7 +442,7 @@ fn test_psbt_input_bip32_derivation() {
         "Fingerprint does not match the expected value"
     );
 
-    let derivation_path = &derivation.unwrap().path;
+    let derivation_path = &derivation.unwrap().path.to_string();
     let expected_derivation_path = "84'/1'/0'/0/0";
     assert_eq!(
         derivation_path, &expected_derivation_path,