Enum DescriptorPublicKey

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

The descriptor pubkey, either a single pubkey or an xpub.

Variants

Single(SinglePub)

Single public key.

XPub(DescriptorXKey<ExtendedPubKey>)

Extended public key (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

👎Deprecated: use has_wildcard instead

Whether or not the key has a wildcard

pub fn has_wildcard(&self) -> bool

Whether or not the key has a wildcard

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

👎Deprecated: use at_derivation_index instead

Deprecated name of [at_derivation_index].

pub fn at_derivation_index(self, index: u32) -> DefiniteDescriptorKey

Replaces any wildcard (i.e. /*) in the key with a particular derivation index, turning it into a definite key (i.e. one where all the derivation paths are set).

Returns

• If this key is not an xpub, returns self.
• If this key is an xpub but does not have a wildcard, returns self.
• Otherwise, returns the xpub at derivation index (removing the wildcard).

Panics

If index ≥ 2^31

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 From<DefiniteDescriptorKey> for DescriptorPublicKey

fn from(d: DefiniteDescriptorKey) -> Self

Converts to this type from the input type.

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 Sha256 = Hash

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

type Hash256 = Hash

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

type Ripemd160 = Hash

The associated [ripedmd160::Hash] for this MiniscriptKey type. used in the ripemd160 fragment

type Hash160 = Hash

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

fn is_uncompressed(&self) -> bool

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

fn is_x_only_key(&self) -> bool

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

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