ethereum.forks.spurious_dragon.vm.interpreter

Ethereum Virtual Machine (EVM) Interpreter.

.. contents:: Table of Contents :backlinks: none :local:

Introduction

A straightforward interpreter that executes EVM code.

STACK_DEPTH_LIMIT

59
STACK_DEPTH_LIMIT = Uint(1024)

MAX_CODE_SIZE

60
MAX_CODE_SIZE = 0x6000

MessageCallOutput

Output of a particular message call.

Contains the following:

  1. `gas_left`: remaining gas after execution.
  2. `refund_counter`: gas to refund after execution.
  3. `logs`: list of `Log` generated during execution.
  4. `accounts_to_delete`: Contracts which have self-destructed.
  5. `touched_accounts`: Accounts that have been touched.
  6. `error`: The error from the execution if any.
63
@final
64
@dataclass
class MessageCallOutput:

gas_left

79
    gas_left: Uint

refund_counter

80
    refund_counter: U256

logs

81
    logs: Tuple[Log, ...]

accounts_to_delete

82
    accounts_to_delete: Set[Address]

touched_accounts

83
    touched_accounts: Set[Address]

error

84
    error: Optional[EthereumException]

process_message_call

If message.target 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.

Returns

output : MessageCallOutput Output of the message call

def process_message_call(message: Message) -> MessageCallOutput:
88
    <snip>
103
    tx_state = message.tx_env.state
104
    refund_counter = U256(0)
105
    if message.target == Bytes0(b""):
106
        if account_deployable(tx_state, message.current_target):
107
            evm = process_create_message(message)
108
        else:
109
            return MessageCallOutput(
110
                gas_left=Uint(0),
111
                refund_counter=U256(0),
112
                logs=tuple(),
113
                accounts_to_delete=set(),
114
                touched_accounts=set(),
115
                error=AddressCollision(),
116
            )
117
    else:
118
        evm = process_message(message)
119
        if account_exists_and_is_empty(tx_state, Address(message.target)):
120
            evm.touched_accounts.add(Address(message.target))
121
122
    if evm.error:
123
        logs: Tuple[Log, ...] = ()
124
        accounts_to_delete = set()
125
        touched_accounts = set()
126
    else:
127
        logs = evm.logs
128
        accounts_to_delete = evm.accounts_to_delete
129
        touched_accounts = evm.touched_accounts
130
        refund_counter += U256(evm.refund_counter)
131
132
    tx_end = TransactionEnd(
133
        int(message.gas) - int(evm.gas_left), evm.output, evm.error
134
    )
135
    evm_trace(evm, tx_end)
136
137
    return MessageCallOutput(
138
        gas_left=evm.gas_left,
139
        refund_counter=refund_counter,
140
        logs=logs,
141
        accounts_to_delete=accounts_to_delete,
142
        touched_accounts=touched_accounts,
143
        error=evm.error,
144
    )

process_create_message

Executes a call to create a smart contract.

Parameters

message : Transaction specific items.

Returns

evm: :py:class:~ethereum.forks.spurious_dragon.vm.Evm Items containing execution specific objects.

def process_create_message(message: Message) -> Evm:
148
    <snip>
162
    tx_state = message.tx_env.state
163
    # take snapshot of state before processing the message
164
    snapshot = copy_tx_state(tx_state)
165
166
    # If the address where the account is being created has storage, it is
167
    # destroyed. This can only happen in the following highly unlikely
168
    # circumstances:
169
    # * The address created by a `CREATE` call collides with a subsequent
170
    #   `CREATE` or `CREATE2` call.
171
    # * The first `CREATE` happened before Spurious Dragon and left empty
172
    #   code.
173
    destroy_storage(tx_state, message.current_target)
174
175
    increment_nonce(tx_state, message.current_target)
176
    evm = process_message(message)
177
    if not evm.error:
178
        contract_code = evm.output
179
        contract_code_gas = (
180
            ulen(contract_code) * GasCosts.CODE_DEPOSIT_PER_BYTE
181
        )
182
        try:
183
            charge_gas(evm, contract_code_gas)
184
            if len(contract_code) > MAX_CODE_SIZE:
185
                raise OutOfGasError
186
        except ExceptionalHalt as error:
187
            restore_tx_state(tx_state, snapshot)
188
            evm.gas_left = Uint(0)
189
            evm.error = error
190
        else:
191
            set_code(tx_state, message.current_target, contract_code)
192
    else:
193
        restore_tx_state(tx_state, snapshot)
194
    return evm

process_message

Move ether and execute the relevant code.

Parameters

message : Transaction specific items.

Returns

evm: :py:class:~ethereum.forks.spurious_dragon.vm.Evm Items containing execution specific objects

def process_message(message: Message) -> Evm:
198
    <snip>
212
    tx_state = message.tx_env.state
213
    if message.depth > STACK_DEPTH_LIMIT:
214
        raise StackDepthLimitError("Stack depth limit reached")
215
216
    code = message.code
217
    valid_jump_destinations = get_valid_jump_destinations(code)
218
    evm = Evm(
219
        pc=Uint(0),
220
        stack=[],
221
        memory=bytearray(),
222
        code=code,
223
        gas_left=message.gas,
224
        valid_jump_destinations=valid_jump_destinations,
225
        logs=(),
226
        refund_counter=0,
227
        running=True,
228
        message=message,
229
        output=b"",
230
        accounts_to_delete=set(),
231
        touched_accounts=set(),
232
        error=None,
233
    )
234
235
    # take snapshot of state before processing the message
236
    snapshot = copy_tx_state(tx_state)
237
238
    touch_account(tx_state, message.current_target)
239
240
    if message.should_transfer_value and message.value != 0:
241
        move_ether(
242
            tx_state,
243
            message.caller,
244
            message.current_target,
245
            message.value,
246
        )
247
248
    try:
249
        if evm.message.code_address in PRE_COMPILED_CONTRACTS:
250
            evm_trace(evm, PrecompileStart(evm.message.code_address))
251
            PRE_COMPILED_CONTRACTS[evm.message.code_address](evm)
252
            evm_trace(evm, PrecompileEnd())
253
        else:
254
            while evm.running and evm.pc < ulen(evm.code):
255
                try:
256
                    op = Ops(evm.code[evm.pc])
257
                except ValueError as e:
258
                    raise InvalidOpcode(evm.code[evm.pc]) from e
259
260
                evm_trace(evm, OpStart(op))
261
                op_implementation[op](evm)
262
                evm_trace(evm, OpEnd())
263
264
            evm_trace(evm, EvmStop(Ops.STOP))
265
266
    except ExceptionalHalt as error:
267
        evm_trace(evm, OpException(error))
268
        evm.gas_left = Uint(0)
269
        evm.error = error
270
271
    if evm.error:
272
        restore_tx_state(tx_state, snapshot)
273
    return evm