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.

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>) -> 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, [ZERO; 4] 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 set_item(&mut self, index: u8, value: Word) -> Result<Word, AccountError>

Sets an item from the storage at the specified index.

Errors

Returns an error if:

• The index specifies a reserved storage slot.
• The update violates storage layout constraints.

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