Struct miniscript::DefiniteDescriptorKey

pub struct DefiniteDescriptorKey(_);

A DescriptorPublicKey without any wildcards.

Implementations

impl DefiniteDescriptorKey

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. To avoid this error you should replace any such public keys first with translate_pk.

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

Trait Implementations

impl Clone for DefiniteDescriptorKey

fn clone(&self) -> DefiniteDescriptorKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DefiniteDescriptorKey

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

Formats the value using the given formatter.

impl Display for DefiniteDescriptorKey

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 DefiniteDescriptorKey

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 DefiniteDescriptorKey

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,

Feeds a slice of this type into the given Hasher.

impl MiniscriptKey for DefiniteDescriptorKey

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 DefiniteDescriptorKey

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<DefiniteDescriptorKey> for DefiniteDescriptorKey

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

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

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

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

impl PartialOrd<DefiniteDescriptorKey> for DefiniteDescriptorKey

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

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

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

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

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

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

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

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

const 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 ToPublicKey for DefiniteDescriptorKey

fn to_public_key(&self) -> PublicKey

Converts an object to a public key

fn to_sha256(hash: &Hash) -> Hash

Converts the generic associated MiniscriptKey::Sha256 to [sha256::Hash]

fn to_hash256(hash: &Hash) -> Hash

Converts the generic associated MiniscriptKey::Hash256 to hash256::Hash

fn to_ripemd160(hash: &Hash) -> Hash

Converts the generic associated MiniscriptKey::Ripemd160 to [ripemd160::Hash]

fn to_hash160(hash: &Hash) -> Hash

Converts the generic associated MiniscriptKey::Hash160 to [hash160::Hash]

fn to_x_only_pubkey(&self) -> XOnlyPublicKey

Convert an object to x-only pubkey

fn to_pubkeyhash(&self, sig_type: SigType) -> Hash

Obtain the public key hash for this MiniscriptKey Expects an argument to specify the signature type. This would determine whether to serialize the key as 32 byte x-only pubkey or regular public key when computing the hash160

impl Eq for DefiniteDescriptorKey

impl StructuralEq for DefiniteDescriptorKey

impl StructuralPartialEq for DefiniteDescriptorKey