ethereum-execution 2.18.0rc6.dev2__py3-none-any.whl

ethereum/forks/cancun/utils/message.py

@@ -0,0 +1,90 @@
+"""
+Hardfork Utility Functions For The Message Data-structure.
+
+.. contents:: Table of Contents
+    :backlinks: none
+    :local:
+
+Introduction
+------------
+
+Message specific functions used in this cancun version of
+specification.
+"""
+
+from ethereum_types.bytes import Bytes, Bytes0
+from ethereum_types.numeric import Uint
+
+from ..fork_types import Address
+from ..state import get_account
+from ..transactions import Transaction
+from ..vm import BlockEnvironment, Message, TransactionEnvironment
+from ..vm.precompiled_contracts.mapping import PRE_COMPILED_CONTRACTS
+from .address import compute_contract_address
+
+
+def prepare_message(
+    block_env: BlockEnvironment,
+    tx_env: TransactionEnvironment,
+    tx: Transaction,
+) -> Message:
+    """
+    Execute a transaction against the provided environment.
+
+    Parameters
+    ----------
+    block_env :
+        Environment for the Ethereum Virtual Machine.
+    tx_env :
+        Environment for the transaction.
+    tx :
+        Transaction to be executed.
+
+    Returns
+    -------
+    message: `ethereum.forks.cancun.vm.Message`
+        Items containing contract creation or message call specific data.
+
+    """
+    accessed_addresses = set()
+    accessed_addresses.add(tx_env.origin)
+    accessed_addresses.update(PRE_COMPILED_CONTRACTS.keys())
+    accessed_addresses.update(tx_env.access_list_addresses)
+
+    if isinstance(tx.to, Bytes0):
+        current_target = compute_contract_address(
+            tx_env.origin,
+            get_account(block_env.state, tx_env.origin).nonce - Uint(1),
+        )
+        msg_data = Bytes(b"")
+        code = tx.data
+        code_address = None
+    elif isinstance(tx.to, Address):
+        current_target = tx.to
+        msg_data = tx.data
+        code = get_account(block_env.state, tx.to).code
+
+        code_address = tx.to
+    else:
+        raise AssertionError("Target must be address or empty bytes")
+
+    accessed_addresses.add(current_target)
+
+    return Message(
+        block_env=block_env,
+        tx_env=tx_env,
+        caller=tx_env.origin,
+        target=tx.to,
+        gas=tx_env.gas,
+        value=tx.value,
+        data=msg_data,
+        code=code,
+        depth=Uint(0),
+        current_target=current_target,
+        code_address=code_address,
+        should_transfer_value=True,
+        is_static=False,
+        accessed_addresses=accessed_addresses,
+        accessed_storage_keys=set(tx_env.access_list_storage_keys),
+        parent_evm=None,
+    )

ethereum/forks/cancun/vm/__init__.py

@@ -0,0 +1,186 @@
+"""
+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`.
+"""
+
+from dataclasses import dataclass, field
+from typing import List, Optional, Set, Tuple
+
+from ethereum_types.bytes import Bytes, Bytes0, Bytes32
+from ethereum_types.numeric import U64, U256, Uint
+
+from ethereum.crypto.hash import Hash32
+from ethereum.exceptions import EthereumException
+
+from ..blocks import Log, Receipt, Withdrawal
+from ..fork_types import Address, VersionedHash
+from ..state import State, TransientStorage
+from ..transactions import LegacyTransaction
+from ..trie import Trie
+
+__all__ = ("Environment", "Evm", "Message")
+
+
+@dataclass
+class BlockEnvironment:
+    """
+    Items external to the virtual machine itself, provided by the environment.
+    """
+
+    chain_id: U64
+    state: State
+    block_gas_limit: Uint
+    block_hashes: List[Hash32]
+    coinbase: Address
+    number: Uint
+    base_fee_per_gas: Uint
+    time: U256
+    prev_randao: Bytes32
+    excess_blob_gas: U64
+    parent_beacon_block_root: Hash32
+
+
+@dataclass
+class 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.
+    """
+
+    block_gas_used: Uint = Uint(0)
+    transactions_trie: Trie[Bytes, Optional[Bytes | LegacyTransaction]] = (
+        field(default_factory=lambda: Trie(secured=False, default=None))
+    )
+    receipts_trie: Trie[Bytes, Optional[Bytes | Receipt]] = field(
+        default_factory=lambda: Trie(secured=False, default=None)
+    )
+    receipt_keys: Tuple[Bytes, ...] = field(default_factory=tuple)
+    block_logs: Tuple[Log, ...] = field(default_factory=tuple)
+    withdrawals_trie: Trie[Bytes, Optional[Bytes | Withdrawal]] = field(
+        default_factory=lambda: Trie(secured=False, default=None)
+    )
+    blob_gas_used: U64 = U64(0)
+
+
+@dataclass
+class TransactionEnvironment:
+    """
+    Items that are used by contract creation or message call.
+    """
+
+    origin: Address
+    gas_price: Uint
+    gas: Uint
+    access_list_addresses: Set[Address]
+    access_list_storage_keys: Set[Tuple[Address, Bytes32]]
+    transient_storage: TransientStorage
+    blob_versioned_hashes: Tuple[VersionedHash, ...]
+    index_in_block: Optional[Uint]
+    tx_hash: Optional[Hash32]
+
+
+@dataclass
+class Message:
+    """
+    Items that are used by contract creation or message call.
+    """
+
+    block_env: BlockEnvironment
+    tx_env: TransactionEnvironment
+    caller: Address
+    target: Bytes0 | Address
+    current_target: Address
+    gas: Uint
+    value: U256
+    data: Bytes
+    code_address: Optional[Address]
+    code: Bytes
+    depth: Uint
+    should_transfer_value: bool
+    is_static: bool
+    accessed_addresses: Set[Address]
+    accessed_storage_keys: Set[Tuple[Address, Bytes32]]
+    parent_evm: Optional["Evm"]
+
+
+@dataclass
+class Evm:
+    """The internal state of the virtual machine."""
+
+    pc: Uint
+    stack: List[U256]
+    memory: bytearray
+    code: Bytes
+    gas_left: Uint
+    valid_jump_destinations: Set[Uint]
+    logs: Tuple[Log, ...]
+    refund_counter: int
+    running: bool
+    message: Message
+    output: Bytes
+    accounts_to_delete: Set[Address]
+    return_data: Bytes
+    error: Optional[EthereumException]
+    accessed_addresses: Set[Address]
+    accessed_storage_keys: Set[Tuple[Address, Bytes32]]
+
+
+def incorporate_child_on_success(evm: Evm, child_evm: Evm) -> None:
+    """
+    Incorporate the state of a successful `child_evm` into the parent `evm`.
+
+    Parameters
+    ----------
+    evm :
+        The parent `EVM`.
+    child_evm :
+        The child evm to incorporate.
+
+    """
+    evm.gas_left += child_evm.gas_left
+    evm.logs += child_evm.logs
+    evm.refund_counter += child_evm.refund_counter
+    evm.accounts_to_delete.update(child_evm.accounts_to_delete)
+    evm.accessed_addresses.update(child_evm.accessed_addresses)
+    evm.accessed_storage_keys.update(child_evm.accessed_storage_keys)
+
+
+def incorporate_child_on_error(evm: Evm, child_evm: Evm) -> None:
+    """
+    Incorporate the state of an unsuccessful `child_evm` into the parent `evm`.
+
+    Parameters
+    ----------
+    evm :
+        The parent `EVM`.
+    child_evm :
+        The child evm to incorporate.
+
+    """
+    evm.gas_left += child_evm.gas_left

ethereum/forks/cancun/vm/exceptions.py

@@ -0,0 +1,139 @@
+"""
+Ethereum Virtual Machine (EVM) Exceptions.
+
+.. contents:: Table of Contents
+    :backlinks: none
+    :local:
+
+Introduction
+------------
+
+Exceptions which cause the EVM to halt exceptionally.
+"""
+
+from ethereum.exceptions import EthereumException
+
+
+class ExceptionalHalt(EthereumException):
+    """
+    Indicates that the EVM has experienced an exceptional halt. This causes
+    execution to immediately end with all gas being consumed.
+    """
+
+
+class Revert(EthereumException):
+    """
+    Raised by the `REVERT` opcode.
+
+    Unlike other EVM exceptions this does not result in the consumption of all
+    gas.
+    """
+
+    pass
+
+
+class StackUnderflowError(ExceptionalHalt):
+    """
+    Occurs when a pop is executed on an empty stack.
+    """
+
+    pass
+
+
+class StackOverflowError(ExceptionalHalt):
+    """
+    Occurs when a push is executed on a stack at max capacity.
+    """
+
+    pass
+
+
+class OutOfGasError(ExceptionalHalt):
+    """
+    Occurs when an operation costs more than the amount of gas left in the
+    frame.
+    """
+
+    pass
+
+
+class InvalidOpcode(ExceptionalHalt):
+    """
+    Raised when an invalid opcode is encountered.
+    """
+
+    code: int
+
+    def __init__(self, code: int) -> None:
+        super().__init__(code)
+        self.code = code
+
+
+class InvalidJumpDestError(ExceptionalHalt):
+    """
+    Occurs when the destination of a jump operation doesn't meet any of the
+    following criteria.
+
+      * The jump destination is less than the length of the code.
+      * The jump destination should have the `JUMPDEST` opcode (0x5B).
+      * The jump destination shouldn't be part of the data corresponding to
+        `PUSH-N` opcodes.
+    """
+
+
+class StackDepthLimitError(ExceptionalHalt):
+    """
+    Raised when the message depth is greater than `1024`.
+    """
+
+    pass
+
+
+class WriteInStaticContext(ExceptionalHalt):
+    """
+    Raised when an attempt is made to modify the state while operating inside
+    of a STATICCALL context.
+    """
+
+    pass
+
+
+class OutOfBoundsRead(ExceptionalHalt):
+    """
+    Raised when an attempt was made to read data beyond the
+    boundaries of the buffer.
+    """
+
+    pass
+
+
+class InvalidParameter(ExceptionalHalt):
+    """
+    Raised when invalid parameters are passed.
+    """
+
+    pass
+
+
+class InvalidContractPrefix(ExceptionalHalt):
+    """
+    Raised when the new contract code starts with 0xEF.
+    """
+
+    pass
+
+
+class AddressCollision(ExceptionalHalt):
+    """
+    Raised when the new contract address has a collision.
+    """
+
+    pass
+
+
+class KZGProofError(ExceptionalHalt):
+    """
+    Raised when the point evaluation precompile can't verify a proof.
+    """
+
+    pass