Enum bdk::keys::DescriptorPublicKey

[−] Show declaration

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

[−] Expand description

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

Variants

SinglePub(DescriptorSinglePub)

[−] Expand description

Single Public Key

XPub(DescriptorXKey<ExtendedPubKey>)

[−] Expand description

Xpub

Implementations

impl DescriptorPublicKey[−]

pub fn derive(self, child_number: ChildNumber) -> DescriptorPublicKey[−]

Derives the specified child key if self is a wildcard xpub. Otherwise returns self.

Panics if given a hardened child number

Trait Implementations

impl Clone for DescriptorPublicKey[+]

[+] Show hidden undocumented items

pub fn clone(&self) -> DescriptorPublicKey[−]

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescriptorPublicKey[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Display for DescriptorPublicKey[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Eq for DescriptorPublicKey

impl FromStr for DescriptorPublicKey[+]

[+] Show hidden undocumented items

type Err = DescriptorKeyParseError

The associated error which can be returned from parsing.

pub fn from_str(
    s: &str
) -> Result<DescriptorPublicKey, <DescriptorPublicKey as FromStr>::Err>[−]

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

impl Hash for DescriptorPublicKey[+]

[+] Show hidden undocumented items

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, [−]

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 MiniscriptKey for DescriptorPublicKey[+]

[+] Show hidden undocumented items

type Hash = DescriptorPublicKey

The associated Hash type with the publicKey

pub fn to_pubkeyhash(&self) -> DescriptorPublicKey[−]

Converts an object to PublicHash

pub fn is_uncompressed(&self) -> bool[−]

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

impl Ord for DescriptorPublicKey[+]

[+] Show hidden undocumented items

pub fn cmp(&self, other: &DescriptorPublicKey) -> Ordering[−]

This method returns an Ordering between self and other.

[+] Expand attributes

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

Compares and returns the maximum of two values.

[+] Expand attributes

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

Compares and returns the minimum of two values.

[+] Expand attributes

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

Restrict a value to a certain interval.

impl PartialEq<DescriptorPublicKey> for DescriptorPublicKey[+]

[+] Show hidden undocumented items

pub fn eq(&self, other: &DescriptorPublicKey) -> bool[−]

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

pub fn ne(&self, other: &DescriptorPublicKey) -> bool[−]

This method tests for !=.

impl PartialOrd<DescriptorPublicKey> for DescriptorPublicKey[+]

[+] Show hidden undocumented items

pub fn partial_cmp(&self, other: &DescriptorPublicKey) -> Option<Ordering>[−]

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

pub fn lt(&self, other: &DescriptorPublicKey) -> bool[−]

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

pub fn le(&self, other: &DescriptorPublicKey) -> bool[−]

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

pub fn gt(&self, other: &DescriptorPublicKey) -> bool[−]

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

pub fn ge(&self, other: &DescriptorPublicKey) -> bool[−]

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

impl StructuralEq for DescriptorPublicKey

impl StructuralPartialEq for DescriptorPublicKey

impl<Ctx: ScriptContext> ToDescriptorKey<Ctx> for DescriptorPublicKey[+]

[+] Show hidden undocumented items

pub fn to_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>[−]

Turn the key into a DescriptorKey within the requested ScriptContext

impl<'secp, C> ToPublicKey<DescriptorPublicKeyCtx<'secp, C>> for DescriptorPublicKey where
    C: Verification, [+]

[+] Show hidden undocumented items

pub fn to_public_key(
    &self,
    to_pk_ctx: DescriptorPublicKeyCtx<'secp, C>
) -> PublicKey[−]

Converts an object to a public key C represents additional context information that maybe required for deriving a bitcoin::PublicKey from MiniscriptKey You may require secp context for crypto operations or additional information for substituting the wildcard in extended pubkeys

pub fn hash_to_hash160(
    hash: &<DescriptorPublicKey as MiniscriptKey>::Hash,
    to_pk_ctx: DescriptorPublicKeyCtx<'secp, C>
) -> Hash[−]

Converts a hashed version of the public key to a hash160 hash.

pub fn serialized_len(&self, to_pk_ctx: ToPkCtx) -> usize[−]

Computes the size of a public key when serialized in a script, including the length bytes