Struct miniscript::descriptor::Tr

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

A taproot descriptor

Implementations

impl<Pk: MiniscriptKey> Tr<Pk>

pub fn new(internal_key: Pk, tree: Option<TapTree<Pk>>) -> Result<Self, Error>

Create a new Tr descriptor from internal key and TapTree

pub fn internal_key(&self) -> &Pk

Obtain the internal key of Tr descriptor

pub fn tap_tree(&self) -> &Option<TapTree<Pk>>

Obtain the TapTree of the Tr descriptor

pub fn taptree(&self) -> &Option<TapTree<Pk>>

👎Deprecated since 11.0.0: use tap_tree instead

Obtain the TapTree of the Tr descriptor

pub fn iter_scripts(&self) -> TapTreeIter<'_, Pk>

Iterate over all scripts in merkle tree. If there is no script path, the iterator yields None

pub fn spend_info(&self) -> Arc<TaprootSpendInfo>where Pk: ToPublicKey,

Compute the TaprootSpendInfo associated with this descriptor if spend data is None.

If spend data is already computed (i.e it is not None), this does not recompute it.

TaprootSpendInfo is only required for spending via the script paths.

pub fn sanity_check(&self) -> Result<(), Error>

Checks whether the descriptor is safe.

pub fn max_weight_to_satisfy(&self) -> Result<Weight, Error>

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

Assumes all Schnorr signatures are 66 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) -> Result<usize, Error>

👎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.

Errors

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

impl<Pk: MiniscriptKey + ToPublicKey> Tr<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 address 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 Tr<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: MiniscriptKey> Clone for Tr<Pk>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Formats the value using the given formatter.

impl<Pk: MiniscriptKey> ForEachKey<Pk> for Tr<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) -> boolwhere Pk: 'a,

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

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

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

Converts to this type from the input type.

impl<Pk: FromStrKey> FromStr for Tr<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 Tr<Pk>

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

Extract a structure from Tree representation

impl<Pk: MiniscriptKey> Hash for Tr<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 Tr<Pk>

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

Converts this object into an abstract policy.

impl<Pk: MiniscriptKey> Ord for Tr<Pk>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<Pk: MiniscriptKey> PartialEq<Tr<Pk>> for Tr<Pk>

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

fn partial_cmp(&self, other: &Self) -> 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<P, Q> TranslatePk<P, Q> for Tr<P>where P: MiniscriptKey, Q: MiniscriptKey,

type Output = Tr<Q>

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

fn translate_pk<T, E>( &self, translate: &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: MiniscriptKey> Eq for Tr<Pk>