ethereum.forks.cancun.vmethereum.forks.prague.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__

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

BlockEnvironment

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

33
@dataclass
class BlockEnvironment:

chain_id

39
    chain_id: U64

state

40
    state: State

block_gas_limit

41
    block_gas_limit: Uint

block_hashes

42
    block_hashes: List[Hash32]

coinbase

43
    coinbase: Address

number

44
    number: Uint

base_fee_per_gas

45
    base_fee_per_gas: Uint

time

46
    time: U256

prev_randao

47
    prev_randao: Bytes32

excess_blob_gas

48
    excess_blob_gas: U64

parent_beacon_block_root

49
    parent_beacon_block_root: Hash32

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. withdrawals_trie : ethereum.fork_types.Root Trie root of all the withdrawals in the block. blob_gas_used : ethereum.base_types.U64 Total blob gas used in the block. requests : Bytes Hash of all the requests in the block.

52
@dataclass
class BlockOutput:

block_gas_used

78
    block_gas_used: Uint = Uint(0)

transactions_trie

79
    transactions_trie: Trie[Bytes, Optional[Bytes | LegacyTransaction]] = (
80
        field(default_factory=lambda: Trie(secured=False, default=None))
81
    )

receipts_trie

82
    receipts_trie: Trie[Bytes, Optional[Bytes | Receipt]] = field(
83
        default_factory=lambda: Trie(secured=False, default=None)
84
    )

receipt_keys

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

block_logs

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

withdrawals_trie

87
    withdrawals_trie: Trie[Bytes, Optional[Bytes | Withdrawal]] = field(
88
        default_factory=lambda: Trie(secured=False, default=None)
89
    )

blob_gas_used

90
    blob_gas_used: U64 = U64(0)

requests

91
    requests: List[Bytes] = field(default_factory=list)

TransactionEnvironment

Items that are used by contract creation or message call.

94
@dataclass
class TransactionEnvironment:

origin

100
    origin: Address

gas_price

101
    gas_price: Uint

gas

102
    gas: Uint

access_list_addresses

103
    access_list_addresses: Set[Address]

access_list_storage_keys

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

transient_storage

105
    transient_storage: TransientStorage

blob_versioned_hashes

106
    blob_versioned_hashes: Tuple[VersionedHash, ...]

authorizations

107
    authorizations: Tuple[Authorization, ...]

index_in_block

108
    index_in_block: Optional[Uint]

tx_hash

109
    tx_hash: Optional[Hash32]

Message

Items that are used by contract creation or message call.

112
@dataclass
class Message:

block_env

118
    block_env: BlockEnvironment

tx_env

119
    tx_env: TransactionEnvironment

caller

120
    caller: Address

target

121
    target: Bytes0 | Address

current_target

122
    current_target: Address

gas

123
    gas: Uint

value

124
    value: U256

data

125
    data: Bytes

code_address

126
    code_address: Optional[Address]

code

127
    code: Bytes

depth

128
    depth: Uint

should_transfer_value

129
    should_transfer_value: bool

is_static

130
    is_static: bool

accessed_addresses

131
    accessed_addresses: Set[Address]

accessed_storage_keys

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

disable_precompiles

133
    disable_precompiles: bool

parent_evm

134
    parent_evm: Optional["Evm"]

Evm

The internal state of the virtual machine.

137
@dataclass
class Evm:

pc

141
    pc: Uint

stack

142
    stack: List[U256]

memory

143
    memory: bytearray

code

144
    code: Bytes

gas_left

145
    gas_left: Uint

valid_jump_destinations

146
    valid_jump_destinations: Set[Uint]

logs

147
    logs: Tuple[Log, ...]

refund_counter

148
    refund_counter: int

running

149
    running: bool

message

150
    message: Message

output

151
    output: Bytes

accounts_to_delete

152
    accounts_to_delete: Set[Address]

return_data

153
    return_data: Bytes

error

154
    error: Optional[EthereumException]

accessed_addresses

155
    accessed_addresses: Set[Address]

accessed_storage_keys

156
    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:
160
    """
161
    Incorporate the state of a successful `child_evm` into the parent `evm`.
162
163
    Parameters
164
    ----------
165
    evm :
166
        The parent `EVM`.
167
    child_evm :
168
        The child evm to incorporate.
169
170
    """
171
    evm.gas_left += child_evm.gas_left
172
    evm.logs += child_evm.logs
173
    evm.refund_counter += child_evm.refund_counter
174
    evm.accounts_to_delete.update(child_evm.accounts_to_delete)
175
    evm.accessed_addresses.update(child_evm.accessed_addresses)
176
    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:
180
    """
181
    Incorporate the state of an unsuccessful `child_evm` into the parent `evm`.
182
183
    Parameters
184
    ----------
185
    evm :
186
        The parent `EVM`.
187
    child_evm :
188
        The child evm to incorporate.
189
190
    """
191
    evm.gas_left += child_evm.gas_left