Struct BatchNoteTree 

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

Wrapper over SimpleSmt<BATCH_NOTE_TREE_DEPTH> for batch note tree.

Value of each leaf is computed as: hash(note_id || note_metadata).

Implementations

impl BatchNoteTree

pub fn with_contiguous_leaves<'a>( entries: impl IntoIterator<Item = (NoteId, &'a NoteMetadata)>, ) -> Result<Self, MerkleError>

Wrapper around SimpleSmt::with_contiguous_leaves which populates notes at contiguous indices starting at index 0.

Errors

Returns an error if the number of entries exceeds the maximum tree capacity, that is 2^{depth}.

pub fn root(&self) -> Word

Returns the root of the tree

pub fn num_leaves(&self) -> usize

Returns the number of non-empty leaves in this tree.

pub fn remove(&mut self, index: u64) -> Result<(), MerkleError>

Removes the note at the given index form the tree by inserting EMPTY_WORD.

Errors

Returns an error if:

• the index is equal to or exceeds MAX_OUTPUT_NOTES_PER_BATCH.

pub fn into_smt(self) -> SimpleSmt<BATCH_NOTE_TREE_DEPTH>

Consumes the batch note tree and returns the underlying SimpleSmt.

Trait Implementations

impl Clone for BatchNoteTree

fn clone(&self) -> BatchNoteTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchNoteTree

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

Formats the value using the given formatter.

impl Deserializable for BatchNoteTree

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl PartialEq for BatchNoteTree

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

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Eq for BatchNoteTree

impl StructuralPartialEq for BatchNoteTree