Struct miden_objects::accounts::code::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. This offset is applied to any accesses made from within the procedure to the associated account’s storage. For example, if storage offset for a procedure is set ot 1, a call to the account::get_item(storage_slot=4) made from this procedure would actually access storage slot with index 5.

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, 0]

Implementations

impl AccountCode

pub const MAX_NUM_PROCEDURES: usize = 256usize

The maximum number of account interface procedures.

pub fn new(library: Library) -> Result<Self, AccountError>

Returns a new AccountCode instantiated from the provided Library.

All procedures exported from the provided library will become members of the account’s public interface.

Errors

Returns an error if the number of procedures exported from the provided library is smaller than 1 or greater than 256.

pub fn compile( source_code: impl Compile, assembler: Assembler, ) -> Result<Self, AccountError>

Returns a new AccountCode compiled from the provided source code using the specified assembler.

All procedures exported from the provided code will become members of the account’s public interface.

Errors

Returns an error if:

• Compilation of the provided source code fails.
• The number of procedures exported from the provided library is smaller than 1 or greater than 256.

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) -> Digest

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 = Digest> + '_

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: Digest) -> 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: Digest) -> 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 exactly 8 elements as follows:

[PROCEDURE_MAST_ROOT, storage_offset, 0, 0, 0]

And then concatenating the resulting elements into a single vector.

Trait Implementations

impl Clone for AccountCode

fn clone(&self) -> AccountCode

Returns a copy 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 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 Serializable for AccountCode

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 AccountCode