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

60
STACK_DEPTH_LIMIT = Uint(1024)

MAX_CODE_SIZE

61
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.
64
@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]

touched_accounts

83
    touched_accounts: Set[Address]

error

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

process_create_message

Executes a call to create a smart contract.

Parameters

message : Transaction specific items.

Returns

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

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

process_message

Move ether and execute the relevant code.

Parameters

message : Transaction specific items.

Returns

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

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