Struct LeafNode

pub struct LeafNode(/* private fields */);

Store information about taproot leaf node.

Implementations

impl LeafNode

pub fn depth(&self) -> u8

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

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

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) -> String

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, [bdk_electrum::bdk_core::bitcoin::taproot::LeafNode::leaf_hash].

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

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

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

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

pub fn merkle_branch(&self) -> Vec<String>

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

Trait Implementations

impl Debug for LeafNode

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

Formats the value using the given formatter.

impl Display for LeafNode

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

Formats the value using the given formatter.

impl<UT> LiftRef<UT> for LeafNode

type LiftType = Arc<LeafNode>

impl<UT> LowerError<UT> for LeafNode

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for LeafNode

type ReturnType = <Arc<LeafNode> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for LeafNode

const TYPE_ID_META: MetadataBuffer