Struct PartialAccountTree 

pub struct PartialAccountTree { /* private fields */ }

The partial sparse merkle tree containing the state commitments of accounts in the chain.

This is the partial version of AccountTree.

Implementations

impl PartialAccountTree

pub fn new(root: Word) -> Self

Creates a new partial account tree with the provided root that does not track any account IDs.

pub fn with_witnesses( witnesses: impl IntoIterator<Item = AccountWitness>, ) -> Result<Self, AccountTreeError>

Returns a new PartialAccountTree instantiated with the provided entries.

Errors

Returns an error if:

• the merkle paths of the witnesses do not result in the same tree root.
• there are multiple witnesses for the same ID prefix.

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

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.

Errors

Returns an error if:

• the account ID is not tracked by this account tree.

pub fn get(&self, account_id: AccountId) -> Result<Word, AccountTreeError>

Returns the current state commitment of the given account ID.

Errors

Returns an error if:

• the account ID is not tracked by this account tree.

pub fn root(&self) -> Word

Returns the root of the tree.

pub fn track_account( &mut self, witness: AccountWitness, ) -> Result<(), AccountTreeError>

Adds the given account witness to the partial tree and tracks it. Once an account has been added to the tree, it can be updated using Self::upsert_state_commitments.

Errors

Returns an error if:

• after the witness’ merkle path was added, the partial account tree has a different root than before it was added (except when the first witness is added).
• there exists a leaf in the tree whose account ID prefix matches the one in the provided witness.

pub fn upsert_state_commitments( &mut self, updates: impl IntoIterator<Item = (AccountId, Word)>, ) -> Result<(), AccountTreeError>

Inserts or updates the provided account ID -> state commitment updates into the partial tree which results in a new tree root.

Errors

Returns an error if:

• the prefix of the account ID already exists in the tree.
• the account_id is not tracked by this partial account tree.

Trait Implementations

impl Clone for PartialAccountTree

fn clone(&self) -> PartialAccountTree

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PartialAccountTree

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

Formats the value using the given formatter.

impl Default for PartialAccountTree

fn default() -> PartialAccountTree

Returns the “default value” for a type.

impl PartialEq for PartialAccountTree

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

impl StructuralPartialEq for PartialAccountTree