Struct Tr

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

A taproot descriptor

Implementations§

Source§

impl<Pk: MiniscriptKey> Tr<Pk>

Source

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

Create a new Tr descriptor from internal key and TapTree

Source

pub fn internal_key(&self) -> &Pk

Obtain the internal key of Tr descriptor

Source

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

Obtain the TapTree of the Tr descriptor

Source

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

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

Source

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.

Source

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

Checks whether the descriptor is safe.

Source

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

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

Source§

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

Source

pub fn script_pubkey(&self) -> Script

Obtains the corresponding script pubkey for this descriptor.

Source

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

Obtains the corresponding address for this descriptor.

Source

pub fn get_satisfaction<S>( &self, satisfier: S, ) -> Result<(Vec<Vec<u8>>, Script), 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.

Source

pub fn get_satisfaction_mall<S>( &self, satisfier: S, ) -> Result<(Vec<Vec<u8>>, Script), 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.

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn for_each_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 every key
Source§

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
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl<Pk> FromStr for Tr<Pk>

Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl<Pk> FromTree for Tr<Pk>

Source§

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

Extract a structure from Tree representation
Source§

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

Source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

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

Source§

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

Convert the object into an abstract policy
Source§

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

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

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

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

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

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<P, Q> TranslatePk<P, Q> for Tr<P>

Source§

type Output = Tr<Q>

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

fn translate_pk<T, E>(&self, translate: &mut T) -> Result<Self::Output, 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.
Source§

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

Auto Trait Implementations§

§

impl<Pk> !Freeze for Tr<Pk>

§

impl<Pk> RefUnwindSafe for Tr<Pk>

§

impl<Pk> Send for Tr<Pk>
where Pk: Send + Sync, <Pk as MiniscriptKey>::Sha256: Sync + Send, <Pk as MiniscriptKey>::Hash256: Sync + Send, <Pk as MiniscriptKey>::Ripemd160: Sync + Send, <Pk as MiniscriptKey>::Hash160: Sync + Send,

§

impl<Pk> Sync for Tr<Pk>
where Pk: Sync + Send, <Pk as MiniscriptKey>::Sha256: Sync + Send, <Pk as MiniscriptKey>::Hash256: Sync + Send, <Pk as MiniscriptKey>::Ripemd160: Sync + Send, <Pk as MiniscriptKey>::Hash160: Sync + Send,

§

impl<Pk> Unpin for Tr<Pk>
where Pk: Unpin,

§

impl<Pk> UnwindSafe for Tr<Pk>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V