Struct miniscript::descriptor::DefiniteDescriptorKey

pub struct DefiniteDescriptorKey(/* private fields */);

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) -> Option<DerivationPath>

Full path from the master key if not a multipath extended key.

pub fn full_derivation_paths(&self) -> Vec<DerivationPath>

Full paths from the master key. The vector will contain just one path for single keys, and multiple ones for multipath extended keys

pub fn as_descriptor_public_key(&self) -> &DescriptorPublicKey

Reference to the underlying DescriptorPublicKey

pub fn into_descriptor_public_key(self) -> DescriptorPublicKey

Converts the definite key into a generic one

Trait Implementations

impl AssetProvider<DefiniteDescriptorKey> for Assets

fn provider_lookup_ecdsa_sig(&self, pk: &DefiniteDescriptorKey) -> bool

Given a public key, look up an ECDSA signature with that key, return whether we found it

fn provider_lookup_tap_key_spend_sig( &self, pk: &DefiniteDescriptorKey ) -> Option<usize>

Lookup the tap key spend sig and return its size

fn provider_lookup_tap_leaf_script_sig( &self, pk: &DefiniteDescriptorKey, tap_leaf_hash: &TapLeafHash ) -> Option<usize>

Given a public key and a associated leaf hash, look up a schnorr signature with that key and return its size

fn provider_lookup_sha256(&self, hash: &Hash) -> bool

Given a SHA256 hash, look up its preimage, return whether we found it

fn provider_lookup_hash256(&self, hash: &Hash) -> bool

Given a HASH256 hash, look up its preimage, return whether we found it

fn provider_lookup_ripemd160(&self, hash: &Hash) -> bool

Given a RIPEMD160 hash, look up its preimage, return whether we found it

fn provider_lookup_hash160(&self, hash: &Hash) -> bool

Given a HASH160 hash, look up its preimage, return whether we found it

fn check_older(&self, s: Sequence) -> bool

Assert whether a relative locktime is satisfied

fn check_after(&self, l: LockTime) -> bool

Assert whether an absolute locktime is satisfied

fn provider_lookup_tap_control_block_map( &self ) -> Option<&BTreeMap<ControlBlock, (ScriptBuf, LeafVersion)>>

Obtain a reference to the control block for a ver and script

fn provider_lookup_raw_pkh_pk(&self, _: &Hash) -> Option<PublicKey>

Given a raw Pkh, lookup corresponding bitcoin::PublicKey

fn provider_lookup_raw_pkh_x_only_pk(&self, _: &Hash) -> Option<XOnlyPublicKey>

Given a raw Pkh, lookup corresponding [bitcoin::secp256k1::XOnlyPublicKey]

fn provider_lookup_raw_pkh_ecdsa_sig(&self, _: &Hash) -> Option<PublicKey>

Given a keyhash, look up the EC signature and the associated key. Returns the key if a signature is found. Even if signatures for public key Hashes are not available, the users can use this map to provide pkh -> pk mapping which can be useful for dissatisfying pkh.

fn provider_lookup_raw_pkh_tap_leaf_script_sig( &self, _: &(Hash, TapLeafHash) ) -> Option<(XOnlyPublicKey, usize)>

Given a keyhash, look up the schnorr signature and the associated key. Returns the key and sig len if a signature is found. Even if signatures for public key Hashes are not available, the users can use this map to provide pkh -> pk mapping which can be useful for dissatisfying pkh.

impl AssetProvider<DefiniteDescriptorKey> for LoggerAssetProvider

fn provider_lookup_ecdsa_sig(&self, pk: &DefiniteDescriptorKey) -> bool

Given a public key, look up an ECDSA signature with that key, return whether we found it

fn provider_lookup_tap_key_spend_sig( &self, pk: &DefiniteDescriptorKey ) -> Option<usize>

Lookup the tap key spend sig and return its size

fn provider_lookup_tap_leaf_script_sig( &self, pk: &DefiniteDescriptorKey, leaf_hash: &TapLeafHash ) -> Option<usize>

Given a public key and a associated leaf hash, look up a schnorr signature with that key and return its size

fn provider_lookup_tap_control_block_map( &self ) -> Option<&BTreeMap<ControlBlock, (ScriptBuf, LeafVersion)>>

Obtain a reference to the control block for a ver and script

fn provider_lookup_raw_pkh_pk(&self, hash: &Hash) -> Option<PublicKey>

Given a raw Pkh, lookup corresponding bitcoin::PublicKey

fn provider_lookup_raw_pkh_x_only_pk( &self, hash: &Hash ) -> Option<XOnlyPublicKey>

Given a raw Pkh, lookup corresponding [bitcoin::secp256k1::XOnlyPublicKey]

fn provider_lookup_raw_pkh_ecdsa_sig(&self, hash: &Hash) -> Option<PublicKey>

Given a keyhash, look up the EC signature and the associated key. Returns the key if a signature is found. Even if signatures for public key Hashes are not available, the users can use this map to provide pkh -> pk mapping which can be useful for dissatisfying pkh.

fn provider_lookup_raw_pkh_tap_leaf_script_sig( &self, hash: &(Hash, TapLeafHash) ) -> Option<(XOnlyPublicKey, usize)>

Given a keyhash, look up the schnorr signature and the associated key. Returns the key and sig len if a signature is found. Even if signatures for public key Hashes are not available, the users can use this map to provide pkh -> pk mapping which can be useful for dissatisfying pkh.

fn provider_lookup_sha256(&self, hash: &Hash) -> bool

Given a SHA256 hash, look up its preimage, return whether we found it

fn provider_lookup_hash256(&self, hash: &Hash) -> bool

Given a HASH256 hash, look up its preimage, return whether we found it

fn provider_lookup_ripemd160(&self, hash: &Hash) -> bool

Given a RIPEMD160 hash, look up its preimage, return whether we found it

fn provider_lookup_hash160(&self, hash: &Hash) -> bool

Given a HASH160 hash, look up its preimage, return whether we found it

fn check_older(&self, s: Sequence) -> bool

Assert whether a relative locktime is satisfied

fn check_after(&self, t: LockTime) -> bool

Assert whether an absolute locktime is satisfied

impl Borrow<DescriptorPublicKey> for DefiniteDescriptorKey

fn borrow(&self) -> &DescriptorPublicKey

Immutably borrows from an owned value.

impl Clone for DefiniteDescriptorKey

fn clone(&self) -> DefiniteDescriptorKey

Returns a copy of the value.

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl MiniscriptKey for DefiniteDescriptorKey

type Sha256 = Hash

The associated [bitcoin::hashes::sha256::Hash] for this MiniscriptKey, used in the sha256 fragment.

type Hash256 = Hash

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

type Ripemd160 = Hash

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

type Hash160 = Hash

The associated [bitcoin::hashes::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.

fn num_der_paths(&self) -> usize

Returns the number of different derivation paths in this key. Only >1 for keys in BIP389 multipath descriptors.

impl Ord for DefiniteDescriptorKey

fn cmp(&self, other: &DefiniteDescriptorKey) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for DefiniteDescriptorKey

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

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

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

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

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

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

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

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

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

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

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

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