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

61
STACK_DEPTH_LIMIT = Uint(1024)

MAX_CODE_SIZE

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

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:
144
    """
145
    Executes a call to create a smart contract.
146
147
    Parameters
148
    ----------
149
    message :
150
        Transaction specific items.
151
152
    Returns
153
    -------
154
    evm: :py:class:`~ethereum.forks.paris.vm.Evm`
155
        Items containing execution specific objects.
156
157
    """
158
    tx_state = message.tx_env.state
159
    # take snapshot of state before processing the message
160
    snapshot = copy_tx_state(tx_state)
161
162
    # If the address where the account is being created has storage, it is
163
    # destroyed. This can only happen in the following highly unlikely
164
    # circumstances:
165
    # * The address created by a `CREATE` call collides with a subsequent
166
    #   `CREATE` or `CREATE2` call.
167
    # * The first `CREATE` happened before Spurious Dragon and left empty
168
    #   code.
169
    destroy_storage(tx_state, message.current_target)
170
171
    # In the previously mentioned edge case the preexisting storage is ignored
172
    # for gas refund purposes. In order to do this we must track created
173
    # accounts.
174
    mark_account_created(tx_state, message.current_target)
175
176
    increment_nonce(tx_state, message.current_target)
177
    evm = process_message(message)
178
    if not evm.error:
179
        contract_code = evm.output
180
        contract_code_gas = (
181
            ulen(contract_code) * GasCosts.CODE_DEPOSIT_PER_BYTE
182
        )
183
        try:
184
            if len(contract_code) > 0:
185
                if contract_code[0] == 0xEF:
186
                    raise InvalidContractPrefix
187
            charge_gas(evm, contract_code_gas)
188
            if len(contract_code) > MAX_CODE_SIZE:
189
                raise OutOfGasError
190
        except ExceptionalHalt as error:
191
            restore_tx_state(tx_state, snapshot)
192
            evm.gas_left = Uint(0)
193
            evm.output = b""
194
            evm.error = error
195
        else:
196
            set_code(tx_state, message.current_target, contract_code)
197
    else:
198
        restore_tx_state(tx_state, snapshot)
199
    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:
203
    """
204
    Move ether and execute the relevant code.
205
206
    Parameters
207
    ----------
208
    message :
209
        Transaction specific items.
210
211
    Returns
212
    -------
213
    evm: :py:class:`~ethereum.forks.paris.vm.Evm`
214
        Items containing execution specific objects
215
216
    """
217
    tx_state = message.tx_env.state
218
    if message.depth > STACK_DEPTH_LIMIT:
219
        raise StackDepthLimitError("Stack depth limit reached")
220
221
    code = message.code
222
    valid_jump_destinations = get_valid_jump_destinations(code)
223
    evm = Evm(
224
        pc=Uint(0),
225
        stack=[],
226
        memory=bytearray(),
227
        code=code,
228
        gas_left=message.gas,
229
        valid_jump_destinations=valid_jump_destinations,
230
        logs=(),
231
        refund_counter=0,
232
        running=True,
233
        message=message,
234
        output=b"",
235
        accounts_to_delete=set(),
236
        return_data=b"",
237
        error=None,
238
        accessed_addresses=message.accessed_addresses,
239
        accessed_storage_keys=message.accessed_storage_keys,
240
    )
241
242
    # take snapshot of state before processing the message
243
    snapshot = copy_tx_state(tx_state)
244
245
    if message.should_transfer_value and message.value != 0:
246
        move_ether(
247
            tx_state,
248
            message.caller,
249
            message.current_target,
250
            message.value,
251
        )
252
253
    try:
254
        if evm.message.code_address in PRE_COMPILED_CONTRACTS:
255
            evm_trace(evm, PrecompileStart(evm.message.code_address))
256
            PRE_COMPILED_CONTRACTS[evm.message.code_address](evm)
257
            evm_trace(evm, PrecompileEnd())
258
        else:
259
            while evm.running and evm.pc < ulen(evm.code):
260
                try:
261
                    op = Ops(evm.code[evm.pc])
262
                except ValueError as e:
263
                    raise InvalidOpcode(evm.code[evm.pc]) from e
264
265
                evm_trace(evm, OpStart(op))
266
                op_implementation[op](evm)
267
                evm_trace(evm, OpEnd())
268
269
            evm_trace(evm, EvmStop(Ops.STOP))
270
271
    except ExceptionalHalt as error:
272
        evm_trace(evm, OpException(error))
273
        evm.gas_left = Uint(0)
274
        evm.output = b""
275
        evm.error = error
276
    except Revert as error:
277
        evm_trace(evm, OpException(error))
278
        evm.error = error
279
280
    if evm.error:
281
        restore_tx_state(tx_state, snapshot)
282
    return evm