diff --git a/src/util/bip32.rs b/src/util/bip32.rs index 964e79e1..2d8db57f 100644 --- a/src/util/bip32.rs +++ b/src/util/bip32.rs @@ -210,12 +210,31 @@ impl serde::Serialize for ChildNumber { } } +/// Trait that allows possibly failable conversion from a type into a +/// derivation path +pub trait IntoDerivationPath { + /// Convers a given type into a [`DerivationPath`] with possible error + fn into_derivation_path(self) -> Result; +} + /// A BIP-32 derivation path. #[derive(Clone, PartialEq, Eq, Ord, PartialOrd, Hash)] pub struct DerivationPath(Vec); impl_index_newtype!(DerivationPath, ChildNumber); serde_string_impl!(DerivationPath, "a BIP-32 derivation path"); +impl Default for DerivationPath { + fn default() -> DerivationPath { + DerivationPath::master() + } +} + +impl IntoDerivationPath for T where T: Into { + fn into_derivation_path(self) -> Result { + Ok(self.into()) + } +} + impl From> for DerivationPath { fn from(numbers: Vec) -> Self { DerivationPath(numbers) @@ -304,6 +323,17 @@ impl DerivationPath { self.0.len() } + /// Returns derivation path for a master key (i.e. empty derivation path) + pub fn master() -> DerivationPath { + DerivationPath(vec![]) + } + + /// 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.0.is_empty() + } + /// Create a new [DerivationPath] that is a child of this one. pub fn child(&self, cn: ChildNumber) -> DerivationPath { let mut path = self.0.clone(); @@ -763,6 +793,8 @@ mod tests { assert_eq!(DerivationPath::from_str("m/0h/0x"), Err(Error::InvalidChildNumberFormat)); assert_eq!(DerivationPath::from_str("m/2147483648"), Err(Error::InvalidChildNumber(2147483648))); + assert_eq!(DerivationPath::master(), DerivationPath::from_str("m").unwrap()); + assert_eq!(DerivationPath::master(), DerivationPath::default()); assert_eq!(DerivationPath::from_str("m"), Ok(vec![].into())); assert_eq!( DerivationPath::from_str("m/0'"),