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

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
    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(
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(
124
            block_env.state, Address(message.target)
125
        ):
126
            evm.touched_accounts.add(Address(message.target))
127
128
    if evm.error:
129
        logs: Tuple[Log, ...] = ()
130
        accounts_to_delete = set()
131
        touched_accounts = set()
132
    else:
133
        logs = evm.logs
134
        accounts_to_delete = evm.accounts_to_delete
135
        touched_accounts = evm.touched_accounts
136
        refund_counter += U256(evm.refund_counter)
137
138
    tx_end = TransactionEnd(
139
        int(message.gas) - int(evm.gas_left), evm.output, evm.error
140
    )
141
    evm_trace(evm, tx_end)
142
143
    return MessageCallOutput(
144
        gas_left=evm.gas_left,
145
        refund_counter=refund_counter,
146
        logs=logs,
147
        accounts_to_delete=accounts_to_delete,
148
        touched_accounts=touched_accounts,
149
        error=evm.error,
150
    )

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 Items containing execution specific objects.

def process_create_message(message: Message) -> Evm:
154
    """
155
    Executes a call to create a smart contract.
156
157
    Parameters
158
    ----------
159
    message :
160
        Transaction specific items.
161
162
    Returns
163
    -------
164
    evm: :py:class:`~ethereum.forks.byzantium.vm.Evm`
165
        Items containing execution specific objects.
166
167
    """
168
    state = message.block_env.state
169
    # take snapshot of state before processing the message
170
    begin_transaction(state)
171
172
    increment_nonce(state, message.current_target)
173
    evm = process_message(message)
174
    if not evm.error:
175
        contract_code = evm.output
176
        contract_code_gas = (
177
            Uint(len(contract_code)) * GAS_CODE_DEPOSIT_PER_BYTE
178
        )
179
        try:
180
            charge_gas(evm, contract_code_gas)
181
            if len(contract_code) > MAX_CODE_SIZE:
182
                raise OutOfGasError
183
        except ExceptionalHalt as error:
184
            rollback_transaction(state)
185
            evm.gas_left = Uint(0)
186
            evm.output = b""
187
            evm.error = error
188
        else:
189
            set_code(state, message.current_target, contract_code)
190
            commit_transaction(state)
191
    else:
192
        rollback_transaction(state)
193
    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 Items containing execution specific objects

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