Crate interpreter

Expand description

§revm-interpreter

Interpreter is part of the project that executes EVM instructions.

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
check: Check if the SPEC is enabled, and fail the instruction if it is not.
debug_unreachable
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
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
return_ok
return_revert
tri: const Option ?.

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.
EOFCreateInputs: Inputs for EOF Create call
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.
Interpreter: Main interpreter structure that contains all components defines in InterpreterTypes.s
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

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.

Instruction: EVM opcode function signature.
InstructionTable: Instruction table is list of instruction function pointers mapped to 256 EVM opcodes.