Modules§
Structs§
- Advice
Inputs - Inputs container to initialize advice provider for the execution of Miden VM programs.
- AsmOp
Info - Contains assembly instruction and operation index in the sequence corresponding to the specified AsmOp decorator. This index starts from 1 instead of 0.
- Assembly
Op - Contains information corresponding to an assembly instruction (only applicable in debug mode).
- Chiplets
Lengths - Contains trace lengths of all chilplets: hash, bitwise, memory and kernel ROM trace lengths.
- Chiplets
Trace - ColMatrix
- A two-dimensional matrix of field elements arranged in column-major order.
- Context
Id - Represents the ID of an execution context
- Decoder
Trace - Default
Host - A default Host implementation that provides the essential functionality required by the VM.
- Default
Source Manager - Digest
- Error
Context - Context information to be used when reporting errors.
- Execution
Options - A set of parameters specifying execution parameters of the VM.
- Execution
Trace - Execution trace which is generated when a program is executed on the VM.
- Fast
Process State - Felt
- Represents base field element in the field using Montgomery representation.
- Kernel
- A list of procedure hashes defining a VM kernel.
- Mast
Forest - Represents one or more procedures, represented as a collection of
MastNodes. - Mast
Node Id - An opaque handle to a
MastNodein someMastForest. It is the responsibility of the user to use a givenMastNodeIdwith the correspondingMastForest. - MemAdvice
Provider - An in-memory
[AdviceProvider]implementation which uses BTreeMaps as its backing storage. - MemMast
Forest Store - A simple
MastForestStorewhere all knownMastForests are held in memory. - Memory
Address - Process
- A Process is the underlying execution engine for a Miden Program.
- Program
- An executable program for Miden VM.
- Program
Info - A program information set consisting of its MAST root and set of kernel procedure roots used for its compilation.
- Quad
Extension - Represents an element in a quadratic extension of a StarkField.
- Range
Check Trace - RecAdvice
Provider - An in-memory
[AdviceProvider]implementation with support for data access recording. - RowIndex
- A newtype wrapper around a usize value representing a step in the execution trace.
- Slow
Process State - Source
Span - This represents a span of bytes in a Miden Assembly source file.
- Stack
Inputs - Defines the initial state of the VM’s operand stack.
- Stack
Outputs - Output container for Miden VM programs.
- Stack
Trace - Trace
LenSummary - Contains the data about lengths of the trace parts.
- VmState
- VmState holds a current process state information at a specific clock cycle.
- VmState
Iterator - Iterator that iterates through vm state at each step of the execution.
Enums§
- Advice
Source - Specifies the source of the value(s) to be pushed onto the advice stack.
- Deserialization
Error - Defines errors which can occur during deserialization.
- Execution
Error - Execution
Options Error - Ext2
Intt Error - Input
Error - Mast
Node - Memory
Error - Operation
- A set of native VM operations which take exactly one cycle to execute.
- Process
State - System
Event - Defines a set of actions which can be initiated from the VM to inject new data into the advice provider.
Constants§
- EMPTY_
WORD - Array of field elements representing word of ZEROs in the Miden base field.
- FMP_MIN
- Memory addresses for procedure locals start at 2^30.
- NUM_
RAND_ ROWS - Number of rows at the end of an execution trace which are injected with random values.
- ONE
- Field element representing ONE in the Miden base filed.
- SMT_
DEPTH - SYSCALL_
FMP_ MIN - Memory address for procedure locals within a SYSCALL starts at 2^31.
- ZERO
- Field element representing ZERO in the Miden base filed.
Traits§
- Advice
Provider - Defines behavior of an advice provider.
- Host
- Defines an interface by which the VM can interact with the host.
- KvMap
- A trait that defines the interface for a key-value map.
- Mast
Forest Store - A set of
MastForests available to the prover that programs may refer to (by means of anvm_core::mast::ExternalNode). - Source
Manager
Functions§
- execute
- Returns an execution trace resulting from executing the provided program against the provided inputs.
- execute_
iter - Returns an iterator which allows callers to step through the execution and inspect VM state at each execution step.
Type Aliases§
- Word
- A group of four field elements in the Miden base field.