Struct bdk_chain::bitcoin::taproot::TaprootSpendInfo

pub struct TaprootSpendInfo { /* private fields */ }
Expand description

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, ScriptBuf)>, 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<TapNodeHash> ) -> 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<TapNodeHash>

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 script_map( &self ) -> &BTreeMap<(ScriptBuf, LeafVersion), BTreeSet<TaprootMerkleBranch>>

Returns a reference to the internal script map.

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 control_block( &self, script_ver: &(ScriptBuf, 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. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for TaprootSpendInfo

§

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

Formats the value using the given formatter. Read more
§

impl From<&TaprootSpendInfo> for TapTweakHash

§

fn from(spend_info: &TaprootSpendInfo) -> TapTweakHash

Converts to this type from the input type.
§

impl From<TaprootSpendInfo> for TapTweakHash

§

fn from(spend_info: TaprootSpendInfo) -> TapTweakHash

Converts to this type from the input type.
§

impl Hash for TaprootSpendInfo

§

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

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
§

impl Ord for TaprootSpendInfo

§

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

Restrict a value to a certain interval. Read more
§

impl PartialEq for TaprootSpendInfo

§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

§

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

This method 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

This method 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

This method 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

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

impl Eq for TaprootSpendInfo

§

impl StructuralPartialEq for TaprootSpendInfo

Auto Trait Implementations§

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
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. 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,

§

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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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

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

§

fn vzip(self) -> V