Struct MerkleHash 

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

Source data for creation of multi-message commitments according to LNPBP-4 procedure.

Implementations

impl MerkleHash

pub fn void(depth: impl Into<u8>, width: impl Into<u256>) -> MerkleHash

pub fn single( depth: impl Into<u8>, width: impl Into<u256>, node: MerkleHash, ) -> MerkleHash

pub fn branches( depth: impl Into<u8>, width: impl Into<u256>, node1: MerkleHash, node2: MerkleHash, ) -> MerkleHash

impl MerkleHash

pub fn merklize(leaves: &impl MerkleLeaves) -> MerkleHash

Merklization procedure that uses tagged hashes with depth commitments according to LNPBP-81 standard of client-side-validation merklization.

Methods from Deref<Target = Array<u8, 32>>

pub fn as_slice(&self) -> &[T]

Returns byte slice representation.

pub fn to_vec(&self) -> Vec<T>

where T: Clone,

Returns vector representing internal slice data

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the array items.

The iterator yields all items from start to end.

pub fn to_byte_array(&self) -> [u8; LEN]

Returns a byte array representation stored in the wrapped type.

Trait Implementations

impl AsRef<Array<u8, 32>> for MerkleHash

fn as_ref(&self) -> &Array<u8, 32>

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

impl Borrow<[u8]> for MerkleHash

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

Immutably borrows from an owned value.

impl Borrow<Array<u8, 32>> for MerkleHash

fn borrow(&self) -> &Array<u8, 32>

Immutably borrows from an owned value.

impl Clone for MerkleHash

fn clone(&self) -> MerkleHash

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommitmentId for MerkleHash

const TAG: &'static str = "urn:ubideco:merkle:node#2024-01-31"

impl Debug for MerkleHash

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

Formats the value using the given formatter.

impl Deref for MerkleHash

type Target = Array<u8, 32>

The resulting type after dereferencing.

fn deref(&self) -> &<MerkleHash as Deref>::Target

Dereferences the value.

impl<'de> Deserialize<'de> for MerkleHash

fn deserialize<__D>( __deserializer: __D, ) -> Result<MerkleHash, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MerkleHash

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

Formats the value using the given formatter.

impl From<[u8; 32]> for MerkleHash

fn from(v: [u8; 32]) -> MerkleHash

Converts to this type from the input type.

impl From<Array<u8, 32>> for MerkleHash

fn from(v: Array<u8, 32>) -> MerkleHash

Converts to this type from the input type.

impl From<MerkleHash> for Array<u8, 32>

fn from(wrapped: MerkleHash) -> Array<u8, 32>

Converts to this type from the input type.

impl FromHex for MerkleHash

fn from_byte_iter<I>(iter: I) -> Result<MerkleHash, Error>

where I: Iterator<Item = Result<u8, Error>> + ExactSizeIterator + DoubleEndedIterator,

Produce an object from a byte iterator

fn from_hex(s: &str) -> Result<Self, Error>

Produce an object from a hex string

impl FromStr for MerkleHash

type Err = <<MerkleHash as Wrapper>::Inner as FromStr>::Err

The associated error which can be returned from parsing.

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

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

impl Hash for MerkleHash

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 Index<Range<usize>> for MerkleHash

type Output = <Array<u8, 32> as Index<Range<usize>>>::Output

The returned type after indexing.

fn index( &self, index: Range<usize>, ) -> &<MerkleHash as Index<Range<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFrom<usize>> for MerkleHash

type Output = <Array<u8, 32> as Index<RangeFrom<usize>>>::Output

The returned type after indexing.

fn index( &self, index: RangeFrom<usize>, ) -> &<MerkleHash as Index<RangeFrom<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeFull> for MerkleHash

type Output = <Array<u8, 32> as Index<RangeFull>>::Output

The returned type after indexing.

fn index(&self, index: RangeFull) -> &<MerkleHash as Index<RangeFull>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeInclusive<usize>> for MerkleHash

type Output = <Array<u8, 32> as Index<RangeInclusive<usize>>>::Output

The returned type after indexing.

fn index( &self, index: RangeInclusive<usize>, ) -> &<MerkleHash as Index<RangeInclusive<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeTo<usize>> for MerkleHash

type Output = <Array<u8, 32> as Index<RangeTo<usize>>>::Output

The returned type after indexing.

fn index( &self, index: RangeTo<usize>, ) -> &<MerkleHash as Index<RangeTo<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<RangeToInclusive<usize>> for MerkleHash

type Output = <Array<u8, 32> as Index<RangeInclusive<usize>>>::Output

The returned type after indexing.

fn index( &self, index: RangeToInclusive<usize>, ) -> &<MerkleHash as Index<RangeToInclusive<usize>>>::Output

Performs the indexing (container[index]) operation.

impl Index<usize> for MerkleHash

type Output = <Array<u8, 32> as Index<usize>>::Output

The returned type after indexing.

fn index(&self, index: usize) -> &<MerkleHash as Index<usize>>::Output

Performs the indexing (container[index]) operation.

impl LowerHex for MerkleHash

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

Formats the value using the given formatter.

impl Ord for MerkleHash

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

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

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

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 StrictDecode for MerkleHash

fn strict_decode(reader: &mut impl TypedRead) -> Result<MerkleHash, DecodeError>

fn strict_read(reader: impl ReadRaw) -> Result<Self, DecodeError>

impl StrictDumb for MerkleHash

fn strict_dumb() -> MerkleHash

impl StrictEncode for MerkleHash

fn strict_encode<W>(&self, writer: W) -> Result<W, Error>

where W: TypedWrite,

fn strict_write(&self, writer: impl WriteRaw) -> Result<(), Error>

impl StrictTuple for MerkleHash

const FIELD_COUNT: u8 = 1u8

fn strict_check_fields()

fn strict_type_info() -> TypeInfo<Self>

impl StrictType for MerkleHash

const STRICT_LIB_NAME: &'static str = LIB_NAME_COMMIT_VERIFY

fn strict_name() -> Option<TypeName>

impl UpperHex for MerkleHash

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

Formats the value using the given formatter.

impl Wrapper for MerkleHash

type Inner = Array<u8, 32>

Inner type wrapped by the current newtype

fn from_inner(inner: <MerkleHash as Wrapper>::Inner) -> MerkleHash

Instantiates wrapper type with the inner data

fn as_inner(&self) -> &<MerkleHash as Wrapper>::Inner

Returns reference to the inner representation for the wrapper type

fn into_inner(self) -> <MerkleHash as Wrapper>::Inner

Unwraps the wrapper returning the inner type

fn to_inner(&self) -> Self::Inner

where Self::Inner: Clone,

Clones inner data of the wrapped type and return them

fn copy(&self) -> Self

where Self: Sized, Self::Inner: Copy,

Copies the wrapped type

impl Copy for MerkleHash

impl Eq for MerkleHash

impl StrictProduct for MerkleHash

impl StructuralPartialEq for MerkleHash