ethereum.muir_glacier.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

59
STACK_DEPTH_LIMIT = U256(1024)

MAX_CODE_SIZE

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

gas_left

78
    gas_left: Uint

refund_counter

79
    refund_counter: U256

logs

80
    logs: Tuple[Log, ...]

accounts_to_delete

81
    accounts_to_delete: Set[Address]

touched_accounts

82
    touched_accounts: Iterable[Address]

error

83
    error: Optional[Exception]

process_message_call

If message.current 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.

env : External items required for EVM execution.

Returns

output : MessageCallOutput Output of the message call

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

process_create_message

Executes a call to create a smart contract.

Parameters

message : Transaction specific items. env : External items required for EVM execution.

Returns

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

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

process_message

Executes a call to create a smart contract.

Parameters

message : Transaction specific items. env : External items required for EVM execution.

Returns

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

def process_message(message: Message, ​​env: Environment) -> Evm:
201
    """
202
    Executes a call to create a smart contract.
203
204
    Parameters
205
    ----------
206
    message :
207
        Transaction specific items.
208
    env :
209
        External items required for EVM execution.
210
211
    Returns
212
    -------
213
    evm: :py:class:`~ethereum.muir_glacier.vm.Evm`
214
        Items containing execution specific objects
215
    """
216
    if message.depth > STACK_DEPTH_LIMIT:
217
        raise StackDepthLimitError("Stack depth limit reached")
218
219
    # take snapshot of state before processing the message
220
    begin_transaction(env.state)
221
222
    touch_account(env.state, message.current_target)
223
224
    if message.should_transfer_value and message.value != 0:
225
        move_ether(
226
            env.state, message.caller, message.current_target, message.value
227
        )
228
229
    evm = execute_code(message, env)
230
    if evm.error:
231
        # revert state to the last saved checkpoint
232
        # since the message call resulted in an error
233
        rollback_transaction(env.state)
234
    else:
235
        commit_transaction(env.state)
236
    return evm

execute_code

Executes bytecode present in the message.

Parameters

message : Transaction specific items. env : External items required for EVM execution.

Returns

evm: ethereum.vm.EVM Items containing execution specific objects

def execute_code(message: Message, ​​env: Environment) -> Evm:
240
    """
241
    Executes bytecode present in the `message`.
242
243
    Parameters
244
    ----------
245
    message :
246
        Transaction specific items.
247
    env :
248
        External items required for EVM execution.
249
250
    Returns
251
    -------
252
    evm: `ethereum.vm.EVM`
253
        Items containing execution specific objects
254
    """
255
    code = message.code
256
    valid_jump_destinations = get_valid_jump_destinations(code)
257
258
    evm = Evm(
259
        pc=Uint(0),
260
        stack=[],
261
        memory=bytearray(),
262
        code=code,
263
        gas_left=message.gas,
264
        env=env,
265
        valid_jump_destinations=valid_jump_destinations,
266
        logs=(),
267
        refund_counter=0,
268
        running=True,
269
        message=message,
270
        output=b"",
271
        accounts_to_delete=set(),
272
        touched_accounts=set(),
273
        return_data=b"",
274
        error=None,
275
    )
276
    try:
277
        if evm.message.code_address in PRE_COMPILED_CONTRACTS:
278
            evm_trace(evm, PrecompileStart(evm.message.code_address))
279
            PRE_COMPILED_CONTRACTS[evm.message.code_address](evm)
280
            evm_trace(evm, PrecompileEnd())
281
            return evm
282
283
        while evm.running and evm.pc < len(evm.code):
284
            try:
285
                op = Ops(evm.code[evm.pc])
286
            except ValueError:
287
                raise InvalidOpcode(evm.code[evm.pc])
288
289
            evm_trace(evm, OpStart(op))
290
            op_implementation[op](evm)
291
            evm_trace(evm, OpEnd())
292
293
        evm_trace(evm, EvmStop(Ops.STOP))
294
295
    except ExceptionalHalt as error:
296
        evm_trace(evm, OpException(error))
297
        evm.gas_left = Uint(0)
298
        evm.output = b""
299
        evm.error = error
300
    except Revert as error:
301
        evm_trace(evm, OpException(error))
302
        evm.error = error
303
    return evm