Enum SystemEvent

pub enum SystemEvent {
    MerkleNodeMerge,
    MerkleNodeToStack,
    MapValueToStack,
    MapValueToStackN,
    U64Div,
    FalconDiv,
    Ext2Inv,
    Ext2Intt,
    SmtPeek,
    U32Clz,
    U32Ctz,
    U32Clo,
    U32Cto,
    ILog2,
    MemToMap,
    HdwordToMap,
    HdwordToMapWithDomain,
    HpermToMap,
}

Defines a set of actions which can be initiated from the VM to inject new data into the advice provider.

These actions can affect all 3 components of the advice provider: Merkle store, advice stack, and advice map.

All actions, except for MerkleNodeMerge, Ext2Inv and UpdateMerkleNode can be invoked directly from Miden assembly via dedicated instructions.

Variants

MerkleNodeMerge

Creates a new Merkle tree in the advice provider by combining Merkle trees with the specified roots. The root of the new tree is defined as Hash(LEFT_ROOT, RIGHT_ROOT).

Inputs: Operand stack: [RIGHT_ROOT, LEFT_ROOT, …] Merkle store: {RIGHT_ROOT, LEFT_ROOT}

Outputs: Operand stack: [RIGHT_ROOT, LEFT_ROOT, …] Merkle store: {RIGHT_ROOT, LEFT_ROOT, hash(LEFT_ROOT, RIGHT_ROOT)}

After the operation, both the original trees and the new tree remains in the advice provider (i.e., the input trees are not removed).

MerkleNodeToStack

Pushes a node of the Merkle tree specified by the values on the top of the operand stack onto the advice stack.

Inputs: Operand stack: [depth, index, TREE_ROOT, …] Advice stack: […] Merkle store: {TREE_ROOT<-NODE}

Outputs: Operand stack: [depth, index, TREE_ROOT, …] Advice stack: [NODE, …] Merkle store: {TREE_ROOT<-NODE}

MapValueToStack

Pushes a list of field elements onto the advice stack. The list is looked up in the advice map using the specified word from the operand stack as the key.

Inputs: Operand stack: [KEY, …] Advice stack: […] Advice map: {KEY: values}

Outputs: Operand stack: [KEY, …] Advice stack: [values, …] Advice map: {KEY: values}

MapValueToStackN

Pushes a list of field elements onto the advice stack, and then the number of elements pushed. The list is looked up in the advice map using the specified word from the operand stack as the key.

Inputs: Operand stack: [KEY, …] Advice stack: […] Advice map: {KEY: values}

Outputs: Operand stack: [KEY, …] Advice stack: [num_values, values, …] Advice map: {KEY: values}

U64Div

Pushes the result of u64 division (both the quotient and the remainder) onto the advice stack.

Inputs: Operand stack: [b1, b0, a1, a0, …] Advice stack: […]

Outputs: Operand stack: [b1, b0, a1, a0, …] Advice stack: [q0, q1, r0, r1, …]

Where (a0, a1) and (b0, b1) are the 32-bit limbs of the dividend and the divisor respectively (with a0 representing the 32 lest significant bits and a1 representing the 32 most significant bits). Similarly, (q0, q1) and (r0, r1) represent the quotient and the remainder respectively.

FalconDiv

Pushes the result of divison (both the quotient and the remainder) of a u64 by the Falcon prime (M = 12289) onto the advice stack.

Inputs: Operand stack: [a1, a0, …] Advice stack: […]

Outputs: Operand stack: [a1, a0, …] Advice stack: [q0, q1, r, …]

Where (a0, a1) are the 32-bit limbs of the dividend (with a0 representing the 32 least significant bits and a1 representing the 32 most significant bits). Similarly, (q0, q1) represent the quotient and r the remainder.

Ext2Inv

Given an element in a quadratic extension field on the top of the stack (i.e., a0, b1), computes its multiplicative inverse and push the result onto the advice stack.

Inputs: Operand stack: [a1, a0, …] Advice stack: […]

Outputs: Operand stack: [a1, a0, …] Advice stack: [b0, b1…]

Where (b0, b1) is the multiplicative inverse of the extension field element (a0, a1) at the top of the stack.

Ext2Intt

Given evaluations of a polynomial over some specified domain, interpolates the evaluations into a polynomial in coefficient form and pushes the result into the advice stack.

The interpolation is performed using the iNTT algorithm. The evaluations are expected to be in the quadratic extension.

Inputs: Operand stack: [output_size, input_size, input_start_ptr, …] Advice stack: […]

Outputs: Operand stack: [output_size, input_size, input_start_ptr, …] Advice stack: [coefficients…]

• input_size is the number of evaluations (each evaluation is 2 base field elements). Must be a power of 2 and greater 1.
• output_size is the number of coefficients in the interpolated polynomial (each coefficient is 2 base field elements). Must be smaller than or equal to the number of input evaluations.
• input_start_ptr is the memory address of the first evaluation.
• coefficients are the coefficients of the interpolated polynomial such that lowest degree coefficients are located at the top of the advice stack.

SmtPeek

Pushes onto the advice stack the value associated with the specified key in a Sparse Merkle Tree defined by the specified root.

If no value was previously associated with the specified key, [ZERO; 4] is pushed onto the advice stack.

Inputs: Operand stack: [KEY, ROOT, …] Advice stack: […]

Outputs: Operand stack: [KEY, ROOT, …] Advice stack: [VALUE, …]

U32Clz

Pushes the number of the leading zeros of the top stack element onto the advice stack.

Inputs: Operand stack: [n, …] Advice stack: […]

Outputs: Operand stack: [n, …] Advice stack: [leading_zeros, …]

U32Ctz

Pushes the number of the trailing zeros of the top stack element onto the advice stack.

Inputs: Operand stack: [n, …] Advice stack: […]

Outputs: Operand stack: [n, …] Advice stack: [trailing_zeros, …]

U32Clo

Pushes the number of the leading ones of the top stack element onto the advice stack.

Inputs: Operand stack: [n, …] Advice stack: […]

Outputs: Operand stack: [n, …] Advice stack: [leading_ones, …]

U32Cto

Pushes the number of the trailing ones of the top stack element onto the advice stack.

Inputs: Operand stack: [n, …] Advice stack: […]

Outputs: Operand stack: [n, …] Advice stack: [trailing_ones, …]

ILog2

Pushes the base 2 logarithm of the top stack element, rounded down. Inputs: Operand stack: [n, …] Advice stack: […]

Outputs: Operand stack: [n, …] Advice stack: [ilog2(n), …]

MemToMap

Reads words from memory at the specified range and inserts them into the advice map under the key KEY located at the top of the stack.

Inputs: Operand stack: [KEY, start_addr, end_addr, …] Advice map: {…}

Outputs: Operand stack: [KEY, start_addr, end_addr, …] Advice map: {KEY: values}

Where values are the elements located in memory[start_addr..end_addr].

HdwordToMap

Reads two word from the operand stack and inserts them into the advice map under the key defined by the hash of these words.

Inputs: Operand stack: [B, A, …] Advice map: {…}

Outputs: Operand stack: [B, A, …] Advice map: {KEY: [a0, a1, a2, a3, b0, b1, b2, b3]}

Where KEY is computed as hash(A || B, domain=0)

HdwordToMapWithDomain

Reads two word from the operand stack and inserts them into the advice map under the key defined by the hash of these words (using d as the domain).

Inputs: Operand stack: [B, A, d, …] Advice map: {…}

Outputs: Operand stack: [B, A, d, …] Advice map: {KEY: [a0, a1, a2, a3, b0, b1, b2, b3]}

Where KEY is computed as hash(A || B, d).

HpermToMap

Reads three words from the operand stack and inserts the top two words into the advice map under the key defined by applying an RPO permutation to all three words.

Inputs: Operand stack: [B, A, C, …] Advice map: {…}

Outputs: Operand stack: [B, A, C, …] Advice map: {KEY: [a0, a1, a2, a3, b0, b1, b2, b3]}

Where KEY is computed by extracting the digest elements from hperm([C, A, B]). For example, if C is [0, d, 0, 0], KEY will be set as hash(A || B, d).

Implementations

impl SystemEvent

pub fn into_event_id(self) -> u32

pub fn from_event_id(event_id: u32) -> Option<SystemEvent>

Returns a system event corresponding to the specified event ID, or None if the event ID is not recognized.

Trait Implementations

impl Clone for SystemEvent

fn clone(&self) -> SystemEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemEvent

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

Formats the value using the given formatter.

impl Display for SystemEvent

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

Formats the value using the given formatter.

impl PartialEq for SystemEvent

fn eq(&self, other: &SystemEvent) -> 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 PrettyPrint for SystemEvent

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 Copy for SystemEvent

impl Eq for SystemEvent

impl StructuralPartialEq for SystemEvent