Struct AccountBuilder

pub struct AccountBuilder { /* private fields */ }

A convenient builder for an Account allowing for safe construction of an account by combining multiple AccountComponents.

This will build a valid new account with these properties:

• An empty AssetVault.
• The nonce set to Felt::ZERO.
• A seed which results in an AccountId valid for the configured account type and storage mode.

By default, the builder is initialized with:

• The account_type set to AccountType::RegularAccountUpdatableCode.
• The storage_mode set to AccountStorageMode::Private.
• The version set to AccountIdVersion::Version0.

The methods that are required to be called are:

• AccountBuilder::with_component, which must be called at least once.
• AccountBuilder::anchor.

The latter methods set the anchor block commitment and epoch which will be used for the generation of the account’s ID. See AccountId for details on its generation and anchor blocks.

Under the testing feature, it is possible to:

• Change the nonce to build an existing account.
• Add assets to the account’s vault, however this will only succeed when using [AccountBuilder::build_existing].

Implementations

impl AccountBuilder

pub fn new(init_seed: [u8; 32]) -> Self

Creates a new builder for an account and sets the initial seed from which the grinding process for that account’s AccountId will start.

This initial seed should come from a cryptographic random number generator.

pub fn anchor(self, anchor: AccountIdAnchor) -> Self

Sets the AccountIdAnchor used for the generation of the account ID.

pub fn version(self, version: AccountIdVersion) -> Self

Sets the AccountIdVersion of the account ID.

pub fn account_type(self, account_type: AccountType) -> Self

Sets the type of the account.

pub fn storage_mode(self, storage_mode: AccountStorageMode) -> Self

Sets the storage mode of the account.

pub fn with_component( self, account_component: impl Into<AccountComponent>, ) -> Self

Adds an AccountComponent to the builder. This method can be called multiple times and must be called at least once since an account must export at least one procedure.

All components will be merged to form the final code and storage of the built account.

pub fn build(self) -> Result<(Account, Word), AccountError>

Builds an Account out of the configured builder.

Errors

Returns an error if:

• The init seed is not set.
• Any of the components does not support the set account type.
• The number of procedures in all merged components is 0 or exceeds AccountCode::MAX_NUM_PROCEDURES.
• Two or more libraries export a procedure with the same MAST root.
• The number of StorageSlots of all components exceeds 255.
• MastForest::merge fails on the given components.
• If duplicate assets were added to the builder (only under the testing feature).
• If the vault is not empty on new accounts (only under the testing feature).

Trait Implementations

impl Clone for AccountBuilder

fn clone(&self) -> AccountBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccountBuilder

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

Formats the value using the given formatter.