Struct AccountStorage 

pub struct AccountStorage { /* private fields */ }

Account storage is composed of a variable number of name-addressable StorageSlots up to 255 slots in total.

Each slot consists of a StorageSlotName and StorageSlotContent which defines its size and structure. Currently, the following content types are supported:

• StorageSlotContent::Value: contains a single Word of data (i.e., 32 bytes).
• StorageSlotContent::Map: contains a StorageMap which is a key-value map where both keys and values are Words. The value of a storage slot containing a map is the commitment to the underlying map.

Slots are sorted by StorageSlotName (or StorageSlotId equivalently). This order is necessary to:

• Simplify lookups of slots in the transaction kernel (using std::collections::sorted_array from the miden core library)
• Allow the AccountStorageDelta to work only with slot names instead of slot indices.
• Make it simple to check for duplicates by iterating the slots and checking that no two adjacent items have the same slot name.

Implementations

impl AccountStorage

pub const MAX_NUM_STORAGE_SLOTS: usize = 255

The maximum number of storage slots allowed in an account storage.

pub fn new(slots: Vec<StorageSlot>) -> Result<AccountStorage, AccountError>

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

This function sorts the slots by StorageSlotName.

Errors

Returns an error if:

• The number of StorageSlots exceeds 255.
• There are multiple storage slots with the same StorageSlotName.

pub fn faucet_sysdata_slot() -> &'static StorageSlotName

Returns the StorageSlotName of the faucet’s protocol system data.

pub fn to_elements(&self) -> Vec<BaseElement>

Converts storage slots of this account storage into a vector of field elements.

Each storage slot is represented by exactly 8 elements:

[[0, slot_type, slot_id_suffix, slot_id_prefix], SLOT_VALUE]

pub fn to_commitment(&self) -> Word

Returns the commitment to the AccountStorage.

pub fn num_slots(&self) -> u8

Returns the number of slots in the account’s storage.

pub fn slots(&self) -> &[StorageSlot]

Returns a reference to the storage slots.

pub fn into_slots(self) -> Vec<StorageSlot>

Consumes self and returns the storage slots of the account storage.

pub fn to_header(&self) -> AccountStorageHeader

Returns an AccountStorageHeader for this account storage.

pub fn get(&self, slot_name: &StorageSlotName) -> Option<&StorageSlot>

Returns a reference to the storage slot with the provided name, if it exists, None otherwise.

pub fn get_item( &self, slot_name: &StorageSlotName, ) -> Result<Word, AccountError>

Returns an item from the storage slot with the given name.

Errors

Returns an error if:

• A slot with the provided name does not exist.

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

Returns a map item from the map in the storage slot with the given name.

Errors

Returns an error if:

• A slot with the provided name does not exist.
• If the StorageSlot is not StorageSlotType::Map.

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

Updates the value of the storage slot with the given name.

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

Errors

Returns an error if:

• A slot with the provided name does not exist.
• The StorageSlot is not StorageSlotType::Value.

pub fn set_map_item( &mut self, slot_name: &StorageSlotName, raw_key: Word, value: Word, ) -> Result<(Word, Word), AccountError>

Updates the value of a key-value pair of a storage map with the given name.

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:

• A slot with the provided name does not exist.
• If the StorageSlot is not StorageSlotType::Map.

Trait Implementations

impl Clone for AccountStorage

fn clone(&self) -> AccountStorage

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Default for AccountStorage

fn default() -> AccountStorage

Returns the “default value” for a type.

impl Deserializable for AccountStorage

fn read_from<R>(source: &mut R) -> Result<AccountStorage, DeserializationError>

where R: ByteReader,

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 IntoIterator for AccountStorage

type Item = StorageSlot

The type of the elements being iterated over.

type IntoIter = IntoIter<StorageSlot>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <AccountStorage as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq for AccountStorage

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

type Commitment = Word

A type of the commitment which must be derivable from Word.

fn to_elements(&self) -> Vec<BaseElement>

Returns a representation of the object as a sequence of fields elements.

fn to_commitment(&self) -> Self::Commitment

Computes the commitment to the object.

impl Serializable for AccountStorage

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

impl Eq for AccountStorage

impl StructuralPartialEq for AccountStorage