Struct miniscript::descriptor::DescriptorXKey

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

Instance of an extended key with origin and derivation path

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: InnerXKey> DescriptorXKey<K>

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

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/*")?;
let xpub = match key {
    DescriptorPublicKey::XPub(xpub) => xpub,
    _ => panic!("Parsing Error"),
};

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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

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

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

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

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

This method tests for !=.

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

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

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

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

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

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

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

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

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

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

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

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

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