Struct AccountTree

pub struct AccountTree { /* private fields */ }

The sparse merkle tree of all accounts in the blockchain.

The key is the AccountId while the value is the current state commitment of the account, i.e. Account::commitment. If the account is new, then the commitment is the EMPTY_WORD.

Each account ID occupies exactly one leaf in the tree, which is identified by its AccountId::prefix. In other words, account ID prefixes are unique in the blockchain.

Implementations

impl AccountTree

pub const DEPTH: u8 = 64u8

The depth of the account tree.

pub fn new() -> Self

Creates a new, empty account tree.

pub fn with_entries<I>( entries: impl IntoIterator<Item = (AccountId, Digest), IntoIter = I>, ) -> Result<Self, AccountTreeError>

where I: ExactSizeIterator<Item = (AccountId, Digest)>,

Returns a new Smt instantiated with the provided entries.

If the concurrent feature of miden-crypto is enabled, this function uses a parallel implementation to process the entries efficiently, otherwise it defaults to the sequential implementation.

Errors

Returns an error if:

• the provided entries contain multiple commitments for the same account ID.
• multiple account IDs share the same prefix.

pub fn open(&self, account_id: AccountId) -> AccountWitness

Returns an opening of the leaf associated with the account_id. This is a proof of the current state commitment of the given account ID.

Conceptually, an opening is a Merkle path to the leaf, as well as the leaf itself.

pub fn get(&self, account_id: AccountId) -> Digest

Returns the current state commitment of the given account ID.

pub fn root(&self) -> Digest

Returns the root of the tree.

pub fn num_accounts(&self) -> usize

Returns the number of account IDs in this tree.

pub fn account_commitments(&self) -> impl Iterator<Item = (AccountId, Digest)>

Returns an iterator over the account ID state commitment pairs in the tree.

pub fn compute_mutations( &self, account_commitments: impl IntoIterator<Item = (AccountId, Digest)>, ) -> Result<AccountMutationSet, AccountTreeError>

Computes the necessary changes to insert the specified (account ID, state commitment) pairs into this tree, allowing for validation before applying those changes.

Self::apply_mutations can be used in order to commit these changes to the tree.

If the concurrent feature of miden-crypto is enabled, this function uses a parallel implementation to compute the mutations, otherwise it defaults to the sequential implementation.

This is a thin wrapper around Smt::compute_mutations. See its documentation for more details.

Errors

Returns an error if:

• an insertion of an account ID would violate the uniqueness of account ID prefixes in the tree.

pub fn insert( &mut self, account_id: AccountId, state_commitment: Digest, ) -> Result<Digest, AccountTreeError>

Inserts the state commitment for the given account ID, returning the previous state commitment associated with that ID.

This also recomputes all hashes between the leaf (associated with the key) and the root, updating the root itself.

Errors

Returns an error if:

• the prefix of the account ID already exists in the tree.

pub fn apply_mutations( &mut self, mutations: AccountMutationSet, ) -> Result<(), AccountTreeError>

Applies the prospective mutations computed with Self::compute_mutations to this tree.

Errors

Returns an error if:

• mutations was computed on a tree with a different root than this one.

Trait Implementations

impl Clone for AccountTree

fn clone(&self) -> AccountTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccountTree

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

Formats the value using the given formatter.

impl Default for AccountTree

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for AccountTree

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

impl StructuralPartialEq for AccountTree