Struct TapNodeHash

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

Tagged hash used in taproot trees.

See BIP-340 for tagging rules.

Implementations

impl TapNodeHash

pub fn from_raw_hash(inner: Hash<TapBranchTag>) -> TapNodeHash

Creates this wrapper type from the inner hash type.

pub fn to_raw_hash(self) -> Hash<TapBranchTag>

Returns the inner hash (sha256, sh256d etc.).

pub fn as_raw_hash(&self) -> &Hash<TapBranchTag>

Returns a reference to the inner hash (sha256, sh256d etc.).

impl TapNodeHash

pub fn from_node_hashes(a: TapNodeHash, b: TapNodeHash) -> TapNodeHash

Computes branch hash given two hashes of the nodes underneath it.

pub fn assume_hidden(hash: [u8; 32]) -> TapNodeHash

Assumes the given 32 byte array as hidden TapNodeHash.

Similar to TapLeafHash::from_byte_array, but explicitly conveys that the hash is constructed from a hidden node. This also has better ergonomics because it does not require the caller to import the Hash trait.

pub fn from_script(script: &Script, ver: LeafVersion) -> TapNodeHash

Computes the TapNodeHash from a script and a leaf version.

Trait Implementations

impl AsRef<[u8]> for TapNodeHash

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<[u8; 32]> for TapNodeHash

fn as_ref(&self) -> &[u8; 32]

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<[u8]> for TapNodeHash

fn borrow(&self) -> &[u8]

Immutably borrows from an owned value.

impl Clone for TapNodeHash

fn clone(&self) -> TapNodeHash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TapNodeHash

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TapNodeHash

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TapNodeHash

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<Hash<TapBranchTag>> for TapNodeHash

fn from(inner: Hash<TapBranchTag>) -> 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 From<TapLeafHash> for TapNodeHash

fn from(leaf: TapLeafHash) -> TapNodeHash

Converts to this type from the input type.

impl From<TapNodeHash> for Hash<TapBranchTag>

fn from(hashtype: TapNodeHash) -> Hash<TapBranchTag>

Converts to this type from the input type.

impl FromStr for TapNodeHash

type Err = HexToArrayError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<TapNodeHash, <TapNodeHash as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for TapNodeHash

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 Hash for TapNodeHash

const LEN: usize = 32usize

Length of the hash, in bytes.

const DISPLAY_BACKWARD: bool = false

Flag indicating whether user-visible serializations of this hash should be backward. For some reason Satoshi decided this should be true for Sha256dHash, so here we are.

type Engine = <Hash<TapBranchTag> as Hash>::Engine

A hashing engine which bytes can be serialized into. It is expected to implement the io::Write trait, and to never return errors under any conditions.

type Bytes = <Hash<TapBranchTag> as Hash>::Bytes

The byte array that represents the hash internally.

fn engine() -> <TapNodeHash as Hash>::Engine

Constructs a new engine.

fn from_engine(e: <TapNodeHash as Hash>::Engine) -> TapNodeHash

Produces a hash from the current state of a given engine.

fn from_slice(sl: &[u8]) -> Result<TapNodeHash, FromSliceError>

Copies a byte slice into a hash object.

fn from_byte_array(bytes: <TapNodeHash as Hash>::Bytes) -> TapNodeHash

Constructs a hash from the underlying byte array.

fn to_byte_array(self) -> <TapNodeHash as Hash>::Bytes

Returns the underlying byte array.

fn as_byte_array(&self) -> &<TapNodeHash as Hash>::Bytes

Returns a reference to the underlying byte array.

fn all_zeros() -> TapNodeHash

Returns an all zero hash.

fn hash(data: &[u8]) -> Self

Hashes some bytes.

fn hash_byte_chunks<B, I>(byte_slices: I) -> Self

where B: AsRef<[u8]>, I: IntoIterator<Item = B>,

Hashes all the byte slices retrieved from the iterator together.

impl<I> Index<I> for TapNodeHash

where I: SliceIndex<[u8]>,

type Output = <I as SliceIndex<[u8]>>::Output

The returned type after indexing.

fn index(&self, index: I) -> &<TapNodeHash as Index<I>>::Output

Performs the indexing (container[index]) operation.

impl LowerHex for TapNodeHash

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

Formats the value using the given formatter.

impl Ord for TapNodeHash

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

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

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

const N: usize = 32usize

Size, in bits, of the hash.

fn from_slice_delegated(sl: &[u8]) -> Result<TapNodeHash, FromSliceError>

Helper function to turn a deserialized slice into the correct hash type.

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

where S: Serializer,

Do serde serialization.

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

where D: Deserializer<'de>,

Do serde deserialization.

impl Serialize for TapNodeHash

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl UpperHex for TapNodeHash

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

Formats the value using the given formatter.

impl Copy for TapNodeHash

impl Eq for TapNodeHash

impl StructuralPartialEq for TapNodeHash