Enum DescriptorPublicKey

pub enum DescriptorPublicKey {
    SinglePub(DescriptorSinglePub),
    XPub(DescriptorXKey<ExtendedPubKey>),
}

The MiniscriptKey corresponding to Descriptors. This can either be Single public key or a Xpub

Variants

SinglePub(DescriptorSinglePub)

Single Public Key

XPub(DescriptorXKey<ExtendedPubKey>)

Xpub

Implementations

impl DescriptorPublicKey

pub fn master_fingerprint(&self) -> Fingerprint

The fingerprint of the master key associated with this key, 0x00000000 if none.

pub fn full_derivation_path(&self) -> DerivationPath

Full path, from the master key

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 is_deriveable(&self) -> bool

Whether or not the key has a wildcards

pub fn derive(self, index: u32) -> DescriptorPublicKey

If this public key has a wildcard, replace it by the given index

Panics if given an index ≥ 2^31

pub fn derive_public_key<C: Verification>( &self, secp: &Secp256k1<C>, ) -> Result<PublicKey, ConversionError>

Computes the public key corresponding to this descriptor key. When deriving from an XOnlyPublicKey, it adds the default 0x02 y-coordinate and returns the obtained full bitcoin::PublicKey. All BIP32 derivations always return a compressed key

Will return an error if the descriptor key has any hardened derivation steps in its path, or if the key has any wildcards.

To ensure there are no wildcards, call .derive(0) or similar; to avoid hardened derivation steps, start from a DescriptorSecretKey and call as_public, or call TranslatePk2::translate_pk2 with some function which has access to secret key data.

Examples found in repository

examples/xpub_descriptors.rs (line 31)

fn main() {
    // For deriving from descriptors, we need to provide a secp context
    let secp_ctx = secp256k1::Secp256k1::verification_only();
    // P2WSH and single xpubs
    let addr_one = Descriptor::<DescriptorPublicKey>::from_str(
            "wsh(sortedmulti(1,xpub661MyMwAqRbcFW31YEwpkMuc5THy2PSt5bDMsktWQcFF8syAmRUapSCGu8ED9W6oDMSgv6Zz8idoc4a6mr8BDzTJY47LJhkJ8UB7WEGuduB,xpub69H7F5d8KSRgmmdJg2KhpAK8SR3DjMwAdkxj3ZuxV27CprR9LgpeyGmXUbC6wb7ERfvrnKZjXoUmmDznezpbZb7ap6r1D3tgFxHmwMkQTPH))",
        )
        .unwrap()
        .translate_pk2(|xpk| xpk.derive_public_key(&secp_ctx))
        .unwrap()
        .address(bitcoin::Network::Bitcoin).unwrap();

    let addr_two = Descriptor::<DescriptorPublicKey>::from_str(
            "wsh(sortedmulti(1,xpub69H7F5d8KSRgmmdJg2KhpAK8SR3DjMwAdkxj3ZuxV27CprR9LgpeyGmXUbC6wb7ERfvrnKZjXoUmmDznezpbZb7ap6r1D3tgFxHmwMkQTPH,xpub661MyMwAqRbcFW31YEwpkMuc5THy2PSt5bDMsktWQcFF8syAmRUapSCGu8ED9W6oDMSgv6Zz8idoc4a6mr8BDzTJY47LJhkJ8UB7WEGuduB))",
        )
        .unwrap()
        .translate_pk2(|xpk| xpk.derive_public_key(&secp_ctx))
        .unwrap()
        .address(bitcoin::Network::Bitcoin).unwrap();
    let expected = bitcoin::Address::from_str(
        "bc1qpq2cfgz5lktxzr5zqv7nrzz46hsvq3492ump9pz8rzcl8wqtwqcspx5y6a",
    )
    .unwrap();
    assert_eq!(addr_one, expected);
    assert_eq!(addr_two, expected);

    // P2WSH-P2SH and ranged xpubs
    let addr_one = Descriptor::<DescriptorPublicKey>::from_str(
            "sh(wsh(sortedmulti(1,xpub661MyMwAqRbcFW31YEwpkMuc5THy2PSt5bDMsktWQcFF8syAmRUapSCGu8ED9W6oDMSgv6Zz8idoc4a6mr8BDzTJY47LJhkJ8UB7WEGuduB/1/0/*,xpub69H7F5d8KSRgmmdJg2KhpAK8SR3DjMwAdkxj3ZuxV27CprR9LgpeyGmXUbC6wb7ERfvrnKZjXoUmmDznezpbZb7ap6r1D3tgFxHmwMkQTPH/0/0/*)))",
        )
        .unwrap()
        .derived_descriptor(&secp_ctx, 5)
        .unwrap()
        .address(bitcoin::Network::Bitcoin).unwrap();

    let addr_two = Descriptor::<DescriptorPublicKey>::from_str(
            "sh(wsh(sortedmulti(1,xpub69H7F5d8KSRgmmdJg2KhpAK8SR3DjMwAdkxj3ZuxV27CprR9LgpeyGmXUbC6wb7ERfvrnKZjXoUmmDznezpbZb7ap6r1D3tgFxHmwMkQTPH/0/0/*,xpub661MyMwAqRbcFW31YEwpkMuc5THy2PSt5bDMsktWQcFF8syAmRUapSCGu8ED9W6oDMSgv6Zz8idoc4a6mr8BDzTJY47LJhkJ8UB7WEGuduB/1/0/*)))",
        )
        .unwrap()
        .derived_descriptor(&secp_ctx, 5)
        .unwrap()
        .address(bitcoin::Network::Bitcoin).unwrap();
    let expected = bitcoin::Address::from_str("325zcVBN5o2eqqqtGwPjmtDd8dJRyYP82s").unwrap();
    assert_eq!(addr_one, expected);
    assert_eq!(addr_two, expected);
}

Trait Implementations

impl Clone for DescriptorPublicKey

fn clone(&self) -> DescriptorPublicKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DescriptorPublicKey

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

Formats the value using the given formatter.

impl Display for DescriptorPublicKey

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

Formats the value using the given formatter.

impl FromStr for DescriptorPublicKey

type Err = DescriptorKeyParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for DescriptorPublicKey

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 MiniscriptKey for DescriptorPublicKey

type Hash = DescriptorPublicKey

The associated Hash type with the publicKey

fn is_uncompressed(&self) -> bool

Check if the publicKey is uncompressed. The default implementation returns false

fn is_x_only_key(&self) -> bool

Check if the publicKey is x-only. The default implementation returns false

fn to_pubkeyhash(&self) -> Self

Converts an object to PublicHash

impl Ord for DescriptorPublicKey

fn cmp(&self, other: &DescriptorPublicKey) -> 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.

impl PartialEq for DescriptorPublicKey

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for DescriptorPublicKey

fn partial_cmp(&self, other: &DescriptorPublicKey) -> 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 Eq for DescriptorPublicKey

impl StructuralPartialEq for DescriptorPublicKey