Struct PartialAccount 

pub struct PartialAccount { /* private fields */ }

A partial representation of an account.

A partial account is used as inputs to the transaction kernel and contains only the essential data needed for verification and transaction processing without requiring the full account state.

For new accounts, the partial storage must be the full initial account storage.

Implementations

impl PartialAccount

pub fn new( id: AccountId, nonce: BaseElement, code: AccountCode, partial_storage: PartialStorage, partial_vault: PartialVault, seed: Option<Word>, ) -> Result<PartialAccount, AccountError>

Creates a new PartialAccount with the provided account parts and seed.

Errors

Returns an error if:

• an account seed is provided but the account’s nonce indicates the account already exists.
• an account seed is not provided but the account’s nonce indicates the account is new.
• an account seed is provided but the account ID derived from it is invalid or does not match the provided ID.

pub fn id(&self) -> AccountId

Returns the account’s unique identifier.

pub fn nonce(&self) -> BaseElement

Returns the account’s current nonce value.

pub fn code(&self) -> &AccountCode

Returns a reference to the account code.

pub fn storage(&self) -> &PartialStorage

Returns a reference to the partial storage representation of the account.

pub fn vault(&self) -> &PartialVault

Returns a reference to the partial vault representation of the account.

pub fn seed(&self) -> Option<Word>

Returns the seed of the account’s ID if the account is new.

That is, if PartialAccount::is_new returns true, the seed will be Some.

pub fn is_new(&self) -> bool

Returns true if the account is new, false otherwise.

An account is considered new if the account’s nonce is zero and it hasn’t been registered on chain yet.

pub fn commitment(&self) -> Word

Returns the commitment of this account.

The commitment of an account is computed as:

hash(id, nonce, vault_root, storage_commitment, code_commitment).

pub fn initial_commitment(&self) -> Word

Returns the commitment of this account as used for the initial account state commitment in transaction proofs.

For existing accounts, this is exactly the same as Account::commitment(), however, for new accounts this value is set to Word::empty. This is because when a transaction is executed against a new account, public input for the initial account state is set to Word::empty to distinguish new accounts from existing accounts. The actual commitment of the initial account state (and the initial state itself), are provided to the VM via the advice provider.

pub fn has_public_state(&self) -> bool

Returns true if the full state of the account is public on chain, and false otherwise.

pub fn into_parts( self, ) -> (AccountId, PartialVault, PartialStorage, AccountCode, BaseElement, Option<Word>)

Consumes self and returns the underlying parts of the partial account.

Trait Implementations

impl Clone for PartialAccount

fn clone(&self) -> PartialAccount

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PartialAccount

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

Formats the value using the given formatter.

impl Deserializable for PartialAccount

fn read_from<R>(source: &mut R) -> Result<PartialAccount, 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 From<&Account> for PartialAccount

fn from(account: &Account) -> PartialAccount

Constructs a PartialAccount from the provided account.

The behavior is different whether the Account::is_new or not:

• For new accounts, the storage is tracked in full. This is because transactions that create accounts need the full state.
• For existing accounts, the storage is tracked minimally, i.e. the minimal necessary data is included.

Because new accounts always have empty vaults, in both cases, the asset vault is a minimal representation.

For precise control over how an account is converted to a partial account, use PartialAccount::new.

impl From<&PartialAccount> for AccountHeader

fn from(account: &PartialAccount) -> AccountHeader

Converts to this type from the input type.

impl From<PartialAccount> for AccountHeader

fn from(account: PartialAccount) -> AccountHeader

Converts to this type from the input type.

impl PartialEq for PartialAccount

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

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

where W: ByteWriter,

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 PartialAccount

impl StructuralPartialEq for PartialAccount