Struct AccountCode 

pub struct AccountCode { /* private fields */ }

A public interface of an account.

Account’s public interface consists of a set of account procedures, each procedure being a Miden VM program. Thus, MAST root of each procedure commits to the underlying program.

Each exported procedure is associated with a storage offset and a storage size.

We commit to the entire account interface by building a sequential hash of all procedure MAST roots and associated storage_offset’s. Specifically, each procedure contributes exactly 8 field elements to the sequence of elements to be hashed. These elements are defined as follows:

[PROCEDURE_MAST_ROOT, storage_offset, 0, 0, storage_size]

Implementations

impl AccountCode

pub const MAX_NUM_PROCEDURES: usize = 256usize

The maximum number of account interface procedures.

pub const MIN_NUM_PROCEDURES: usize = 2usize

The minimum number of account interface procedures (one auth and at least one non-auth).

pub fn from_bytes(bytes: &[u8]) -> Result<Self, AccountError>

Returns a new AccountCode deserialized from the provided bytes.

Errors

Returns an error if account code deserialization fails.

pub fn from_parts( mast: Arc<MastForest>, procedures: Vec<AccountProcedureInfo>, ) -> Self

Returns a new definition of an account’s interface instantiated from the provided MastForest and a list of AccountProcedureInfos.

Panics

Panics if:

• The number of procedures is smaller than 1 or greater than 256.
• If some any of the provided procedures does not have a corresponding root in the provided MAST forest.

pub fn commitment(&self) -> Word

Returns a commitment to an account’s public interface.

pub fn mast(&self) -> Arc<MastForest>

Returns a reference to the MastForest backing this account code.

pub fn procedures(&self) -> &[AccountProcedureInfo]

Returns a reference to the account procedures.

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

Returns an iterator over the procedure MAST roots of this account code.

pub fn num_procedures(&self) -> usize

Returns the number of public interface procedures defined in this account code.

pub fn has_procedure(&self, mast_root: Word) -> bool

Returns true if a procedure with the specified MAST root is defined in this account code.

pub fn get_procedure_by_index(&self, index: usize) -> &AccountProcedureInfo

Returns information about the procedure at the specified index.

Panics

Panics if the provided index is out of bounds.

pub fn get_procedure_index_by_root(&self, root: Word) -> Option<usize>

Returns the procedure index for the procedure with the specified MAST root or None if such procedure is not defined in this AccountCode.

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

Converts procedure information in this AccountCode into a vector of field elements.

This is done by first converting each procedure into 8 field elements as follows:

[PROCEDURE_MAST_ROOT, storage_offset, storage_size, 0, 0]

And then concatenating the resulting elements into a single vector.

pub fn printable_procedures(&self) -> impl Iterator<Item = PrintableProcedure>

Returns an iterator of printable representations for all procedures in this account code.

Returns

An iterator yielding PrintableProcedure instances for all procedures in this account code.

Trait Implementations

impl Clone for AccountCode

fn clone(&self) -> AccountCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccountCode

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

Formats the value using the given formatter.

impl Deserializable for AccountCode

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 Ord for AccountCode

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,

Restrict a value to a certain interval.

impl PartialEq for AccountCode

fn eq(&self, other: &Self) -> 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 PartialOrd for AccountCode

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl PrettyPrint for AccountCode

fn render(&self) -> Document

The core of the PrettyPrint functionality.

fn to_pretty_string(&self) -> String

Produce a String containing the results of pretty-printing this object.

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

Pretty-print this object to the given core::fmt::Formatter.

impl Serializable for AccountCode

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

Serializes self into bytes and writes these bytes into the target.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

impl Eq for AccountCode