Struct AccountStorageHeader 

pub struct AccountStorageHeader { /* private fields */ }

The header of an AccountStorage, storing only the slot name, slot type and value of each storage slot.

The stored value differs based on the slot type:

• StorageSlotType::Value: The value of the slot itself.
• StorageSlotType::Map: The root of the SMT that represents the storage map.

Implementations

impl AccountStorageHeader

pub fn new(slots: Vec<StorageSlotHeader>) -> Result<Self, AccountError>

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

Errors

Returns an error if:

• The number of provided slots is greater than AccountStorage::MAX_NUM_STORAGE_SLOTS.
• The slots are not sorted by StorageSlotId.
• There are multiple storage slots with the same StorageSlotName.

pub fn slots(&self) -> impl Iterator<Item = &StorageSlotHeader>

Returns an iterator over the storage header slots.

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

Returns an iterator over the storage header map slots.

pub fn num_slots(&self) -> u8

Returns the number of slots contained in the storage header.

pub fn find_slot_header_by_name( &self, slot_name: &StorageSlotName, ) -> Option<&StorageSlotHeader>

Returns the storage slot header for the slot with the given name.

Returns None if a slot with the provided name does not exist.

pub fn find_slot_header_by_id( &self, slot_id: StorageSlotId, ) -> Option<&StorageSlotHeader>

Returns the storage slot header for the slot with the given ID.

Returns None if a slot with the provided slot ID does not exist.

pub fn is_map_slot(&self, name: &StorageSlotName) -> Result<bool, AccountError>

Indicates whether the slot with the given name is a map slot.

Errors

Returns an error if:

• a slot with the provided name does not exist.

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

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

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

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

And then concatenating the resulting elements into a single vector.

pub fn try_from_elements( elements: &[Felt], slot_names: &BTreeMap<StorageSlotId, StorageSlotName>, ) -> Result<Self, AccountError>

Reconstructs an AccountStorageHeader from field elements with provided slot names.

The elements are expected to be groups of 8 elements per slot: [[0, slot_type, slot_id_suffix, slot_id_prefix], SLOT_VALUE]

pub fn to_commitment(&self) -> Word

Returns the commitment to the AccountStorage this header represents.

Trait Implementations

impl Clone for AccountStorageHeader

fn clone(&self) -> AccountStorageHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccountStorageHeader

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

Formats the value using the given formatter.

impl Deserializable for AccountStorageHeader

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 AccountStorageHeader

fn from(value: &AccountStorage) -> Self

Converts to this type from the input type.

impl PartialEq for AccountStorageHeader

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

type Commitment = Word

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

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

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 AccountStorageHeader

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 AccountStorageHeader

impl StructuralPartialEq for AccountStorageHeader