Struct miden_objects::accounts::AccountStorage

pub struct AccountStorage { /* private fields */ }

Account storage consists of 256 index-addressable storage slots.

Each slot has a type which defines the size and the structure of the slot. Currently, the following types are supported:

• Scalar: a sequence of up to 256 words.
• Array: a sparse array of up to 2^n values where n > 1 and n <= 64 and each value contains up to 256 words.
• Map: a key-value map where keys are words and values contain up to 256 words.

Storage slots are stored in a simple Sparse Merkle Tree of depth 8. Slot 255 is always reserved and contains information about slot types of all other slots.

Optionally, a user can make use of storage maps. Storage maps are represented by a SMT and they can hold more data as there is in plain usage of the storage slots. The root of the SMT consumes one storage slot.

Implementations

impl AccountStorage

pub const STORAGE_TREE_DEPTH: u8 = 8u8

Depth of the storage tree.

pub const NUM_STORAGE_SLOTS: usize = 256usize

Total number of storage slots.

pub const SLOT_LAYOUT_COMMITMENT_INDEX: u8 = 255u8

The storage slot at which the layout commitment is stored.

pub fn new( items: Vec<SlotItem>, maps: BTreeMap<u8, StorageMap>, ) -> Result<AccountStorage, AccountError>

Returns a new instance of account storage initialized with the provided items.

pub fn root(&self) -> Digest

Returns a commitment to this storage.

pub fn get_item(&self, index: u8) -> Digest

Returns an item from the storage at the specified index.

If the item is not present in the storage, crate::EMPTY_WORD is returned.

pub fn get_map_item(&self, index: u8, key: Word) -> Result<Word, AccountError>

Returns a map item from the storage at the specified index.

If the item is not present in the storage, crate::EMPTY_WORD is returned.

pub fn slots(&self) -> &SimpleSmt<STORAGE_TREE_DEPTH>

Returns a reference to the Sparse Merkle Tree that backs the storage slots.

pub fn layout(&self) -> &[StorageSlotType]

Returns layout info for this storage.

pub fn layout_commitment(&self) -> Digest

Returns a commitment to the storage layout.

pub fn maps(&self) -> &BTreeMap<u8, StorageMap>

Returns the storage maps for this storage.

pub fn set_item(&mut self, index: u8, value: Word) -> Result<Word, AccountError>

Updates the value of the storage slot at the specified index.

This method should be used only to update simple value slots. For updating values in storage maps, please see AccountStorage::set_map_item().

Errors

Returns an error if:

• The index specifies a reserved storage slot.
• The update tries to set a slot of type array.
• The update has a value arity different from 0.

pub fn set_map_item( &mut self, index: u8, key: Word, value: Word, ) -> Result<(Word, Word), AccountError>

Updates the value of a key-value pair of a storage map at the specified index.

This method should be used only to update storage maps. For updating values in storage slots, please see AccountStorage::set_item().

Errors

Returns an error if:

• The index specifies a reserved storage slot.
• The index is not a map slot.
• The update tries to set a slot of type value or array.
• The update has a value arity different from 0.

Trait Implementations

impl Clone for AccountStorage

fn clone(&self) -> AccountStorage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccountStorage

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

Formats the value using the given formatter.

impl Deserializable for AccountStorage

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 AccountStorage

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

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 AccountStorage

impl StructuralPartialEq for AccountStorage