Struct Pkh

pub struct Pkh<Pk: MiniscriptKey> { /* private fields */ }

A bare PkH descriptor at top level

Implementations

impl<Pk: MiniscriptKey> Pkh<Pk>

pub fn new(pk: Pk) -> Result<Self, ScriptContextError>

Create a new Pkh descriptor

pub fn as_inner(&self) -> &Pk

Get a reference to the inner key

pub fn into_inner(self) -> Pk

Get the inner key

pub fn max_weight_to_satisfy(&self) -> Weight

Computes an upper bound on the difference between a non-satisfied TxIn’s segwit_weight and a satisfied TxIn’s segwit_weight

Since this method uses segwit_weight instead of legacy_weight, if you want to include only legacy inputs in your transaction, you should remove 1WU from each input’s max_weight_to_satisfy for a more accurate estimate.

Assumes all ECDSA signatures are 73 bytes, including push opcode and sighash suffix.

Errors

When the descriptor is impossible to safisfy (ex: sh(OP_FALSE)).

pub fn max_satisfaction_weight(&self) -> usize

👎Deprecated since 10.0.0: Use max_weight_to_satisfy instead. The method to count bytes was redesigned and the results will differ from max_weight_to_satisfy. For more details check rust-bitcoin/rust-miniscript#476.

Computes an upper bound on the weight of a satisfying witness to the transaction.

Assumes all ec-signatures are 73 bytes, including push opcode and sighash suffix. Includes the weight of the VarInts encoding the scriptSig and witness stack length.

impl<Pk: MiniscriptKey + ToPublicKey> Pkh<Pk>

pub fn script_pubkey(&self) -> ScriptBuf

Obtains the corresponding script pubkey for this descriptor.

pub fn address(&self, network: Network) -> Address

Obtains the corresponding script pubkey for this descriptor.

pub fn inner_script(&self) -> ScriptBuf

Obtains the underlying miniscript for this descriptor.

pub fn ecdsa_sighash_script_code(&self) -> ScriptBuf

Obtains the pre bip-340 signature script code for this descriptor.

pub fn get_satisfaction<S>( &self, satisfier: S, ) -> Result<(Vec<Vec<u8>>, ScriptBuf), Error>

where S: Satisfier<Pk>,

Returns satisfying non-malleable witness and scriptSig with minimum weight to spend an output controlled by the given descriptor if it is possible to construct one using the satisfier.

pub fn get_satisfaction_mall<S>( &self, satisfier: S, ) -> Result<(Vec<Vec<u8>>, ScriptBuf), Error>

where S: Satisfier<Pk>,

Returns satisfying, possibly malleable, witness and scriptSig with minimum weight to spend an output controlled by the given descriptor if it is possible to construct one using the satisfier.

impl Pkh<DefiniteDescriptorKey>

pub fn plan_satisfaction<P>( &self, provider: &P, ) -> Satisfaction<Placeholder<DefiniteDescriptorKey>>

where P: AssetProvider<DefiniteDescriptorKey>,

Returns a plan if the provided assets are sufficient to produce a non-malleable satisfaction

pub fn plan_satisfaction_mall<P>( &self, provider: &P, ) -> Satisfaction<Placeholder<DefiniteDescriptorKey>>

where P: AssetProvider<DefiniteDescriptorKey>,

Returns a plan if the provided assets are sufficient to produce a malleable satisfaction

Trait Implementations

impl<Pk: Clone + MiniscriptKey> Clone for Pkh<Pk>

fn clone(&self) -> Pkh<Pk>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Pk: MiniscriptKey> Debug for Pkh<Pk>

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

Formats the value using the given formatter.

impl<Pk: MiniscriptKey> Display for Pkh<Pk>

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

Formats the value using the given formatter.

impl<Pk: MiniscriptKey> ForEachKey<Pk> for Pkh<Pk>

fn for_each_key<'a, F: FnMut(&'a Pk) -> bool>(&'a self, pred: F) -> bool

Run a predicate on every key in the descriptor, returning whether the predicate returned true for every key

fn for_any_key<'a, F: FnMut(&'a Pk) -> bool>(&'a self, pred: F) -> bool

where Pk: 'a,

Run a predicate on every key in the descriptor, returning whether the predicate returned true for any key

impl<Pk: MiniscriptKey> From<Pkh<Pk>> for Descriptor<Pk>

fn from(inner: Pkh<Pk>) -> Self

Converts to this type from the input type.

impl<Pk: FromStrKey> FromStr for Pkh<Pk>

type Err = Error

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<Pk: FromStrKey> FromTree for Pkh<Pk>

fn from_tree(top: &Tree<'_>) -> Result<Self, Error>

Extract a structure from Tree representation

impl<Pk: Hash + MiniscriptKey> Hash for Pkh<Pk>

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<Pk: MiniscriptKey> Liftable<Pk> for Pkh<Pk>

fn lift(&self) -> Result<Policy<Pk>, Error>

Converts this object into an abstract policy.

impl<Pk: Ord + MiniscriptKey> Ord for Pkh<Pk>

fn cmp(&self, other: &Pkh<Pk>) -> 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<Pk: PartialEq + MiniscriptKey> PartialEq for Pkh<Pk>

fn eq(&self, other: &Pkh<Pk>) -> 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<Pk: PartialOrd + MiniscriptKey> PartialOrd for Pkh<Pk>

fn partial_cmp(&self, other: &Pkh<Pk>) -> 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<P, Q> TranslatePk<P, Q> for Pkh<P>

where P: MiniscriptKey, Q: MiniscriptKey,

type Output = Pkh<Q>

The associated output type. This must be Self<Q>.

fn translate_pk<T, E>(&self, t: &mut T) -> Result<Self::Output, TranslateErr<E>>

where T: Translator<P, Q, E>,

Translates a struct from one generic to another where the translations for Pk are provided by the given Translator.

impl<Pk: Eq + MiniscriptKey> Eq for Pkh<Pk>

impl<Pk: MiniscriptKey> StructuralPartialEq for Pkh<Pk>