Struct miniscript::descriptor::Tr
source · pub struct Tr<Pk: MiniscriptKey> { /* private fields */ }
Expand description
A taproot descriptor
Implementations§
source§impl<Pk: MiniscriptKey> Tr<Pk>
impl<Pk: MiniscriptKey> Tr<Pk>
sourcepub fn internal_key(&self) -> &Pk
pub fn internal_key(&self) -> &Pk
Obtain the internal key of Tr
descriptor
sourcepub fn iter_scripts(&self) -> TapTreeIter<'_, Pk>
pub fn iter_scripts(&self) -> TapTreeIter<'_, Pk>
Iterate over all scripts in merkle tree. If there is no script path, the iterator
yields None
sourcepub fn spend_info(&self) -> Arc<TaprootSpendInfo>where
Pk: ToPublicKey,
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.
sourcepub fn sanity_check(&self) -> Result<(), Error>
pub fn sanity_check(&self) -> Result<(), Error>
Checks whether the descriptor is safe.
sourcepub fn max_satisfaction_weight(&self) -> Result<usize, Error>
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>
impl<Pk: MiniscriptKey + ToPublicKey> Tr<Pk>
sourcepub fn script_pubkey(&self) -> Script
pub fn script_pubkey(&self) -> Script
Obtains the corresponding script pubkey for this descriptor.
sourcepub fn address(&self, network: Network) -> Address
pub fn address(&self, network: Network) -> Address
Obtains the corresponding address for this descriptor.
sourcepub fn get_satisfaction<S>(
&self,
satisfier: S
) -> Result<(Vec<Vec<u8>>, Script), Error>where
S: Satisfier<Pk>,
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
.
sourcepub fn get_satisfaction_mall<S>(
&self,
satisfier: S
) -> Result<(Vec<Vec<u8>>, Script), Error>where
S: Satisfier<Pk>,
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>
impl<Pk: MiniscriptKey> Clone for Tr<Pk>
source§impl<Pk: MiniscriptKey> Debug for Tr<Pk>
impl<Pk: MiniscriptKey> Debug for Tr<Pk>
source§impl<Pk: MiniscriptKey> Display for Tr<Pk>
impl<Pk: MiniscriptKey> Display for Tr<Pk>
source§impl<Pk: MiniscriptKey> ForEachKey<Pk> for Tr<Pk>
impl<Pk: MiniscriptKey> ForEachKey<Pk> for Tr<Pk>
source§impl<Pk: MiniscriptKey> From<Tr<Pk>> for Descriptor<Pk>
impl<Pk: MiniscriptKey> From<Tr<Pk>> for Descriptor<Pk>
source§impl<Pk> FromStr for Tr<Pk>where
Pk: MiniscriptKey + FromStr,
Pk::Sha256: FromStr,
Pk::Hash256: FromStr,
Pk::Ripemd160: FromStr,
Pk::Hash160: FromStr,
<Pk as FromStr>::Err: ToString,
<<Pk as MiniscriptKey>::Sha256 as FromStr>::Err: ToString,
<<Pk as MiniscriptKey>::Hash256 as FromStr>::Err: ToString,
<<Pk as MiniscriptKey>::Ripemd160 as FromStr>::Err: ToString,
<<Pk as MiniscriptKey>::Hash160 as FromStr>::Err: ToString,
impl<Pk> FromStr for Tr<Pk>where Pk: MiniscriptKey + FromStr, Pk::Sha256: FromStr, Pk::Hash256: FromStr, Pk::Ripemd160: FromStr, Pk::Hash160: FromStr, <Pk as FromStr>::Err: ToString, <<Pk as MiniscriptKey>::Sha256 as FromStr>::Err: ToString, <<Pk as MiniscriptKey>::Hash256 as FromStr>::Err: ToString, <<Pk as MiniscriptKey>::Ripemd160 as FromStr>::Err: ToString, <<Pk as MiniscriptKey>::Hash160 as FromStr>::Err: ToString,
source§impl<Pk> FromTree for Tr<Pk>where
Pk: MiniscriptKey + FromStr,
Pk::Sha256: FromStr,
Pk::Hash256: FromStr,
Pk::Ripemd160: FromStr,
Pk::Hash160: FromStr,
<Pk as FromStr>::Err: ToString,
<<Pk as MiniscriptKey>::Sha256 as FromStr>::Err: ToString,
<<Pk as MiniscriptKey>::Hash256 as FromStr>::Err: ToString,
<<Pk as MiniscriptKey>::Ripemd160 as FromStr>::Err: ToString,
<<Pk as MiniscriptKey>::Hash160 as FromStr>::Err: ToString,
impl<Pk> FromTree for Tr<Pk>where Pk: MiniscriptKey + FromStr, Pk::Sha256: FromStr, Pk::Hash256: FromStr, Pk::Ripemd160: FromStr, Pk::Hash160: FromStr, <Pk as FromStr>::Err: ToString, <<Pk as MiniscriptKey>::Sha256 as FromStr>::Err: ToString, <<Pk as MiniscriptKey>::Hash256 as FromStr>::Err: ToString, <<Pk as MiniscriptKey>::Ripemd160 as FromStr>::Err: ToString, <<Pk as MiniscriptKey>::Hash160 as FromStr>::Err: ToString,
source§impl<Pk: MiniscriptKey> Hash for Tr<Pk>
impl<Pk: MiniscriptKey> Hash for Tr<Pk>
source§impl<Pk: MiniscriptKey> Liftable<Pk> for Tr<Pk>
impl<Pk: MiniscriptKey> Liftable<Pk> for Tr<Pk>
source§impl<Pk: MiniscriptKey> Ord for Tr<Pk>
impl<Pk: MiniscriptKey> Ord for Tr<Pk>
source§impl<Pk: MiniscriptKey> PartialEq<Tr<Pk>> for Tr<Pk>
impl<Pk: MiniscriptKey> PartialEq<Tr<Pk>> for Tr<Pk>
source§impl<Pk: MiniscriptKey> PartialOrd<Tr<Pk>> for Tr<Pk>
impl<Pk: MiniscriptKey> PartialOrd<Tr<Pk>> for Tr<Pk>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl<P, Q> TranslatePk<P, Q> for Tr<P>where
P: MiniscriptKey,
Q: MiniscriptKey,
impl<P, Q> TranslatePk<P, Q> for Tr<P>where P: MiniscriptKey, Q: MiniscriptKey,
source§fn translate_pk<T, E>(&self, translate: &mut T) -> Result<Self::Output, E>where
T: Translator<P, Q, E>,
fn translate_pk<T, E>(&self, translate: &mut T) -> Result<Self::Output, E>where T: Translator<P, Q, E>,
Translator
.