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

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
@final
65
@dataclass
class MessageCallOutput:

gas_left

80
    gas_left: Uint

refund_counter

81
    refund_counter: U256

logs

82
    logs: Tuple[Log, ...]

accounts_to_delete

83
    accounts_to_delete: Set[Address]

touched_accounts

84
    touched_accounts: Set[Address]

error

85
    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:
89
    <snip>
104
    tx_state = message.tx_env.state
105
    refund_counter = U256(0)
106
    if message.target == Bytes0(b""):
107
        if account_deployable(tx_state, message.current_target):
108
            evm = process_create_message(message)
109
        else:
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_message(message)
120
        if account_exists_and_is_empty(tx_state, Address(message.target)):
121
            evm.touched_accounts.add(Address(message.target))
122
123
    if evm.error:
124
        logs: Tuple[Log, ...] = ()
125
        accounts_to_delete = set()
126
        touched_accounts = set()
127
    else:
128
        logs = evm.logs
129
        accounts_to_delete = evm.accounts_to_delete
130
        touched_accounts = evm.touched_accounts
131
        refund_counter += U256(evm.refund_counter)
132
133
    tx_end = TransactionEnd(
134
        int(message.gas) - int(evm.gas_left), evm.output, evm.error
135
    )
136
    evm_trace(evm, tx_end)
137
138
    return MessageCallOutput(
139
        gas_left=evm.gas_left,
140
        refund_counter=refund_counter,
141
        logs=logs,
142
        accounts_to_delete=accounts_to_delete,
143
        touched_accounts=touched_accounts,
144
        error=evm.error,
145
    )

process_create_message

Executes a call to create a smart contract.

Parameters

message : Transaction specific items.

Returns

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

def process_create_message(message: Message) -> Evm:
149
    <snip>
163
    tx_state = message.tx_env.state
164
    # take snapshot of state before processing the message
165
    snapshot = copy_tx_state(tx_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 a `CREATE` call collides with a subsequent
171
    #   `CREATE` or `CREATE2` call.
172
    # * The first `CREATE` happened before Spurious Dragon and left empty
173
    #   code.
174
    destroy_storage(tx_state, message.current_target)
175
176
    increment_nonce(tx_state, message.current_target)
177
    evm = process_message(message)
178
    if not evm.error:
179
        contract_code = evm.output
180
        contract_code_gas = (
181
            ulen(contract_code) * GasCosts.CODE_DEPOSIT_PER_BYTE
182
        )
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
            restore_tx_state(tx_state, snapshot)
189
            evm.gas_left = Uint(0)
190
            evm.output = b""
191
            evm.error = error
192
        else:
193
            set_code(tx_state, message.current_target, contract_code)
194
    else:
195
        restore_tx_state(tx_state, snapshot)
196
    return evm

process_message

Move ether and execute the relevant code.

Parameters

message : Transaction specific items.

Returns

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

def process_message(message: Message) -> Evm:
200
    <snip>
214
    tx_state = message.tx_env.state
215
    if message.depth > STACK_DEPTH_LIMIT:
216
        raise StackDepthLimitError("Stack depth limit reached")
217
218
    code = message.code
219
    valid_jump_destinations = get_valid_jump_destinations(code)
220
    evm = Evm(
221
        pc=Uint(0),
222
        stack=[],
223
        memory=bytearray(),
224
        code=code,
225
        gas_left=message.gas,
226
        valid_jump_destinations=valid_jump_destinations,
227
        logs=(),
228
        refund_counter=0,
229
        running=True,
230
        message=message,
231
        output=b"",
232
        accounts_to_delete=set(),
233
        touched_accounts=set(),
234
        return_data=b"",
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.output = b""
273
        evm.error = error
274
    except Revert as error:
275
        evm_trace(evm, OpException(error))
276
        evm.error = error
277
278
    if evm.error:
279
        restore_tx_state(tx_state, snapshot)
280
    return evm