Struct AccountStorage

pub struct AccountStorage { /* private fields */ }

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

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

• StorageSlot::Value: contains a single Word of data (i.e., 32 bytes).
• StorageSlot::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.

Implementations

impl AccountStorage

pub const MAX_NUM_STORAGE_SLOTS: usize = 255usize

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 items.

Errors

Returns an error if:

• The number of StorageSlots exceeds 255.

pub fn slots(&self) -> &Vec<StorageSlot>

Returns a reference to the storage slots.

pub fn commitment(&self) -> Digest

Returns a commitment to this storage.

pub fn as_elements(&self) -> Vec<Felt>

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

This is done by first converting each storage slot into exactly 8 elements as follows:

[STORAGE_SLOT_VALUE, storage_slot_type, 0, 0, 0]

And then concatenating the resulting elements into a single vector.

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

Returns an item from the storage at the specified index.

Errors:

• If the index is out of bounds

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

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

Errors:

• If the index is out of bounds
• If the StorageSlot is not StorageSlotType::Map

pub fn get_header(&self) -> AccountStorageHeader

Returns an AccountStorageHeader for this account 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 value slots. For updating values in storage maps, please see AccountStorage::set_map_item().

Errors:

• If the index is out of bounds
• If the StorageSlot is not StorageSlotType::Value

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:

• If the index is out of bounds
• If the StorageSlot is not StorageSlotType::Map

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 From<AccountStorage> for AccountStorageDelta

Converts an AccountStorage into an AccountStorageDelta for initial delta construction.

fn from(storage: AccountStorage) -> Self

Converts to this type from the input type.

impl From<AccountStorage> for AccountStorageHeader

fn from(value: AccountStorage) -> Self

Converts to this type from the input type.

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) -> Self::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 Serializable for AccountStorage

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

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