Struct bdk_chain::bitcoin::taproot::LeafNode

pub struct LeafNode { /* private fields */ }
Expand description

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. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
§

impl Debug for LeafNode

§

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

Formats the value using the given formatter. Read more
§

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. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
§

impl Ord for LeafNode

§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized + PartialOrd,

Restrict a value to a certain interval. Read more
§

impl PartialEq for LeafNode

§

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

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

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

This method 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. Read more
1.0.0 · source§

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more
§

impl Eq for LeafNode

§

impl StructuralPartialEq for LeafNode

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V