Ethereum Virtual Machine (EVM) Interpreter
Table of Contents
Introduction
A straightforward interpreter that executes EVM code.
Module Contents
Classes
Output of a particular message call |
Functions
If message.current is empty then it creates a smart contract |
|
Executes a call to create a smart contract. |
|
Executes a call to create a smart contract. |
|
Executes bytecode present in the message. |
Attributes
Module Details
STACK_DEPTH_LIMIT
- STACK_DEPTH_LIMIT
STACK_DEPTH_LIMIT = U256(1024)
MAX_CODE_SIZE
- MAX_CODE_SIZE
MAX_CODE_SIZE = 0x6000
MessageCallOutput
Output of a particular message call
Contains the following:
gas_left: remaining gas after execution.
refund_counter: gas to refund after execution.
logs: list of Log generated during execution.
accounts_to_delete: Contracts which have self-destructed.
touched_accounts: Accounts that have been touched.
error: The error from the execution if any.
- class MessageCallOutput
- gas_left :ethereum.base_types.Uint
- refund_counter :ethereum.base_types.U256
- logs :Tuple[ethereum.istanbul.fork_types.Log,:Tuple[ethereum.muir_glacier.fork_types.Log, Ellipsis]
- accounts_to_delete :Set[ethereum.istanbul.fork_types.Address]:Set[ethereum.muir_glacier.fork_types.Address]
- touched_accounts :Iterable[ethereum.istanbul.fork_types.Address]:Iterable[ethereum.muir_glacier.fork_types.Address]
- error :Optional[Exception]
process_message_call
- process_message_call(message, env)
If message.current is empty then it creates a smart contract else it executes a call from the message.caller to the message.target.
- Parameters
message – Transaction specific items.
env – External items required for EVM execution.
- Returns
output – Output of the message call
- Return type
MessageCallOutput
def process_message_call(
message: Message, env: Environment
) -> MessageCallOutput:
if message.target == Bytes0(b""):
is_collision = account_has_code_or_nonce(
env.state, message.current_target
)
if is_collision:
return MessageCallOutput(
Uint(0), U256(0), tuple(), set(), set(), AddressCollision()
)
else:
evm = process_create_message(message, env)
else:
evm = process_message(message, env)
if account_exists_and_is_empty(env.state, Address(message.target)):
evm.touched_accounts.add(Address(message.target))
if evm.error:
logs: Tuple[Log, ...] = ()
accounts_to_delete = set()
touched_accounts = set()
refund_counter = U256(0)
else:
logs = evm.logs
accounts_to_delete = evm.accounts_to_delete
touched_accounts = evm.touched_accounts
refund_counter = U256(evm.refund_counter)
# + REFUND_SELF_DESTRUCT * len(
# evm.accounts_to_delete
#tx_end = TransactionEnd(message.gas - evm.gas_left, evm.output, evm.error)
evm_trace(evm, tx_end)
return MessageCallOutput(
gas_left=evm.gas_left,
refund_counter=refund_counter,
logs=logs,
accounts_to_delete=accounts_to_delete,
touched_accounts=touched_accounts,
error=evm.error, )
tx_end = TransactionEnd(message.gas - evm.gas_left, evm.output, evm.error)
evm_trace(evm, tx_end)
return MessageCallOutput(
gas_left=evm.gas_left,
refund_counter=refund_counter,
logs=logs,
accounts_to_delete=accounts_to_delete,
touched_accounts=touched_accounts,
error=evm.error,
)
process_create_message
- process_create_message(message, env)
Executes a call to create a smart contract.
- Parameters
message – Transaction specific items.
env – External items required for EVM execution.
- Returns
evm – Items containing execution specific objects.
- Return type
def process_create_message(message: Message, env: Environment) -> Evm:
# take snapshot of state before processing the message
begin_transaction(env.state)
# If the address where the account is being created has storage, it is
# destroyed. This can only happen in the following highly unlikely
# circumstances:
# * The address created by a `CREATE` call collides with a subsequent
# `CREATE` or `CREATE2` call.
# * The first `CREATE` happened before Spurious Dragon and left empty
# code.
destroy_storage(env.state, message.current_target)
# In the previously mentioned edge case the preexisting storage is ignored
# for gas refund purposes. In order to do this we must track created
# accounts.
mark_account_created(env.state, message.current_target)
increment_nonce(env.state, message.current_target)
evm = process_message(message, env)
if not evm.error:
contract_code = evm.output
contract_code_gas = len(contract_code) * GAS_CODE_DEPOSIT
try:
charge_gas(evm, contract_code_gas)
ensure(len(contract_code) <= MAX_CODE_SIZE, OutOfGasError)
except ExceptionalHalt as error:
rollback_transaction(env.state)
evm.gas_left = Uint(0)
evm.output = b""
evm.error = error
else:
set_code(env.state, message.current_target, contract_code)
commit_transaction(env.state)
else:
rollback_transaction(env.state)
return evm
process_message
- process_message(message, env)
Executes a call to create a smart contract.
- Parameters
message – Transaction specific items.
env – External items required for EVM execution.
- Returns
evm – Items containing execution specific objects
- Return type
def process_message(message: Message, env: Environment) -> Evm:
if message.depth > STACK_DEPTH_LIMIT:
raise StackDepthLimitError("Stack depth limit reached")
# take snapshot of state before processing the message
begin_transaction(env.state)
touch_account(env.state, message.current_target)
if message.should_transfer_value and message.value != 0:
move_ether(
env.state, message.caller, message.current_target, message.value
)
evm = execute_code(message, env)
if evm.error:
# revert state to the last saved checkpoint
# since the message call resulted in an error
rollback_transaction(env.state)
else:
commit_transaction(env.state)
return evm
execute_code
- execute_code(message, env)
Executes bytecode present in the message.
- Parameters
message – Transaction specific items.
env – External items required for EVM execution.
- Returns
evm – Items containing execution specific objects
- Return type
ethereum.vm.EVM
def execute_code(message: Message, env: Environment) -> Evm:
code = message.code
valid_jump_destinations = get_valid_jump_destinations(code)
evm = Evm(
pc=Uint(0),
stack=[],
memory=bytearray(),
code=code,
gas_left=message.gas,
env=env,
valid_jump_destinations=valid_jump_destinations,
logs=(),
refund_counter=0,
running=True,
message=message,
output=b"",
accounts_to_delete=set(),
touched_accounts=set(),
return_data=b"",
error=None,
)
try:
if evm.message.code_address in PRE_COMPILED_CONTRACTS:
evm_trace(evm, PrecompileStart(evm.message.code_address))
PRE_COMPILED_CONTRACTS[evm.message.code_address](evm)
evm_trace(evm, PrecompileEnd())
return evm
while evm.running and evm.pc < len(evm.code):
try:
op = Ops(evm.code[evm.pc])
except ValueError:
raise InvalidOpcode(evm.code[evm.pc])
evm_trace(evm, OpStart(op))
op_implementation[op](evm)
evm_trace(evm, OpEnd())
evm_trace(evm, EvmStop(Ops.STOP))
except ExceptionalHalt as error:
evm_trace(evm, OpException(error))
evm.gas_left = Uint(0)
evm.output = b""
evm.error = error
except Revert as error:
evm_trace(evm, OpException(error))
evm.error = error
return evm