Struct LeafNode

pub struct LeafNode { /* private fields */ }

Store information about taproot leaf node.

Implementations

impl LeafNode

pub fn new_script(script: ScriptBuf, ver: LeafVersion) -> LeafNode

Creates an new ScriptLeaf from script and ver and no merkle branch.

pub fn new_hidden(hash: TapNodeHash) -> LeafNode

Creates an new ScriptLeaf from hash and no merkle branch.

pub fn depth(&self) -> u8

Returns the depth of this script leaf in the tap tree.

pub fn leaf_hash(&self) -> Option<TapLeafHash>

Computes a leaf hash for this ScriptLeaf if the leaf is known.

This TapLeafHash is useful while signing taproot script spends.

See LeafNode::node_hash for computing the TapNodeHash which returns the hidden node hash if the node is hidden.

pub fn node_hash(&self) -> TapNodeHash

Computes the TapNodeHash for this ScriptLeaf. This returns the leaf hash if the leaf is known and the hidden node hash if the leaf is hidden. See also, LeafNode::leaf_hash.

pub fn script(&self) -> Option<&Script>

Returns reference to the leaf script if the leaf is known.

pub fn leaf_version(&self) -> Option<LeafVersion>

Returns leaf version of the script if the leaf is known.

pub fn merkle_branch(&self) -> &TaprootMerkleBranch

Returns reference to the merkle proof (hashing partners) to get this node in form of TaprootMerkleBranch.

pub fn leaf(&self) -> &TapLeaf

Returns a reference to the leaf of this ScriptLeaf.

Trait Implementations

impl Clone for LeafNode

fn clone(&self) -> LeafNode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LeafNode

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

Formats the value using the given formatter.

impl From<&LeafNode> for TapNodeHash

fn from(leaf: &LeafNode) -> TapNodeHash

Converts to this type from the input type.

impl From<LeafNode> for TapNodeHash

fn from(leaf: LeafNode) -> TapNodeHash

Converts to this type from the input type.

impl Hash for LeafNode

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 LeafNode

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

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

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

impl StructuralPartialEq for LeafNode