Struct MerkleTree

#[repr(C)]
pub struct MerkleTree<H, C>
where
    H: Hasher,
    C: MerkleTreeConfig,
{
    pub height: u64,
    pub filled_subtrees: [[u8; 32]; 18],
    pub roots: [[u8; 32]; 20],
    pub next_index: u64,
    pub current_root_index: u64,
    /* private fields */
}

Fields

height: u64

Height of the Merkle tree.

filled_subtrees: [[u8; 32]; 18]

Subtree hashes.

roots: [[u8; 32]; 20]

Full history of roots of the Merkle tree (the last one is the current one).

next_index: u64

Next index to insert a leaf.

current_root_index: u64

Current index of the root.

Implementations

impl<H, C> MerkleTree<H, C>

where H: Hasher, C: MerkleTreeConfig,

pub fn new(height: usize) -> Self

Create a new Merkle tree with the given height.

pub fn hash(&mut self, leaf1: [u8; 32], leaf2: [u8; 32]) -> Hash

pub fn insert(&mut self, leaf1: [u8; 32], leaf2: [u8; 32])

pub fn is_known_root(&self, root: [u8; 32]) -> bool

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

Trait Implementations

impl<H, C> Clone for MerkleTree<H, C>

where H: Hasher + Clone, C: MerkleTreeConfig + Clone,

fn clone(&self) -> MerkleTree<H, C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<H, C> Debug for MerkleTree<H, C>

where H: Hasher + Debug, C: MerkleTreeConfig + Debug,

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

Formats the value using the given formatter.

impl<H, C> PartialEq for MerkleTree<H, C>

where H: Hasher + PartialEq, C: MerkleTreeConfig + PartialEq,

fn eq(&self, other: &MerkleTree<H, C>) -> 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<H, C> Zeroable for MerkleTree<H, C>

where H: Hasher, C: MerkleTreeConfig,

The Zeroable trait is used under the hood by the zero_copy attribute macro and is required for usage in zero-copy Solana accounts.

SAFETY: Generic parameters are used only as PhantomData and they don’t affect the layout of the struct nor its size or padding. The only reason why we can’t #[derive(Zeroable)] is because bytemuck is not aware of that and it doesn’t allow to derive Zeroable for structs with generic parameters. Would be nice to fix that upstream: https://github.com/Lokathor/bytemuck/issues/191

fn zeroed() -> Self

Calls zeroed.

impl<H, C> Copy for MerkleTree<H, C>

where H: Hasher + Copy, C: MerkleTreeConfig + Copy,

impl<H, C> Eq for MerkleTree<H, C>

where H: Hasher + Eq, C: MerkleTreeConfig + Eq,

impl<H, C> Pod for MerkleTree<H, C>

where H: Hasher + Copy + 'static, C: MerkleTreeConfig + Copy + 'static,

The Pod trait is used under the hood by the zero_copy attribute macro and is required for usage in zero-copy Solana accounts.

SAFETY: Generic parameters are used only as PhantomData and they don’t affect the layout of the struct nor its size or padding. The only reason why we can’t #[derive(Pod)] is because bytemuck is not aware of that and it doesn’t allow to derive Pod for structs with generic parameters. Would be nice to fix that upstream: https://github.com/Lokathor/bytemuck/issues/191

impl<H, C> StructuralPartialEq for MerkleTree<H, C>

where H: Hasher, C: MerkleTreeConfig,