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. We commit to the entire account interface by building a simple Merkle tree out of all procedure MAST roots.

Implementations

impl AccountCode

pub const PROCEDURE_TREE_DEPTH: u8 = 8u8

The depth of the Merkle tree that is used to commit to the account’s public interface.

pub const MAX_NUM_PROCEDURES: usize = 256usize

The maximum number of account interface procedures.

pub fn new( module: ModuleAst, assembler: &Assembler ) -> Result<Self, AccountError>

Returns a new definition of an account’s interface compiled from the specified source code.

Errors

Returns an error if:

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

pub fn from_parts(module: ModuleAst, procedures: Vec<Digest>) -> Self

Returns a new definition of an account’s interface instantiated from the provided module and list of procedure digests.

Note: this function assumes that the list of provided procedure digests results from the compilation of the provided module, but this is not checked.

Panics

Panics if the number of procedures is smaller than 1 or greater than 256.

pub fn root(&self) -> Digest

Returns a commitment to an account’s public interface.

pub fn module(&self) -> &ModuleAst

Returns a reference to the ModuleAst backing the AccountCode.

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

Returns a reference to the account procedure digests.

pub fn procedure_tree(&self) -> &SimpleSmt<PROCEDURE_TREE_DEPTH>

Returns a reference to the procedure tree.

pub fn num_procedures(&self) -> usize

Returns the number of public interface procedures defined for this account.

pub fn has_procedure(&self, root: Digest) -> bool

Returns true if a procedure with the specified root is defined for this account.

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

Returns a procedure digest for the procedure with 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 root or None if such procedure is not defined for this account.

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

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