ethereum.forks.constantinople.vmethereum.forks.istanbul.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[Transaction]] = field(
72
        default_factory=lambda: Trie(secured=False, default=None)
73
    )

receipts_trie

74
    receipts_trie: Trie[Bytes, Optional[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

index_in_block

90
    index_in_block: Uint

tx_hash

91
    tx_hash: Optional[Hash32]

Message

Items that are used by contract creation or message call.

94
@dataclass
class Message:

block_env

100
    block_env: BlockEnvironment

tx_env

101
    tx_env: TransactionEnvironment

caller

102
    caller: Address

target

103
    target: Bytes0 | Address

current_target

104
    current_target: Address

gas

105
    gas: Uint

value

106
    value: U256

data

107
    data: Bytes

code_address

108
    code_address: Optional[Address]

code

109
    code: Bytes

depth

110
    depth: Uint

should_transfer_value

111
    should_transfer_value: bool

is_static

112
    is_static: bool

parent_evm

113
    parent_evm: Optional["Evm"]

Evm

The internal state of the virtual machine.

116
@dataclass
class Evm:

pc

120
    pc: Uint

stack

121
    stack: List[U256]

memory

122
    memory: bytearray

code

123
    code: Bytes

gas_left

124
    gas_left: Uint

valid_jump_destinations

125
    valid_jump_destinations: Set[Uint]

logs

126
    logs: Tuple[Log, ...]

refund_counter

127
    refund_counter: int

running

128
    running: bool

message

129
    message: Message

output

130
    output: Bytes

accounts_to_delete

131
    accounts_to_delete: Set[Address]

touched_accounts

132
    touched_accounts: Set[Address]

return_data

133
    return_data: Bytes

error

134
    error: Optional[EthereumException]

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:
138
    """
139
    Incorporate the state of a successful `child_evm` into the parent `evm`.
140
141
    Parameters
142
    ----------
143
    evm :
144
        The parent `EVM`.
145
    child_evm :
146
        The child evm to incorporate.
147
148
    """
149
    evm.gas_left += child_evm.gas_left
150
    evm.logs += child_evm.logs
151
    evm.refund_counter += child_evm.refund_counter
152
    evm.accounts_to_delete.update(child_evm.accounts_to_delete)
153
    evm.touched_accounts.update(child_evm.touched_accounts)
154
    if account_exists_and_is_empty(
155
        evm.message.block_env.state, child_evm.message.current_target
156
    ):
157
        evm.touched_accounts.add(child_evm.message.current_target)

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