Merge #898: feat: add support for BIP-388 wallet policies

945adb7 feat: add support for BIP-388 wallet policies (Trevor Arjeski)
4906bed feat: add new functions on DescriptorPublicKey (Trevor Arjeski)
15e3465 refactor: parse_xkey_deriv to use FromStr instead of accepting closure (Trevor Arjeski)
f5a6857 chore: implement Display for Wildcard (Trevor Arjeski)

Pull request description:

  Implemented BIP-388 by introducing a new type, `WalletPolicy`, which can be used
  to create descriptor templates.
  
  The idea is pretty simple and only really required making a new type that
  implements `MiniscriptKey`, then the existing parser and `Translator` trait
  takes care of the rest.
  
  There are a few edge cases that require validation, which isn't so nice, but
  works for now. Test cases that require BIP-390 and BIP-387's sortedmulti_a are
  commented out and issues could arise with those test vectors when/if those BIPs
  are implemented.
  
  See `WalletPolicy`'s doc and the unit tests for usage.


ACKs for top commit:
  apoelstra:
    ACK 945adb7; successfully ran local tests; looks great! Lol Tobin the errors here are well above the current standards of this crate.


Tree-SHA512: 094facc19a7b221876498762a0e5b4c9e63c76e12e09bbd608166e23eabedf63739279e4e1c2edf1b614d20920d6a3624395cf1701498b05aef932fbe0cc9f71

Author: apoelstra

src/descriptor/key.rs

@@ -12,6 +12,7 @@ use bitcoin::key::{PublicKey, XOnlyPublicKey};
 use bitcoin::secp256k1::{Secp256k1, Signing, Verification};
 use bitcoin::NetworkKind;
 
+use super::WalletPolicyError;
 use crate::prelude::*;
 #[cfg(feature = "serde")]
 use crate::serde::{Deserialize, Deserializer, Serialize, Serializer};
@@ -201,6 +202,16 @@ pub enum Wildcard {
     Hardened,
 }
 
+impl fmt::Display for Wildcard {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            Wildcard::None => write!(f, ""),
+            Wildcard::Unhardened => write!(f, "/*"),
+            Wildcard::Hardened => write!(f, "/*h"),
+        }
+    }
+}
+
 impl SinglePriv {
     /// Returns the public key of this key.
     fn to_public<C: Signing>(&self, secp: &Secp256k1<C>) -> SinglePub {
@@ -412,16 +423,12 @@ impl fmt::Display for MalformedKeyDataKind {
 #[derive(Debug, PartialEq, Eq, Clone)]
 #[non_exhaustive]
 pub enum DescriptorKeyParseError {
-    /// Error while parsing a BIP32 extended private key
-    Bip32Xpriv(bip32::Error),
-    /// Error while parsing a BIP32 extended public key
-    Bip32Xpub(bip32::Error),
     /// Error while parsing a derivation index
     DerivationIndexError {
         /// The invalid index
         index: String,
         /// The underlying parse error
-        err: bitcoin::bip32::Error,
+        err: bip32::Error,
     },
     /// Error deriving the hardened private key.
     DeriveHardenedKey(bip32::Error),
@@ -444,13 +451,13 @@ pub enum DescriptorKeyParseError {
     WifPrivateKey(bitcoin::key::FromWifError),
     /// Error while parsing an X-only public key (Secp256k1 error).
     XonlyPublicKey(bitcoin::secp256k1::Error),
+    /// XKey parsing error
+    XKeyParseError(XKeyParseError),
 }
 
 impl fmt::Display for DescriptorKeyParseError {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         match self {
-            Self::Bip32Xpriv(err) => err.fmt(f),
-            Self::Bip32Xpub(err) => err.fmt(f),
             Self::DerivationIndexError { index, err } => {
                 write!(f, "at derivation index '{index}': {err}")
             }
@@ -464,29 +471,59 @@ impl fmt::Display for DescriptorKeyParseError {
             Self::FullPublicKey(err) => err.fmt(f),
             Self::WifPrivateKey(err) => err.fmt(f),
             Self::XonlyPublicKey(err) => err.fmt(f),
+            Self::XKeyParseError(err) => err.fmt(f),
         }
     }
 }
 
 #[cfg(feature = "std")]
 impl error::Error for DescriptorKeyParseError {
-    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
         match self {
-            Self::Bip32Xpriv(err)
-            | Self::Bip32Xpub(err)
-            | Self::DerivationIndexError { err, .. }
+            Self::DerivationIndexError { err, .. }
             | Self::DeriveHardenedKey(err)
             | Self::MasterDerivationPath(err) => Some(err),
             Self::MasterFingerprint { err, .. } => Some(err),
             Self::NonDefiniteKey(err) => Some(err),
             Self::FullPublicKey(err) => Some(err),
             Self::WifPrivateKey(err) => Some(err),
             Self::XonlyPublicKey(err) => Some(err),
+            Self::XKeyParseError(err) => Some(err),
             Self::MalformedKeyData(_) => None,
         }
     }
 }
 
+/// An error when parsing an extended key.
+#[derive(Debug, PartialEq, Eq, Clone)]
+pub enum XKeyParseError {
+    Bip32(bip32::Error),
+    Bip388(WalletPolicyError),
+}
+
+#[cfg(feature = "std")]
+impl error::Error for XKeyParseError {
+    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
+        match self {
+            Self::Bip32(err) => Some(err),
+            Self::Bip388(err) => Some(err),
+        }
+    }
+}
+
+impl fmt::Display for XKeyParseError {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            Self::Bip32(err) => err.fmt(f),
+            Self::Bip388(err) => err.fmt(f),
+        }
+    }
+}
+
+impl From<bip32::Error> for XKeyParseError {
+    fn from(err: bip32::Error) -> Self { Self::Bip32(err) }
+}
+
 impl fmt::Display for DescriptorPublicKey {
     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
         match *self {
@@ -502,22 +539,14 @@ impl fmt::Display for DescriptorPublicKey {
                 maybe_fmt_master_id(f, &xpub.origin)?;
                 xpub.xkey.fmt(f)?;
                 fmt_derivation_path(f, &xpub.derivation_path)?;
-                match xpub.wildcard {
-                    Wildcard::None => {}
-                    Wildcard::Unhardened => write!(f, "/*")?,
-                    Wildcard::Hardened => write!(f, "/*h")?,
-                }
+                xpub.wildcard.fmt(f)?;
                 Ok(())
             }
             Self::MultiXPub(ref xpub) => {
                 maybe_fmt_master_id(f, &xpub.origin)?;
                 xpub.xkey.fmt(f)?;
                 fmt_derivation_paths(f, xpub.derivation_paths.paths())?;
-                match xpub.wildcard {
-                    Wildcard::None => {}
-                    Wildcard::Unhardened => write!(f, "/*")?,
-                    Wildcard::Hardened => write!(f, "/*h")?,
-                }
+                xpub.wildcard.fmt(f)?;
                 Ok(())
             }
         }
@@ -610,7 +639,10 @@ fn fmt_derivation_path(f: &mut fmt::Formatter, path: &bip32::DerivationPath) ->
 /// Writes multiple derivation paths to the formatter, no leading 'm'.
 /// NOTE: we assume paths only differ at a single index, as prescribed by BIP389.
 /// Will panic if the list of paths is empty.
-fn fmt_derivation_paths(f: &mut fmt::Formatter, paths: &[bip32::DerivationPath]) -> fmt::Result {
+pub(crate) fn fmt_derivation_paths<W: fmt::Write>(
+    f: &mut W,
+    paths: &[bip32::DerivationPath],
+) -> fmt::Result {
     for (i, child) in paths[0].into_iter().enumerate() {
         if paths.len() > 1 && child != &paths[1][i] {
             write!(f, "/<")?;
@@ -642,7 +674,7 @@ impl FromStr for DescriptorPublicKey {
         let (key_part, origin) = parse_key_origin(s)?;
 
         if key_part.contains("pub") {
-            let (xpub, derivation_paths, wildcard) = parse_xkey_deriv(parse_bip32_xpub, key_part)?;
+            let (xpub, derivation_paths, wildcard) = parse_xkey_deriv(key_part)?;
             if derivation_paths.len() > 1 {
                 Ok(DescriptorPublicKey::MultiXPub(DescriptorMultiXKey {
                     origin,
@@ -795,6 +827,38 @@ impl DescriptorPublicKey {
         }
     }
 
+    /// Derivation path without the origin prefix.
+    ///
+    /// For wildcard keys this will return the path up to the wildcard, so you
+    /// can get full paths by appending one additional derivation step, according
+    /// to the wildcard type (hardened or normal).
+    ///
+    /// For multipath extended keys, this returns `None`.
+    pub fn derivation_path(&self) -> Option<bip32::DerivationPath> {
+        match *self {
+            DescriptorPublicKey::XPub(ref xpub) => Some(xpub.derivation_path.clone()),
+            DescriptorPublicKey::Single(_) => Some(bip32::DerivationPath::from(vec![])),
+            DescriptorPublicKey::MultiXPub(_) => None,
+        }
+    }
+
+    /// Returns a vector of derivation paths without the origin prefix.
+    ///
+    /// For wildcard keys this will return the path up to the wildcard, so you
+    /// can get full paths by appending one additional derivation step, according
+    /// to the wildcard type (hardened or normal).
+    pub fn derivation_paths(&self) -> Vec<bip32::DerivationPath> {
+        match &self {
+            DescriptorPublicKey::XPub(xpub) => {
+                vec![xpub.derivation_path.clone()]
+            }
+            DescriptorPublicKey::Single(_) => {
+                vec![bip32::DerivationPath::from(vec![])]
+            }
+            DescriptorPublicKey::MultiXPub(xpub) => xpub.derivation_paths.paths().clone(),
+        }
+    }
+
     /// Whether or not the key has a wildcard
     pub fn has_wildcard(&self) -> bool {
         match *self {
@@ -804,7 +868,16 @@ impl DescriptorPublicKey {
         }
     }
 
-    /// Whether or not the key has a wildcard
+    /// Return a Wildcard if key is a XKey
+    pub fn wildcard(&self) -> Option<Wildcard> {
+        match *self {
+            DescriptorPublicKey::Single(..) => None,
+            DescriptorPublicKey::XPub(ref xpub) => Some(xpub.wildcard),
+            DescriptorPublicKey::MultiXPub(ref xpub) => Some(xpub.wildcard),
+        }
+    }
+
+    /// Whether or not the key has a hardened step in path
     pub fn has_hardened_step(&self) -> bool {
         let paths = match self {
             DescriptorPublicKey::Single(..) => &[],
@@ -925,8 +998,7 @@ impl FromStr for DescriptorSecretKey {
                 .map_err(DescriptorKeyParseError::WifPrivateKey)?;
             Ok(DescriptorSecretKey::Single(SinglePriv { key: sk, origin }))
         } else {
-            let (xpriv, derivation_paths, wildcard) =
-                parse_xkey_deriv(parse_bip32_xpriv, key_part)?;
+            let (xpriv, derivation_paths, wildcard) = parse_xkey_deriv(key_part)?;
             if derivation_paths.len() > 1 {
                 Ok(DescriptorSecretKey::MultiXPrv(DescriptorMultiXKey {
                     origin,
@@ -1009,26 +1081,22 @@ fn parse_key_origin(s: &str) -> Result<(&str, Option<bip32::KeySource>), Descrip
     }
 }
 
-fn parse_bip32_xpub(xkey_str: &str) -> Result<bip32::Xpub, DescriptorKeyParseError> {
-    bip32::Xpub::from_str(xkey_str).map_err(DescriptorKeyParseError::Bip32Xpub)
-}
-
-fn parse_bip32_xpriv(xkey_str: &str) -> Result<bip32::Xpriv, DescriptorKeyParseError> {
-    bip32::Xpriv::from_str(xkey_str).map_err(DescriptorKeyParseError::Bip32Xpriv)
-}
-
-fn parse_xkey_deriv<Key>(
-    parse_xkey_fn: impl Fn(&str) -> Result<Key, DescriptorKeyParseError>,
+pub(crate) fn parse_xkey_deriv<Key, E>(
     key_deriv: &str,
-) -> Result<(Key, Vec<bip32::DerivationPath>, Wildcard), DescriptorKeyParseError> {
+) -> Result<(Key, Vec<bip32::DerivationPath>, Wildcard), DescriptorKeyParseError>
+where
+    Key: FromStr<Err = E>,
+    E: Into<XKeyParseError>,
+{
     let mut key_deriv = key_deriv.split('/');
     let xkey_str = key_deriv
         .next()
         .ok_or(DescriptorKeyParseError::MalformedKeyData(
             MalformedKeyDataKind::NoKeyAfterOrigin,
         ))?;
 
-    let xkey = parse_xkey_fn(xkey_str)?;
+    let xkey =
+        Key::from_str(xkey_str).map_err(|e| DescriptorKeyParseError::XKeyParseError(e.into()))?;
 
     let mut wildcard = Wildcard::None;
     let mut multipath = false;
@@ -1097,7 +1165,7 @@ fn parse_xkey_deriv<Key>(
         // step all the vectors of indexes contain a single element. If it did though, one of the
         // vectors contains more than one element.
         // Now transform this list of vectors of steps into distinct derivation paths.
-        .try_fold(Vec::new(), |mut paths, index_list| {
+        .try_fold(Vec::new(), |mut paths, index_list| -> Result<_, DescriptorKeyParseError> {
             let mut index_list = index_list?.into_iter();
             let first_index = index_list
                 .next()

src/descriptor/mod.rs

@@ -53,13 +53,15 @@ pub use self::tr::{
 pub mod checksum;
 mod key;
 mod key_map;
+mod wallet_policy;
 
 pub use self::key::{
     DefiniteDescriptorKey, DerivPaths, DescriptorKeyParseError, DescriptorMultiXKey,
     DescriptorPublicKey, DescriptorSecretKey, DescriptorXKey, InnerXKey, MalformedKeyDataKind,
     NonDefiniteKeyError, SinglePriv, SinglePub, SinglePubKey, Wildcard, XKeyNetwork,
 };
 pub use self::key_map::KeyMap;
+pub use self::wallet_policy::{WalletPolicy, WalletPolicyError};
 
 /// Script descriptor
 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]