Modules§
Macros§
- err_ctx
- Constructs an error context for the given node in the MAST forest.
Structs§
- Advice
Inputs - Inputs container to initialize advice provider for the execution of Miden VM programs.
- Advice
Provider - An advice provider is a component through which the VM can request nondeterministic inputs from the host (i.e., result of a computation performed outside of the VM), as well as insert new data into the advice provider to be recovered by the host after the program has finished executing.
- 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
Debug Handler - Default implementation of
DebugHandlerthat writes debug information tostdoutwhen available. - Default
Host - A default Host implementation that provides the essential functionality required by the VM.
- Error
Context Impl - Context information to be used when reporting errors.
- Event
Handler Registry - Registry for maintaining event handlers.
- 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.
- Felt
- Represents base field element in the field using Montgomery representation.
- Host
Library - A rich library representing a
MastForestwhich also exports a list of handlers for events it may call. - 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. - MemMast
Forest Store - A simple
MastForestStorewhere all knownMastForests are held in memory. - Memory
Address - Noop
Event Handler - A handler which ignores the process state and leaves the
AdviceProviderunchanged. - Precompile
Request - Represents a single precompile request consisting of an event ID and byte data.
- 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 - RowIndex
- A newtype wrapper around a usize value representing a step in the execution trace.
- Slow
Process State - 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.
- Word
- A unit of data consisting of 4 field elements.
Enums§
- Advice
Error - Advice
Mutation - Any possible way an event can modify the advice provider.
- Deserialization
Error - Defines errors which can occur during deserialization.
- Execution
Error - Execution
Options 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.
- 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 - The depth of the sparse Merkle tree.
- WORD_
SIZE - Number of field elements in a word.
- ZERO
- Field element representing ZERO in the Miden base filed.
Traits§
- Async
Host - Analogous to the SyncHost trait, but designed for asynchronous execution contexts.
- Base
Host - Defines the common interface between SyncHost and AsyncHost, by which the VM can interact with the host.
- Debug
Handler - Handler for debug and trace operations
- Error
Context - Trait defining the interface for error context providers.
- Event
Handler - An
EventHandlerdefines a function that that can be called from the processor which can read the VM state and modify the state of the advice provider. - Future
Maybe Send - Alias for a
Future - Mast
Forest Store - A set of
MastForests available to the prover that programs may refer to (by means of anmiden_core::mast::ExternalNode). - Mast
Node Ext - Sync
Host - Defines an interface by which the VM can interact with the host.
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§
- Event
Error - A generic
Errorwrapper allowing handlers to return errors to the Host caller. - Precompile
Transcript State - Type alias representing the precompile transcript state (sponge capacity word).