ethereum.spurious_dragon.vm.interpreterethereum.byzantium.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.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.

Returns

output : MessageCallOutput Output of the message call

def process_message_call(message: Message) -> MessageCallOutput:
91
    """
92
    If `message.current` 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
    block_env = message.block_env
106
    refund_counter = U256(0)
107
    if message.target == Bytes0(b""):
108
        is_collision = account_has_code_or_nonce(
109
            block_env.state, message.current_target
110
        ) or account_has_storage(block_env.state, message.current_target)
111
        if is_collision:
112
            return MessageCallOutput(
113
                Uint(0), U256(0), tuple(), set(), set(), AddressCollision()
114
            )
115
        else:
116
            evm = process_create_message(message)
117
    else:
118
        evm = process_message(message)
119
        if account_exists_and_is_empty(
120
            block_env.state, Address(message.target)
121
        ):
122
            evm.touched_accounts.add(Address(message.target))
123
124
    if evm.error:
125
        logs: Tuple[Log, ...] = ()
126
        accounts_to_delete = set()
127
        touched_accounts = set()
128
    else:
129
        logs = evm.logs
130
        accounts_to_delete = evm.accounts_to_delete
131
        touched_accounts = evm.touched_accounts
132
        refund_counter += U256(evm.refund_counter)
133
134
    tx_end = TransactionEnd(
135
        int(message.gas) - int(evm.gas_left), evm.output, evm.error
136
    )
137
    evm_trace(evm, tx_end)
138
139
    return MessageCallOutput(
140
        gas_left=evm.gas_left,
141
        refund_counter=refund_counter,
142
        logs=logs,
143
        accounts_to_delete=accounts_to_delete,
144
        touched_accounts=touched_accounts,
145
        error=evm.error,
146
    )

process_create_message

Executes a call to create a smart contract.

Parameters

message : Transaction specific items.

Returns

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

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

process_message

Move ether and execute the relevant code.

Parameters

message : Transaction specific items.

Returns

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

def process_message(message: Message) -> Evm:
198
    """
199
    Move ether and execute the relevant code.
200
201
    Parameters
202
    ----------
203
    message :
204
        Transaction specific items.
205
206
    Returns
207
    -------
206
    evm: :py:class:`~ethereum.spurious_dragon.vm.Evm`
208
    evm: :py:class:`~ethereum.byzantium.vm.Evm`
209
        Items containing execution specific objects
210
    """
211
    state = message.block_env.state
212
    if message.depth > STACK_DEPTH_LIMIT:
213
        raise StackDepthLimitError("Stack depth limit reached")
214
215
    # take snapshot of state before processing the message
216
    begin_transaction(state)
217
218
    touch_account(state, message.current_target)
219
220
    if message.should_transfer_value and message.value != 0:
221
        move_ether(
222
            state, message.caller, message.current_target, message.value
223
        )
224
225
    evm = execute_code(message)
226
    if evm.error:
227
        # revert state to the last saved checkpoint
228
        # since the message call resulted in an error
229
        rollback_transaction(state)
230
    else:
231
        commit_transaction(state)
232
    return evm

execute_code

Executes bytecode present in the message.

Parameters

message : Transaction specific items.

Returns

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

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