Crate miden_processor 

Modules

advice

crypto

event

field

mast

MAST forest: a collection of procedures represented as Merkle trees.

operation

precompile

Precompile framework for deferred verification in the Miden VM.

serde

trace

utils

Structs

ContextId

Represents the ID of an execution context

DefaultDebugHandler

Default implementation of DebugHandler that writes debug information to stdout when available.

DefaultHost

A default Host implementation that provides the essential functionality required by the VM.

ExecutionOptions

A set of parameters specifying execution parameters of the VM.

ExecutionOutput

The output of a program execution, containing the state of the stack, advice provider, memory, and final precompile transcript at the end of execution.

FastProcessor

A fast processor which doesn’t generate any trace.

Felt

The prime field known as Goldilocks, defined as F_p where p = 2^64 - 2^32 + 1.

HostLibrary

A rich library representing a MastForest which also exports a list of handlers for events it may call.

Kernel

A list of procedure hashes defining a VM kernel.

MemMastForestStore

A simple MastForestStore where all known MastForests are held in memory.

MemoryAddress

ProcessorState

A view into the current state of the processor.

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.

ResumeContext

The context required to resume execution of a program from the last point at which it was stopped.

StackInputs

Defines the initial state of the VM’s operand stack.

StackOutputs

Defines the final state of the VM’s operand stack at the end of program execution.

Word

A unit of data consisting of 4 field elements.

Enums

BreakReason

The reason why execution was interrupted.

ExecutionError

ExecutionOptionsError

InputError

MemoryError

Lightweight error type for memory operations.

Constants

EMPTY_WORD

Array of field elements representing word of ZEROs in the Miden base field.

MIN_STACK_DEPTH

Represents:

ONE

Field element representing ONE in the Miden base filed.

WORD_SIZE

Number of field elements in a word.

ZERO

Field element representing ZERO in the Miden base filed.

Traits

DebugHandler

Handler for debug and trace operations

FutureMaybeSend

Alias for a Future

Host

Defines an interface by which the VM can interact with the host.

MastForestStore

A set of MastForests available to the prover that programs may refer to (by means of an miden_core::mast::ExternalNode).

Stopper

A trait for types that determine whether execution should be stopped at a given point.

Functions

execute

Returns an execution trace resulting from executing the provided program against the provided inputs.

execute_sync

Synchronous wrapper for the async execute() function.

Type Aliases

DebugError

A generic Error wrapper for debug handler errors.

TraceError

A generic Error wrapper for trace handler errors.