ethereum.forks.byzantium.vm.interpreterethereum.forks.constantinople.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. `touched_accounts`: Accounts that have been touched.
  6. `error`: The error from the execution if any.
65
@final
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
    <snip>
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.byzantium.vm.Evm~ethereum.forks.constantinople.vm.Evm Items containing execution specific objects.

def process_create_message(message: Message) -> Evm:
153
    <snip>
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
    increment_nonce(tx_state, message.current_target)
181
    evm = process_message(message)
182
    if not evm.error:
183
        contract_code = evm.output
184
        contract_code_gas = (
185
            ulen(contract_code) * GasCosts.CODE_DEPOSIT_PER_BYTE
186
        )
187
        try:
188
            charge_gas(evm, contract_code_gas)
189
            if len(contract_code) > MAX_CODE_SIZE:
190
                raise OutOfGasError
191
        except ExceptionalHalt as error:
192
            restore_tx_state(tx_state, snapshot)
193
            evm.gas_left = Uint(0)
194
            evm.output = b""
195
            evm.error = error
196
        else:
197
            set_code(tx_state, message.current_target, contract_code)
198
    else:
199
        restore_tx_state(tx_state, snapshot)
200
    return evm

process_message

Move ether and execute the relevant code.

Parameters

message : Transaction specific items.

Returns

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

def process_message(message: Message) -> Evm:
204
    <snip>
218
    tx_state = message.tx_env.state
219
    if message.depth > STACK_DEPTH_LIMIT:
220
        raise StackDepthLimitError("Stack depth limit reached")
221
222
    code = message.code
223
    valid_jump_destinations = get_valid_jump_destinations(code)
224
    evm = Evm(
225
        pc=Uint(0),
226
        stack=[],
227
        memory=bytearray(),
228
        code=code,
229
        gas_left=message.gas,
230
        valid_jump_destinations=valid_jump_destinations,
231
        logs=(),
232
        refund_counter=0,
233
        running=True,
234
        message=message,
235
        output=b"",
236
        accounts_to_delete=set(),
237
        touched_accounts=set(),
238
        return_data=b"",
239
        error=None,
240
    )
241
242
    # take snapshot of state before processing the message
243
    snapshot = copy_tx_state(tx_state)
244
245
    touch_account(tx_state, message.current_target)
246
247
    if message.should_transfer_value and message.value != 0:
248
        move_ether(
249
            tx_state,
250
            message.caller,
251
            message.current_target,
252
            message.value,
253
        )
254
255
    try:
256
        if evm.message.code_address in PRE_COMPILED_CONTRACTS:
257
            evm_trace(evm, PrecompileStart(evm.message.code_address))
258
            PRE_COMPILED_CONTRACTS[evm.message.code_address](evm)
259
            evm_trace(evm, PrecompileEnd())
260
        else:
261
            while evm.running and evm.pc < ulen(evm.code):
262
                try:
263
                    op = Ops(evm.code[evm.pc])
264
                except ValueError as e:
265
                    raise InvalidOpcode(evm.code[evm.pc]) from e
266
267
                evm_trace(evm, OpStart(op))
268
                op_implementation[op](evm)
269
                evm_trace(evm, OpEnd())
270
271
            evm_trace(evm, EvmStop(Ops.STOP))
272
273
    except ExceptionalHalt as error:
274
        evm_trace(evm, OpException(error))
275
        evm.gas_left = Uint(0)
276
        evm.output = b""
277
        evm.error = error
278
    except Revert as error:
279
        evm_trace(evm, OpException(error))
280
        evm.error = error
281
282
    if evm.error:
283
        restore_tx_state(tx_state, snapshot)
284
    return evm