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

62
STACK_DEPTH_LIMIT = Uint(1024)

MAX_CODE_SIZE

63
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.
66
@dataclass
class MessageCallOutput:

gas_left

81
    gas_left: Uint

refund_counter

82
    refund_counter: U256

logs

83
    logs: Tuple[Log, ...]

accounts_to_delete

84
    accounts_to_delete: Set[Address]

touched_accounts

85
    touched_accounts: Set[Address]

error

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

process_create_message

Executes a call to create a smart contract.

Parameters

message : Transaction specific items.

Returns

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

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

process_message

Move ether and execute the relevant code.

Parameters

message : Transaction specific items.

Returns

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

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