Struct AccountCode 

pub struct AccountCode { /* private fields */ }

The public interface of an account.

An account’s public interface consists of a set of account procedures, each of which is identified and committed to by a MAST root. They are represented by AccountProcedureRoot.

The set of procedures has an arbitrary order, i.e. they are not sorted. The only exception is the authentication procedure of the account, which is always at index 0. This procedure is automatically called at the end of a transaction to validate an account’s state transition.

The code commits to the entire account interface by building a sequential hash of all procedure MAST roots. Specifically, each procedure contributes exactly 4 field elements to the sequence of elements to be hashed. Each procedure is represented by its MAST root:

[PROCEDURE_MAST_ROOT]

Implementations

impl AccountCode

pub const MIN_NUM_PROCEDURES: usize = 2

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

pub const MAX_NUM_PROCEDURES: usize = 256

The maximum number of account interface procedures.

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<AccountProcedureRoot>, ) -> Self

Returns a new AccountCode instantiated from the provided MastForest and a list of AccountProcedureRoots.

Panics

Panics if:

• The number of procedures is smaller than 2 or greater than 256.

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) -> &[AccountProcedureRoot]

Returns a reference to the account procedure roots.

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(&self, index: usize) -> Option<&AccountProcedureRoot>

Returns the procedure root at the specified index.

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

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

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

[PROCEDURE_MAST_ROOT]

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