ethereum.forks.amsterdam.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
@dataclass
class MessageCallOutput:

gas_left

84
    gas_left: Uint

refund_counter

85
    refund_counter: U256

logs

86
    logs: Tuple[Log, ...]

accounts_to_delete

87
    accounts_to_delete: Set[Address]

error

88
    error: Optional[EthereumException]

return_data

89
    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:
93
    """
94
    If `message.target` is empty then it creates a smart contract
95
    else it executes a call from the `message.caller` to the `message.target`.
96
97
    Parameters
98
    ----------
99
    message :
100
        Transaction specific items.
101
102
    Returns
103
    -------
104
    output : `MessageCallOutput`
105
        Output of the message call
106
107
    """
108
    tx_state = message.tx_env.state
109
    refund_counter = U256(0)
110
    if message.target == Bytes0(b""):
111
        is_collision = account_has_code_or_nonce(
112
            tx_state, message.current_target
113
        ) or account_has_storage(tx_state, message.current_target)
114
        track_address(tx_state, message.current_target)
115
        if is_collision:
116
            return MessageCallOutput(
117
                Uint(0),
118
                U256(0),
119
                tuple(),
120
                set(),
121
                AddressCollision(),
122
                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_account(tx_state, delegated_address).code
135
            message.code_address = delegated_address
136
            track_address(tx_state, delegated_address)
137
138
        evm = process_message(message)
139
140
    if evm.error:
141
        logs: Tuple[Log, ...] = ()
142
        accounts_to_delete = set()
143
    else:
144
        logs = evm.logs
145
        accounts_to_delete = evm.accounts_to_delete
146
        refund_counter += U256(evm.refund_counter)
147
148
    tx_end = TransactionEnd(
149
        int(message.gas) - int(evm.gas_left), evm.output, evm.error
150
    )
151
    evm_trace(evm, tx_end)
152
153
    return MessageCallOutput(
154
        gas_left=evm.gas_left,
155
        refund_counter=refund_counter,
156
        logs=logs,
157
        accounts_to_delete=accounts_to_delete,
158
        error=evm.error,
159
        return_data=evm.output,
160
    )

process_create_message

Executes a call to create a smart contract.

Parameters

message : Transaction specific items.

Returns

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

def process_create_message(message: Message) -> Evm:
164
    """
165
    Executes a call to create a smart contract.
166
167
    Parameters
168
    ----------
169
    message :
170
        Transaction specific items.
171
172
    Returns
173
    -------
174
    evm: :py:class:`~ethereum.forks.amsterdam.vm.Evm`
175
        Items containing execution specific objects.
176
177
    """
178
    tx_state = message.tx_env.state
179
    # take snapshot of state before processing the message
180
    snapshot = copy_tx_state(tx_state)
181
182
    # If the address where the account is being created has storage, it is
183
    # destroyed. This can only happen in the following highly unlikely
184
    # circumstances:
185
    # * The address created by a `CREATE` call collides with a subsequent
186
    #   `CREATE` or `CREATE2` call.
187
    # * The first `CREATE` happened before Spurious Dragon and left empty
188
    #   code.
189
    destroy_storage(tx_state, message.current_target)
190
191
    # In the previously mentioned edge case the preexisting storage is ignored
192
    # for gas refund purposes. In order to do this we must track created
193
    # accounts. This tracking is also needed to respect the constraints
194
    # added to SELFDESTRUCT by EIP-6780.
195
    mark_account_created(tx_state, message.current_target)
196
197
    increment_nonce(tx_state, message.current_target)
198
199
    evm = process_message(message)
200
    if not evm.error:
201
        contract_code = evm.output
202
        contract_code_gas = Uint(len(contract_code)) * GAS_CODE_DEPOSIT
203
        try:
204
            if len(contract_code) > 0:
205
                if contract_code[0] == 0xEF:
206
                    raise InvalidContractPrefix
207
            charge_gas(evm, contract_code_gas)
208
            if len(contract_code) > MAX_CODE_SIZE:
209
                raise OutOfGasError
210
        except ExceptionalHalt as error:
211
            restore_tx_state(tx_state, snapshot)
212
            evm.gas_left = Uint(0)
213
            evm.output = b""
214
            evm.error = error
215
        else:
216
            set_code(tx_state, message.current_target, contract_code)
217
    else:
218
        restore_tx_state(tx_state, snapshot)
219
    return evm

process_message

Move ether and execute the relevant code.

Parameters

message : Transaction specific items.

Returns

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

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