Struct miden_objects::accounts::AccountId

pub struct AccountId(/* private fields */);

Unique identifier of an account.

Account ID consists of 1 field element (~64 bits). The most significant bits in the id are used to encode the account’ storage and type.

The top two bits are used to encode the storage type. The values [OFF_CHAIN] and [ON_CHAIN] encode the account’s storage type. The next two bits encode the account type. The values [FUNGIBLE_FAUCET], [NON_FUNGIBLE_FAUCET], [REGULAR_ACCOUNT_IMMUTABLE_CODE], and [REGULAR_ACCOUNT_UPDATABLE_CODE] encode the account’s type.

Implementations

impl AccountId

pub const REGULAR_ACCOUNT_SEED_DIGEST_MIN_TRAILING_ZEROS: u32 = 23u32

Specifies a minimum number of trailing zeros required in the last element of the seed digest.

Note: The account id includes 4 bits of metadata, these bits determine the account type (normal account, fungible token, non-fungible token), the storage type (on/off chain), and for the normal accounts if the code is updatable or not. These metadata bits are also checked by the PoW and add to the total work defined below.

pub const FAUCET_SEED_DIGEST_MIN_TRAILING_ZEROS: u32 = 31u32

pub const MIN_ACCOUNT_ONES: u32 = 5u32

Specifies a minimum number of ones for a valid account ID.

pub fn new( seed: Word, code_root: Digest, storage_root: Digest ) -> Result<Self, AccountError>

Returns a new account ID derived from the specified seed, code root and storage root.

The account ID is computed by hashing the seed, code root and storage root and using 1 element of the resulting digest to form the ID. Specifically we take element 0. We also require that the last element of the seed digest has at least 23 trailing zeros if it is a regular account, or 31 trailing zeros if it is a faucet account.

The seed digest is computed using a sequential hash over hash(SEED, CODE_ROOT, STORAGE_ROOT, ZERO). This takes two permutations.

Errors

Returns an error if the resulting account ID does not comply with account ID rules:

• the metadata embedded in the ID (i.e., the first 4 bits) is valid.
• the ID has at least 5 ones.
• the last element of the seed digest has at least 23 trailing zeros for regular accounts.
• the last element of the seed digest has at least 31 trailing zeros for faucet accounts.

pub fn new_unchecked(value: Felt) -> Self

Creates a new AccountId without checking its validity.

This function requires that the provided value is a valid Felt representation of an AccountId.

pub fn account_type(&self) -> AccountType

Returns the type of this account ID.

pub fn is_faucet(&self) -> bool

Returns true if an account with this ID is a faucet (can issue assets).

pub fn is_regular_account(&self) -> bool

Returns true if an account with this ID is a regular account.

pub fn storage_type(&self) -> AccountStorageType

Returns the storage type of this account (e.g., on-chain or off-chain).

pub fn is_on_chain(&self) -> bool

Returns true if an account with this ID is an on-chain account.

pub fn get_account_seed( init_seed: [u8; 32], account_type: AccountType, storage_type: AccountStorageType, code_root: Digest, storage_root: Digest ) -> Result<Word, AccountError>

Finds and returns a seed suitable for creating an account ID for the specified account type using the provided initial seed as a starting point.

pub fn from_hex(hex_value: &str) -> Result<AccountId, AccountError>

Creates an Account Id from a hex string. Assumes the string starts with “0x” and that the hexadecimal characters are big-endian encoded.

pub fn to_hex(&self) -> String

Returns a big-endian, hex-encoded string.

Trait Implementations

impl Clone for AccountId

fn clone(&self) -> AccountId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccountId

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

Formats the value using the given formatter.

impl Deserializable for AccountId

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 Display for AccountId

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

Formats the value using the given formatter.

impl From<AccountId> for [u8; 8]

fn from(id: AccountId) -> Self

Converts to this type from the input type.

impl From<AccountId> for Felt

fn from(id: AccountId) -> Self

Converts to this type from the input type.

impl From<AccountId> for LeafIndex<ACCOUNT_TREE_DEPTH>

Account IDs are used as indexes in the account database, which is a tree of depth 64.

fn from(id: AccountId) -> Self

Converts to this type from the input type.

impl From<AccountId> for u64

fn from(id: AccountId) -> Self

Converts to this type from the input type.

impl Ord for AccountId

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for AccountId

fn eq(&self, other: &AccountId) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for AccountId

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serializable for AccountId

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 TryFrom<[u8; 8]> for AccountId

type Error = AccountError

The type returned in the event of a conversion error.

fn try_from(value: [u8; 8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<BaseElement> for AccountId

fn try_from(value: Felt) -> Result<Self, Self::Error>

Returns an AccountId instantiated with the provided field element.

Errors

Returns an error if:

• If there are fewer than AccountId::MIN_ACCOUNT_ONES in the provided value.
• If the provided value contains invalid account ID metadata (i.e., the first 4 bits).

type Error = AccountError

The type returned in the event of a conversion error.

impl TryFrom<u64> for AccountId

type Error = AccountError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for AccountId

impl Eq for AccountId

impl StructuralPartialEq for AccountId