Struct TaprootSpendInfo

pub struct TaprootSpendInfo { /* private fields */ }

Represents taproot spending information.

Taproot output corresponds to a combination of a single public key condition (known as the internal key), and zero or more general conditions encoded in scripts organized in the form of a binary tree.

Taproot can be spent by either:

• Spending using the key path i.e., with secret key corresponding to the tweaked output_key.
• By satisfying any of the scripts in the script spend path. Each script can be satisfied by providing a witness stack consisting of the script’s inputs, plus the script itself and the control block.

If one or more of the spending conditions consist of just a single key (after aggregation), the most likely key should be made the internal key. See BIP341 for more details on choosing internal keys for a taproot application.

Note: This library currently does not support annex.

Implementations

impl TaprootSpendInfo

pub fn with_huffman_tree<C, I>( secp: &Secp256k1<C>, internal_key: XOnlyPublicKey, script_weights: I, ) -> Result<TaprootSpendInfo, TaprootBuilderError>

where I: IntoIterator<Item = (u32, Script)>, C: Verification,

Creates a new TaprootSpendInfo from a list of scripts (with default script version) and weights of satisfaction for that script.

See TaprootBuilder::with_huffman_tree for more detailed documentation.

pub fn new_key_spend<C>( secp: &Secp256k1<C>, internal_key: XOnlyPublicKey, merkle_root: Option<TapBranchHash>, ) -> TaprootSpendInfo

where C: Verification,

Creates a new key spend with internal_key and merkle_root. Provide None for the merkle_root if there is no script path.

Note: As per BIP341

When the merkle root is None, the output key commits to an unspendable script path instead of having no script path. This is achieved by computing the output key point as Q = P + int(hashTapTweak(bytes(P)))G. See also TaprootSpendInfo::tap_tweak.

Refer to BIP 341 footnote (‘Why should the output key always have a taproot commitment, even if there is no script path?’) for more details.

pub fn tap_tweak(&self) -> TapTweakHash

Returns the TapTweakHash for this TaprootSpendInfo i.e., the tweak using internal_key and merkle_root.

pub fn internal_key(&self) -> XOnlyPublicKey

Returns the internal key for this TaprootSpendInfo.

pub fn merkle_root(&self) -> Option<TapBranchHash>

Returns the merkle root for this TaprootSpendInfo.

pub fn output_key(&self) -> TweakedPublicKey

Returns the output key (the key used in script pubkey) for this TaprootSpendInfo.

pub fn output_key_parity(&self) -> Parity

Returns the parity of the output key. See also TaprootSpendInfo::output_key.

pub fn from_node_info<C>( secp: &Secp256k1<C>, internal_key: XOnlyPublicKey, node: NodeInfo, ) -> TaprootSpendInfo

where C: Verification,

Computes the TaprootSpendInfo from internal_key and node.

This is useful when you want to manually build a taproot tree without using TaprootBuilder.

pub fn as_script_map( &self, ) -> &BTreeMap<(Script, LeafVersion), BTreeSet<TaprootMerkleBranch>>

Returns the internal script map.

pub fn control_block( &self, script_ver: &(Script, LeafVersion), ) -> Option<ControlBlock>

Constructs a ControlBlock for particular script with the given version.

Returns

• If there are multiple control blocks possible, returns the shortest one.
• If the script is not contained in the TaprootSpendInfo, returns None.

Trait Implementations

impl Clone for TaprootSpendInfo

fn clone(&self) -> TaprootSpendInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TaprootSpendInfo

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

Formats the value using the given formatter.

impl Hash for TaprootSpendInfo

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

where __H: Hasher,

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 Ord for TaprootSpendInfo

fn cmp(&self, other: &TaprootSpendInfo) -> 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 PartialEq for TaprootSpendInfo

fn eq(&self, other: &TaprootSpendInfo) -> 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 PartialOrd for TaprootSpendInfo

fn partial_cmp(&self, other: &TaprootSpendInfo) -> 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 Eq for TaprootSpendInfo

impl StructuralPartialEq for TaprootSpendInfo