feat: Expose DerivationPath methods

Author: ItoroD

bdk-ffi/src/keys.rs

@@ -1,18 +1,18 @@
 use crate::error::{Bip32Error, Bip39Error, DescriptorKeyError};
 
+use bdk_wallet::bitcoin::Network;
 use bdk_wallet::bitcoin::bip32::DerivationPath as BdkDerivationPath;
 use bdk_wallet::bitcoin::key::Secp256k1;
 use bdk_wallet::bitcoin::secp256k1::rand;
 use bdk_wallet::bitcoin::secp256k1::rand::Rng;
-use bdk_wallet::bitcoin::Network;
 use bdk_wallet::keys::bip39::WordCount;
 use bdk_wallet::keys::bip39::{Language, Mnemonic as BdkMnemonic};
 use bdk_wallet::keys::{
     DerivableKey, DescriptorPublicKey as BdkDescriptorPublicKey,
     DescriptorSecretKey as BdkDescriptorSecretKey, ExtendedKey, GeneratableKey, GeneratedKey,
 };
-use bdk_wallet::miniscript::descriptor::{DescriptorXKey, Wildcard};
 use bdk_wallet::miniscript::BareCtx;
+use bdk_wallet::miniscript::descriptor::{DescriptorXKey, Wildcard};
 
 use std::fmt::Display;
 use std::str::FromStr;
@@ -76,6 +76,43 @@ impl DerivationPath {
             .map(DerivationPath)
             .map_err(Bip32Error::from)
     }
+
+    /// Returns derivation path for a master key (i.e. empty derivation path)
+    #[uniffi::constructor]
+    pub fn master() -> Arc<Self> {
+        Arc::new(DerivationPath {
+            inner_mutex: Mutex::new(BdkDerivationPath::master()),
+        })
+    }
+
+    /// Returns whether derivation path represents master key (i.e. it's length
+    /// is empty). True for `m` path.
+    pub fn is_master(&self) -> bool {
+        self.get_derivation_path().is_master()
+    }
+
+    /// Returns length of the derivation path
+    pub fn len(&self) -> u64 {
+        self.get_derivation_path().len() as u64
+    }
+
+    /// Returns `true` if the derivation path is empty
+    pub fn is_empty(&self) -> bool {
+        self.get_derivation_path().is_empty()
+    }
+}
+
+impl Display for DerivationPath {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        let path = self.get_derivation_path();
+        write!(f, "{}", path)
+    }
+}
+
+impl DerivationPath {
+    pub(crate) fn get_derivation_path(&self) -> MutexGuard<'_, BdkDerivationPath> {
+        self.inner_mutex.lock().expect("derivation path")
+    }
 }
 
 /// A descriptor containing secret data.