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 implementMatrix<F>
.DIGEST_ELEMS
– number ofW
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>
impl<F: Clone + Send + Sync, W: Clone, M: Matrix<F>, const DIGEST_ELEMS: usize> MerkleTree<F, W, M, DIGEST_ELEMS>
Sourcepub fn new<P, PW, H, C>(h: &H, c: &C, leaves: Vec<M>) -> Selfwhere
P: PackedValue<Value = F>,
PW: PackedValue<Value = W>,
H: CryptographicHasher<F, [W; DIGEST_ELEMS]> + CryptographicHasher<P, [PW; DIGEST_ELEMS]> + Sync,
C: PseudoCompressionFunction<[W; DIGEST_ELEMS], 2> + PseudoCompressionFunction<[PW; DIGEST_ELEMS], 2> + Sync,
pub fn new<P, PW, H, C>(h: &H, c: &C, leaves: Vec<M>) -> Selfwhere
P: PackedValue<Value = F>,
PW: PackedValue<Value = W>,
H: CryptographicHasher<F, [W; DIGEST_ELEMS]> + CryptographicHasher<P, [PW; DIGEST_ELEMS]> + Sync,
C: PseudoCompressionFunction<[W; DIGEST_ELEMS], 2> + PseudoCompressionFunction<[PW; DIGEST_ELEMS], 2> + Sync,
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
andPW
differ. - If two leaf heights round up to the same power-of-two but are not equal (violates balancing rule).
Trait Implementations§
Source§impl<F: Debug, W: Debug, M: Debug, const DIGEST_ELEMS: usize> Debug for MerkleTree<F, W, M, DIGEST_ELEMS>
impl<F: Debug, W: Debug, M: Debug, const DIGEST_ELEMS: usize> Debug for MerkleTree<F, W, M, DIGEST_ELEMS>
Source§impl<'de, F, W, M, const DIGEST_ELEMS: usize> Deserialize<'de> for MerkleTree<F, W, M, DIGEST_ELEMS>
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>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl<F, W, M, const DIGEST_ELEMS: usize> Serialize for MerkleTree<F, W, M, DIGEST_ELEMS>
impl<F, W, M, const DIGEST_ELEMS: usize> Serialize for MerkleTree<F, W, M, DIGEST_ELEMS>
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>
impl<F, W, M, const DIGEST_ELEMS: usize> Sync for MerkleTree<F, W, M, DIGEST_ELEMS>
impl<F, W, M, const DIGEST_ELEMS: usize> Unpin for MerkleTree<F, W, M, DIGEST_ELEMS>
impl<F, W, M, const DIGEST_ELEMS: usize> UnwindSafe for MerkleTree<F, W, M, DIGEST_ELEMS>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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