ethereum.forks.prague.vm.interpreterethereum.forks.osaka.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

64
STACK_DEPTH_LIMIT = Uint(1024)

MAX_CODE_SIZE

65
MAX_CODE_SIZE = 0x6000

MAX_INIT_CODE_SIZE

66
MAX_INIT_CODE_SIZE = 2 * MAX_CODE_SIZE

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.
  6. `return_data`: The output of the execution.
69
@final
70
@dataclass
class MessageCallOutput:

gas_left

85
    gas_left: Uint

refund_counter

86
    refund_counter: U256

logs

87
    logs: Tuple[Log, ...]

accounts_to_delete

88
    accounts_to_delete: Set[Address]

error

89
    error: Optional[EthereumException]

return_data

90
    return_data: Bytes

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:
94
    <snip>
109
    tx_state = message.tx_env.state
110
    refund_counter = U256(0)
111
    if message.target == Bytes0(b""):
112
        is_collision = account_has_code_or_nonce(
113
            tx_state, message.current_target
114
        ) or account_has_storage(tx_state, message.current_target)
115
        if is_collision:
116
            return MessageCallOutput(
117
                gas_left=Uint(0),
118
                refund_counter=U256(0),
119
                logs=tuple(),
120
                accounts_to_delete=set(),
121
                error=AddressCollision(),
122
                return_data=Bytes(b""),
123
            )
124
        else:
125
            evm = process_create_message(message)
126
    else:
127
        if message.tx_env.authorizations != ():
128
            refund_counter += set_delegation(message)
129
130
        delegated_address = get_delegated_code_address(message.code)
131
        if delegated_address is not None:
132
            message.disable_precompiles = True
133
            message.accessed_addresses.add(delegated_address)
134
            message.code = get_code(
135
                tx_state,
136
                get_account(tx_state, delegated_address).code_hash,
137
            )
138
            message.code_address = delegated_address
139
140
        evm = process_message(message)
141
142
    if evm.error:
143
        logs: Tuple[Log, ...] = ()
144
        accounts_to_delete = set()
145
    else:
146
        logs = evm.logs
147
        accounts_to_delete = evm.accounts_to_delete
148
        refund_counter += U256(evm.refund_counter)
149
150
    tx_end = TransactionEnd(
151
        int(message.gas) - int(evm.gas_left), evm.output, evm.error
152
    )
153
    evm_trace(evm, tx_end)
154
155
    return MessageCallOutput(
156
        gas_left=evm.gas_left,
157
        refund_counter=refund_counter,
158
        logs=logs,
159
        accounts_to_delete=accounts_to_delete,
160
        error=evm.error,
161
        return_data=evm.output,
162
    )

process_create_message

Executes a call to create a smart contract.

Parameters

message : Transaction specific items.

Returns

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

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

process_message

Move ether and execute the relevant code.

Parameters

message : Transaction specific items.

Returns

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

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