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

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

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:
152
    """
153
    Executes a call to create a smart contract.
154
155
    Parameters
156
    ----------
157
    message :
158
        Transaction specific items.
159
160
    Returns
161
    -------
162
    evm: :py:class:`~ethereum.forks.constantinople.vm.Evm`
163
        Items containing execution specific objects.
164
165
    """
166
    tx_state = message.tx_env.state
167
    # take snapshot of state before processing the message
168
    snapshot = copy_tx_state(tx_state)
169
170
    # If the address where the account is being created has storage, it is
171
    # destroyed. This can only happen in the following highly unlikely
172
    # circumstances:
173
    # * The address created by a `CREATE` call collides with a subsequent
174
    #   `CREATE` or `CREATE2` call.
175
    # * The first `CREATE` happened before Spurious Dragon and left empty
176
    #   code.
177
    destroy_storage(tx_state, message.current_target)
178
179
    increment_nonce(tx_state, message.current_target)
180
    evm = process_message(message)
181
    if not evm.error:
182
        contract_code = evm.output
183
        contract_code_gas = (
184
            ulen(contract_code) * GasCosts.CODE_DEPOSIT_PER_BYTE
185
        )
186
        try:
187
            charge_gas(evm, contract_code_gas)
188
            if len(contract_code) > MAX_CODE_SIZE:
189
                raise OutOfGasError
190
        except ExceptionalHalt as error:
191
            restore_tx_state(tx_state, snapshot)
192
            evm.gas_left = Uint(0)
193
            evm.output = b""
194
            evm.error = error
195
        else:
196
            set_code(tx_state, message.current_target, contract_code)
197
    else:
198
        restore_tx_state(tx_state, snapshot)
199
    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:
203
    """
204
    Move ether and execute the relevant code.
205
206
    Parameters
207
    ----------
208
    message :
209
        Transaction specific items.
210
211
    Returns
212
    -------
213
    evm: :py:class:`~ethereum.forks.constantinople.vm.Evm`
214
        Items containing execution specific objects
215
216
    """
217
    tx_state = message.tx_env.state
218
    if message.depth > STACK_DEPTH_LIMIT:
219
        raise StackDepthLimitError("Stack depth limit reached")
220
221
    code = message.code
222
    valid_jump_destinations = get_valid_jump_destinations(code)
223
    evm = Evm(
224
        pc=Uint(0),
225
        stack=[],
226
        memory=bytearray(),
227
        code=code,
228
        gas_left=message.gas,
229
        valid_jump_destinations=valid_jump_destinations,
230
        logs=(),
231
        refund_counter=0,
232
        running=True,
233
        message=message,
234
        output=b"",
235
        accounts_to_delete=set(),
236
        touched_accounts=set(),
237
        return_data=b"",
238
        error=None,
239
    )
240
241
    # take snapshot of state before processing the message
242
    snapshot = copy_tx_state(tx_state)
243
244
    touch_account(tx_state, message.current_target)
245
246
    if message.should_transfer_value and message.value != 0:
247
        move_ether(
248
            tx_state,
249
            message.caller,
250
            message.current_target,
251
            message.value,
252
        )
253
254
    try:
255
        if evm.message.code_address in PRE_COMPILED_CONTRACTS:
256
            evm_trace(evm, PrecompileStart(evm.message.code_address))
257
            PRE_COMPILED_CONTRACTS[evm.message.code_address](evm)
258
            evm_trace(evm, PrecompileEnd())
259
        else:
260
            while evm.running and evm.pc < ulen(evm.code):
261
                try:
262
                    op = Ops(evm.code[evm.pc])
263
                except ValueError as e:
264
                    raise InvalidOpcode(evm.code[evm.pc]) from e
265
266
                evm_trace(evm, OpStart(op))
267
                op_implementation[op](evm)
268
                evm_trace(evm, OpEnd())
269
270
            evm_trace(evm, EvmStop(Ops.STOP))
271
272
    except ExceptionalHalt as error:
273
        evm_trace(evm, OpException(error))
274
        evm.gas_left = Uint(0)
275
        evm.output = b""
276
        evm.error = error
277
    except Revert as error:
278
        evm_trace(evm, OpException(error))
279
        evm.error = error
280
281
    if evm.error:
282
        restore_tx_state(tx_state, snapshot)
283
    return evm