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 new_hidden_node(hash: TapNodeHash) -> NodeInfo

Creates a new NodeInfo with omitted/hidden info.

pub fn new_leaf_with_ver(script: ScriptBuf, ver: LeafVersion) -> NodeInfo

Creates a new leaf NodeInfo with given ScriptBuf and LeafVersion.

pub fn combine( a: NodeInfo, b: NodeInfo, ) -> Result<NodeInfo, TaprootBuilderError>

Combines two NodeInfo to create a new parent.

pub fn leaf_nodes(&self) -> LeafNodes<'_>

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

pub fn node_hash(&self) -> TapNodeHash

Returns the root TapNodeHash of this node info.

Trait Implementations

impl Clone for NodeInfo

fn clone(&self) -> NodeInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NodeInfo

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for NodeInfo

fn deserialize<D>( deserializer: D, ) -> Result<NodeInfo, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TapTree> for NodeInfo

fn from(tree: TapTree) -> NodeInfo

Converts to this type from the input type.

impl Hash for NodeInfo

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 NodeInfo

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

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

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

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<NodeInfo> for TapTree

fn try_from( node_info: NodeInfo, ) -> Result<TapTree, <TapTree as TryFrom<NodeInfo>>::Error>

Constructs TapTree from a NodeInfo if it is complete binary tree.

Returns

A TapTree iff the NodeInfo has no hidden nodes, otherwise return HiddenNodesError error with the content of incomplete NodeInfo instance.

type Error = HiddenNodesError

The type returned in the event of a conversion error.

impl TryFrom<TaprootBuilder> for NodeInfo

type Error = IncompleteBuilderError

The type returned in the event of a conversion error.

fn try_from( builder: TaprootBuilder, ) -> Result<NodeInfo, <NodeInfo as TryFrom<TaprootBuilder>>::Error>

Performs the conversion.

impl Eq for NodeInfo