ethereum.forks.berlin.vm

Ethereum Virtual Machine (EVM).

.. contents:: Table of Contents :backlinks: none :local:

Introduction

The abstract computer which runs the code stored in an .fork_types.Account.

__all__

31
__all__ = ("Environment", "Evm", "Message")

BlockEnvironment

Items external to the virtual machine itself, provided by the environment.

34
@dataclass
class BlockEnvironment:

chain_id

40
    chain_id: U64

state

41
    state: State

block_gas_limit

42
    block_gas_limit: Uint

block_hashes

43
    block_hashes: List[Hash32]

coinbase

44
    coinbase: Address

number

45
    number: Uint

time

46
    time: U256

difficulty

47
    difficulty: Uint

BlockOutput

Output from applying the block body to the present state.

Contains the following:

block_gas_used : ethereum.base_types.Uint Gas used for executing all transactions. transactions_trie : ethereum.fork_types.Root Trie of all the transactions in the block. receipts_trie : ethereum.fork_types.Root Trie root of all the receipts in the block. receipt_keys : Key of all the receipts in the block. block_logs : Bloom Logs bloom of all the logs included in all the transactions of the block.

50
@dataclass
class BlockOutput:

block_gas_used

70
    block_gas_used: Uint = Uint(0)

transactions_trie

71
    transactions_trie: Trie[Bytes, Optional[Bytes | LegacyTransaction]] = (
72
        field(default_factory=lambda: Trie(secured=False, default=None))
73
    )

receipts_trie

74
    receipts_trie: Trie[Bytes, Optional[Bytes | Receipt]] = field(
75
        default_factory=lambda: Trie(secured=False, default=None)
76
    )

receipt_keys

77
    receipt_keys: Tuple[Bytes, ...] = field(default_factory=tuple)

block_logs

78
    block_logs: Tuple[Log, ...] = field(default_factory=tuple)

TransactionEnvironment

Items that are used by contract creation or message call.

81
@dataclass
class TransactionEnvironment:

origin

87
    origin: Address

gas_price

88
    gas_price: Uint

gas

89
    gas: Uint

access_list_addresses

90
    access_list_addresses: Set[Address]

access_list_storage_keys

91
    access_list_storage_keys: Set[Tuple[Address, Bytes32]]

index_in_block

92
    index_in_block: Optional[Uint]

tx_hash

93
    tx_hash: Optional[Hash32]

Message

Items that are used by contract creation or message call.

96
@dataclass
class Message:

block_env

102
    block_env: BlockEnvironment

tx_env

103
    tx_env: TransactionEnvironment

caller

104
    caller: Address

target

105
    target: Bytes0 | Address

current_target

106
    current_target: Address

gas

107
    gas: Uint

value

108
    value: U256

data

109
    data: Bytes

code_address

110
    code_address: Optional[Address]

code

111
    code: Bytes

depth

112
    depth: Uint

should_transfer_value

113
    should_transfer_value: bool

is_static

114
    is_static: bool

accessed_addresses

115
    accessed_addresses: Set[Address]

accessed_storage_keys

116
    accessed_storage_keys: Set[Tuple[Address, Bytes32]]

parent_evm

117
    parent_evm: Optional["Evm"]

Evm

The internal state of the virtual machine.

120
@dataclass
class Evm:

pc

124
    pc: Uint

stack

125
    stack: List[U256]

memory

126
    memory: bytearray

code

127
    code: Bytes

gas_left

128
    gas_left: Uint

valid_jump_destinations

129
    valid_jump_destinations: Set[Uint]

logs

130
    logs: Tuple[Log, ...]

refund_counter

131
    refund_counter: int

running

132
    running: bool

message

133
    message: Message

output

134
    output: Bytes

accounts_to_delete

135
    accounts_to_delete: Set[Address]

touched_accounts

136
    touched_accounts: Set[Address]

return_data

137
    return_data: Bytes

error

138
    error: Optional[EthereumException]

accessed_addresses

139
    accessed_addresses: Set[Address]

accessed_storage_keys

140
    accessed_storage_keys: Set[Tuple[Address, Bytes32]]

incorporate_child_on_success

Incorporate the state of a successful child_evm into the parent evm.

Parameters

evm : The parent EVM. child_evm : The child evm to incorporate.

def incorporate_child_on_success(​evm: Evm, ​​child_evm: Evm​) -> None:
144
    """
145
    Incorporate the state of a successful `child_evm` into the parent `evm`.
146
147
    Parameters
148
    ----------
149
    evm :
150
        The parent `EVM`.
151
    child_evm :
152
        The child evm to incorporate.
153
154
    """
155
    evm.gas_left += child_evm.gas_left
156
    evm.logs += child_evm.logs
157
    evm.refund_counter += child_evm.refund_counter
158
    evm.accounts_to_delete.update(child_evm.accounts_to_delete)
159
    evm.touched_accounts.update(child_evm.touched_accounts)
160
    if account_exists_and_is_empty(
161
        evm.message.block_env.state, child_evm.message.current_target
162
    ):
163
        evm.touched_accounts.add(child_evm.message.current_target)
164
    evm.accessed_addresses.update(child_evm.accessed_addresses)
165
    evm.accessed_storage_keys.update(child_evm.accessed_storage_keys)

incorporate_child_on_error

Incorporate the state of an unsuccessful child_evm into the parent evm.

Parameters

evm : The parent EVM. child_evm : The child evm to incorporate.

def incorporate_child_on_error(​evm: Evm, ​​child_evm: Evm​) -> None:
169
    """
170
    Incorporate the state of an unsuccessful `child_evm` into the parent `evm`.
171
172
    Parameters
173
    ----------
174
    evm :
175
        The parent `EVM`.
176
    child_evm :
177
        The child evm to incorporate.
178
179
    """
180
    # In block 2675119, the empty account at 0x3 (the RIPEMD160 precompile) was
181
    # cleared despite running out of gas. This is an obscure edge case that can
182
    # only happen to a precompile.
183
    # According to the general rules governing clearing of empty accounts, the
184
    # touch should have been reverted. Due to client bugs, this event went
185
    # unnoticed and 0x3 has been exempted from the rule that touches are
186
    # reverted in order to preserve this historical behaviour.
187
    if RIPEMD160_ADDRESS in child_evm.touched_accounts:
188
        evm.touched_accounts.add(RIPEMD160_ADDRESS)
189
    if child_evm.message.current_target == RIPEMD160_ADDRESS:
190
        if account_exists_and_is_empty(
191
            evm.message.block_env.state, child_evm.message.current_target
192
        ):
193
            evm.touched_accounts.add(RIPEMD160_ADDRESS)
194
    evm.gas_left += child_evm.gas_left