Struct bdk::descriptor::DerivedDescriptorKey

pub struct DerivedDescriptorKey<'s>(_, _);

Extended DescriptorPublicKey that has been derived

Derived keys are guaranteed to never contain wildcards of any kind

Implementations

impl<'s> DerivedDescriptorKey<'s>

pub fn new(
    key: DescriptorPublicKey,
    secp: &'s Secp256k1<All>
) -> DerivedDescriptorKey<'s>

Construct a new derived key

Panics if the key is wildcard

Methods from Deref<Target = DescriptorPublicKey>

pub fn master_fingerprint(&self) -> Fingerprint

The fingerprint of the master key associated with this key

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_public_key<C>(
    &self,
    secp: &Secp256k1<C>
) -> Result<PublicKey, ConversionError> where
    C: Verification, 

Computes the public key corresponding to this descriptor 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.

Trait Implementations

impl<'s> Clone for DerivedDescriptorKey<'s>

fn clone(&self) -> DerivedDescriptorKey<'s>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'s> Debug for DerivedDescriptorKey<'s>

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

Formats the value using the given formatter.

impl<'s> Deref for DerivedDescriptorKey<'s>

type Target = DescriptorPublicKey

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'s> Display for DerivedDescriptorKey<'s>

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

Formats the value using the given formatter.

impl<'s> Eq for DerivedDescriptorKey<'s>

impl<'s> Hash for DerivedDescriptorKey<'s>

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<'s> MiniscriptKey for DerivedDescriptorKey<'s>

type Hash = Self

The associated Hash type with the publicKey

fn to_pubkeyhash(&self) -> Self::Hash

Converts an object to PublicHash

fn is_uncompressed(&self) -> bool

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

fn serialized_len(&self) -> usize

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

impl<'s> Ord for DerivedDescriptorKey<'s>

fn cmp(&self, other: &Self) -> 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<'s> PartialEq<DerivedDescriptorKey<'s>> for DerivedDescriptorKey<'s>

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'s> PartialOrd<DerivedDescriptorKey<'s>> for DerivedDescriptorKey<'s>

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl<'s> ToPublicKey for DerivedDescriptorKey<'s>

fn to_public_key(&self) -> PublicKey

Converts an object to a public key

fn hash_to_hash160(hash: &Self::Hash) -> Hash

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