ethereum.forks.paris.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

60
STACK_DEPTH_LIMIT = Uint(1024)

MAX_CODE_SIZE

61
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. `error`: The error from the execution if any.
64
@final
65
@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]

error

83
    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:
87
    <snip>
102
    tx_state = message.tx_env.state
103
    refund_counter = U256(0)
104
    if message.target == Bytes0(b""):
105
        if account_deployable(tx_state, message.current_target):
106
            evm = process_create_message(message)
107
        else:
108
            return MessageCallOutput(
109
                gas_left=Uint(0),
110
                refund_counter=U256(0),
111
                logs=tuple(),
112
                accounts_to_delete=set(),
113
                error=AddressCollision(),
114
            )
115
    else:
116
        evm = process_message(message)
117
118
    if evm.error:
119
        logs: Tuple[Log, ...] = ()
120
        accounts_to_delete = set()
121
    else:
122
        logs = evm.logs
123
        accounts_to_delete = evm.accounts_to_delete
124
        refund_counter += U256(evm.refund_counter)
125
126
    tx_end = TransactionEnd(
127
        int(message.gas) - int(evm.gas_left), evm.output, evm.error
128
    )
129
    evm_trace(evm, tx_end)
130
131
    return MessageCallOutput(
132
        gas_left=evm.gas_left,
133
        refund_counter=refund_counter,
134
        logs=logs,
135
        accounts_to_delete=accounts_to_delete,
136
        error=evm.error,
137
    )

process_create_message

Executes a call to create a smart contract.

Parameters

message : Transaction specific items.

Returns

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

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

process_message

Move ether and execute the relevant code.

Parameters

message : Transaction specific items.

Returns

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

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