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

ethereum/forks/byzantium/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
+from ethereum_types.numeric import U64, U256, Uint
+
+from ethereum.crypto.hash import Hash32
+from ethereum.exceptions import EthereumException
+
+from ..blocks import Log, Receipt
+from ..fork_types import Address
+from ..state import State, account_exists_and_is_empty
+from ..transactions import Transaction
+from ..trie import Trie
+from .precompiled_contracts import RIPEMD160_ADDRESS
+
+__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
+    time: U256
+    difficulty: Uint
+
+
+@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.
+    """
+
+    block_gas_used: Uint = Uint(0)
+    transactions_trie: Trie[Bytes, Optional[Transaction]] = field(
+        default_factory=lambda: Trie(secured=False, default=None)
+    )
+    receipts_trie: Trie[Bytes, Optional[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)
+
+
+@dataclass
+class TransactionEnvironment:
+    """
+    Items that are used by contract creation or message call.
+    """
+
+    origin: Address
+    gas_price: Uint
+    gas: Uint
+    index_in_block: 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
+    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]
+    touched_accounts: Set[Address]
+    return_data: Bytes
+    error: Optional[EthereumException]
+
+
+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.touched_accounts.update(child_evm.touched_accounts)
+    if account_exists_and_is_empty(
+        evm.message.block_env.state, child_evm.message.current_target
+    ):
+        evm.touched_accounts.add(child_evm.message.current_target)
+
+
+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.
+
+    """
+    # In block 2675119, the empty account at 0x3 (the RIPEMD160 precompile) was
+    # cleared despite running out of gas. This is an obscure edge case that can
+    # only happen to a precompile.
+    # According to the general rules governing clearing of empty accounts, the
+    # touch should have been reverted. Due to client bugs, this event went
+    # unnoticed and 0x3 has been exempted from the rule that touches are
+    # reverted in order to preserve this historical behaviour.
+    if RIPEMD160_ADDRESS in child_evm.touched_accounts:
+        evm.touched_accounts.add(RIPEMD160_ADDRESS)
+    if child_evm.message.current_target == RIPEMD160_ADDRESS:
+        if account_exists_and_is_empty(
+            evm.message.block_env.state, child_evm.message.current_target
+        ):
+            evm.touched_accounts.add(RIPEMD160_ADDRESS)
+    evm.gas_left += child_evm.gas_left

ethereum/forks/byzantium/vm/exceptions.py

@@ -0,0 +1,123 @@
+"""
+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 AddressCollision(ExceptionalHalt):
+    """
+    Raised when the new contract address has a collision.
+    """
+
+    pass

ethereum/forks/byzantium/vm/gas.py

@@ -0,0 +1,245 @@
+"""
+Ethereum Virtual Machine (EVM) Gas.
+
+.. contents:: Table of Contents
+    :backlinks: none
+    :local:
+
+Introduction
+------------
+
+EVM gas constants and calculators.
+"""
+
+from dataclasses import dataclass
+from typing import List, Tuple
+
+from ethereum_types.numeric import U256, Uint
+
+from ethereum.trace import GasAndRefund, evm_trace
+from ethereum.utils.numeric import ceil32
+
+from . import Evm
+from .exceptions import OutOfGasError
+
+GAS_JUMPDEST = Uint(1)
+GAS_BASE = Uint(2)
+GAS_VERY_LOW = Uint(3)
+GAS_SLOAD = Uint(200)
+GAS_STORAGE_SET = Uint(20000)
+GAS_STORAGE_UPDATE = Uint(5000)
+GAS_STORAGE_CLEAR_REFUND = Uint(15000)
+GAS_LOW = Uint(5)
+GAS_MID = Uint(8)
+GAS_HIGH = Uint(10)
+GAS_EXPONENTIATION = Uint(10)
+GAS_EXPONENTIATION_PER_BYTE = Uint(50)
+GAS_MEMORY = Uint(3)
+GAS_KECCAK256 = Uint(30)
+GAS_KECCAK256_WORD = Uint(6)
+GAS_COPY = Uint(3)
+GAS_BLOCK_HASH = Uint(20)
+GAS_EXTERNAL = Uint(700)
+GAS_BALANCE = Uint(400)
+GAS_LOG = Uint(375)
+GAS_LOG_DATA = Uint(8)
+GAS_LOG_TOPIC = Uint(375)
+GAS_CREATE = Uint(32000)
+GAS_CODE_DEPOSIT = Uint(200)
+GAS_ZERO = Uint(0)
+GAS_CALL = Uint(700)
+GAS_NEW_ACCOUNT = Uint(25000)
+GAS_CALL_VALUE = Uint(9000)
+GAS_CALL_STIPEND = Uint(2300)
+GAS_SELF_DESTRUCT = Uint(5000)
+GAS_SELF_DESTRUCT_NEW_ACCOUNT = Uint(25000)
+REFUND_SELF_DESTRUCT = 24000
+GAS_ECRECOVER = Uint(3000)
+GAS_SHA256 = Uint(60)
+GAS_SHA256_WORD = Uint(12)
+GAS_RIPEMD160 = Uint(600)
+GAS_RIPEMD160_WORD = Uint(120)
+GAS_IDENTITY = Uint(15)
+GAS_IDENTITY_WORD = Uint(3)
+GAS_RETURN_DATA_COPY = Uint(3)
+
+
+@dataclass
+class ExtendMemory:
+    """
+    Define the parameters for memory extension in opcodes.
+
+    `cost`: `ethereum.base_types.Uint`
+        The gas required to perform the extension
+    `expand_by`: `ethereum.base_types.Uint`
+        The size by which the memory will be extended
+    """
+
+    cost: Uint
+    expand_by: Uint
+
+
+@dataclass
+class MessageCallGas:
+    """
+    Define the gas cost and gas given to the sub-call for
+    executing the call opcodes.
+
+    `cost`: `ethereum.base_types.Uint`
+        The gas required to execute the call opcode, excludes
+        memory expansion costs.
+    `sub_call`: `ethereum.base_types.Uint`
+        The portion of gas available to sub-calls that is refundable
+        if not consumed.
+    """
+
+    cost: Uint
+    sub_call: Uint
+
+
+def charge_gas(evm: Evm, amount: Uint) -> None:
+    """
+    Subtracts `amount` from `evm.gas_left`.
+
+    Parameters
+    ----------
+    evm :
+        The current EVM.
+    amount :
+        The amount of gas the current operation requires.
+
+    """
+    evm_trace(evm, GasAndRefund(int(amount)))
+
+    if evm.gas_left < amount:
+        raise OutOfGasError
+    else:
+        evm.gas_left -= amount
+
+
+def calculate_memory_gas_cost(size_in_bytes: Uint) -> Uint:
+    """
+    Calculates the gas cost for allocating memory
+    to the smallest multiple of 32 bytes,
+    such that the allocated size is at least as big as the given size.
+
+    Parameters
+    ----------
+    size_in_bytes :
+        The size of the data in bytes.
+
+    Returns
+    -------
+    total_gas_cost : `ethereum.base_types.Uint`
+        The gas cost for storing data in memory.
+
+    """
+    size_in_words = ceil32(size_in_bytes) // Uint(32)
+    linear_cost = size_in_words * GAS_MEMORY
+    quadratic_cost = size_in_words ** Uint(2) // Uint(512)
+    total_gas_cost = linear_cost + quadratic_cost
+    try:
+        return total_gas_cost
+    except ValueError as e:
+        raise OutOfGasError from e
+
+
+def calculate_gas_extend_memory(
+    memory: bytearray, extensions: List[Tuple[U256, U256]]
+) -> ExtendMemory:
+    """
+    Calculates the gas amount to extend memory.
+
+    Parameters
+    ----------
+    memory :
+        Memory contents of the EVM.
+    extensions:
+        List of extensions to be made to the memory.
+        Consists of a tuple of start position and size.
+
+    Returns
+    -------
+    extend_memory: `ExtendMemory`
+
+    """
+    size_to_extend = Uint(0)
+    to_be_paid = Uint(0)
+    current_size = Uint(len(memory))
+    for start_position, size in extensions:
+        if size == 0:
+            continue
+        before_size = ceil32(current_size)
+        after_size = ceil32(Uint(start_position) + Uint(size))
+        if after_size <= before_size:
+            continue
+
+        size_to_extend += after_size - before_size
+        already_paid = calculate_memory_gas_cost(before_size)
+        total_cost = calculate_memory_gas_cost(after_size)
+        to_be_paid += total_cost - already_paid
+
+        current_size = after_size
+
+    return ExtendMemory(to_be_paid, size_to_extend)
+
+
+def calculate_message_call_gas(
+    value: U256,
+    gas: Uint,
+    gas_left: Uint,
+    memory_cost: Uint,
+    extra_gas: Uint,
+    call_stipend: Uint = GAS_CALL_STIPEND,
+) -> MessageCallGas:
+    """
+    Calculates the MessageCallGas (cost and gas made available to the sub-call)
+    for executing call Opcodes.
+
+    Parameters
+    ----------
+    value:
+        The amount of `ETH` that needs to be transferred.
+    gas :
+        The amount of gas provided to the message-call.
+    gas_left :
+        The amount of gas left in the current frame.
+    memory_cost :
+        The amount needed to extend the memory in the current frame.
+    extra_gas :
+        The amount of gas needed for transferring value + creating a new
+        account inside a message call.
+    call_stipend :
+        The amount of stipend provided to a message call to execute code while
+        transferring value(ETH).
+
+    Returns
+    -------
+    message_call_gas: `MessageCallGas`
+
+    """
+    call_stipend = Uint(0) if value == 0 else call_stipend
+    if gas_left < extra_gas + memory_cost:
+        return MessageCallGas(gas + extra_gas, gas + call_stipend)
+
+    gas = min(gas, max_message_call_gas(gas_left - memory_cost - extra_gas))
+
+    return MessageCallGas(gas + extra_gas, gas + call_stipend)
+
+
+def max_message_call_gas(gas: Uint) -> Uint:
+    """
+    Calculates the maximum gas that is allowed for making a message call.
+
+    Parameters
+    ----------
+    gas :
+        The amount of gas provided to the message-call.
+
+    Returns
+    -------
+    max_allowed_message_call_gas: `ethereum.base_types.Uint`
+        The maximum gas allowed for making the message-call.
+
+    """
+    return gas - (gas // Uint(64))