Struct DescriptorXKey 

pub struct DescriptorXKey<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: 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::bip32;
use miniscript::descriptor::DescriptorPublicKey;

let ctx = miniscript::elements::secp256k1_zkp::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>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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>

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

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> MiniscriptKey for DescriptorXKey<K>

where K: InnerXKey + Clone + Ord + Eq + Hash + Debug,

type Sha256 = Hash

The associated bitcoin::hashes::sha256::Hash for this MiniscriptKey, used in the sha256 fragment.

type Hash256 = Hash

The associated miniscript::hash256::Hash for this MiniscriptKey, used in the hash256 fragment.

type Ripemd160 = Hash

The associated bitcoin::hashes::ripemd160::Hash for this MiniscriptKey type, used in the ripemd160 fragment.

type Hash160 = Hash

The associated bitcoin::hashes::hash160::Hash for this MiniscriptKey type, used in the hash160 fragment.

fn is_x_only_key(&self) -> bool

Returns true if the pubkey is an x-only pubkey. Defaults to false.

fn num_der_paths(&self) -> usize

Returns the number of different derivation paths in this key. Only >1 for keys in BIP389 multipath descriptors.

fn is_uncompressed(&self) -> bool

Returns true if the pubkey is uncompressed. Defaults to false.

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

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

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

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

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

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

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