ethereum.forks.tangerine_whistle.vm.interpreterethereum.forks.spurious_dragon.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. `error`: The error from the execution if any.
  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
    block_env = message.block_env
105
    refund_counter = U256(0)
106
    if message.target == Bytes0(b""):
107
        is_collision = account_has_code_or_nonce(
108
            block_env.state, message.current_target
109
        ) or account_has_storage(block_env.state, message.current_target)
110
        if is_collision:
111
            return MessageCallOutput(
106
                Uint(0), U256(0), tuple(), set(), AddressCollision()
112
                Uint(0), U256(0), tuple(), set(), set(), AddressCollision()
113
            )
114
        else:
115
            evm = process_create_message(message)
116
    else:
111
        evm = process_message(message)
117
        evm = process_message(message)
118
        if account_exists_and_is_empty(
119
            block_env.state, Address(message.target)
120
        ):
121
            evm.touched_accounts.add(Address(message.target))
122
123
    if evm.error:
124
        logs: Tuple[Log, ...] = ()
115
        accounts_to_delete = set()
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.tangerine_whistle.vm.Evm~ethereum.forks.spurious_dragon.vm.Evm Items containing execution specific objects.

def process_create_message(message: Message) -> Evm:
149
    """
150
    Executes a call to create a smart contract.
151
152
    Parameters
153
    ----------
154
    message :
155
        Transaction specific items.
156
157
    Returns
158
    -------
146
    evm: :py:class:`~ethereum.forks.tangerine_whistle.vm.Evm`
159
    evm: :py:class:`~ethereum.forks.spurious_dragon.vm.Evm`
160
        Items containing execution specific objects.
161
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.
158
    # * The first `CREATE` left empty code.
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 = (
180
            Uint(len(contract_code)) * GAS_CODE_DEPOSIT_PER_BYTE
181
        )
182
        try:
168
            charge_gas(evm, contract_code_gas)
183
            charge_gas(evm, contract_code_gas)
184
            if len(contract_code) > MAX_CODE_SIZE:
185
                raise OutOfGasError
186
        except ExceptionalHalt as error:
187
            rollback_transaction(state)
188
            evm.gas_left = Uint(0)
189
            evm.error = error
190
        else:
191
            set_code(state, message.current_target, contract_code)
192
            commit_transaction(state)
193
    else:
194
        rollback_transaction(state)
195
    return evm

process_message

Move ether and execute the relevant code.

Parameters

message : Transaction specific items.

Returns

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

def process_message(message: Message) -> Evm:
199
    """
200
    Move ether and execute the relevant code.
201
202
    Parameters
203
    ----------
204
    message :
205
        Transaction specific items.
206
207
    Returns
208
    -------
192
    evm: :py:class:`~ethereum.forks.tangerine_whistle.vm.Evm`
209
    evm: :py:class:`~ethereum.forks.spurious_dragon.vm.Evm`
210
        Items containing execution specific objects
211
212
    """
213
    state = message.block_env.state
214
    if message.depth > STACK_DEPTH_LIMIT:
215
        raise StackDepthLimitError("Stack depth limit reached")
216
217
    code = message.code
218
    valid_jump_destinations = get_valid_jump_destinations(code)
219
    evm = Evm(
220
        pc=Uint(0),
221
        stack=[],
222
        memory=bytearray(),
223
        code=code,
224
        gas_left=message.gas,
225
        valid_jump_destinations=valid_jump_destinations,
226
        logs=(),
227
        refund_counter=0,
228
        running=True,
229
        message=message,
230
        output=b"",
231
        accounts_to_delete=set(),
232
        touched_accounts=set(),
233
        error=None,
234
    )
235
236
    # take snapshot of state before processing the message
237
    begin_transaction(state)
238
239
    touch_account(state, message.current_target)
240
241
    if message.should_transfer_value and message.value != 0:
242
        move_ether(
243
            state, message.caller, message.current_target, message.value
244
        )
245
246
    try:
247
        if evm.message.code_address in PRE_COMPILED_CONTRACTS:
248
            evm_trace(evm, PrecompileStart(evm.message.code_address))
249
            PRE_COMPILED_CONTRACTS[evm.message.code_address](evm)
250
            evm_trace(evm, PrecompileEnd())
251
        else:
252
            while evm.running and evm.pc < ulen(evm.code):
253
                try:
254
                    op = Ops(evm.code[evm.pc])
255
                except ValueError as e:
256
                    raise InvalidOpcode(evm.code[evm.pc]) from e
257
258
                evm_trace(evm, OpStart(op))
259
                op_implementation[op](evm)
260
                evm_trace(evm, OpEnd())
261
262
            evm_trace(evm, EvmStop(Ops.STOP))
263
264
    except ExceptionalHalt as error:
265
        evm_trace(evm, OpException(error))
266
        evm.gas_left = Uint(0)
267
        evm.error = error
268
269
    if evm.error:
270
        # revert state to the last saved checkpoint
271
        # since the message call resulted in an error
272
        rollback_transaction(state)
273
    else:
274
        commit_transaction(state)
275
    return evm