Struct sapio_bitcoin::util::taproot::TaprootBuilder

pub struct TaprootBuilder { /* private fields */ }

Builder for building taproot iteratively. Users can specify tap leaf or omitted/hidden branches in a depth-first search (DFS) walk order to construct this tree.

See Wikipedia for more details on DFS.

Implementations

impl TaprootBuilder

pub fn new() -> Self

Creates a new instance of TaprootBuilder.

pub fn with_huffman_tree<I>(
    script_weights: I
) -> Result<Self, TaprootBuilderError> where
    I: IntoIterator<Item = (u32, Script)>, 

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

The weights represent the probability of each branch being taken. If probabilities/weights for each condition are known, constructing the tree as a Huffman Tree is the optimal way to minimize average case satisfaction cost. This function takes as input an iterator of tuple(u32, &Script) where u32 represents the satisfaction weights of the branch. For example, [(3, S1), (2, S2), (5, S3)] would construct a TapTree that has optimal satisfaction weight when probability for S1 is 30%, S2 is 20% and S3 is 50%.

Errors:

• When the optimal Huffman Tree has a depth more than 128.
• If the provided list of script weights is empty.

Edge Cases:

If the script weight calculations overflow, a sub-optimal tree may be generated. This should not happen unless you are dealing with billions of branches with weights close to 2^32.

pub fn add_leaf_with_ver(
    self,
    depth: u8,
    script: Script,
    ver: LeafVersion
) -> Result<Self, TaprootBuilderError>

Adds a leaf script at depth to the builder with script version ver. Errors if the leaves are not provided in DFS walk order. The depth of the root node is 0.

pub fn add_leaf(
    self,
    depth: u8,
    script: Script
) -> Result<Self, TaprootBuilderError>

Adds a leaf script at depth to the builder with default script version. Errors if the leaves are not provided in DFS walk order. The depth of the root node is 0.

See TaprootBuilder::add_leaf_with_ver for adding a leaf with specific version.

pub fn add_hidden_node(
    self,
    depth: u8,
    hash: Hash
) -> Result<Self, TaprootBuilderError>

Adds a hidden/omitted node at depth to the builder. Errors if the leaves are not provided in DFS walk order. The depth of the root node is 0.

pub fn is_finalized(&self) -> bool

Checks if the builder has finalized building a tree.

pub fn has_hidden_nodes(&self) -> bool

Checks if the builder has hidden nodes.

pub fn finalize<C: Verification>(
    self,
    secp: &Secp256k1<C>,
    internal_key: UntweakedPublicKey
) -> Result<TaprootSpendInfo, TaprootBuilderError>

Creates a TaprootSpendInfo with the given internal key.

Trait Implementations

impl Clone for TaprootBuilder

fn clone(&self) -> TaprootBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TaprootBuilder

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TaprootBuilder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl From<TapTree> for TaprootBuilder

fn from(tree: TapTree) -> Self

Converts to this type from the input type.

impl Hash for TaprootBuilder

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for TaprootBuilder

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<TaprootBuilder> for TaprootBuilder

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

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

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

This method tests for !=.

impl PartialOrd<TaprootBuilder> for TaprootBuilder

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for TaprootBuilder

impl StructuralEq for TaprootBuilder

impl StructuralPartialEq for TaprootBuilder