MerkleTree

Struct MerkleTree 

Source
pub struct MerkleTree<F, W, M, const DIGEST_ELEMS: usize> { /* private fields */ }
Expand description

A binary Merkle tree whose leaves are vectors of matrix rows.

  • F – scalar element type inside each matrix row.
  • W – scalar element type of every digest word.
  • M – matrix type. Must implement Matrix<F>.
  • DIGEST_ELEMS – number of W words in one digest.

The tree is balanced only at the digest layer. Leaf matrices may have arbitrary heights as long as any two heights that round up to the same power-of-two are equal.

Use [root] to fetch the final digest once the tree is built.

This generally shouldn’t be used directly. If you’re using a Merkle tree as an MMCS, see MerkleTreeMmcs.

Implementations§

Source§

impl<F: Clone + Send + Sync, W: Clone, M: Matrix<F>, const DIGEST_ELEMS: usize> MerkleTree<F, W, M, DIGEST_ELEMS>

Source

pub fn new<P, PW, H, C>(h: &H, c: &C, leaves: Vec<M>) -> Self

Build a tree from one or more matrices.

  • h – hashing function used on raw rows.
  • c – 2-to-1 compression function used on digests.
  • leaves – matrices to commit to. Must be non-empty.

Matrices do not need to have power-of-two heights. However, any two matrices whose heights round up to the same power-of-two must have equal actual height. This ensures proper balancing when folding digests layer-by-layer.

All matrices are hashed row-by-row with h. The resulting digests are then folded upwards with c until a single root remains.

§Panics
  • If leaves is empty.
  • If the packing widths of P and PW differ.
  • If two leaf heights round up to the same power-of-two but are not equal (violates balancing rule).
Source

pub fn root(&self) -> Hash<F, W, DIGEST_ELEMS>
where W: Copy,

Return the root digest of the tree.

Trait Implementations§

Source§

impl<F: Debug, W: Debug, M: Debug, const DIGEST_ELEMS: usize> Debug for MerkleTree<F, W, M, DIGEST_ELEMS>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de, F, W, M, const DIGEST_ELEMS: usize> Deserialize<'de> for MerkleTree<F, W, M, DIGEST_ELEMS>

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<F, W, M, const DIGEST_ELEMS: usize> Serialize for MerkleTree<F, W, M, DIGEST_ELEMS>

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<F, W, M, const DIGEST_ELEMS: usize> Freeze for MerkleTree<F, W, M, DIGEST_ELEMS>

§

impl<F, W, M, const DIGEST_ELEMS: usize> RefUnwindSafe for MerkleTree<F, W, M, DIGEST_ELEMS>

§

impl<F, W, M, const DIGEST_ELEMS: usize> Send for MerkleTree<F, W, M, DIGEST_ELEMS>
where F: Send, M: Send, W: Send,

§

impl<F, W, M, const DIGEST_ELEMS: usize> Sync for MerkleTree<F, W, M, DIGEST_ELEMS>
where F: Sync, M: Sync, W: Sync,

§

impl<F, W, M, const DIGEST_ELEMS: usize> Unpin for MerkleTree<F, W, M, DIGEST_ELEMS>
where F: Unpin, M: Unpin, W: Unpin,

§

impl<F, W, M, const DIGEST_ELEMS: usize> UnwindSafe for MerkleTree<F, W, M, DIGEST_ELEMS>
where F: UnwindSafe, M: UnwindSafe, W: UnwindSafe,

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

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>,

Source§

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,