Struct AccountHeader 

pub struct AccountHeader { /* private fields */ }

A header of an account which contains information that succinctly describes the state of the components of the account.

The AccountHeader is composed of:

• id: the account ID (AccountId) of the account.
• nonce: the nonce of the account.
• vault_root: a commitment to the account’s vault (super::AssetVault).
• storage_commitment: a commitment to the account’s storage (super::AccountStorage).
• code_commitment: a commitment to the account’s code (super::AccountCode).

Implementations

impl AccountHeader

pub fn new( id: AccountId, nonce: Felt, vault_root: Word, storage_commitment: Word, code_commitment: Word, ) -> Self

Creates a new AccountHeader.

pub fn to_commitment(&self) -> Word

Returns the commitment of this account.

The commitment of an account is computed as a hash over the account header elements returned by Self::to_elements. Computing the account commitment requires 2 permutations of the hash function.

pub fn id(&self) -> AccountId

Returns the id of this account.

pub fn nonce(&self) -> Felt

Returns the nonce of this account.

pub fn vault_root(&self) -> Word

Returns the vault root of this account.

pub fn storage_commitment(&self) -> Word

Returns the storage commitment of this account.

pub fn code_commitment(&self) -> Word

Returns the code commitment of this account.

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

Returns the account header encoded to a vector of field elements.

This is a vector of the following field elements:

[
    [account_nonce, 0, account_id_suffix, account_id_prefix],
    VAULT_ROOT,
    STORAGE_COMMITMENT,
    CODE_COMMITMENT,
]

Trait Implementations

impl Clone for AccountHeader

fn clone(&self) -> AccountHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccountHeader

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

Formats the value using the given formatter.

impl Deserializable for AccountHeader

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<&Account> for AccountHeader

fn from(account: &Account) -> Self

Converts to this type from the input type.

impl From<&PartialAccount> for AccountHeader

fn from(account: &PartialAccount) -> Self

Converts to this type from the input type.

impl From<Account> for AccountHeader

fn from(account: Account) -> Self

Converts to this type from the input type.

impl From<PartialAccount> for AccountHeader

fn from(account: PartialAccount) -> Self

Converts to this type from the input type.

impl PartialEq for AccountHeader

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

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 AccountHeader

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 AccountHeader

impl StructuralPartialEq for AccountHeader