ethereum.forks.arrow_glacier.vm.interpreterethereum.forks.gray_glacier.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

63
STACK_DEPTH_LIMIT = Uint(1024)

MAX_CODE_SIZE

64
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.
67
@final
68
@dataclass
class MessageCallOutput:

gas_left

83
    gas_left: Uint

refund_counter

84
    refund_counter: U256

logs

85
    logs: Tuple[Log, ...]

accounts_to_delete

86
    accounts_to_delete: Set[Address]

touched_accounts

87
    touched_accounts: Set[Address]

error

88
    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:
92
    <snip>
107
    tx_state = message.tx_env.state
108
    refund_counter = U256(0)
109
    if message.target == Bytes0(b""):
110
        is_collision = account_has_code_or_nonce(
111
            tx_state, message.current_target
112
        ) or account_has_storage(tx_state, message.current_target)
113
        if is_collision:
114
            return MessageCallOutput(
115
                gas_left=Uint(0),
116
                refund_counter=U256(0),
117
                logs=tuple(),
118
                accounts_to_delete=set(),
119
                touched_accounts=set(),
120
                error=AddressCollision(),
121
            )
122
        else:
123
            evm = process_create_message(message)
124
    else:
125
        evm = process_message(message)
126
        if account_exists_and_is_empty(tx_state, Address(message.target)):
127
            evm.touched_accounts.add(Address(message.target))
128
129
    if evm.error:
130
        logs: Tuple[Log, ...] = ()
131
        accounts_to_delete = set()
132
        touched_accounts = set()
133
    else:
134
        logs = evm.logs
135
        accounts_to_delete = evm.accounts_to_delete
136
        touched_accounts = evm.touched_accounts
137
        refund_counter += U256(evm.refund_counter)
138
139
    tx_end = TransactionEnd(
140
        int(message.gas) - int(evm.gas_left), evm.output, evm.error
141
    )
142
    evm_trace(evm, tx_end)
143
144
    return MessageCallOutput(
145
        gas_left=evm.gas_left,
146
        refund_counter=refund_counter,
147
        logs=logs,
148
        accounts_to_delete=accounts_to_delete,
149
        touched_accounts=touched_accounts,
150
        error=evm.error,
151
    )

process_create_message

Executes a call to create a smart contract.

Parameters

message : Transaction specific items.

Returns

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

def process_create_message(message: Message) -> Evm:
155
    <snip>
169
    tx_state = message.tx_env.state
170
    # take snapshot of state before processing the message
171
    snapshot = copy_tx_state(tx_state)
172
173
    # If the address where the account is being created has storage, it is
174
    # destroyed. This can only happen in the following highly unlikely
175
    # circumstances:
176
    # * The address created by a `CREATE` call collides with a subsequent
177
    #   `CREATE` or `CREATE2` call.
178
    # * The first `CREATE` happened before Spurious Dragon and left empty
179
    #   code.
180
    destroy_storage(tx_state, message.current_target)
181
182
    # In the previously mentioned edge case the preexisting storage is ignored
183
    # for gas refund purposes. In order to do this we must track created
184
    # accounts.
185
    mark_account_created(tx_state, message.current_target)
186
187
    increment_nonce(tx_state, message.current_target)
188
    evm = process_message(message)
189
    if not evm.error:
190
        contract_code = evm.output
191
        contract_code_gas = (
192
            ulen(contract_code) * GasCosts.CODE_DEPOSIT_PER_BYTE
193
        )
194
        try:
195
            if len(contract_code) > 0:
196
                if contract_code[0] == 0xEF:
197
                    raise InvalidContractPrefix
198
            charge_gas(evm, contract_code_gas)
199
            if len(contract_code) > MAX_CODE_SIZE:
200
                raise OutOfGasError
201
        except ExceptionalHalt as error:
202
            restore_tx_state(tx_state, snapshot)
203
            evm.gas_left = Uint(0)
204
            evm.output = b""
205
            evm.error = error
206
        else:
207
            set_code(tx_state, message.current_target, contract_code)
208
    else:
209
        restore_tx_state(tx_state, snapshot)
210
    return evm

process_message

Move ether and execute the relevant code.

Parameters

message : Transaction specific items.

Returns

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

def process_message(message: Message) -> Evm:
214
    <snip>
228
    tx_state = message.tx_env.state
229
    if message.depth > STACK_DEPTH_LIMIT:
230
        raise StackDepthLimitError("Stack depth limit reached")
231
232
    code = message.code
233
    valid_jump_destinations = get_valid_jump_destinations(code)
234
    evm = Evm(
235
        pc=Uint(0),
236
        stack=[],
237
        memory=bytearray(),
238
        code=code,
239
        gas_left=message.gas,
240
        valid_jump_destinations=valid_jump_destinations,
241
        logs=(),
242
        refund_counter=0,
243
        running=True,
244
        message=message,
245
        output=b"",
246
        accounts_to_delete=set(),
247
        touched_accounts=set(),
248
        return_data=b"",
249
        error=None,
250
        accessed_addresses=message.accessed_addresses,
251
        accessed_storage_keys=message.accessed_storage_keys,
252
    )
253
254
    # take snapshot of state before processing the message
255
    snapshot = copy_tx_state(tx_state)
256
257
    touch_account(tx_state, message.current_target)
258
259
    if message.should_transfer_value and message.value != 0:
260
        move_ether(
261
            tx_state,
262
            message.caller,
263
            message.current_target,
264
            message.value,
265
        )
266
267
    try:
268
        if evm.message.code_address in PRE_COMPILED_CONTRACTS:
269
            evm_trace(evm, PrecompileStart(evm.message.code_address))
270
            PRE_COMPILED_CONTRACTS[evm.message.code_address](evm)
271
            evm_trace(evm, PrecompileEnd())
272
        else:
273
            while evm.running and evm.pc < ulen(evm.code):
274
                try:
275
                    op = Ops(evm.code[evm.pc])
276
                except ValueError as e:
277
                    raise InvalidOpcode(evm.code[evm.pc]) from e
278
279
                evm_trace(evm, OpStart(op))
280
                op_implementation[op](evm)
281
                evm_trace(evm, OpEnd())
282
283
            evm_trace(evm, EvmStop(Ops.STOP))
284
285
    except ExceptionalHalt as error:
286
        evm_trace(evm, OpException(error))
287
        evm.gas_left = Uint(0)
288
        evm.output = b""
289
        evm.error = error
290
    except Revert as error:
291
        evm_trace(evm, OpException(error))
292
        evm.error = error
293
294
    if evm.error:
295
        restore_tx_state(tx_state, snapshot)
296
    return evm