ethereum.muir_glacier.vmethereum.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__
| 32 | __all__ = ("Environment", "Evm", "Message") |
|---|
BlockEnvironment
Items external to the virtual machine itself, provided by the environment.
| 35 | @dataclass |
|---|
class BlockEnvironment:
chain_id
| 41 | chain_id: U64 |
|---|
state
| 42 | state: State |
|---|
block_gas_limit
| 43 | block_gas_limit: Uint |
|---|
block_hashes
| 44 | block_hashes: List[Hash32] |
|---|
coinbase
| 45 | coinbase: Address |
|---|
number
| 46 | number: Uint |
|---|
time
| 47 | time: U256 |
|---|
difficulty
| 48 | 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.
| 51 | @dataclass |
|---|
class BlockOutput:
block_gas_used
| 71 | block_gas_used: Uint = Uint(0) |
|---|
transactions_trie
| 72 | transactions_trie: Trie[Bytes, Optional[Transaction]] = field( |
|---|---|
| 73 | default_factory=lambda: Trie(secured=False, default=None) |
| 74 | ) |
| 72 | transactions_trie: Trie[ |
| 73 | Bytes, Optional[Union[Bytes, LegacyTransaction]] |
| 74 | ] = field(default_factory=lambda: Trie(secured=False, default=None)) |
receipts_trie
| 75 | receipts_trie: Trie[Bytes, Optional[Receipt]] = field( |
|---|---|
| 75 | receipts_trie: Trie[Bytes, Optional[Union[Bytes, Receipt]]] = field( |
| 76 | default_factory=lambda: Trie(secured=False, default=None) |
| 77 | ) |
receipt_keys
| 78 | receipt_keys: Tuple[Bytes, ...] = field(default_factory=tuple) |
|---|
block_logs
| 79 | block_logs: Tuple[Log, ...] = field(default_factory=tuple) |
|---|
TransactionEnvironment
Items that are used by contract creation or message call.
| 82 | @dataclass |
|---|
class TransactionEnvironment:
origin
| 88 | origin: Address |
|---|
gas_price
| 89 | gas_price: Uint |
|---|
gas
| 90 | gas: Uint |
|---|
access_list_addresses
| 91 | access_list_addresses: Set[Address] |
|---|
access_list_storage_keys
| 92 | access_list_storage_keys: Set[Tuple[Address, Bytes32]] |
|---|
index_in_block
| 91 | index_in_block: Uint |
|---|---|
| 93 | index_in_block: Optional[Uint] |
tx_hash
| 94 | tx_hash: Optional[Hash32] |
|---|
traces
| 95 | traces: List[dict] |
|---|
Message
Items that are used by contract creation or message call.
| 98 | @dataclass |
|---|
class Message:
block_env
| 104 | block_env: BlockEnvironment |
|---|
tx_env
| 105 | tx_env: TransactionEnvironment |
|---|
caller
| 106 | caller: Address |
|---|
target
| 107 | target: Union[Bytes0, Address] |
|---|
current_target
| 108 | current_target: Address |
|---|
gas
| 109 | gas: Uint |
|---|
value
| 110 | value: U256 |
|---|
data
| 111 | data: Bytes |
|---|
code_address
| 112 | code_address: Optional[Address] |
|---|
code
| 113 | code: Bytes |
|---|
depth
| 114 | depth: Uint |
|---|
should_transfer_value
| 115 | should_transfer_value: bool |
|---|
is_static
| 116 | is_static: bool |
|---|
accessed_addresses
| 117 | accessed_addresses: Set[Address] |
|---|
accessed_storage_keys
| 118 | accessed_storage_keys: Set[Tuple[Address, Bytes32]] |
|---|
parent_evm
| 119 | parent_evm: Optional["Evm"] |
|---|
Evm
The internal state of the virtual machine.
| 122 | @dataclass |
|---|
class Evm:
pc
| 126 | pc: Uint |
|---|
stack
| 127 | stack: List[U256] |
|---|
memory
| 128 | memory: bytearray |
|---|
code
| 129 | code: Bytes |
|---|
gas_left
| 130 | gas_left: Uint |
|---|
valid_jump_destinations
| 131 | valid_jump_destinations: Set[Uint] |
|---|
logs
| 132 | logs: Tuple[Log, ...] |
|---|
refund_counter
| 133 | refund_counter: int |
|---|
running
| 134 | running: bool |
|---|
message
| 135 | message: Message |
|---|
output
| 136 | output: Bytes |
|---|
accounts_to_delete
| 137 | accounts_to_delete: Set[Address] |
|---|
touched_accounts
| 138 | touched_accounts: Set[Address] |
|---|
return_data
| 139 | return_data: Bytes |
|---|
error
| 140 | error: Optional[EthereumException] |
|---|
accessed_addresses
| 141 | accessed_addresses: Set[Address] |
|---|
accessed_storage_keys
| 142 | 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:
| 146 | """ |
|---|---|
| 147 | Incorporate the state of a successful `child_evm` into the parent `evm`. |
| 148 | |
| 149 | Parameters |
| 150 | ---------- |
| 151 | evm : |
| 152 | The parent `EVM`. |
| 153 | child_evm : |
| 154 | The child evm to incorporate. |
| 155 | """ |
| 156 | evm.gas_left += child_evm.gas_left |
| 157 | evm.logs += child_evm.logs |
| 158 | evm.refund_counter += child_evm.refund_counter |
| 159 | evm.accounts_to_delete.update(child_evm.accounts_to_delete) |
| 160 | evm.touched_accounts.update(child_evm.touched_accounts) |
| 161 | if account_exists_and_is_empty( |
| 162 | evm.message.block_env.state, child_evm.message.current_target |
| 163 | ): |
| 158 | evm.touched_accounts.add(child_evm.message.current_target) |
| 164 | evm.touched_accounts.add(child_evm.message.current_target) |
| 165 | evm.accessed_addresses.update(child_evm.accessed_addresses) |
| 166 | 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:
| 170 | """ |
|---|---|
| 171 | Incorporate the state of an unsuccessful `child_evm` into the parent `evm`. |
| 172 | |
| 173 | Parameters |
| 174 | ---------- |
| 175 | evm : |
| 176 | The parent `EVM`. |
| 177 | child_evm : |
| 178 | The child evm to incorporate. |
| 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 |