Crate miden_processor

Source

Modules§

crypto
fast
math
utils

Macros§

err_ctx
Constructs an error context for the given node in the MAST forest.

Structs§

AdviceInputs
Inputs container to initialize advice provider for the execution of Miden VM programs.
AdviceProvider
An advice provider is a component through which the host can interact with the advice provider. The host can request nondeterministic inputs from the advice provider (i.e., result of a computation performed outside of the VM), as well as insert new data into the advice provider.
AsmOpInfo
Contains assembly instruction and operation index in the sequence corresponding to the specified AsmOp decorator. This index starts from 1 instead of 0.
AssemblyOp
Contains information corresponding to an assembly instruction (only applicable in debug mode).
ChipletsLengths
Contains trace lengths of all chilplets: hash, bitwise, memory and kernel ROM trace lengths.
ChipletsTrace
ColMatrix
A two-dimensional matrix of field elements arranged in column-major order.
ContextId
Represents the ID of an execution context
DecoderTrace
DefaultHost
A default BaseHost, SyncHost and AsyncHost implementation that provides the essential functionality required by the VM.
ExecutionOptions
A set of parameters specifying execution parameters of the VM.
ExecutionTrace
Execution trace which is generated when a program is executed on the VM.
Felt
Represents base field element in the field using Montgomery representation.
Kernel
A list of procedure hashes defining a VM kernel.
MastForest
Represents one or more procedures, represented as a collection of MastNodes.
MastNodeId
An opaque handle to a MastNode in some MastForest. It is the responsibility of the user to use a given MastNodeId with the corresponding MastForest.
MemMastForestStore
A simple MastForestStore where all known MastForests are held in memory.
MemoryAddress
Process
A Process is the underlying execution engine for a Miden Program.
Program
An executable program for Miden VM.
ProgramInfo
A program information set consisting of its MAST root and set of kernel procedure roots used for its compilation.
QuadExtension
Represents an element in a quadratic extension of a StarkField.
RangeCheckTrace
RowIndex
A newtype wrapper around a usize value representing a step in the execution trace.
SlowProcessState
StackInputs
Defines the initial state of the VM’s operand stack.
StackOutputs
Output container for Miden VM programs.
StackTrace
TraceLenSummary
Contains the data about lengths of the trace parts.
VmState
VmState holds a current process state information at a specific clock cycle.
VmStateIterator
Iterator that iterates through vm state at each step of the execution.
Word
A unit of data consisting of 4 field elements.

Enums§

AdviceError
DeserializationError
Defines errors which can occur during deserialization.
ExecutionError
ExecutionOptionsError
InputError
MastNode
MemoryError
Operation
A set of native VM operations which take exactly one cycle to execute.
ProcessState
SystemEvent
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
The depth of the sparse Merkle tree.
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§

AsyncHost
Analogous to the SyncHost trait, but designed for asynchronous execution contexts.
BaseHost
Defines the common interface between SyncHost and AsyncHost, by which the VM can interact with the host.
ErrorContext
Trait defining the interface for error context providers.
KvMap
A trait that defines the interface for a key-value map.
MastForestStore
A set of MastForests available to the prover that programs may refer to (by means of an miden_core::mast::ExternalNode).
SyncHost
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.