Struct BlockNoteTree

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

Wrapper over SimpleSmt<BLOCK_NOTE_TREE_DEPTH> for notes tree.

Each note is stored as two adjacent leaves: odd leaf for id, even leaf for metadata hash. ID’s leaf index is calculated as [(batch_idx * MAX_NOTES_PER_BATCH + note_idx_in_batch) * 2]. Metadata hash leaf is stored the next after id leaf: [id_index + 1].

Implementations

impl BlockNoteTree

pub fn with_entries( entries: impl IntoIterator<Item = (BlockNoteIndex, NoteId, NoteMetadata)>, ) -> Result<Self, MerkleError>

Returns a new BlockNoteTree instantiated with entries set as specified by the provided entries.

Entry format: (note_index, note_id, note_metadata).

Value of each leaf is computed as: hash(note_id || note_metadata). All leaves omitted from the entries list are set to crate::EMPTY_WORD.

Errors

Returns an error if:

• The number of entries exceeds the maximum notes tree capacity, that is 2^16.
• The provided entries contain multiple values for the same key.

pub fn empty() -> Self

Returns a new, empty BlockNoteTree.

pub fn insert_batch_note_subtree( &mut self, batch_idx: u64, batch_note_tree: BatchNoteTree, ) -> Result<(), MerkleError>

Inserts the given BatchNoteTree as a subtree into the block note tree at the specified index.

Errors

Returns an error if:

• the given batch index is greater or equal to MAX_BATCHES_PER_BLOCK

pub fn root(&self) -> RpoDigest

Returns the root of the tree

pub fn get_note_path(&self, index: BlockNoteIndex) -> MerklePath

Returns merkle path for the note with specified batch/note indexes.

pub fn num_notes(&self) -> usize

Returns the number of notes in this block note tree.

pub fn is_empty(&self) -> bool

Returns a boolean value indicating whether the block note tree is empty.

Trait Implementations

impl Clone for BlockNoteTree

fn clone(&self) -> BlockNoteTree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockNoteTree

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

Formats the value using the given formatter.

impl Default for BlockNoteTree

fn default() -> Self

Returns the “default value” for a type.

impl Deserializable for BlockNoteTree

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 BlockNoteTree

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

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 BlockNoteTree

impl StructuralPartialEq for BlockNoteTree