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

gas_left

82
    gas_left: Uint

refund_counter

83
    refund_counter: U256

logs

84
    logs: Tuple[Log, ...]

accounts_to_delete

85
    accounts_to_delete: Set[Address]

touched_accounts

86
    touched_accounts: Set[Address]

error

87
    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:
91
    """
92
    If `message.target` is empty then it creates a smart contract
93
    else it executes a call from the `message.caller` to the `message.target`.
94
95
    Parameters
96
    ----------
97
    message :
98
        Transaction specific items.
99
100
    Returns
101
    -------
102
    output : `MessageCallOutput`
103
        Output of the message call
104
105
    """
106
    tx_state = message.tx_env.state
107
    refund_counter = U256(0)
108
    if message.target == Bytes0(b""):
109
        is_collision = account_has_code_or_nonce(
110
            tx_state, message.current_target
111
        ) or account_has_storage(tx_state, message.current_target)
112
        if is_collision:
113
            return MessageCallOutput(
114
                gas_left=Uint(0),
115
                refund_counter=U256(0),
116
                logs=tuple(),
117
                accounts_to_delete=set(),
118
                touched_accounts=set(),
119
                error=AddressCollision(),
120
            )
121
        else:
122
            evm = process_create_message(message)
123
    else:
124
        evm = process_message(message)
125
        if account_exists_and_is_empty(tx_state, Address(message.target)):
126
            evm.touched_accounts.add(Address(message.target))
127
128
    if evm.error:
129
        logs: Tuple[Log, ...] = ()
130
        accounts_to_delete = set()
131
        touched_accounts = set()
132
    else:
133
        logs = evm.logs
134
        accounts_to_delete = evm.accounts_to_delete
135
        touched_accounts = evm.touched_accounts
136
        refund_counter += U256(evm.refund_counter)
137
138
    tx_end = TransactionEnd(
139
        int(message.gas) - int(evm.gas_left), evm.output, evm.error
140
    )
141
    evm_trace(evm, tx_end)
142
143
    return MessageCallOutput(
144
        gas_left=evm.gas_left,
145
        refund_counter=refund_counter,
146
        logs=logs,
147
        accounts_to_delete=accounts_to_delete,
148
        touched_accounts=touched_accounts,
149
        error=evm.error,
150
    )

process_create_message

Executes a call to create a smart contract.

Parameters

message : Transaction specific items.

Returns

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

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

process_message

Move ether and execute the relevant code.

Parameters

message : Transaction specific items.

Returns

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

def process_message(message: Message) -> Evm:
213
    """
214
    Move ether and execute the relevant code.
215
216
    Parameters
217
    ----------
218
    message :
219
        Transaction specific items.
220
221
    Returns
222
    -------
223
    evm: :py:class:`~ethereum.forks.london.vm.Evm`
224
        Items containing execution specific objects
225
226
    """
227
    tx_state = message.tx_env.state
228
    if message.depth > STACK_DEPTH_LIMIT:
229
        raise StackDepthLimitError("Stack depth limit reached")
230
231
    code = message.code
232
    valid_jump_destinations = get_valid_jump_destinations(code)
233
    evm = Evm(
234
        pc=Uint(0),
235
        stack=[],
236
        memory=bytearray(),
237
        code=code,
238
        gas_left=message.gas,
239
        valid_jump_destinations=valid_jump_destinations,
240
        logs=(),
241
        refund_counter=0,
242
        running=True,
243
        message=message,
244
        output=b"",
245
        accounts_to_delete=set(),
246
        touched_accounts=set(),
247
        return_data=b"",
248
        error=None,
249
        accessed_addresses=message.accessed_addresses,
250
        accessed_storage_keys=message.accessed_storage_keys,
251
    )
252
253
    # take snapshot of state before processing the message
254
    snapshot = copy_tx_state(tx_state)
255
256
    touch_account(tx_state, message.current_target)
257
258
    if message.should_transfer_value and message.value != 0:
259
        move_ether(
260
            tx_state,
261
            message.caller,
262
            message.current_target,
263
            message.value,
264
        )
265
266
    try:
267
        if evm.message.code_address in PRE_COMPILED_CONTRACTS:
268
            evm_trace(evm, PrecompileStart(evm.message.code_address))
269
            PRE_COMPILED_CONTRACTS[evm.message.code_address](evm)
270
            evm_trace(evm, PrecompileEnd())
271
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