Struct bdk::descriptor::DescriptorXKey

pub struct DescriptorXKey<K>where
    K: InnerXKey,{
    pub origin: Option<(Fingerprint, DerivationPath)>,
    pub xkey: K,
    pub derivation_path: DerivationPath,
    pub wildcard: Wildcard,
}

An extended key with origin, derivation path, and wildcard.

Fields

origin: Option<(Fingerprint, DerivationPath)>

Origin information

xkey: K

The extended key

derivation_path: DerivationPath

The derivation path

wildcard: Wildcard

Whether the descriptor is wildcard

Implementations

impl<K> DescriptorXKey<K>where
    K: InnerXKey,

pub fn matches<C>(
    &self,
    keysource: &(Fingerprint, DerivationPath),
    secp: &Secp256k1<C>
) -> Option<DerivationPath>where
    C: Signing,

Compares this key with a keysource and returns the matching derivation path, if any.

For keys that have an origin, the keysource’s fingerprint will be compared with the origin’s fingerprint, and the keysource’s path will be compared with the concatenation of the origin’s and key’s paths.

If the key wildcard, the last item of the keysource’s path will be ignored,

Examples

use miniscript::bitcoin::util::bip32;
use miniscript::descriptor::DescriptorPublicKey;

let ctx = miniscript::bitcoin::secp256k1::Secp256k1::signing_only();

let key = DescriptorPublicKey::from_str("[d34db33f/44'/0'/0']xpub6ERApfZwUNrhLCkDtcHTcxd75RbzS1ed54G1LkBUHQVHQKqhMkhgbmJbZRkrgZw4koxb5JaHWkY4ALHY2grBGRjaDMzQLcgJvLJuZZvRcEL/1/*").or(Err(()))?;
let xpub = match key {
    DescriptorPublicKey::XPub(xpub) => xpub,
    _ => panic!("Parsing Error"),
};

assert_eq!(
    xpub.matches(&(
        bip32::Fingerprint::from_str("d34db33f").or(Err(()))?,
        bip32::DerivationPath::from_str("m/44'/0'/0'/1/42").or(Err(()))?
    ), &ctx),
    Some(bip32::DerivationPath::from_str("m/44'/0'/0'/1").or(Err(()))?)
);
assert_eq!(
    xpub.matches(&(
        bip32::Fingerprint::from_str("ffffffff").or(Err(()))?,
        bip32::DerivationPath::from_str("m/44'/0'/0'/1/42").or(Err(()))?
    ), &ctx),
    None
);
assert_eq!(
    xpub.matches(&(
        bip32::Fingerprint::from_str("d34db33f").or(Err(()))?,
        bip32::DerivationPath::from_str("m/44'/0'/0'/100/0").or(Err(()))?
    ), &ctx),
    None
);

Trait Implementations

impl<K> Clone for DescriptorXKey<K>where
    K: Clone + InnerXKey,

fn clone(&self) -> DescriptorXKey<K>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K> Debug for DescriptorXKey<K>where
    K: Debug + InnerXKey,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<K> Hash for DescriptorXKey<K>where
    K: Hash + InnerXKey,

fn hash<__H>(&self, state: &mut __H)where
    __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<K> Ord for DescriptorXKey<K>where
    K: Ord + InnerXKey,

fn cmp(&self, other: &DescriptorXKey<K>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<K> PartialEq<DescriptorXKey<K>> for DescriptorXKey<K>where
    K: PartialEq<K> + InnerXKey,

fn eq(&self, other: &DescriptorXKey<K>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K> PartialOrd<DescriptorXKey<K>> for DescriptorXKey<K>where
    K: PartialOrd<K> + InnerXKey,

fn partial_cmp(&self, other: &DescriptorXKey<K>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<K> Eq for DescriptorXKey<K>where
    K: Eq + InnerXKey,

impl<K> StructuralEq for DescriptorXKey<K>where
    K: InnerXKey,

impl<K> StructuralPartialEq for DescriptorXKey<K>where
    K: InnerXKey,