Crate interpreter

revm-interpreter

Interpreter is part of the project that executes EVM instructions.

Modules

gas

Gas calculation utilities and constants. EVM gas calculation utilities.

host

Host interface for external blockchain state access.

instruction_context

Context passed to instruction implementations.

instructions

EVM instruction implementations organized by category. EVM opcode implementations.

interpreter

Core interpreter implementation for EVM bytecode execution. Core interpreter implementation and components.

interpreter_action

Types for interpreter actions like calls and contract creation.

interpreter_types

Type traits and definitions for interpreter customization.

Macros

as_isize_saturated

Converts a U256 value to a isize, saturating to isize::MAX if the value is too large.

as_u64_saturated

Converts a U256 value to a u64, saturating to MAX if the value is too large.

as_usize_or_fail

Converts a U256 value to a usize, failing the instruction if the value is too large.

as_usize_or_fail_ret

Converts a U256 value to a usize and returns ret, failing the instruction if the value is too large.

as_usize_saturated

Converts a U256 value to a usize, saturating to MAX if the value is too large.

assume

Macro for asserting assumptions in debug builds. In debug builds, this will trigger unreachable code if the assumption is false. In release builds, this serves as an optimization hint.

check

Check if the SPEC is enabled, and fail the instruction if it is not.

debug_unreachable

Macro that triggers unreachable! in debug builds but uses unchecked unreachable in release builds. This provides better error messages during development while optimizing for performance in release.

gas

Records a gas cost and fails the instruction if it would exceed the available gas.

gas_or_fail

Same as gas!, but with gas as an option.

otry

Macro for optional try - returns early if the expression evaluates to None. Similar to the ? operator but for use in instruction implementations.

popn

Pops n values from the stack. Fails the instruction if n values can’t be popped.

popn_top

Pops n values from the stack and returns the top value. Fails the instruction if n values can’t be popped.

push

Pushes a B256 value onto the stack. Fails the instruction if the stack is full.

require_eof

Error if the current call is executing EOF.

require_non_staticcall

Fails the instruction if the current call is static.

resize_memory

Resizes the interpreterreter memory if necessary. Fails the instruction if the memory or gas limit is exceeded.

return_error

Macro that matches all error instruction results. Used in pattern matching to handle all error outcomes.

return_ok

Macro that matches all successful instruction results. Used in pattern matching to handle all successful execution outcomes.

return_revert

Macro that matches all revert instruction results. Used in pattern matching to handle all revert outcomes.

tri

const Option ?.

Structs

CallInputs

Inputs for a call.

CallOutcome

Represents the outcome of a call operation in a virtual machine.

CreateInputs

Inputs for a create call

CreateOutcome

Represents the outcome of a create operation in an interpreter.

Gas

Represents the state of gas during execution.

InitialAndFloorGas

Init and floor gas from transaction

InputsImpl

Inputs for the interpreter that are used for execution of the call.

InstructionContext

Context passed to instruction implementations containing the host and interpreter. This struct provides access to both the host interface for external state operations and the interpreter state for stack, memory, and gas operations.

Interpreter

Main interpreter structure that contains all components defined in InterpreterTypes.

InterpreterResult

The result of an interpreter operation.

SStoreResult

Represents the result of an sstore operation.

SelfDestructResult

Result of a selfdestruct action

SharedMemory

A sequential memory shared between calls, which uses a Vec for internal representation. A SharedMemory instance should always be obtained using the new static method to ensure memory safety.

Stack

EVM stack with STACK_LIMIT capacity of words.

StateLoad

State load information that contains the data and if the account or storage is cold loaded

Enums

CallInput

Input enum for a call.

CallScheme

Call scheme.

CallValue

Call value.

CreateScheme

Create scheme

FrameInput

Input data for creating a new execution frame.

InstructionResult

Result of executing an EVM instruction. This enum represents all possible outcomes when executing an instruction, including successful execution, reverts, and various error conditions.

InternalResult

Internal results that are not exposed externally

InterpreterAction

Actions that the interpreter can request from the host environment.

SuccessOrHalt

Represents the outcome of instruction execution, distinguishing between success, revert, halt (error), fatal external errors, and internal results.

Constants

MAX_CODE_SIZE

By default the limit is 0xC000 (49_152 bytes).

MAX_INITCODE_SIZE

By default the limit is 0x12000 (73_728 bytes).

STACK_LIMIT

EVM interpreter stack limit.

Traits

Host

Host trait with all methods that are needed by the Interpreter.

InterpreterTypes

Trait defining the component types used by an interpreter implementation.

Functions

instruction_table

Returns the instruction table for the given spec.

num_words

Returns number of words what would fit to provided number of bytes, i.e. it rounds up the number bytes to number of words.

Type Aliases

Instruction

EVM opcode function signature.

InstructionTable

Instruction table is list of instruction function pointers mapped to 256 EVM opcodes.