Struct miden_objects::accounts::StorageMap

pub struct StorageMap { /* private fields */ }

Account storage map is a Sparse Merkle Tree of depth 64. It can be used to store more data as there is in plain usage of the storage slots. The root of the SMT consumes one account storage slot.

Implementations

impl StorageMap

pub const STORAGE_MAP_TREE_DEPTH: u8 = 64u8

Depth of the storage tree.

pub const EMPTY_VALUE: Word = Smt::EMPTY_VALUE

The default value of empty leaves.

pub fn new() -> Self

Returns a new StorageMap.

All leaves in the returned tree are set to Self::EMPTY_VALUE.

pub fn with_entries( entries: impl IntoIterator<Item = (RpoDigest, Word)>, ) -> Result<Self, AccountError>

pub const fn depth(&self) -> u8

pub fn root(&self) -> RpoDigest

pub fn get_leaf(&self, key: &RpoDigest) -> SmtLeaf

pub fn get_value(&self, key: &RpoDigest) -> Word

pub fn open(&self, key: &RpoDigest) -> SmtProof

pub fn leaves(&self) -> impl Iterator<Item = (LeafIndex<SMT_DEPTH>, &SmtLeaf)>

pub fn entries(&self) -> impl Iterator<Item = &(RpoDigest, Word)>

pub fn inner_nodes(&self) -> impl Iterator<Item = InnerNodeInfo> + '_

pub fn insert(&mut self, key: RpoDigest, value: Word) -> Word

pub fn apply_delta( &mut self, delta: &StorageMapDelta, ) -> Result<Digest, AccountError>

Applies the provided delta to this account storage.

This method assumes that the delta has been validated by the calling method and so, no additional validation of delta is performed.

Trait Implementations

impl Clone for StorageMap

fn clone(&self) -> StorageMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StorageMap

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

Formats the value using the given formatter.

impl Default for StorageMap

fn default() -> Self

Returns the “default value” for a type.

impl Deserializable for StorageMap

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 StorageMap

fn eq(&self, other: &StorageMap) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serializable for StorageMap

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 StorageMap

impl StructuralPartialEq for StorageMap