Struct NodeInfo

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

Represents the node information in taproot tree. In contrast to TapTree, this is allowed to have hidden leaves as children.

Helper type used in merkle tree construction allowing one to build sparse merkle trees. The node represents part of the tree that has information about all of its descendants. See how TaprootBuilder works for more details. You can use TaprootSpendInfo::from_node_info to a get a TaprootSpendInfo from the merkle root NodeInfo.

Implementations

impl NodeInfo

pub fn leaf_nodes(&self) -> Vec<Arc<LeafNode>>

Creates an iterator over all leaves (including hidden leaves) in the tree.

pub fn node_hash(&self) -> String

Returns the root TapNodeHash of this node info.

Trait Implementations

impl Debug for NodeInfo

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

Formats the value using the given formatter.

impl Display for NodeInfo

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

Formats the value using the given formatter.

impl<UT> LiftRef<UT> for NodeInfo

type LiftType = Arc<NodeInfo>

impl<UT> LowerError<UT> for NodeInfo

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for NodeInfo

type ReturnType = <Arc<NodeInfo> 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 NodeInfo

const TYPE_ID_META: MetadataBuffer