diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000000..7d2e46cbd0 --- /dev/null +++ b/.flake8 @@ -0,0 +1,32 @@ +[flake8] +dictionaries=en_US,python,technical +docstring-convention = all +extend-ignore = + U101 + E203 + D107 + D200 + D203 + D205 + D212 + D400 + D401 + D410 + D411 + D412 + D413 + D414 + D415 + D416 + +extend-exclude = + doc/ + tests/fixtures/ + +per-file-ignores = + tests/*:D100,D101,D103,D104,E501,SC100,SC200 + +unused-arguments-ignore-abstract-functions = true +unused-arguments-ignore-override-functions = true +unused-arguments-ignore-overload-functions = true +unused-arguments-ignore-dunder = true diff --git a/.github/workflows/gh-pages.yaml b/.github/workflows/gh-pages.yaml index 6c49e56d31..4b801eebda 100644 --- a/.github/workflows/gh-pages.yaml +++ b/.github/workflows/gh-pages.yaml @@ -4,6 +4,8 @@ on: push: branches: - master + - mainnet + - 'forks/**' workflow_dispatch: pull_request: @@ -41,7 +43,7 @@ jobs: needs: build runs-on: ubuntu-latest name: "Deploy Documentation" - if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }} + if: ${{ github.event_name == 'push' && github.ref_name == github.event.repository.default_branch }} permissions: pages: write diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 66815e9a01..8274d6369e 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -4,6 +4,8 @@ on: push: branches: - master + - mainnet + - 'forks/**' workflow_dispatch: pull_request: @@ -43,7 +45,7 @@ jobs: - name: Run Tox (CPython) if: "${{ !startsWith(matrix.py, 'pypy') }}" - run: tox -e static,optimized,py3 + run: tox -e static,py3_eest,optimized,py3 - name: Run Tox (PyPy) if: "${{ startsWith(matrix.py, 'pypy') }}" diff --git a/.gitignore b/.gitignore index 144dc04c86..fd08eaf32b 100644 --- a/.gitignore +++ b/.gitignore @@ -58,3 +58,5 @@ pip-delete-this-directory.txt tests/execution-spec-generated-tests tests/fixtures tests/t8n_testdata + +fixtures diff --git a/.gitmodules b/.gitmodules index e69de29bb2..4e4c40f501 100644 --- a/.gitmodules +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "eest_tests/execution-spec-tests"] + path = eest_tests/execution-spec-tests + url = https://github.com/ethereum/execution-spec-tests.git diff --git a/README.md b/README.md index 9471f9672f..8e84adc3d5 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ Some clarifications were enabled without protocol releases: | [EIP-2681](https://eips.ethereum.org/EIPS/eip-2681) | 0 | | [EIP-3607](https://eips.ethereum.org/EIPS/eip-3607) | 0 | | [EIP-7523](https://eips.ethereum.org/EIPS/eip-7523) | 15537394 | -| [EIP-7610](https://github.com/ethereum/EIPs/pull/8161) | 0 | +| [EIP-7610](https://eips.ethereum.org/EIPS/eip-7610) | 0 | ## Execution Specification (work-in-progress) diff --git a/SECURITY.md b/SECURITY.md index 040e6e0292..1def537f6a 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -18,7 +18,7 @@ recommend using the [latest version](https://github.com/ethereum/execution-specs ### What Contitutes a Serious Issue - Issues which affect any production EL client (geth, Nethermind, Besu, etc.) -- EELS has inadvertantly leaked secure information into the codebase +- EELS has inadvertently leaked secure information into the codebase ### What Does _Not_ Constitute a Serious Issue diff --git a/eest_tests/conftest.py b/eest_tests/conftest.py new file mode 100644 index 0000000000..190ce053af --- /dev/null +++ b/eest_tests/conftest.py @@ -0,0 +1,8 @@ +import pytest +from ethereum_spec_tools.evm_tools.t8n.transition_tool import EELST8N +from ethereum_clis import TransitionTool + + +@pytest.hookimpl(tryfirst=True) +def pytest_configure(config): + TransitionTool.set_default_tool(EELST8N) diff --git a/eest_tests/execution-spec-tests b/eest_tests/execution-spec-tests new file mode 160000 index 0000000000..6cf5107cee --- /dev/null +++ b/eest_tests/execution-spec-tests @@ -0,0 +1 @@ +Subproject commit 6cf5107cee0eae1c2d4dd6a5ef5bc729aea6c379 diff --git a/network-upgrades/mainnet-upgrades/cancun.md b/network-upgrades/mainnet-upgrades/cancun.md index 897ad00263..82cf5c65ba 100644 --- a/network-upgrades/mainnet-upgrades/cancun.md +++ b/network-upgrades/mainnet-upgrades/cancun.md @@ -11,7 +11,7 @@ Execution layer changes included in the Network Upgrade. * [EIP-7516: BLOBBASEFEE opcode](https://eips.ethereum.org/EIPS/eip-7516) -### Implementation Progresss +### Implementation Progress Implementation status of Included EIPs across participating clients. diff --git a/pyproject.toml b/pyproject.toml index 7f7fcd68a4..3346190b51 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,216 @@ [build-system] -requires = ["setuptools", "wheel"] +requires = ["setuptools>=77.0.3", "wheel"] build-backend = "setuptools.build_meta" +[project] +name = "ethereum-execution" +description = "Ethereum execution layer specification, provided as a Python package for tooling and testing" +readme = "README.md" +requires-python = ">=3.11" +dynamic = ["version"] +license = "CC0-1.0" +urls = { "Homepage" = "https://github.com/ethereum/execution-specs" } +classifiers = [ + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: Implementation :: PyPy", + "Programming Language :: Python :: Implementation :: CPython", + "Intended Audience :: Developers", + "Natural Language :: English", +] +dependencies = [ + "pycryptodome>=3.22,<4", + "coincurve>=20,<21", + "typing_extensions>=4.4", + "py-ecc>=8.0.0b2,<9", + "ethereum-types>=0.2.1,<0.3", + "ethereum-rlp>=0.1.4,<0.2", + "cryptography>=45.0.1,<46", + "ethereum-execution-spec-tests @ git+https://github.com/ethereum/execution-spec-tests@6cf5107cee0eae1c2d4dd6a5ef5bc729aea6c379", + "ethereum-spec-evm-resolver @ git+https://github.com/petertdavies/ethereum-spec-evm-resolver", +] + +[tool.setuptools] +package-dir = {"" = "src"} +packages = [ + "ethereum_spec_tools", + "ethereum_spec_tools.evm_tools", + "ethereum_spec_tools.evm_tools.t8n", + "ethereum_spec_tools.evm_tools.b11r", + "ethereum_spec_tools.evm_tools.statetest", + "ethereum_spec_tools.evm_tools.loaders", + "ethereum_spec_tools.lint", + "ethereum_spec_tools.lint.lints", + "ethereum", + "ethereum.frontier", + "ethereum.frontier.utils", + "ethereum.frontier.vm", + "ethereum.frontier.vm.instructions", + "ethereum.frontier.vm.precompiled_contracts", + "ethereum.utils", + "ethereum.crypto", + "ethereum_optimized", + "ethereum.homestead", + "ethereum.homestead.utils", + "ethereum.homestead.vm", + "ethereum.homestead.vm.instructions", + "ethereum.homestead.vm.precompiled_contracts", + "ethereum.dao_fork", + "ethereum.dao_fork.utils", + "ethereum.dao_fork.vm", + "ethereum.dao_fork.vm.instructions", + "ethereum.dao_fork.vm.precompiled_contracts", + "ethereum.tangerine_whistle", + "ethereum.tangerine_whistle.utils", + "ethereum.tangerine_whistle.vm", + "ethereum.tangerine_whistle.vm.instructions", + "ethereum.tangerine_whistle.vm.precompiled_contracts", + "ethereum.spurious_dragon", + "ethereum.spurious_dragon.utils", + "ethereum.spurious_dragon.vm", + "ethereum.spurious_dragon.vm.instructions", + "ethereum.spurious_dragon.vm.precompiled_contracts", + "ethereum.byzantium", + "ethereum.byzantium.utils", + "ethereum.byzantium.vm", + "ethereum.byzantium.vm.instructions", + "ethereum.byzantium.vm.precompiled_contracts", + "ethereum.constantinople", + "ethereum.constantinople.utils", + "ethereum.constantinople.vm", + "ethereum.constantinople.vm.instructions", + "ethereum.constantinople.vm.precompiled_contracts", + "ethereum.istanbul", + "ethereum.istanbul.utils", + "ethereum.istanbul.vm", + "ethereum.istanbul.vm.instructions", + "ethereum.istanbul.vm.precompiled_contracts", + "ethereum.muir_glacier", + "ethereum.muir_glacier.utils", + "ethereum.muir_glacier.vm", + "ethereum.muir_glacier.vm.instructions", + "ethereum.muir_glacier.vm.precompiled_contracts", + "ethereum.berlin", + "ethereum.berlin.utils", + "ethereum.berlin.vm", + "ethereum.berlin.vm.instructions", + "ethereum.berlin.vm.precompiled_contracts", + "ethereum.london", + "ethereum.london.utils", + "ethereum.london.vm", + "ethereum.london.vm.instructions", + "ethereum.london.vm.precompiled_contracts", + "ethereum.arrow_glacier", + "ethereum.arrow_glacier.utils", + "ethereum.arrow_glacier.vm", + "ethereum.arrow_glacier.vm.instructions", + "ethereum.arrow_glacier.vm.precompiled_contracts", + "ethereum.gray_glacier", + "ethereum.gray_glacier.utils", + "ethereum.gray_glacier.vm", + "ethereum.gray_glacier.vm.instructions", + "ethereum.gray_glacier.vm.precompiled_contracts", + "ethereum.paris", + "ethereum.paris.utils", + "ethereum.paris.vm", + "ethereum.paris.vm.instructions", + "ethereum.paris.vm.precompiled_contracts", + "ethereum.shanghai", + "ethereum.shanghai.utils", + "ethereum.shanghai.vm", + "ethereum.shanghai.vm.instructions", + "ethereum.shanghai.vm.precompiled_contracts", + "ethereum.cancun", + "ethereum.cancun.utils", + "ethereum.cancun.vm", + "ethereum.cancun.vm.instructions", + "ethereum.cancun.vm.precompiled_contracts", + "ethereum.prague", + "ethereum.prague.utils", + "ethereum.prague.vm", + "ethereum.prague.vm.instructions", + "ethereum.prague.vm.precompiled_contracts", + "ethereum.prague.vm.precompiled_contracts.bls12_381", + "ethereum.osaka", + "ethereum.osaka.utils", + "ethereum.osaka.vm", + "ethereum.osaka.vm.instructions", + "ethereum.osaka.vm.precompiled_contracts", + "ethereum.osaka.vm.precompiled_contracts.bls12_381", +] + +[tool.setuptools.package-data] +"ethereum" = [ + "py.typed", + "assets/mainnet.json", + "assets/mainnet_genesis_alloc_rlp.hex", + "assets/cache_sizes_2048_epochs.json", + "assets/dataset_sizes_2048_epochs.json", + "assets/blocks/block_1.json", + "assets/blocks/block_1234567.json", + "assets/blocks/block_12964999.json", +] +"ethereum_spec_tools" = ["py.typed"] + +[project.optional-dependencies] +test = [ + "pytest>=8,<9", + "pytest-cov>=4.1.0,<5", + "pytest-xdist>=3.3.1,<4", + "GitPython>=3.1.0,<3.2", + "filelock>=3.15.1,<4", + "requests", + "requests-cache>=1.2.1,<2", +] + +lint = [ + "isort==5.13.2", + "mypy==1.14.1", + "black==23.12.0", + "flake8==6.1.0", + "flake8-bugbear==23.12.2", + "flake8-docstrings==1.7.0", + "flake8-spellcheck==0.28.0", + "flake8-unused-arguments==0.0.13", + "vulture==2.14.0", +] + +tools = [ + "platformdirs>=4.2,<5", +] +doc = [ + "docc>=0.3.0,<0.4.0", + "fladrif>=0.2.0,<0.3.0", +] +optimized = [ + "rust-pyspec-glue>=0.0.9,<0.1.0", + "ethash>=1.1.0,<2", +] + + +[tool.setuptools.dynamic] +version = { attr = "ethereum.__version__" } + +[project.scripts] +ethereum-spec-lint = "ethereum_spec_tools.lint:main" +ethereum-spec-sync = "ethereum_spec_tools.sync:main" +ethereum-spec-new-fork = "ethereum_spec_tools.new_fork:main" +ethereum-spec-patch = "ethereum_spec_tools.patch_tool:main" +ethereum-spec-evm = "ethereum_spec_tools.evm_tools:main" +ethereum-spec-fill = "cli.pytest_commands.fill:fill" +ethereum-spec-forks = "ethereum_spec_tools.cli_forks:main" + +[project.entry-points."docc.plugins"] +"ethereum_spec_tools.docc.discover" = "ethereum_spec_tools.docc:EthereumDiscover" +"ethereum_spec_tools.docc.build" = "ethereum_spec_tools.docc:EthereumBuilder" +"ethereum_spec_tools.docc.fix-indexes" = "ethereum_spec_tools.docc:FixIndexTransform" +"ethereum_spec_tools.docc.minimize-diffs" = "ethereum_spec_tools.docc:MinimizeDiffsTransform" + +[project.entry-points."docc.plugins.html"] +"ethereum_spec_tools.docc:DiffNode" = "ethereum_spec_tools.docc:render_diff" +"ethereum_spec_tools.docc:BeforeNode" = "ethereum_spec_tools.docc:render_before_after" +"ethereum_spec_tools.docc:AfterNode" = "ethereum_spec_tools.docc:render_before_after" + [tool.isort] profile = "black" multi_line_output = 3 diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index c14b64c476..0000000000 --- a/setup.cfg +++ /dev/null @@ -1,233 +0,0 @@ -[metadata] -name = ethereum-execution -description = Ethereum execution layer specification, provided as a Python package for tooling and testing -long_description = file: README.md -long_description_content_type = text/markdown -version = attr: ethereum.__version__ -url = https://github.com/ethereum/execution-specs -license_files = - LICENSE.md -classifiers = - License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication - Programming Language :: Python :: 3 - Programming Language :: Python :: 3.11 - Programming Language :: Python :: Implementation :: PyPy - Programming Language :: Python :: Implementation :: CPython - Intended Audience :: Developers - Natural Language :: English - -[options] -packages = - ethereum_spec_tools - ethereum_spec_tools/evm_tools - ethereum_spec_tools/evm_tools/t8n - ethereum_spec_tools/evm_tools/b11r - ethereum_spec_tools/evm_tools/statetest - ethereum_spec_tools/evm_tools/loaders - ethereum_spec_tools/lint - ethereum_spec_tools/lint/lints - ethereum - ethereum/frontier - ethereum/frontier/utils - ethereum/frontier/vm - ethereum/frontier/vm/instructions - ethereum/frontier/vm/precompiled_contracts - ethereum/utils - ethereum/crypto - ethereum_optimized/ - ethereum/homestead - ethereum/homestead/utils - ethereum/homestead/vm - ethereum/homestead/vm/instructions - ethereum/homestead/vm/precompiled_contracts - ethereum/dao_fork - ethereum/dao_fork/utils - ethereum/dao_fork/vm - ethereum/dao_fork/vm/instructions - ethereum/dao_fork/vm/precompiled_contracts - ethereum/tangerine_whistle - ethereum/tangerine_whistle/utils - ethereum/tangerine_whistle/vm - ethereum/tangerine_whistle/vm/instructions - ethereum/tangerine_whistle/vm/precompiled_contracts - ethereum/spurious_dragon - ethereum/spurious_dragon/utils - ethereum/spurious_dragon/vm - ethereum/spurious_dragon/vm/instructions - ethereum/spurious_dragon/vm/precompiled_contracts - ethereum/byzantium - ethereum/byzantium/utils - ethereum/byzantium/vm - ethereum/byzantium/vm/instructions - ethereum/byzantium/vm/precompiled_contracts - ethereum/constantinople - ethereum/constantinople/utils - ethereum/constantinople/vm - ethereum/constantinople/vm/instructions - ethereum/constantinople/vm/precompiled_contracts - ethereum/istanbul - ethereum/istanbul/utils - ethereum/istanbul/vm - ethereum/istanbul/vm/instructions - ethereum/istanbul/vm/precompiled_contracts - ethereum/muir_glacier - ethereum/muir_glacier/utils - ethereum/muir_glacier/vm - ethereum/muir_glacier/vm/instructions - ethereum/muir_glacier/vm/precompiled_contracts - ethereum/berlin - ethereum/berlin/utils - ethereum/berlin/vm - ethereum/berlin/vm/instructions - ethereum/berlin/vm/precompiled_contracts - ethereum/london - ethereum/london/utils - ethereum/london/vm - ethereum/london/vm/instructions - ethereum/london/vm/precompiled_contracts - ethereum/arrow_glacier - ethereum/arrow_glacier/utils - ethereum/arrow_glacier/vm - ethereum/arrow_glacier/vm/instructions - ethereum/arrow_glacier/vm/precompiled_contracts - ethereum/gray_glacier - ethereum/gray_glacier/utils - ethereum/gray_glacier/vm - ethereum/gray_glacier/vm/instructions - ethereum/gray_glacier/vm/precompiled_contracts - ethereum/paris - ethereum/paris/utils - ethereum/paris/vm - ethereum/paris/vm/instructions - ethereum/paris/vm/precompiled_contracts - ethereum/shanghai - ethereum/shanghai/utils - ethereum/shanghai/vm - ethereum/shanghai/vm/instructions - ethereum/shanghai/vm/precompiled_contracts - ethereum/cancun - ethereum/cancun/utils - ethereum/cancun/vm - ethereum/cancun/vm/instructions - ethereum/cancun/vm/precompiled_contracts - ethereum/prague - ethereum/prague/utils - ethereum/prague/vm - ethereum/prague/vm/instructions - ethereum/prague/vm/precompiled_contracts - ethereum/prague/vm/precompiled_contracts/bls12_381 - - -package_dir = - =src - -python_requires = >=3.11 -install_requires = - pycryptodome>=3,<4 - coincurve>=20,<21 - typing_extensions>=4.4 - py-ecc>=8.0.0b2,<9 - ethereum-types>=0.2.1,<0.3 - ethereum-rlp>=0.1.4,<0.2 - -[options.package_data] -ethereum = - py.typed - assets/mainnet.json - assets/mainnet_genesis_alloc_rlp.hex - assets/cache_sizes_2048_epochs.json - assets/dataset_sizes_2048_epochs.json - assets/blocks/block_1.json - assets/blocks/block_1234567.json - assets/blocks/block_12964999.json - -ethereum_spec_tools = - py.typed - -[options.entry_points] -console_scripts = - ethereum-spec-lint = ethereum_spec_tools.lint:main - ethereum-spec-sync = ethereum_spec_tools.sync:main - ethereum-spec-new-fork = ethereum_spec_tools.new_fork:main - ethereum-spec-patch = ethereum_spec_tools.patch_tool:main - ethereum-spec-evm = ethereum_spec_tools.evm_tools:main - -docc.plugins = - ethereum_spec_tools.docc.discover = ethereum_spec_tools.docc:EthereumDiscover - ethereum_spec_tools.docc.build = ethereum_spec_tools.docc:EthereumBuilder - ethereum_spec_tools.docc.fix-indexes = ethereum_spec_tools.docc:FixIndexTransform - ethereum_spec_tools.docc.minimize-diffs = ethereum_spec_tools.docc:MinimizeDiffsTransform - -docc.plugins.html = - ethereum_spec_tools.docc:DiffNode = ethereum_spec_tools.docc:render_diff - ethereum_spec_tools.docc:BeforeNode = ethereum_spec_tools.docc:render_before_after - ethereum_spec_tools.docc:AfterNode = ethereum_spec_tools.docc:render_before_after - -[options.extras_require] -test = - pytest>=7.4.0,<8 - pytest-cov>=4.1.0,<5 - pytest-xdist>=3.3.1,<4 - GitPython>=3.1.0,<3.2 - filelock>=3.12.3,<3.13 - requests - requests-cache>=1.2.1,<2 - -lint = - types-setuptools>=68.1.0.1,<69 - isort==5.13.2 - mypy==1.14.1 - black==23.12.0 - flake8==6.1.0 - flake8-bugbear==23.12.2 - flake8-docstrings==1.7.0 - flake8-spellcheck==0.28.0 - flake8-unused-arguments==0.0.13 - vulture==2.14.0 - -tools = - platformdirs>=4.2,<5 - -doc = - docc>=0.3.0,<0.4.0 - fladrif>=0.2.0,<0.3.0 - -optimized = - rust-pyspec-glue>=0.0.9,<0.1.0 - ethash>=1.1.0,<2 - -[flake8] -dictionaries=en_US,python,technical -docstring-convention = all -extend-ignore = - U101 - E203 - D107 - D200 - D203 - D205 - D212 - D400 - D401 - D410 - D411 - D412 - D413 - D414 - D415 - D416 - -extend-exclude = - setup.py - doc/ - tests/fixtures/ - -per-file-ignores = - tests/*:D100,D101,D103,D104,E501,SC100,SC200 - -unused-arguments-ignore-abstract-functions = true -unused-arguments-ignore-override-functions = true -unused-arguments-ignore-overload-functions = true -unused-arguments-ignore-dunder = true - -# vim: set ft=dosini: diff --git a/setup.py b/setup.py deleted file mode 100644 index b908cbe55c..0000000000 --- a/setup.py +++ /dev/null @@ -1,3 +0,0 @@ -import setuptools - -setuptools.setup() diff --git a/src/ethereum/__init__.py b/src/ethereum/__init__.py index b3f30987df..832bd231b3 100644 --- a/src/ethereum/__init__.py +++ b/src/ethereum/__init__.py @@ -18,7 +18,7 @@ """ import sys -__version__ = "1.17.0" +__version__ = "2.18.0rc2" # # Ensure we can reach 1024 frames of recursion diff --git a/src/ethereum/arrow_glacier/state.py b/src/ethereum/arrow_glacier/state.py index 23d74a1e3c..31d21bfe6e 100644 --- a/src/ethereum/arrow_glacier/state.py +++ b/src/ethereum/arrow_glacier/state.py @@ -391,31 +391,6 @@ def account_has_storage(state: State, address: Address) -> bool: return address in state._storage_tries -def is_account_empty(state: State, address: Address) -> bool: - """ - Checks if an account has zero nonce, empty code and zero balance. - - Parameters - ---------- - state: - The state - address: - Address of the account that needs to be checked. - - Returns - ------- - is_empty : `bool` - True if an account has zero nonce, empty code and zero balance, - False otherwise. - """ - account = get_account(state, address) - return ( - account.nonce == Uint(0) - and account.code == b"" - and account.balance == 0 - ) - - def account_exists_and_is_empty(state: State, address: Address) -> bool: """ Checks if an account exists and has zero nonce, empty code and zero diff --git a/src/ethereum/arrow_glacier/transactions.py b/src/ethereum/arrow_glacier/transactions.py index bd857edcf6..751ed8fff7 100644 --- a/src/ethereum/arrow_glacier/transactions.py +++ b/src/ethereum/arrow_glacier/transactions.py @@ -13,7 +13,11 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) from .exceptions import TransactionTypeError from .fork_types import Address @@ -337,15 +341,17 @@ def validate_transaction(tx: Transaction) -> Uint: This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an - `InvalidTransaction` exception if the transaction is invalid. + `InsufficientTransactionGasError` exception if the transaction does not + provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` + exception if the nonce is greater than `2**64 - 2`. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 """ intrinsic_gas = calculate_intrinsic_cost(tx) if intrinsic_gas > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") + raise NonceOverflowError("Nonce too high") return intrinsic_gas diff --git a/src/ethereum/arrow_glacier/utils/address.py b/src/ethereum/arrow_glacier/utils/address.py index 78001d7167..6e036e3083 100644 --- a/src/ethereum/arrow_glacier/utils/address.py +++ b/src/ethereum/arrow_glacier/utils/address.py @@ -22,7 +22,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/arrow_glacier/utils/hexadecimal.py b/src/ethereum/arrow_glacier/utils/hexadecimal.py index f89513dc57..fb04f04728 100644 --- a/src/ethereum/arrow_glacier/utils/hexadecimal.py +++ b/src/ethereum/arrow_glacier/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/arrow_glacier/vm/instructions/environment.py b/src/ethereum/arrow_glacier/vm/instructions/environment.py index 172ce97d70..2dc640b449 100644 --- a/src/ethereum/arrow_glacier/vm/instructions/environment.py +++ b/src/ethereum/arrow_glacier/vm/instructions/environment.py @@ -19,7 +19,7 @@ from ...fork_types import EMPTY_ACCOUNT from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..exceptions import OutOfBoundsRead @@ -71,7 +71,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: @@ -336,7 +336,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: @@ -368,7 +368,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) @@ -464,7 +464,7 @@ def extcodehash(evm: Evm) -> None: The current EVM frame. """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: diff --git a/src/ethereum/arrow_glacier/vm/instructions/system.py b/src/ethereum/arrow_glacier/vm/instructions/system.py index cec5eebd51..bc551501ce 100644 --- a/src/ethereum/arrow_glacier/vm/instructions/system.py +++ b/src/ethereum/arrow_glacier/vm/instructions/system.py @@ -30,7 +30,7 @@ from ...utils.address import ( compute_contract_address, compute_create2_contract_address, - to_address, + to_address_masked, ) from .. import ( Evm, @@ -329,7 +329,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -353,11 +353,9 @@ def call(evm: Evm) -> None: code_address = to - create_gas_cost = ( - Uint(0) - if is_account_alive(evm.message.block_env.state, to) or value == 0 - else GAS_NEW_ACCOUNT - ) + create_gas_cost = GAS_NEW_ACCOUNT + if value == 0 or is_account_alive(evm.message.block_env.state, to): + create_gas_cost = Uint(0) transfer_gas_cost = Uint(0) if value == 0 else GAS_CALL_VALUE message_call_gas = calculate_message_call_gas( value, @@ -408,7 +406,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -481,7 +479,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_SELF_DESTRUCT @@ -546,7 +544,7 @@ def delegatecall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) @@ -604,7 +602,7 @@ def staticcall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) diff --git a/src/ethereum/berlin/state.py b/src/ethereum/berlin/state.py index 23d74a1e3c..31d21bfe6e 100644 --- a/src/ethereum/berlin/state.py +++ b/src/ethereum/berlin/state.py @@ -391,31 +391,6 @@ def account_has_storage(state: State, address: Address) -> bool: return address in state._storage_tries -def is_account_empty(state: State, address: Address) -> bool: - """ - Checks if an account has zero nonce, empty code and zero balance. - - Parameters - ---------- - state: - The state - address: - Address of the account that needs to be checked. - - Returns - ------- - is_empty : `bool` - True if an account has zero nonce, empty code and zero balance, - False otherwise. - """ - account = get_account(state, address) - return ( - account.nonce == Uint(0) - and account.code == b"" - and account.balance == 0 - ) - - def account_exists_and_is_empty(state: State, address: Address) -> bool: """ Checks if an account exists and has zero nonce, empty code and zero diff --git a/src/ethereum/berlin/transactions.py b/src/ethereum/berlin/transactions.py index c1f3c990fc..4832858f53 100644 --- a/src/ethereum/berlin/transactions.py +++ b/src/ethereum/berlin/transactions.py @@ -13,7 +13,11 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) from .exceptions import TransactionTypeError from .fork_types import Address @@ -254,15 +258,17 @@ def validate_transaction(tx: Transaction) -> Uint: This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an - `InvalidTransaction` exception if the transaction is invalid. + `InsufficientTransactionGasError` exception if the transaction does not + provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` + exception if the nonce is greater than `2**64 - 2`. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 """ intrinsic_gas = calculate_intrinsic_cost(tx) if intrinsic_gas > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") + raise NonceOverflowError("Nonce too high") return intrinsic_gas diff --git a/src/ethereum/berlin/utils/address.py b/src/ethereum/berlin/utils/address.py index b34265ed7b..5a691ba060 100644 --- a/src/ethereum/berlin/utils/address.py +++ b/src/ethereum/berlin/utils/address.py @@ -22,7 +22,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/berlin/utils/hexadecimal.py b/src/ethereum/berlin/utils/hexadecimal.py index 3cfc657e6e..46cf34e1ce 100644 --- a/src/ethereum/berlin/utils/hexadecimal.py +++ b/src/ethereum/berlin/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/berlin/vm/instructions/environment.py b/src/ethereum/berlin/vm/instructions/environment.py index a3807aa28b..33e8e8ad7e 100644 --- a/src/ethereum/berlin/vm/instructions/environment.py +++ b/src/ethereum/berlin/vm/instructions/environment.py @@ -19,7 +19,7 @@ from ...fork_types import EMPTY_ACCOUNT from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..exceptions import OutOfBoundsRead @@ -71,7 +71,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: @@ -336,7 +336,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: @@ -368,7 +368,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) @@ -464,7 +464,7 @@ def extcodehash(evm: Evm) -> None: The current EVM frame. """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: diff --git a/src/ethereum/berlin/vm/instructions/system.py b/src/ethereum/berlin/vm/instructions/system.py index 200280dc0e..0a2f3c88d2 100644 --- a/src/ethereum/berlin/vm/instructions/system.py +++ b/src/ethereum/berlin/vm/instructions/system.py @@ -30,7 +30,7 @@ from ...utils.address import ( compute_contract_address, compute_create2_contract_address, - to_address, + to_address_masked, ) from .. import ( Evm, @@ -330,7 +330,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -354,11 +354,9 @@ def call(evm: Evm) -> None: code_address = to - create_gas_cost = ( - Uint(0) - if is_account_alive(evm.message.block_env.state, to) or value == 0 - else GAS_NEW_ACCOUNT - ) + create_gas_cost = GAS_NEW_ACCOUNT + if value == 0 or is_account_alive(evm.message.block_env.state, to): + create_gas_cost = Uint(0) transfer_gas_cost = Uint(0) if value == 0 else GAS_CALL_VALUE message_call_gas = calculate_message_call_gas( value, @@ -409,7 +407,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -482,7 +480,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_SELF_DESTRUCT @@ -558,7 +556,7 @@ def delegatecall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) @@ -616,7 +614,7 @@ def staticcall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) diff --git a/src/ethereum/byzantium/state.py b/src/ethereum/byzantium/state.py index 49c86fcc3d..8d14219bbe 100644 --- a/src/ethereum/byzantium/state.py +++ b/src/ethereum/byzantium/state.py @@ -365,31 +365,6 @@ def account_has_storage(state: State, address: Address) -> bool: return address in state._storage_tries -def is_account_empty(state: State, address: Address) -> bool: - """ - Checks if an account has zero nonce, empty code and zero balance. - - Parameters - ---------- - state: - The state - address: - Address of the account that needs to be checked. - - Returns - ------- - is_empty : `bool` - True if an account has zero nonce, empty code and zero balance, - False otherwise. - """ - account = get_account(state, address) - return ( - account.nonce == Uint(0) - and account.code == b"" - and account.balance == 0 - ) - - def account_exists_and_is_empty(state: State, address: Address) -> bool: """ Checks if an account exists and has zero nonce, empty code and zero diff --git a/src/ethereum/byzantium/transactions.py b/src/ethereum/byzantium/transactions.py index 5d84645388..7474ad74b6 100644 --- a/src/ethereum/byzantium/transactions.py +++ b/src/ethereum/byzantium/transactions.py @@ -12,7 +12,11 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) from .fork_types import Address @@ -110,15 +114,17 @@ def validate_transaction(tx: Transaction) -> Uint: This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an - `InvalidTransaction` exception if the transaction is invalid. + `InsufficientTransactionGasError` exception if the transaction does not + provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` + exception if the nonce is greater than `2**64 - 2`. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 """ intrinsic_gas = calculate_intrinsic_cost(tx) if intrinsic_gas > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") + raise NonceOverflowError("Nonce too high") return intrinsic_gas diff --git a/src/ethereum/byzantium/utils/address.py b/src/ethereum/byzantium/utils/address.py index 0ec3d5d532..a0a9e4f921 100644 --- a/src/ethereum/byzantium/utils/address.py +++ b/src/ethereum/byzantium/utils/address.py @@ -21,7 +21,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/byzantium/utils/hexadecimal.py b/src/ethereum/byzantium/utils/hexadecimal.py index 8ae1d5a5aa..e8284242e9 100644 --- a/src/ethereum/byzantium/utils/hexadecimal.py +++ b/src/ethereum/byzantium/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/byzantium/vm/instructions/environment.py b/src/ethereum/byzantium/vm/instructions/environment.py index 561efd63da..ef8045fcab 100644 --- a/src/ethereum/byzantium/vm/instructions/environment.py +++ b/src/ethereum/byzantium/vm/instructions/environment.py @@ -17,7 +17,7 @@ from ethereum.utils.numeric import ceil32 from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..exceptions import OutOfBoundsRead @@ -68,7 +68,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_BALANCE) @@ -329,7 +329,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_EXTERNAL) @@ -355,7 +355,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) diff --git a/src/ethereum/byzantium/vm/instructions/system.py b/src/ethereum/byzantium/vm/instructions/system.py index 79f9f98044..6ea0f1d178 100644 --- a/src/ethereum/byzantium/vm/instructions/system.py +++ b/src/ethereum/byzantium/vm/instructions/system.py @@ -24,7 +24,7 @@ is_account_alive, set_account_balance, ) -from ...utils.address import compute_contract_address, to_address +from ...utils.address import compute_contract_address, to_address_masked from .. import ( Evm, Message, @@ -256,7 +256,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -274,11 +274,9 @@ def call(evm: Evm) -> None: code_address = to - create_gas_cost = ( - Uint(0) - if is_account_alive(evm.message.block_env.state, to) or value == 0 - else GAS_NEW_ACCOUNT - ) + create_gas_cost = GAS_NEW_ACCOUNT + if value == 0 or is_account_alive(evm.message.block_env.state, to): + create_gas_cost = Uint(0) transfer_gas_cost = Uint(0) if value == 0 else GAS_CALL_VALUE message_call_gas = calculate_message_call_gas( value, @@ -329,7 +327,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -395,7 +393,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_SELF_DESTRUCT @@ -466,7 +464,7 @@ def delegatecall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) @@ -517,7 +515,7 @@ def staticcall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) diff --git a/src/ethereum/cancun/exceptions.py b/src/ethereum/cancun/exceptions.py index 60b5f5f50f..5b46b80556 100644 --- a/src/ethereum/cancun/exceptions.py +++ b/src/ethereum/cancun/exceptions.py @@ -101,3 +101,9 @@ class PriorityFeeGreaterThanMaxFeeError(InvalidTransaction): """ The priority fee is greater than the maximum fee per gas. """ + + +class InitCodeTooLargeError(InvalidTransaction): + """ + The init code of the transaction is too large. + """ diff --git a/src/ethereum/cancun/state.py b/src/ethereum/cancun/state.py index 9378584196..b067ed2286 100644 --- a/src/ethereum/cancun/state.py +++ b/src/ethereum/cancun/state.py @@ -246,7 +246,8 @@ def mark_account_created(state: State, address: Address) -> None: """ Mark an account as having been created in the current transaction. This information is used by `get_storage_original()` to handle an obscure - edgecase. + edgecase, and to respect the constraints added to SELFDESTRUCT by + EIP-6780. The marker is not removed even if the account creation reverts. Since the account cannot have had code prior to its creation and can't call @@ -424,31 +425,6 @@ def account_has_storage(state: State, address: Address) -> bool: return address in state._storage_tries -def is_account_empty(state: State, address: Address) -> bool: - """ - Checks if an account has zero nonce, empty code and zero balance. - - Parameters - ---------- - state: - The state - address: - Address of the account that needs to be checked. - - Returns - ------- - is_empty : `bool` - True if an account has zero nonce, empty code and zero balance, - False otherwise. - """ - account = get_account(state, address) - return ( - account.nonce == Uint(0) - and account.code == b"" - and account.balance == 0 - ) - - def account_exists_and_is_empty(state: State, address: Address) -> bool: """ Checks if an account exists and has zero nonce, empty code and zero diff --git a/src/ethereum/cancun/transactions.py b/src/ethereum/cancun/transactions.py index 5c8be4708d..98a82bd21d 100644 --- a/src/ethereum/cancun/transactions.py +++ b/src/ethereum/cancun/transactions.py @@ -13,9 +13,13 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) -from .exceptions import TransactionTypeError +from .exceptions import InitCodeTooLargeError, TransactionTypeError from .fork_types import Address, VersionedHash TX_BASE_COST = Uint(21000) @@ -439,19 +443,23 @@ def validate_transaction(tx: Transaction) -> Uint: This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an - `InvalidTransaction` exception if the transaction is invalid. + `InsufficientTransactionGasError` exception if the transaction does not + provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` + exception if the nonce is greater than `2**64 - 2`. It also raises an + `InitCodeTooLargeError` if the code size of a contract creation transaction + exceeds the maximum allowed size. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 """ - from .vm.interpreter import MAX_CODE_SIZE + from .vm.interpreter import MAX_INIT_CODE_SIZE intrinsic_gas = calculate_intrinsic_cost(tx) if intrinsic_gas > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") - if tx.to == Bytes0(b"") and len(tx.data) > 2 * MAX_CODE_SIZE: - raise InvalidTransaction("Code size too large") + raise NonceOverflowError("Nonce too high") + if tx.to == Bytes0(b"") and len(tx.data) > MAX_INIT_CODE_SIZE: + raise InitCodeTooLargeError("Code size too large") return intrinsic_gas diff --git a/src/ethereum/cancun/utils/address.py b/src/ethereum/cancun/utils/address.py index 6e0e553dbe..39279c4334 100644 --- a/src/ethereum/cancun/utils/address.py +++ b/src/ethereum/cancun/utils/address.py @@ -22,7 +22,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/cancun/utils/hexadecimal.py b/src/ethereum/cancun/utils/hexadecimal.py index 4170fc9e4c..915aa7144f 100644 --- a/src/ethereum/cancun/utils/hexadecimal.py +++ b/src/ethereum/cancun/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/cancun/vm/gas.py b/src/ethereum/cancun/vm/gas.py index 75ed79b18c..d45b749551 100644 --- a/src/ethereum/cancun/vm/gas.py +++ b/src/ethereum/cancun/vm/gas.py @@ -297,8 +297,8 @@ def calculate_excess_blob_gas(parent_header: Header) -> U64: parent_blob_gas = excess_blob_gas + blob_gas_used if parent_blob_gas < TARGET_BLOB_GAS_PER_BLOCK: return U64(0) - else: - return parent_blob_gas - TARGET_BLOB_GAS_PER_BLOCK + + return parent_blob_gas - TARGET_BLOB_GAS_PER_BLOCK def calculate_total_blob_gas(tx: Transaction) -> U64: diff --git a/src/ethereum/cancun/vm/instructions/environment.py b/src/ethereum/cancun/vm/instructions/environment.py index 5ddd12dac8..226b3d3bb3 100644 --- a/src/ethereum/cancun/vm/instructions/environment.py +++ b/src/ethereum/cancun/vm/instructions/environment.py @@ -20,7 +20,7 @@ from ...fork_types import EMPTY_ACCOUNT from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..exceptions import OutOfBoundsRead @@ -74,7 +74,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: @@ -339,7 +339,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: @@ -371,7 +371,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) @@ -467,7 +467,7 @@ def extcodehash(evm: Evm) -> None: The current EVM frame. """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: diff --git a/src/ethereum/cancun/vm/instructions/system.py b/src/ethereum/cancun/vm/instructions/system.py index eff607eede..4f55dd1d0c 100644 --- a/src/ethereum/cancun/vm/instructions/system.py +++ b/src/ethereum/cancun/vm/instructions/system.py @@ -30,7 +30,7 @@ from ...utils.address import ( compute_contract_address, compute_create2_contract_address, - to_address, + to_address_masked, ) from .. import ( Evm, @@ -72,7 +72,7 @@ def generic_create( # This import causes a circular import error # if it's not moved inside this method from ...vm.interpreter import ( - MAX_CODE_SIZE, + MAX_INIT_CODE_SIZE, STACK_DEPTH_LIMIT, process_create_message, ) @@ -80,7 +80,7 @@ def generic_create( call_data = memory_read_bytes( evm.memory, memory_start_position, memory_size ) - if len(call_data) > 2 * MAX_CODE_SIZE: + if len(call_data) > MAX_INIT_CODE_SIZE: raise OutOfGasError create_message_gas = max_message_call_gas(Uint(evm.gas_left)) @@ -349,7 +349,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -373,11 +373,9 @@ def call(evm: Evm) -> None: code_address = to - create_gas_cost = ( - Uint(0) - if is_account_alive(evm.message.block_env.state, to) or value == 0 - else GAS_NEW_ACCOUNT - ) + create_gas_cost = GAS_NEW_ACCOUNT + if value == 0 or is_account_alive(evm.message.block_env.state, to): + create_gas_cost = Uint(0) transfer_gas_cost = Uint(0) if value == 0 else GAS_CALL_VALUE message_call_gas = calculate_message_call_gas( value, @@ -428,7 +426,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -501,7 +499,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_SELF_DESTRUCT @@ -560,7 +558,7 @@ def delegatecall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) @@ -618,7 +616,7 @@ def staticcall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) diff --git a/src/ethereum/cancun/vm/interpreter.py b/src/ethereum/cancun/vm/interpreter.py index 4681b1cb70..b67812cb3e 100644 --- a/src/ethereum/cancun/vm/interpreter.py +++ b/src/ethereum/cancun/vm/interpreter.py @@ -62,6 +62,7 @@ STACK_DEPTH_LIMIT = Uint(1024) MAX_CODE_SIZE = 0x6000 +MAX_INIT_CODE_SIZE = 2 * MAX_CODE_SIZE @dataclass @@ -167,7 +168,8 @@ def process_create_message(message: Message) -> Evm: # In the previously mentioned edge case the preexisting storage is ignored # for gas refund purposes. In order to do this we must track created - # accounts. + # accounts. This tracking is also needed to respect the constraints + # added to SELFDESTRUCT by EIP-6780. mark_account_created(state, message.current_target) increment_nonce(state, message.current_target) diff --git a/src/ethereum/constantinople/state.py b/src/ethereum/constantinople/state.py index 49c86fcc3d..8d14219bbe 100644 --- a/src/ethereum/constantinople/state.py +++ b/src/ethereum/constantinople/state.py @@ -365,31 +365,6 @@ def account_has_storage(state: State, address: Address) -> bool: return address in state._storage_tries -def is_account_empty(state: State, address: Address) -> bool: - """ - Checks if an account has zero nonce, empty code and zero balance. - - Parameters - ---------- - state: - The state - address: - Address of the account that needs to be checked. - - Returns - ------- - is_empty : `bool` - True if an account has zero nonce, empty code and zero balance, - False otherwise. - """ - account = get_account(state, address) - return ( - account.nonce == Uint(0) - and account.code == b"" - and account.balance == 0 - ) - - def account_exists_and_is_empty(state: State, address: Address) -> bool: """ Checks if an account exists and has zero nonce, empty code and zero diff --git a/src/ethereum/constantinople/transactions.py b/src/ethereum/constantinople/transactions.py index 5d84645388..7474ad74b6 100644 --- a/src/ethereum/constantinople/transactions.py +++ b/src/ethereum/constantinople/transactions.py @@ -12,7 +12,11 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) from .fork_types import Address @@ -110,15 +114,17 @@ def validate_transaction(tx: Transaction) -> Uint: This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an - `InvalidTransaction` exception if the transaction is invalid. + `InsufficientTransactionGasError` exception if the transaction does not + provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` + exception if the nonce is greater than `2**64 - 2`. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 """ intrinsic_gas = calculate_intrinsic_cost(tx) if intrinsic_gas > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") + raise NonceOverflowError("Nonce too high") return intrinsic_gas diff --git a/src/ethereum/constantinople/utils/address.py b/src/ethereum/constantinople/utils/address.py index 93df9485f4..b105175ecd 100644 --- a/src/ethereum/constantinople/utils/address.py +++ b/src/ethereum/constantinople/utils/address.py @@ -22,7 +22,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/constantinople/utils/hexadecimal.py b/src/ethereum/constantinople/utils/hexadecimal.py index eb78b1590d..f2165a8c91 100644 --- a/src/ethereum/constantinople/utils/hexadecimal.py +++ b/src/ethereum/constantinople/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/constantinople/vm/instructions/environment.py b/src/ethereum/constantinople/vm/instructions/environment.py index 77ebb8c5fb..f0c6b6144a 100644 --- a/src/ethereum/constantinople/vm/instructions/environment.py +++ b/src/ethereum/constantinople/vm/instructions/environment.py @@ -19,7 +19,7 @@ from ...fork_types import EMPTY_ACCOUNT from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..exceptions import OutOfBoundsRead @@ -71,7 +71,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_BALANCE) @@ -332,7 +332,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_EXTERNAL) @@ -358,7 +358,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) @@ -447,7 +447,7 @@ def extcodehash(evm: Evm) -> None: The current EVM frame. """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_CODE_HASH) diff --git a/src/ethereum/constantinople/vm/instructions/system.py b/src/ethereum/constantinople/vm/instructions/system.py index bd1429793b..31868a9c27 100644 --- a/src/ethereum/constantinople/vm/instructions/system.py +++ b/src/ethereum/constantinople/vm/instructions/system.py @@ -29,7 +29,7 @@ from ...utils.address import ( compute_contract_address, compute_create2_contract_address, - to_address, + to_address_masked, ) from .. import ( Evm, @@ -326,7 +326,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -344,11 +344,9 @@ def call(evm: Evm) -> None: code_address = to - create_gas_cost = ( - Uint(0) - if is_account_alive(evm.message.block_env.state, to) or value == 0 - else GAS_NEW_ACCOUNT - ) + create_gas_cost = GAS_NEW_ACCOUNT + if value == 0 or is_account_alive(evm.message.block_env.state, to): + create_gas_cost = Uint(0) transfer_gas_cost = Uint(0) if value == 0 else GAS_CALL_VALUE message_call_gas = calculate_message_call_gas( value, @@ -399,7 +397,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -465,7 +463,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_SELF_DESTRUCT @@ -537,7 +535,7 @@ def delegatecall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) @@ -588,7 +586,7 @@ def staticcall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) diff --git a/src/ethereum/crypto/elliptic_curve.py b/src/ethereum/crypto/elliptic_curve.py index 8a6c0e1764..5cacbf0f73 100644 --- a/src/ethereum/crypto/elliptic_curve.py +++ b/src/ethereum/crypto/elliptic_curve.py @@ -4,6 +4,12 @@ """ import coincurve +from Crypto.Util.asn1 import DerSequence +from cryptography.exceptions import InvalidSignature +from cryptography.hazmat.backends import default_backend +from cryptography.hazmat.primitives import hashes +from cryptography.hazmat.primitives.asymmetric import ec +from cryptography.hazmat.primitives.asymmetric.utils import Prehashed from ethereum_types.bytes import Bytes from ethereum_types.numeric import U256 @@ -71,3 +77,95 @@ def secp256k1_recover(r: U256, s: U256, v: U256, msg_hash: Hash32) -> Bytes: public_key = public_key.format(compressed=False)[1:] return public_key + + +SECP256R1N = U256( + 0xFFFFFFFF00000000FFFFFFFFFFFFFFFFBCE6FAADA7179E84F3B9CAC2FC632551 +) +SECP256R1P = U256( + 0xFFFFFFFF00000001000000000000000000000000FFFFFFFFFFFFFFFFFFFFFFFF +) +SECP256R1A = U256( + 0xFFFFFFFF00000001000000000000000000000000FFFFFFFFFFFFFFFFFFFFFFFC +) +SECP256R1B = U256( + 0x5AC635D8AA3A93E7B3EBBD55769886BC651D06B0CC53B0F63BCE3C3E27D2604B +) + + +def secp256r1_verify( + r: U256, s: U256, x: U256, y: U256, msg_hash: Hash32 +) -> None: + """ + Verifies a P-256 signature. + + Parameters + ---------- + r : + the `r` component of the signature + s : + the `s` component of the signature + x : + the `x` coordinate of the public key + y : + the `y` coordinate of the public key + msg_hash : + Hash of the message being recovered. + + Raises + ------ + + Raises an `InvalidSignatureError` if the signature is not valid. + """ + # Convert U256 to regular integers for DerSequence + r_int = int(r) + s_int = int(s) + x_int = int(x) + y_int = int(y) + + sig = DerSequence([r_int, s_int]).encode() + + pubnum = ec.EllipticCurvePublicNumbers(x_int, y_int, ec.SECP256R1()) + pubkey = pubnum.public_key(default_backend()) + + try: + pubkey.verify(sig, msg_hash, ec.ECDSA(Prehashed(hashes.SHA256()))) + except InvalidSignature as e: + raise InvalidSignatureError from e + + +def is_on_curve_secp256r1(x: U256, y: U256) -> bool: + """ + Checks if a point is on the secp256r1 curve. + + The point (x, y) must satisfy the curve equation: + y^2 ≡ x^3 + a*x + b (mod p) + + Parameters + ---------- + x : U256 + The x-coordinate of the point + y : U256 + The y-coordinate of the point + + Returns + ------- + bool + True if the point is on the curve, False otherwise + """ + # Convert U256 to int for calculations + x_int = int(x) + y_int = int(y) + p_int = int(SECP256R1P) + a_int = int(SECP256R1A) + b_int = int(SECP256R1B) + + # Calculate y^2 mod p + y_squared = (y_int * y_int) % p_int + + # Calculate x^3 + ax + b mod p + x_cubed = (x_int * x_int * x_int) % p_int + ax = (a_int * x_int) % p_int + right_side = (x_cubed + ax + b_int) % p_int + + return y_squared == right_side diff --git a/src/ethereum/crypto/kzg.py b/src/ethereum/crypto/kzg.py index 5e36b368fb..8d00075711 100644 --- a/src/ethereum/crypto/kzg.py +++ b/src/ethereum/crypto/kzg.py @@ -6,7 +6,7 @@ from typing import Tuple from eth_typing.bls import BLSPubkey, BLSSignature -from ethereum_types.bytes import Bytes32, Bytes48, Bytes96 +from ethereum_types.bytes import Bytes32, Bytes48 from ethereum_types.numeric import U256 from py_ecc.bls import G2ProofOfPossession from py_ecc.bls.g2_primitives import pubkey_to_G1, signature_to_G2 @@ -53,12 +53,6 @@ class VersionedHash(Bytes32): pass -class G2Point(Bytes96): - """A point in G2.""" - - pass - - VERSIONED_HASH_VERSION_KZG = hex_to_bytes("0x01") BYTES_PER_COMMITMENT = 48 BYTES_PER_PROOF = 48 @@ -67,7 +61,6 @@ class G2Point(Bytes96): BLS_MODULUS = BLSFieldElement( 52435875175126190479447740508185965837690552500527637822603658699938581184513 # noqa: E501 ) -KZG_SETUP_G2_LENGTH = 65 KZG_SETUP_G2_MONOMIAL_1 = "0xb5bfd7dd8cdeb128843bc287230af38926187075cbfbefa81009a2ce615ac53d2914e5870cb452d2afaaab24f3499f72185cbfee53492714734429b7b38608e23926c911cceceac9a36851477ba4c60b087041de621000edc98edada20c1def2" # noqa: E501 diff --git a/src/ethereum/dao_fork/transactions.py b/src/ethereum/dao_fork/transactions.py index 777e9d8fdf..ca3591a720 100644 --- a/src/ethereum/dao_fork/transactions.py +++ b/src/ethereum/dao_fork/transactions.py @@ -12,7 +12,11 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) from .fork_types import Address @@ -110,15 +114,17 @@ def validate_transaction(tx: Transaction) -> Uint: This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an - `InvalidTransaction` exception if the transaction is invalid. + `InsufficientTransactionGasError` exception if the transaction does not + provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` + exception if the nonce is greater than `2**64 - 2`. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 """ intrinsic_gas = calculate_intrinsic_cost(tx) if intrinsic_gas > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") + raise NonceOverflowError("Nonce too high") return intrinsic_gas diff --git a/src/ethereum/dao_fork/utils/address.py b/src/ethereum/dao_fork/utils/address.py index 68e3d97695..bf502c84a4 100644 --- a/src/ethereum/dao_fork/utils/address.py +++ b/src/ethereum/dao_fork/utils/address.py @@ -20,7 +20,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/dao_fork/utils/hexadecimal.py b/src/ethereum/dao_fork/utils/hexadecimal.py index d8ec83683f..3a18c9df5f 100644 --- a/src/ethereum/dao_fork/utils/hexadecimal.py +++ b/src/ethereum/dao_fork/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/dao_fork/vm/instructions/environment.py b/src/ethereum/dao_fork/vm/instructions/environment.py index 36215ecb1a..cb9d3d69c6 100644 --- a/src/ethereum/dao_fork/vm/instructions/environment.py +++ b/src/ethereum/dao_fork/vm/instructions/environment.py @@ -17,7 +17,7 @@ from ethereum.utils.numeric import ceil32 from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..gas import ( @@ -66,7 +66,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_BALANCE) @@ -327,7 +327,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_EXTERNAL) @@ -353,7 +353,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) diff --git a/src/ethereum/dao_fork/vm/instructions/system.py b/src/ethereum/dao_fork/vm/instructions/system.py index 4dcdfbf858..228e00e051 100644 --- a/src/ethereum/dao_fork/vm/instructions/system.py +++ b/src/ethereum/dao_fork/vm/instructions/system.py @@ -22,7 +22,7 @@ increment_nonce, set_account_balance, ) -from ...utils.address import compute_contract_address, to_address +from ...utils.address import compute_contract_address, to_address_masked from .. import ( Evm, Message, @@ -237,7 +237,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -298,7 +298,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -357,7 +357,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_ZERO @@ -415,7 +415,7 @@ def delegatecall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) diff --git a/src/ethereum/exceptions.py b/src/ethereum/exceptions.py index b961b0e88a..7bff361467 100644 --- a/src/ethereum/exceptions.py +++ b/src/ethereum/exceptions.py @@ -60,3 +60,16 @@ class GasUsedExceedsLimitError(InvalidTransaction): Thrown when a transaction's gas usage exceeds the gas available in the block. """ + + +class InsufficientTransactionGasError(InvalidTransaction): + """ + Thrown when a transaction does not provide enough gas to cover its + intrinsic cost. + """ + + +class NonceOverflowError(InvalidTransaction): + """ + Thrown when a transaction's nonce is greater than `2**64 - 2`. + """ diff --git a/src/ethereum/frontier/transactions.py b/src/ethereum/frontier/transactions.py index b71d72b49e..4b4d20aa80 100644 --- a/src/ethereum/frontier/transactions.py +++ b/src/ethereum/frontier/transactions.py @@ -12,7 +12,11 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) from .fork_types import Address @@ -105,15 +109,17 @@ def validate_transaction(tx: Transaction) -> Uint: This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an - `InvalidTransaction` exception if the transaction is invalid. + `InsufficientTransactionGasError` exception if the transaction does not + provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` + exception if the nonce is greater than `2**64 - 2`. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 """ intrinsic_gas = calculate_intrinsic_cost(tx) if intrinsic_gas > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") + raise NonceOverflowError("Nonce too high") return intrinsic_gas diff --git a/src/ethereum/frontier/utils/address.py b/src/ethereum/frontier/utils/address.py index f33c2fd2bd..0f798fb72c 100644 --- a/src/ethereum/frontier/utils/address.py +++ b/src/ethereum/frontier/utils/address.py @@ -20,7 +20,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/frontier/utils/hexadecimal.py b/src/ethereum/frontier/utils/hexadecimal.py index a54b908eb7..4e0233d7b3 100644 --- a/src/ethereum/frontier/utils/hexadecimal.py +++ b/src/ethereum/frontier/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/frontier/vm/instructions/environment.py b/src/ethereum/frontier/vm/instructions/environment.py index 36215ecb1a..cb9d3d69c6 100644 --- a/src/ethereum/frontier/vm/instructions/environment.py +++ b/src/ethereum/frontier/vm/instructions/environment.py @@ -17,7 +17,7 @@ from ethereum.utils.numeric import ceil32 from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..gas import ( @@ -66,7 +66,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_BALANCE) @@ -327,7 +327,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_EXTERNAL) @@ -353,7 +353,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) diff --git a/src/ethereum/frontier/vm/instructions/system.py b/src/ethereum/frontier/vm/instructions/system.py index e399926d57..ba58ceff44 100644 --- a/src/ethereum/frontier/vm/instructions/system.py +++ b/src/ethereum/frontier/vm/instructions/system.py @@ -22,7 +22,7 @@ increment_nonce, set_account_balance, ) -from ...utils.address import compute_contract_address, to_address +from ...utils.address import compute_contract_address, to_address_masked from .. import ( Evm, Message, @@ -233,7 +233,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -293,7 +293,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -351,7 +351,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_ZERO diff --git a/src/ethereum/gray_glacier/state.py b/src/ethereum/gray_glacier/state.py index 23d74a1e3c..31d21bfe6e 100644 --- a/src/ethereum/gray_glacier/state.py +++ b/src/ethereum/gray_glacier/state.py @@ -391,31 +391,6 @@ def account_has_storage(state: State, address: Address) -> bool: return address in state._storage_tries -def is_account_empty(state: State, address: Address) -> bool: - """ - Checks if an account has zero nonce, empty code and zero balance. - - Parameters - ---------- - state: - The state - address: - Address of the account that needs to be checked. - - Returns - ------- - is_empty : `bool` - True if an account has zero nonce, empty code and zero balance, - False otherwise. - """ - account = get_account(state, address) - return ( - account.nonce == Uint(0) - and account.code == b"" - and account.balance == 0 - ) - - def account_exists_and_is_empty(state: State, address: Address) -> bool: """ Checks if an account exists and has zero nonce, empty code and zero diff --git a/src/ethereum/gray_glacier/transactions.py b/src/ethereum/gray_glacier/transactions.py index bd857edcf6..751ed8fff7 100644 --- a/src/ethereum/gray_glacier/transactions.py +++ b/src/ethereum/gray_glacier/transactions.py @@ -13,7 +13,11 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) from .exceptions import TransactionTypeError from .fork_types import Address @@ -337,15 +341,17 @@ def validate_transaction(tx: Transaction) -> Uint: This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an - `InvalidTransaction` exception if the transaction is invalid. + `InsufficientTransactionGasError` exception if the transaction does not + provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` + exception if the nonce is greater than `2**64 - 2`. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 """ intrinsic_gas = calculate_intrinsic_cost(tx) if intrinsic_gas > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") + raise NonceOverflowError("Nonce too high") return intrinsic_gas diff --git a/src/ethereum/gray_glacier/utils/address.py b/src/ethereum/gray_glacier/utils/address.py index f0c848a45b..862818bcd6 100644 --- a/src/ethereum/gray_glacier/utils/address.py +++ b/src/ethereum/gray_glacier/utils/address.py @@ -22,7 +22,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/gray_glacier/utils/hexadecimal.py b/src/ethereum/gray_glacier/utils/hexadecimal.py index 05b29fd0d8..9c7577facb 100644 --- a/src/ethereum/gray_glacier/utils/hexadecimal.py +++ b/src/ethereum/gray_glacier/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/gray_glacier/vm/instructions/environment.py b/src/ethereum/gray_glacier/vm/instructions/environment.py index 172ce97d70..2dc640b449 100644 --- a/src/ethereum/gray_glacier/vm/instructions/environment.py +++ b/src/ethereum/gray_glacier/vm/instructions/environment.py @@ -19,7 +19,7 @@ from ...fork_types import EMPTY_ACCOUNT from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..exceptions import OutOfBoundsRead @@ -71,7 +71,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: @@ -336,7 +336,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: @@ -368,7 +368,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) @@ -464,7 +464,7 @@ def extcodehash(evm: Evm) -> None: The current EVM frame. """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: diff --git a/src/ethereum/gray_glacier/vm/instructions/system.py b/src/ethereum/gray_glacier/vm/instructions/system.py index cec5eebd51..bc551501ce 100644 --- a/src/ethereum/gray_glacier/vm/instructions/system.py +++ b/src/ethereum/gray_glacier/vm/instructions/system.py @@ -30,7 +30,7 @@ from ...utils.address import ( compute_contract_address, compute_create2_contract_address, - to_address, + to_address_masked, ) from .. import ( Evm, @@ -329,7 +329,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -353,11 +353,9 @@ def call(evm: Evm) -> None: code_address = to - create_gas_cost = ( - Uint(0) - if is_account_alive(evm.message.block_env.state, to) or value == 0 - else GAS_NEW_ACCOUNT - ) + create_gas_cost = GAS_NEW_ACCOUNT + if value == 0 or is_account_alive(evm.message.block_env.state, to): + create_gas_cost = Uint(0) transfer_gas_cost = Uint(0) if value == 0 else GAS_CALL_VALUE message_call_gas = calculate_message_call_gas( value, @@ -408,7 +406,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -481,7 +479,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_SELF_DESTRUCT @@ -546,7 +544,7 @@ def delegatecall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) @@ -604,7 +602,7 @@ def staticcall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) diff --git a/src/ethereum/homestead/transactions.py b/src/ethereum/homestead/transactions.py index 777e9d8fdf..ca3591a720 100644 --- a/src/ethereum/homestead/transactions.py +++ b/src/ethereum/homestead/transactions.py @@ -12,7 +12,11 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) from .fork_types import Address @@ -110,15 +114,17 @@ def validate_transaction(tx: Transaction) -> Uint: This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an - `InvalidTransaction` exception if the transaction is invalid. + `InsufficientTransactionGasError` exception if the transaction does not + provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` + exception if the nonce is greater than `2**64 - 2`. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 """ intrinsic_gas = calculate_intrinsic_cost(tx) if intrinsic_gas > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") + raise NonceOverflowError("Nonce too high") return intrinsic_gas diff --git a/src/ethereum/homestead/utils/address.py b/src/ethereum/homestead/utils/address.py index 0d464921de..a1ca990b8d 100644 --- a/src/ethereum/homestead/utils/address.py +++ b/src/ethereum/homestead/utils/address.py @@ -20,7 +20,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/homestead/utils/hexadecimal.py b/src/ethereum/homestead/utils/hexadecimal.py index a873cc85e6..49d1c8ba38 100644 --- a/src/ethereum/homestead/utils/hexadecimal.py +++ b/src/ethereum/homestead/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/homestead/vm/instructions/environment.py b/src/ethereum/homestead/vm/instructions/environment.py index 36215ecb1a..cb9d3d69c6 100644 --- a/src/ethereum/homestead/vm/instructions/environment.py +++ b/src/ethereum/homestead/vm/instructions/environment.py @@ -17,7 +17,7 @@ from ethereum.utils.numeric import ceil32 from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..gas import ( @@ -66,7 +66,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_BALANCE) @@ -327,7 +327,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_EXTERNAL) @@ -353,7 +353,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) diff --git a/src/ethereum/homestead/vm/instructions/system.py b/src/ethereum/homestead/vm/instructions/system.py index 4dcdfbf858..228e00e051 100644 --- a/src/ethereum/homestead/vm/instructions/system.py +++ b/src/ethereum/homestead/vm/instructions/system.py @@ -22,7 +22,7 @@ increment_nonce, set_account_balance, ) -from ...utils.address import compute_contract_address, to_address +from ...utils.address import compute_contract_address, to_address_masked from .. import ( Evm, Message, @@ -237,7 +237,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -298,7 +298,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -357,7 +357,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_ZERO @@ -415,7 +415,7 @@ def delegatecall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) diff --git a/src/ethereum/istanbul/state.py b/src/ethereum/istanbul/state.py index 23d74a1e3c..31d21bfe6e 100644 --- a/src/ethereum/istanbul/state.py +++ b/src/ethereum/istanbul/state.py @@ -391,31 +391,6 @@ def account_has_storage(state: State, address: Address) -> bool: return address in state._storage_tries -def is_account_empty(state: State, address: Address) -> bool: - """ - Checks if an account has zero nonce, empty code and zero balance. - - Parameters - ---------- - state: - The state - address: - Address of the account that needs to be checked. - - Returns - ------- - is_empty : `bool` - True if an account has zero nonce, empty code and zero balance, - False otherwise. - """ - account = get_account(state, address) - return ( - account.nonce == Uint(0) - and account.code == b"" - and account.balance == 0 - ) - - def account_exists_and_is_empty(state: State, address: Address) -> bool: """ Checks if an account exists and has zero nonce, empty code and zero diff --git a/src/ethereum/istanbul/transactions.py b/src/ethereum/istanbul/transactions.py index 81b1e51eee..46304b1fd6 100644 --- a/src/ethereum/istanbul/transactions.py +++ b/src/ethereum/istanbul/transactions.py @@ -12,7 +12,11 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) from .fork_types import Address @@ -110,15 +114,17 @@ def validate_transaction(tx: Transaction) -> Uint: This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an - `InvalidTransaction` exception if the transaction is invalid. + `InsufficientTransactionGasError` exception if the transaction does not + provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` + exception if the nonce is greater than `2**64 - 2`. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 """ intrinsic_gas = calculate_intrinsic_cost(tx) if intrinsic_gas > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") + raise NonceOverflowError("Nonce too high") return intrinsic_gas diff --git a/src/ethereum/istanbul/utils/address.py b/src/ethereum/istanbul/utils/address.py index 27a80c1931..0afd6dd0ce 100644 --- a/src/ethereum/istanbul/utils/address.py +++ b/src/ethereum/istanbul/utils/address.py @@ -22,7 +22,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/istanbul/utils/hexadecimal.py b/src/ethereum/istanbul/utils/hexadecimal.py index 9ad0cec48b..48d71718c4 100644 --- a/src/ethereum/istanbul/utils/hexadecimal.py +++ b/src/ethereum/istanbul/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/istanbul/vm/instructions/environment.py b/src/ethereum/istanbul/vm/instructions/environment.py index 9f26185b8f..729f98b6c0 100644 --- a/src/ethereum/istanbul/vm/instructions/environment.py +++ b/src/ethereum/istanbul/vm/instructions/environment.py @@ -19,7 +19,7 @@ from ...fork_types import EMPTY_ACCOUNT from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..exceptions import OutOfBoundsRead @@ -72,7 +72,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_BALANCE) @@ -333,7 +333,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_EXTERNAL) @@ -359,7 +359,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) @@ -448,7 +448,7 @@ def extcodehash(evm: Evm) -> None: The current EVM frame. """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_CODE_HASH) diff --git a/src/ethereum/istanbul/vm/instructions/system.py b/src/ethereum/istanbul/vm/instructions/system.py index bd1429793b..31868a9c27 100644 --- a/src/ethereum/istanbul/vm/instructions/system.py +++ b/src/ethereum/istanbul/vm/instructions/system.py @@ -29,7 +29,7 @@ from ...utils.address import ( compute_contract_address, compute_create2_contract_address, - to_address, + to_address_masked, ) from .. import ( Evm, @@ -326,7 +326,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -344,11 +344,9 @@ def call(evm: Evm) -> None: code_address = to - create_gas_cost = ( - Uint(0) - if is_account_alive(evm.message.block_env.state, to) or value == 0 - else GAS_NEW_ACCOUNT - ) + create_gas_cost = GAS_NEW_ACCOUNT + if value == 0 or is_account_alive(evm.message.block_env.state, to): + create_gas_cost = Uint(0) transfer_gas_cost = Uint(0) if value == 0 else GAS_CALL_VALUE message_call_gas = calculate_message_call_gas( value, @@ -399,7 +397,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -465,7 +463,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_SELF_DESTRUCT @@ -537,7 +535,7 @@ def delegatecall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) @@ -588,7 +586,7 @@ def staticcall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) diff --git a/src/ethereum/london/state.py b/src/ethereum/london/state.py index 23d74a1e3c..31d21bfe6e 100644 --- a/src/ethereum/london/state.py +++ b/src/ethereum/london/state.py @@ -391,31 +391,6 @@ def account_has_storage(state: State, address: Address) -> bool: return address in state._storage_tries -def is_account_empty(state: State, address: Address) -> bool: - """ - Checks if an account has zero nonce, empty code and zero balance. - - Parameters - ---------- - state: - The state - address: - Address of the account that needs to be checked. - - Returns - ------- - is_empty : `bool` - True if an account has zero nonce, empty code and zero balance, - False otherwise. - """ - account = get_account(state, address) - return ( - account.nonce == Uint(0) - and account.code == b"" - and account.balance == 0 - ) - - def account_exists_and_is_empty(state: State, address: Address) -> bool: """ Checks if an account exists and has zero nonce, empty code and zero diff --git a/src/ethereum/london/transactions.py b/src/ethereum/london/transactions.py index bd857edcf6..751ed8fff7 100644 --- a/src/ethereum/london/transactions.py +++ b/src/ethereum/london/transactions.py @@ -13,7 +13,11 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) from .exceptions import TransactionTypeError from .fork_types import Address @@ -337,15 +341,17 @@ def validate_transaction(tx: Transaction) -> Uint: This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an - `InvalidTransaction` exception if the transaction is invalid. + `InsufficientTransactionGasError` exception if the transaction does not + provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` + exception if the nonce is greater than `2**64 - 2`. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 """ intrinsic_gas = calculate_intrinsic_cost(tx) if intrinsic_gas > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") + raise NonceOverflowError("Nonce too high") return intrinsic_gas diff --git a/src/ethereum/london/utils/address.py b/src/ethereum/london/utils/address.py index 573c7c2187..721034bbef 100644 --- a/src/ethereum/london/utils/address.py +++ b/src/ethereum/london/utils/address.py @@ -22,7 +22,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/london/utils/hexadecimal.py b/src/ethereum/london/utils/hexadecimal.py index 40cf31c42b..61e14d5ec2 100644 --- a/src/ethereum/london/utils/hexadecimal.py +++ b/src/ethereum/london/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/london/vm/instructions/environment.py b/src/ethereum/london/vm/instructions/environment.py index 172ce97d70..2dc640b449 100644 --- a/src/ethereum/london/vm/instructions/environment.py +++ b/src/ethereum/london/vm/instructions/environment.py @@ -19,7 +19,7 @@ from ...fork_types import EMPTY_ACCOUNT from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..exceptions import OutOfBoundsRead @@ -71,7 +71,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: @@ -336,7 +336,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: @@ -368,7 +368,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) @@ -464,7 +464,7 @@ def extcodehash(evm: Evm) -> None: The current EVM frame. """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: diff --git a/src/ethereum/london/vm/instructions/system.py b/src/ethereum/london/vm/instructions/system.py index cec5eebd51..bc551501ce 100644 --- a/src/ethereum/london/vm/instructions/system.py +++ b/src/ethereum/london/vm/instructions/system.py @@ -30,7 +30,7 @@ from ...utils.address import ( compute_contract_address, compute_create2_contract_address, - to_address, + to_address_masked, ) from .. import ( Evm, @@ -329,7 +329,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -353,11 +353,9 @@ def call(evm: Evm) -> None: code_address = to - create_gas_cost = ( - Uint(0) - if is_account_alive(evm.message.block_env.state, to) or value == 0 - else GAS_NEW_ACCOUNT - ) + create_gas_cost = GAS_NEW_ACCOUNT + if value == 0 or is_account_alive(evm.message.block_env.state, to): + create_gas_cost = Uint(0) transfer_gas_cost = Uint(0) if value == 0 else GAS_CALL_VALUE message_call_gas = calculate_message_call_gas( value, @@ -408,7 +406,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -481,7 +479,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_SELF_DESTRUCT @@ -546,7 +544,7 @@ def delegatecall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) @@ -604,7 +602,7 @@ def staticcall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) diff --git a/src/ethereum/muir_glacier/state.py b/src/ethereum/muir_glacier/state.py index 23d74a1e3c..31d21bfe6e 100644 --- a/src/ethereum/muir_glacier/state.py +++ b/src/ethereum/muir_glacier/state.py @@ -391,31 +391,6 @@ def account_has_storage(state: State, address: Address) -> bool: return address in state._storage_tries -def is_account_empty(state: State, address: Address) -> bool: - """ - Checks if an account has zero nonce, empty code and zero balance. - - Parameters - ---------- - state: - The state - address: - Address of the account that needs to be checked. - - Returns - ------- - is_empty : `bool` - True if an account has zero nonce, empty code and zero balance, - False otherwise. - """ - account = get_account(state, address) - return ( - account.nonce == Uint(0) - and account.code == b"" - and account.balance == 0 - ) - - def account_exists_and_is_empty(state: State, address: Address) -> bool: """ Checks if an account exists and has zero nonce, empty code and zero diff --git a/src/ethereum/muir_glacier/transactions.py b/src/ethereum/muir_glacier/transactions.py index 81b1e51eee..46304b1fd6 100644 --- a/src/ethereum/muir_glacier/transactions.py +++ b/src/ethereum/muir_glacier/transactions.py @@ -12,7 +12,11 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) from .fork_types import Address @@ -110,15 +114,17 @@ def validate_transaction(tx: Transaction) -> Uint: This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an - `InvalidTransaction` exception if the transaction is invalid. + `InsufficientTransactionGasError` exception if the transaction does not + provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` + exception if the nonce is greater than `2**64 - 2`. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 """ intrinsic_gas = calculate_intrinsic_cost(tx) if intrinsic_gas > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") + raise NonceOverflowError("Nonce too high") return intrinsic_gas diff --git a/src/ethereum/muir_glacier/utils/address.py b/src/ethereum/muir_glacier/utils/address.py index e2b2770e33..47121af5df 100644 --- a/src/ethereum/muir_glacier/utils/address.py +++ b/src/ethereum/muir_glacier/utils/address.py @@ -22,7 +22,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/muir_glacier/utils/hexadecimal.py b/src/ethereum/muir_glacier/utils/hexadecimal.py index 167275f4e0..a08ed3fb14 100644 --- a/src/ethereum/muir_glacier/utils/hexadecimal.py +++ b/src/ethereum/muir_glacier/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/muir_glacier/vm/instructions/environment.py b/src/ethereum/muir_glacier/vm/instructions/environment.py index 9f26185b8f..729f98b6c0 100644 --- a/src/ethereum/muir_glacier/vm/instructions/environment.py +++ b/src/ethereum/muir_glacier/vm/instructions/environment.py @@ -19,7 +19,7 @@ from ...fork_types import EMPTY_ACCOUNT from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..exceptions import OutOfBoundsRead @@ -72,7 +72,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_BALANCE) @@ -333,7 +333,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_EXTERNAL) @@ -359,7 +359,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) @@ -448,7 +448,7 @@ def extcodehash(evm: Evm) -> None: The current EVM frame. """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_CODE_HASH) diff --git a/src/ethereum/muir_glacier/vm/instructions/system.py b/src/ethereum/muir_glacier/vm/instructions/system.py index bd1429793b..31868a9c27 100644 --- a/src/ethereum/muir_glacier/vm/instructions/system.py +++ b/src/ethereum/muir_glacier/vm/instructions/system.py @@ -29,7 +29,7 @@ from ...utils.address import ( compute_contract_address, compute_create2_contract_address, - to_address, + to_address_masked, ) from .. import ( Evm, @@ -326,7 +326,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -344,11 +344,9 @@ def call(evm: Evm) -> None: code_address = to - create_gas_cost = ( - Uint(0) - if is_account_alive(evm.message.block_env.state, to) or value == 0 - else GAS_NEW_ACCOUNT - ) + create_gas_cost = GAS_NEW_ACCOUNT + if value == 0 or is_account_alive(evm.message.block_env.state, to): + create_gas_cost = Uint(0) transfer_gas_cost = Uint(0) if value == 0 else GAS_CALL_VALUE message_call_gas = calculate_message_call_gas( value, @@ -399,7 +397,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -465,7 +463,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_SELF_DESTRUCT @@ -537,7 +535,7 @@ def delegatecall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) @@ -588,7 +586,7 @@ def staticcall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) diff --git a/src/ethereum/osaka/__init__.py b/src/ethereum/osaka/__init__.py new file mode 100644 index 0000000000..8c5c37298a --- /dev/null +++ b/src/ethereum/osaka/__init__.py @@ -0,0 +1,7 @@ +""" +The Osaka fork. +""" + +from ethereum.fork_criteria import Unscheduled + +FORK_CRITERIA = Unscheduled() diff --git a/src/ethereum/osaka/blocks.py b/src/ethereum/osaka/blocks.py new file mode 100644 index 0000000000..fd906d8f71 --- /dev/null +++ b/src/ethereum/osaka/blocks.py @@ -0,0 +1,403 @@ +""" +A `Block` is a single link in the chain that is Ethereum. Each `Block` contains +a `Header` and zero or more transactions. Each `Header` contains associated +metadata like the block number, parent block hash, and how much gas was +consumed by its transactions. + +Together, these blocks form a cryptographically secure journal recording the +history of all state transitions that have happened since the genesis of the +chain. +""" +from dataclasses import dataclass +from typing import Tuple + +from ethereum_rlp import rlp +from ethereum_types.bytes import Bytes, Bytes8, Bytes32 +from ethereum_types.frozen import slotted_freezable +from ethereum_types.numeric import U64, U256, Uint + +from ..crypto.hash import Hash32 +from .fork_types import Address, Bloom, Root +from .transactions import ( + AccessListTransaction, + BlobTransaction, + FeeMarketTransaction, + LegacyTransaction, + SetCodeTransaction, + Transaction, +) + + +@slotted_freezable +@dataclass +class Withdrawal: + """ + Withdrawals represent a transfer of ETH from the consensus layer (beacon + chain) to the execution layer, as validated by the consensus layer. Each + withdrawal is listed in the block's list of withdrawals. See [`block`] + + [`block`]: ref:ethereum.osaka.blocks.Block.withdrawals + """ + + index: U64 + """ + The unique index of the withdrawal, incremented for each withdrawal + processed. + """ + + validator_index: U64 + """ + The index of the validator on the consensus layer that is withdrawing. + """ + + address: Address + """ + The execution-layer address receiving the withdrawn ETH. + """ + + amount: U256 + """ + The amount of ETH being withdrawn. + """ + + +@slotted_freezable +@dataclass +class Header: + """ + Header portion of a block on the chain, containing metadata and + cryptographic commitments to the block's contents. + """ + + parent_hash: Hash32 + """ + Hash ([`keccak256`]) of the parent block's header, encoded with [RLP]. + + [`keccak256`]: ref:ethereum.crypto.hash.keccak256 + [RLP]: https://ethereum.github.io/ethereum-rlp/src/ethereum_rlp/rlp.py.html + """ + + ommers_hash: Hash32 + """ + Hash ([`keccak256`]) of the ommers (uncle blocks) in this block, encoded + with [RLP]. However, in post merge forks `ommers_hash` is always + [`EMPTY_OMMER_HASH`]. + + [`keccak256`]: ref:ethereum.crypto.hash.keccak256 + [RLP]: https://ethereum.github.io/ethereum-rlp/src/ethereum_rlp/rlp.py.html + [`EMPTY_OMMER_HASH`]: ref:ethereum.osaka.fork.EMPTY_OMMER_HASH + """ + + coinbase: Address + """ + Address of the miner (or validator) who mined this block. + + The coinbase address receives the block reward and the priority fees (tips) + from included transactions. Base fees (introduced in [EIP-1559]) are burned + and do not go to the coinbase. + + [EIP-1559]: https://eips.ethereum.org/EIPS/eip-1559 + """ + + state_root: Root + """ + Root hash ([`keccak256`]) of the state trie after executing all + transactions in this block. It represents the state of the Ethereum Virtual + Machine (EVM) after all transactions in this block have been processed. It + is computed using the [`state_root()`] function, which computes the root + of the Merkle-Patricia [Trie] representing the Ethereum world state. + + [`keccak256`]: ref:ethereum.crypto.hash.keccak256 + [`state_root()`]: ref:ethereum.osaka.state.state_root + [Trie]: ref:ethereum.osaka.trie.Trie + """ + + transactions_root: Root + """ + Root hash ([`keccak256`]) of the transactions trie, which contains all + transactions included in this block in their original order. It is computed + using the [`root()`] function over the Merkle-Patricia [trie] of + transactions as the parameter. + + [`keccak256`]: ref:ethereum.crypto.hash.keccak256 + [`root()`]: ref:ethereum.osaka.trie.root + [Trie]: ref:ethereum.osaka.trie.Trie + """ + + receipt_root: Root + """ + Root hash ([`keccak256`]) of the receipts trie, which contains all receipts + for transactions in this block. It is computed using the [`root()`] + function over the Merkle-Patricia [trie] constructed from the receipts. + + [`keccak256`]: ref:ethereum.crypto.hash.keccak256 + [`root()`]: ref:ethereum.osaka.trie.root + [Trie]: ref:ethereum.osaka.trie.Trie + """ + + bloom: Bloom + """ + Bloom filter for logs generated by transactions in this block. + Constructed from all logs in the block using the [logs bloom] mechanism. + + [logs bloom]: ref:ethereum.osaka.bloom.logs_bloom + """ + + difficulty: Uint + """ + Difficulty of the block (pre-PoS), or a constant in PoS. + """ + + number: Uint + """ + Block number, (height) in the chain. + """ + + gas_limit: Uint + """ + Maximum gas allowed in this block. Pre [EIP-1559], this was the maximum + gas that could be consumed by all transactions in the block. Post + [EIP-1559], this is still the maximum gas limit, but the base fee per gas + is also considered when calculating the effective gas limit. This can be + [adjusted by a factor of 1/1024] from the previous block's gas limit, up + until a maximum of 30 million gas. + + [EIP-1559]: https://eips.ethereum.org/EIPS/eip-1559 + [adjusted by a factor of 1/1024]: + https://ethereum.org/en/developers/docs/blocks/ + """ + + gas_used: Uint + """ + Total gas used by all transactions in this block. + """ + + timestamp: U256 + """ + Timestamp of when the block was mined, in seconds since the unix epoch. + """ + + extra_data: Bytes + """ + Arbitrary data included by the miner. + """ + + prev_randao: Bytes32 + """ + Output of the RANDAO beacon for random validator selection. + """ + + nonce: Bytes8 + """ + Nonce used in the mining process (pre-PoS), set to zero in PoS. + """ + + base_fee_per_gas: Uint + """ + Base fee per gas for transactions in this block, introduced in + [EIP-1559]. This is the minimum fee per gas that must be paid for a + transaction to be included in this block. + + [EIP-1559]: https://eips.ethereum.org/EIPS/eip-1559 + """ + + withdrawals_root: Root + """ + Root hash of the withdrawals trie, which contains all withdrawals in this + block. + """ + + blob_gas_used: U64 + """ + Total blob gas consumed by the transactions within this block. Introduced + in [EIP-4844]. + + [EIP-4844]: https://eips.ethereum.org/EIPS/eip-4844 + """ + + excess_blob_gas: U64 + """ + Running total of blob gas consumed in excess of the target, prior to this + block. Blocks with above-target blob gas consumption increase this value, + while blocks with below-target blob gas consumption decrease it (to a + minimum of zero). Introduced in [EIP-4844]. + + [EIP-4844]: https://eips.ethereum.org/EIPS/eip-4844 + """ + + parent_beacon_block_root: Root + """ + Root hash of the corresponding beacon chain block. + """ + + requests_hash: Hash32 + """ + [SHA2-256] hash of all the collected requests in this block. Introduced in + [EIP-7685]. See [`compute_requests_hash`][crh] for more details. + + [EIP-7685]: https://eips.ethereum.org/EIPS/eip-7685 + [crh]: ref:ethereum.osaka.requests.compute_requests_hash + [SHA2-256]: https://en.wikipedia.org/wiki/SHA-2 + """ + + +@slotted_freezable +@dataclass +class Block: + """ + A complete block on Ethereum, which is composed of a block [`header`], + a list of transactions, a list of ommers (deprecated), and a list of + validator [withdrawals]. + + The block [`header`] includes fields relevant to the Proof-of-Stake + consensus, with deprecated Proof-of-Work fields such as `difficulty`, + `nonce`, and `ommersHash` set to constants. The `coinbase` field + denotes the address receiving priority fees from the block. + + The header also contains commitments to the current state (`stateRoot`), + the transactions (`transactionsRoot`), the transaction receipts + (`receiptsRoot`), and `withdrawalsRoot` committing to the validator + withdrawals included in this block. It also includes a bloom filter which + summarizes log data from the transactions. + + Withdrawals represent ETH transfers from validators to their recipients, + introduced by the consensus layer. Ommers remain deprecated and empty. + + [`header`]: ref:ethereum.osaka.blocks.Header + [withdrawals]: ref:ethereum.osaka.blocks.Withdrawal + """ + + header: Header + """ + The block header containing metadata and cryptographic commitments. Refer + [headers] for more details on the fields included in the header. + + [headers]: ref:ethereum.osaka.blocks.Header + """ + + transactions: Tuple[Bytes | LegacyTransaction, ...] + """ + A tuple of transactions included in this block. Each transaction can be + any of a legacy transaction, an access list transaction, a fee market + transaction, a blob transaction, or a set code transaction. + """ + + ommers: Tuple[Header, ...] + """ + A tuple of ommers (uncle blocks) included in this block. Always empty in + Proof-of-Stake forks. + """ + + withdrawals: Tuple[Withdrawal, ...] + """ + A tuple of withdrawals processed in this block. + """ + + +@slotted_freezable +@dataclass +class Log: + """ + Data record produced during the execution of a transaction. Logs are used + by smart contracts to emit events (using the EVM log opcodes ([`LOG0`], + [`LOG1`], [`LOG2`], [`LOG3`] and [`LOG4`]), which can be efficiently + searched using the bloom filter in the block header. + + [`LOG0`]: ref:ethereum.osaka.vm.instructions.log.log0 + [`LOG1`]: ref:ethereum.osaka.vm.instructions.log.log1 + [`LOG2`]: ref:ethereum.osaka.vm.instructions.log.log2 + [`LOG3`]: ref:ethereum.osaka.vm.instructions.log.log3 + [`LOG4`]: ref:ethereum.osaka.vm.instructions.log.log4 + """ + + address: Address + """ + The address of the contract that emitted the log. + """ + + topics: Tuple[Hash32, ...] + """ + A tuple of up to four topics associated with the log, used for filtering. + """ + + data: Bytes + """ + The data payload of the log, which can contain any arbitrary data. + """ + + +@slotted_freezable +@dataclass +class Receipt: + """ + Result of a transaction execution. Receipts are included in the receipts + trie. + """ + + succeeded: bool + """ + Whether the transaction execution was successful. + """ + + cumulative_gas_used: Uint + """ + Total gas used in the block up to and including this transaction. + """ + + bloom: Bloom + """ + Bloom filter for logs generated by this transaction. This is a 2048-byte + bit array that allows for efficient filtering of logs. + """ + + logs: Tuple[Log, ...] + """ + A tuple of logs generated by this transaction. Each log contains the + address of the contract that emitted it, a tuple of topics, and the data + payload. + """ + + +def encode_receipt(tx: Transaction, receipt: Receipt) -> Bytes | Receipt: + r""" + Encodes a transaction receipt based on the transaction type. + + The encoding follows the same format as transactions encoding, where: + - AccessListTransaction receipts are prefixed with `b"\x01"`. + - FeeMarketTransaction receipts are prefixed with `b"\x02"`. + - BlobTransaction receipts are prefixed with `b"\x03"`. + - SetCodeTransaction receipts are prefixed with `b"\x04"`. + - LegacyTransaction receipts are returned as is. + """ + if isinstance(tx, AccessListTransaction): + return b"\x01" + rlp.encode(receipt) + elif isinstance(tx, FeeMarketTransaction): + return b"\x02" + rlp.encode(receipt) + elif isinstance(tx, BlobTransaction): + return b"\x03" + rlp.encode(receipt) + elif isinstance(tx, SetCodeTransaction): + return b"\x04" + rlp.encode(receipt) + else: + return receipt + + +def decode_receipt(receipt: Bytes | Receipt) -> Receipt: + r""" + Decodes a receipt from its serialized form. + + The decoding follows the same format as transactions decoding, where: + - Receipts prefixed with `b"\x01"` are decoded as AccessListTransaction + receipts. + - Receipts prefixed with `b"\x02"` are decoded as FeeMarketTransaction + receipts. + - Receipts prefixed with `b"\x03"` are decoded as BlobTransaction + receipts. + - Receipts prefixed with `b"\x04"` are decoded as SetCodeTransaction + receipts. + - LegacyTransaction receipts are returned as is. + """ + if isinstance(receipt, Bytes): + assert receipt[0] in (1, 2, 3, 4) + return rlp.decode_to(Receipt, receipt[1:]) + else: + return receipt diff --git a/src/ethereum/osaka/bloom.py b/src/ethereum/osaka/bloom.py new file mode 100644 index 0000000000..63db26dab5 --- /dev/null +++ b/src/ethereum/osaka/bloom.py @@ -0,0 +1,86 @@ +""" +Ethereum Logs Bloom +^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +This modules defines functions for calculating bloom filters of logs. For the +general theory of bloom filters see e.g. `Wikipedia +`_. Bloom filters are used to allow +for efficient searching of logs by address and/or topic, by rapidly +eliminating blocks and receipts from their search. +""" + +from typing import Tuple + +from ethereum_types.bytes import Bytes +from ethereum_types.numeric import Uint + +from ethereum.crypto.hash import keccak256 + +from .blocks import Log +from .fork_types import Bloom + + +def add_to_bloom(bloom: bytearray, bloom_entry: Bytes) -> None: + """ + Add a bloom entry to the bloom filter (`bloom`). + + The number of hash functions used is 3. They are calculated by taking the + least significant 11 bits from the first 3 16-bit words of the + `keccak_256()` hash of `bloom_entry`. + + Parameters + ---------- + bloom : + The bloom filter. + bloom_entry : + An entry which is to be added to bloom filter. + """ + hash = keccak256(bloom_entry) + + for idx in (0, 2, 4): + # Obtain the least significant 11 bits from the pair of bytes + # (16 bits), and set this bit in bloom bytearray. + # The obtained bit is 0-indexed in the bloom filter from the least + # significant bit to the most significant bit. + bit_to_set = Uint.from_be_bytes(hash[idx : idx + 2]) & Uint(0x07FF) + # Below is the index of the bit in the bytearray (where 0-indexed + # byte is the most significant byte) + bit_index = 0x07FF - int(bit_to_set) + + byte_index = bit_index // 8 + bit_value = 1 << (7 - (bit_index % 8)) + bloom[byte_index] = bloom[byte_index] | bit_value + + +def logs_bloom(logs: Tuple[Log, ...]) -> Bloom: + """ + Obtain the logs bloom from a list of log entries. + + The address and each topic of a log are added to the bloom filter. + + Parameters + ---------- + logs : + List of logs for which the logs bloom is to be obtained. + + Returns + ------- + logs_bloom : `Bloom` + The logs bloom obtained which is 256 bytes with some bits set as per + the caller address and the log topics. + """ + bloom: bytearray = bytearray(b"\x00" * 256) + + for log in logs: + add_to_bloom(bloom, log.address) + for topic in log.topics: + add_to_bloom(bloom, topic) + + return Bloom(bloom) diff --git a/src/ethereum/osaka/exceptions.py b/src/ethereum/osaka/exceptions.py new file mode 100644 index 0000000000..e74948cb59 --- /dev/null +++ b/src/ethereum/osaka/exceptions.py @@ -0,0 +1,125 @@ +""" +Exceptions specific to this fork. +""" + +from typing import TYPE_CHECKING, Final + +from ethereum_types.numeric import Uint + +from ethereum.exceptions import InvalidTransaction + +if TYPE_CHECKING: + from .transactions import Transaction + + +class TransactionTypeError(InvalidTransaction): + """ + Unknown [EIP-2718] transaction type byte. + + [EIP-2718]: https://eips.ethereum.org/EIPS/eip-2718 + """ + + transaction_type: Final[int] + """ + The type byte of the transaction that caused the error. + """ + + def __init__(self, transaction_type: int): + super().__init__(f"unknown transaction type `{transaction_type}`") + self.transaction_type = transaction_type + + +class TransactionTypeContractCreationError(InvalidTransaction): + """ + Contract creation is not allowed for a transaction type. + """ + + transaction: "Transaction" + """ + The transaction that caused the error. + """ + + def __init__(self, transaction: "Transaction"): + super().__init__( + f"transaction type `{type(transaction).__name__}` not allowed to " + "create contracts" + ) + self.transaction = transaction + + +class BlobGasLimitExceededError(InvalidTransaction): + """ + The blob gas limit for the transaction exceeds the maximum allowed. + """ + + +class InsufficientMaxFeePerBlobGasError(InvalidTransaction): + """ + The maximum fee per blob gas is insufficient for the transaction. + """ + + +class InsufficientMaxFeePerGasError(InvalidTransaction): + """ + The maximum fee per gas is insufficient for the transaction. + """ + + transaction_max_fee_per_gas: Final[Uint] + """ + The maximum fee per gas specified in the transaction. + """ + + block_base_fee_per_gas: Final[Uint] + """ + The base fee per gas of the block in which the transaction is included. + """ + + def __init__( + self, transaction_max_fee_per_gas: Uint, block_base_fee_per_gas: Uint + ): + super().__init__( + f"Insufficient max fee per gas " + f"({transaction_max_fee_per_gas} < {block_base_fee_per_gas})" + ) + self.transaction_max_fee_per_gas = transaction_max_fee_per_gas + self.block_base_fee_per_gas = block_base_fee_per_gas + + +class InvalidBlobVersionedHashError(InvalidTransaction): + """ + The versioned hash of the blob is invalid. + """ + + +class NoBlobDataError(InvalidTransaction): + """ + The transaction does not contain any blob data. + """ + + +class PriorityFeeGreaterThanMaxFeeError(InvalidTransaction): + """ + The priority fee is greater than the maximum fee per gas. + """ + + +class EmptyAuthorizationListError(InvalidTransaction): + """ + The authorization list in the transaction is empty. + """ + + +class InitCodeTooLargeError(InvalidTransaction): + """ + The init code of the transaction is too large. + """ + + +class TransactionGasLimitExceededError(InvalidTransaction): + """ + The transaction has specified a gas limit that is greater than the allowed + maximum. + + Note that this is _not_ the exception thrown when bytecode execution runs + out of gas. + """ diff --git a/src/ethereum/osaka/fork.py b/src/ethereum/osaka/fork.py new file mode 100644 index 0000000000..1cf5ce95dd --- /dev/null +++ b/src/ethereum/osaka/fork.py @@ -0,0 +1,1047 @@ +""" +Ethereum Specification +^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Entry point for the Ethereum specification. +""" + +from dataclasses import dataclass +from typing import List, Optional, Tuple + +from ethereum_rlp import rlp +from ethereum_types.bytes import Bytes +from ethereum_types.numeric import U64, U256, Uint + +from ethereum.crypto.hash import Hash32, keccak256 +from ethereum.exceptions import ( + EthereumException, + GasUsedExceedsLimitError, + InsufficientBalanceError, + InvalidBlock, + InvalidSenderError, + NonceMismatchError, +) + +from . import vm +from .blocks import Block, Header, Log, Receipt, Withdrawal, encode_receipt +from .bloom import logs_bloom +from .exceptions import ( + BlobGasLimitExceededError, + EmptyAuthorizationListError, + InsufficientMaxFeePerBlobGasError, + InsufficientMaxFeePerGasError, + InvalidBlobVersionedHashError, + NoBlobDataError, + PriorityFeeGreaterThanMaxFeeError, + TransactionTypeContractCreationError, +) +from .fork_types import Account, Address, Authorization, VersionedHash +from .requests import ( + CONSOLIDATION_REQUEST_TYPE, + DEPOSIT_REQUEST_TYPE, + WITHDRAWAL_REQUEST_TYPE, + compute_requests_hash, + parse_deposit_requests, +) +from .state import ( + State, + TransientStorage, + account_exists_and_is_empty, + destroy_account, + get_account, + increment_nonce, + modify_state, + set_account_balance, + state_root, +) +from .transactions import ( + AccessListTransaction, + BlobTransaction, + FeeMarketTransaction, + LegacyTransaction, + SetCodeTransaction, + Transaction, + decode_transaction, + encode_transaction, + get_transaction_hash, + recover_sender, + validate_transaction, +) +from .trie import root, trie_set +from .utils.hexadecimal import hex_to_address +from .utils.message import prepare_message +from .vm import Message +from .vm.eoa_delegation import is_valid_delegation +from .vm.gas import ( + calculate_blob_gas_price, + calculate_data_fee, + calculate_excess_blob_gas, + calculate_total_blob_gas, +) +from .vm.interpreter import MessageCallOutput, process_message_call + +BASE_FEE_MAX_CHANGE_DENOMINATOR = Uint(8) +ELASTICITY_MULTIPLIER = Uint(2) +GAS_LIMIT_ADJUSTMENT_FACTOR = Uint(1024) +GAS_LIMIT_MINIMUM = Uint(5000) +EMPTY_OMMER_HASH = keccak256(rlp.encode([])) +SYSTEM_ADDRESS = hex_to_address("0xfffffffffffffffffffffffffffffffffffffffe") +BEACON_ROOTS_ADDRESS = hex_to_address( + "0x000F3df6D732807Ef1319fB7B8bB8522d0Beac02" +) +SYSTEM_TRANSACTION_GAS = Uint(30000000) +MAX_BLOB_GAS_PER_BLOCK = U64(1179648) +VERSIONED_HASH_VERSION_KZG = b"\x01" + +WITHDRAWAL_REQUEST_PREDEPLOY_ADDRESS = hex_to_address( + "0x00000961Ef480Eb55e80D19ad83579A64c007002" +) +CONSOLIDATION_REQUEST_PREDEPLOY_ADDRESS = hex_to_address( + "0x0000BBdDc7CE488642fb579F8B00f3a590007251" +) +HISTORY_STORAGE_ADDRESS = hex_to_address( + "0x0000F90827F1C53a10cb7A02335B175320002935" +) +MAX_BLOCK_SIZE = 10_485_760 +SAFETY_MARGIN = 2_097_152 +MAX_RLP_BLOCK_SIZE = MAX_BLOCK_SIZE - SAFETY_MARGIN + + +@dataclass +class BlockChain: + """ + History and current state of the block chain. + """ + + blocks: List[Block] + state: State + chain_id: U64 + + +def apply_fork(old: BlockChain) -> BlockChain: + """ + Transforms the state from the previous hard fork (`old`) into the block + chain object for this hard fork and returns it. + + When forks need to implement an irregular state transition, this function + is used to handle the irregularity. See the :ref:`DAO Fork ` for + an example. + + Parameters + ---------- + old : + Previous block chain object. + + Returns + ------- + new : `BlockChain` + Upgraded block chain object for this hard fork. + """ + return old + + +def get_last_256_block_hashes(chain: BlockChain) -> List[Hash32]: + """ + Obtain the list of hashes of the previous 256 blocks in order of + increasing block number. + + This function will return less hashes for the first 256 blocks. + + The ``BLOCKHASH`` opcode needs to access the latest hashes on the chain, + therefore this function retrieves them. + + Parameters + ---------- + chain : + History and current state. + + Returns + ------- + recent_block_hashes : `List[Hash32]` + Hashes of the recent 256 blocks in order of increasing block number. + """ + recent_blocks = chain.blocks[-255:] + # TODO: This function has not been tested rigorously + if len(recent_blocks) == 0: + return [] + + recent_block_hashes = [] + + for block in recent_blocks: + prev_block_hash = block.header.parent_hash + recent_block_hashes.append(prev_block_hash) + + # We are computing the hash only for the most recent block and not for + # the rest of the blocks as they have successors which have the hash of + # the current block as parent hash. + most_recent_block_hash = keccak256(rlp.encode(recent_blocks[-1].header)) + recent_block_hashes.append(most_recent_block_hash) + + return recent_block_hashes + + +def state_transition(chain: BlockChain, block: Block) -> None: + """ + Attempts to apply a block to an existing block chain. + + All parts of the block's contents need to be verified before being added + to the chain. Blocks are verified by ensuring that the contents of the + block make logical sense with the contents of the parent block. The + information in the block's header must also match the corresponding + information in the block. + + To implement Ethereum, in theory clients are only required to store the + most recent 255 blocks of the chain since as far as execution is + concerned, only those blocks are accessed. Practically, however, clients + should store more blocks to handle reorgs. + + Parameters + ---------- + chain : + History and current state. + block : + Block to apply to `chain`. + """ + if len(rlp.encode(block)) > MAX_RLP_BLOCK_SIZE: + raise InvalidBlock("Block rlp size exceeds MAX_RLP_BLOCK_SIZE") + + validate_header(chain, block.header) + if block.ommers != (): + raise InvalidBlock + + block_env = vm.BlockEnvironment( + chain_id=chain.chain_id, + state=chain.state, + block_gas_limit=block.header.gas_limit, + block_hashes=get_last_256_block_hashes(chain), + coinbase=block.header.coinbase, + number=block.header.number, + base_fee_per_gas=block.header.base_fee_per_gas, + time=block.header.timestamp, + prev_randao=block.header.prev_randao, + excess_blob_gas=block.header.excess_blob_gas, + parent_beacon_block_root=block.header.parent_beacon_block_root, + ) + + block_output = apply_body( + block_env=block_env, + transactions=block.transactions, + withdrawals=block.withdrawals, + ) + block_state_root = state_root(block_env.state) + transactions_root = root(block_output.transactions_trie) + receipt_root = root(block_output.receipts_trie) + block_logs_bloom = logs_bloom(block_output.block_logs) + withdrawals_root = root(block_output.withdrawals_trie) + requests_hash = compute_requests_hash(block_output.requests) + + if block_output.block_gas_used != block.header.gas_used: + raise InvalidBlock( + f"{block_output.block_gas_used} != {block.header.gas_used}" + ) + if transactions_root != block.header.transactions_root: + raise InvalidBlock + if block_state_root != block.header.state_root: + raise InvalidBlock + if receipt_root != block.header.receipt_root: + raise InvalidBlock + if block_logs_bloom != block.header.bloom: + raise InvalidBlock + if withdrawals_root != block.header.withdrawals_root: + raise InvalidBlock + if block_output.blob_gas_used != block.header.blob_gas_used: + raise InvalidBlock + if requests_hash != block.header.requests_hash: + raise InvalidBlock + + chain.blocks.append(block) + if len(chain.blocks) > 255: + # Real clients have to store more blocks to deal with reorgs, but the + # protocol only requires the last 255 + chain.blocks = chain.blocks[-255:] + + +def calculate_base_fee_per_gas( + block_gas_limit: Uint, + parent_gas_limit: Uint, + parent_gas_used: Uint, + parent_base_fee_per_gas: Uint, +) -> Uint: + """ + Calculates the base fee per gas for the block. + + Parameters + ---------- + block_gas_limit : + Gas limit of the block for which the base fee is being calculated. + parent_gas_limit : + Gas limit of the parent block. + parent_gas_used : + Gas used in the parent block. + parent_base_fee_per_gas : + Base fee per gas of the parent block. + + Returns + ------- + base_fee_per_gas : `Uint` + Base fee per gas for the block. + """ + parent_gas_target = parent_gas_limit // ELASTICITY_MULTIPLIER + if not check_gas_limit(block_gas_limit, parent_gas_limit): + raise InvalidBlock + + if parent_gas_used == parent_gas_target: + expected_base_fee_per_gas = parent_base_fee_per_gas + elif parent_gas_used > parent_gas_target: + gas_used_delta = parent_gas_used - parent_gas_target + + parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta + target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target + + base_fee_per_gas_delta = max( + target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR, + Uint(1), + ) + + expected_base_fee_per_gas = ( + parent_base_fee_per_gas + base_fee_per_gas_delta + ) + else: + gas_used_delta = parent_gas_target - parent_gas_used + + parent_fee_gas_delta = parent_base_fee_per_gas * gas_used_delta + target_fee_gas_delta = parent_fee_gas_delta // parent_gas_target + + base_fee_per_gas_delta = ( + target_fee_gas_delta // BASE_FEE_MAX_CHANGE_DENOMINATOR + ) + + expected_base_fee_per_gas = ( + parent_base_fee_per_gas - base_fee_per_gas_delta + ) + + return Uint(expected_base_fee_per_gas) + + +def validate_header(chain: BlockChain, header: Header) -> None: + """ + Verifies a block header. + + In order to consider a block's header valid, the logic for the + quantities in the header should match the logic for the block itself. + For example the header timestamp should be greater than the block's parent + timestamp because the block was created *after* the parent block. + Additionally, the block's number should be directly following the parent + block's number since it is the next block in the sequence. + + Parameters + ---------- + chain : + History and current state. + header : + Header to check for correctness. + """ + if header.number < Uint(1): + raise InvalidBlock + + parent_header = chain.blocks[-1].header + + excess_blob_gas = calculate_excess_blob_gas(parent_header) + if header.excess_blob_gas != excess_blob_gas: + raise InvalidBlock + + if header.gas_used > header.gas_limit: + raise InvalidBlock + + expected_base_fee_per_gas = calculate_base_fee_per_gas( + header.gas_limit, + parent_header.gas_limit, + parent_header.gas_used, + parent_header.base_fee_per_gas, + ) + if expected_base_fee_per_gas != header.base_fee_per_gas: + raise InvalidBlock + if header.timestamp <= parent_header.timestamp: + raise InvalidBlock + if header.number != parent_header.number + Uint(1): + raise InvalidBlock + if len(header.extra_data) > 32: + raise InvalidBlock + if header.difficulty != 0: + raise InvalidBlock + if header.nonce != b"\x00\x00\x00\x00\x00\x00\x00\x00": + raise InvalidBlock + if header.ommers_hash != EMPTY_OMMER_HASH: + raise InvalidBlock + + block_parent_hash = keccak256(rlp.encode(parent_header)) + if header.parent_hash != block_parent_hash: + raise InvalidBlock + + +def check_transaction( + block_env: vm.BlockEnvironment, + block_output: vm.BlockOutput, + tx: Transaction, +) -> Tuple[Address, Uint, Tuple[VersionedHash, ...], U64]: + """ + Check if the transaction is includable in the block. + + Parameters + ---------- + block_env : + The block scoped environment. + block_output : + The block output for the current block. + tx : + The transaction. + + Returns + ------- + sender_address : + The sender of the transaction. + effective_gas_price : + The price to charge for gas when the transaction is executed. + blob_versioned_hashes : + The blob versioned hashes of the transaction. + tx_blob_gas_used: + The blob gas used by the transaction. + + Raises + ------ + InvalidBlock : + If the transaction is not includable. + GasUsedExceedsLimitError : + If the gas used by the transaction exceeds the block's gas limit. + NonceMismatchError : + If the nonce of the transaction is not equal to the sender's nonce. + InsufficientBalanceError : + If the sender's balance is not enough to pay for the transaction. + InvalidSenderError : + If the transaction is from an address that does not exist anymore. + PriorityFeeGreaterThanMaxFeeError : + If the priority fee is greater than the maximum fee per gas. + InsufficientMaxFeePerGasError : + If the maximum fee per gas is insufficient for the transaction. + InsufficientMaxFeePerBlobGasError : + If the maximum fee per blob gas is insufficient for the transaction. + BlobGasLimitExceededError : + If the blob gas used by the transaction exceeds the block's blob gas + limit. + InvalidBlobVersionedHashError : + If the transaction contains a blob versioned hash with an invalid + version. + NoBlobDataError : + If the transaction is a type 3 but has no blobs. + TransactionTypeContractCreationError: + If the transaction type is not allowed to create contracts. + EmptyAuthorizationListError : + If the transaction is a SetCodeTransaction and the authorization list + is empty. + """ + gas_available = block_env.block_gas_limit - block_output.block_gas_used + blob_gas_available = MAX_BLOB_GAS_PER_BLOCK - block_output.blob_gas_used + + if tx.gas > gas_available: + raise GasUsedExceedsLimitError("gas used exceeds limit") + + tx_blob_gas_used = calculate_total_blob_gas(tx) + if tx_blob_gas_used > blob_gas_available: + raise BlobGasLimitExceededError("blob gas limit exceeded") + + sender_address = recover_sender(block_env.chain_id, tx) + sender_account = get_account(block_env.state, sender_address) + + if isinstance( + tx, (FeeMarketTransaction, BlobTransaction, SetCodeTransaction) + ): + if tx.max_fee_per_gas < tx.max_priority_fee_per_gas: + raise PriorityFeeGreaterThanMaxFeeError( + "priority fee greater than max fee" + ) + if tx.max_fee_per_gas < block_env.base_fee_per_gas: + raise InsufficientMaxFeePerGasError( + tx.max_fee_per_gas, block_env.base_fee_per_gas + ) + + priority_fee_per_gas = min( + tx.max_priority_fee_per_gas, + tx.max_fee_per_gas - block_env.base_fee_per_gas, + ) + effective_gas_price = priority_fee_per_gas + block_env.base_fee_per_gas + max_gas_fee = tx.gas * tx.max_fee_per_gas + else: + if tx.gas_price < block_env.base_fee_per_gas: + raise InvalidBlock + effective_gas_price = tx.gas_price + max_gas_fee = tx.gas * tx.gas_price + + if isinstance(tx, BlobTransaction): + if len(tx.blob_versioned_hashes) == 0: + raise NoBlobDataError("no blob data in transaction") + for blob_versioned_hash in tx.blob_versioned_hashes: + if blob_versioned_hash[0:1] != VERSIONED_HASH_VERSION_KZG: + raise InvalidBlobVersionedHashError( + "invalid blob versioned hash" + ) + + blob_gas_price = calculate_blob_gas_price(block_env.excess_blob_gas) + if Uint(tx.max_fee_per_blob_gas) < blob_gas_price: + raise InsufficientMaxFeePerBlobGasError( + "insufficient max fee per blob gas" + ) + + max_gas_fee += Uint(calculate_total_blob_gas(tx)) * Uint( + tx.max_fee_per_blob_gas + ) + blob_versioned_hashes = tx.blob_versioned_hashes + else: + blob_versioned_hashes = () + + if isinstance(tx, (BlobTransaction, SetCodeTransaction)): + if not isinstance(tx.to, Address): + raise TransactionTypeContractCreationError(tx) + + if isinstance(tx, SetCodeTransaction): + if not any(tx.authorizations): + raise EmptyAuthorizationListError("empty authorization list") + + if sender_account.nonce > Uint(tx.nonce): + raise NonceMismatchError("nonce too low") + elif sender_account.nonce < Uint(tx.nonce): + raise NonceMismatchError("nonce too high") + + if Uint(sender_account.balance) < max_gas_fee + Uint(tx.value): + raise InsufficientBalanceError("insufficient sender balance") + if sender_account.code and not is_valid_delegation(sender_account.code): + raise InvalidSenderError("not EOA") + + return ( + sender_address, + effective_gas_price, + blob_versioned_hashes, + tx_blob_gas_used, + ) + + +def make_receipt( + tx: Transaction, + error: Optional[EthereumException], + cumulative_gas_used: Uint, + logs: Tuple[Log, ...], +) -> Bytes | Receipt: + """ + Make the receipt for a transaction that was executed. + + Parameters + ---------- + tx : + The executed transaction. + error : + Error in the top level frame of the transaction, if any. + cumulative_gas_used : + The total gas used so far in the block after the transaction was + executed. + logs : + The logs produced by the transaction. + + Returns + ------- + receipt : + The receipt for the transaction. + """ + receipt = Receipt( + succeeded=error is None, + cumulative_gas_used=cumulative_gas_used, + bloom=logs_bloom(logs), + logs=logs, + ) + + return encode_receipt(tx, receipt) + + +def process_system_transaction( + block_env: vm.BlockEnvironment, + target_address: Address, + system_contract_code: Bytes, + data: Bytes, +) -> MessageCallOutput: + """ + Process a system transaction with the given code. + + Prefer calling `process_checked_system_transaction` or + `process_unchecked_system_transaction` depending on whether missing code or + an execution error should cause the block to be rejected. + + Parameters + ---------- + block_env : + The block scoped environment. + target_address : + Address of the contract to call. + system_contract_code : + Code of the contract to call. + data : + Data to pass to the contract. + + Returns + ------- + system_tx_output : `MessageCallOutput` + Output of processing the system transaction. + """ + tx_env = vm.TransactionEnvironment( + origin=SYSTEM_ADDRESS, + gas_price=block_env.base_fee_per_gas, + gas=SYSTEM_TRANSACTION_GAS, + access_list_addresses=set(), + access_list_storage_keys=set(), + transient_storage=TransientStorage(), + blob_versioned_hashes=(), + authorizations=(), + index_in_block=None, + tx_hash=None, + traces=[], + ) + + system_tx_message = Message( + block_env=block_env, + tx_env=tx_env, + caller=SYSTEM_ADDRESS, + target=target_address, + gas=SYSTEM_TRANSACTION_GAS, + value=U256(0), + data=data, + code=system_contract_code, + depth=Uint(0), + current_target=target_address, + code_address=target_address, + should_transfer_value=False, + is_static=False, + accessed_addresses=set(), + accessed_storage_keys=set(), + disable_precompiles=False, + warm_code_addresses=set(), + parent_evm=None, + ) + + system_tx_output = process_message_call(system_tx_message) + + return system_tx_output + + +def process_checked_system_transaction( + block_env: vm.BlockEnvironment, + target_address: Address, + data: Bytes, +) -> MessageCallOutput: + """ + Process a system transaction and raise an error if the contract does not + contain code or if the transaction fails. + + Parameters + ---------- + block_env : + The block scoped environment. + target_address : + Address of the contract to call. + data : + Data to pass to the contract. + + Returns + ------- + system_tx_output : `MessageCallOutput` + Output of processing the system transaction. + """ + system_contract_code = get_account(block_env.state, target_address).code + + if len(system_contract_code) == 0: + raise InvalidBlock( + f"System contract address {target_address.hex()} does not " + "contain code" + ) + + system_tx_output = process_system_transaction( + block_env, + target_address, + system_contract_code, + data, + ) + + if system_tx_output.error: + raise InvalidBlock( + f"System contract ({target_address.hex()}) call failed: " + f"{system_tx_output.error}" + ) + + return system_tx_output + + +def process_unchecked_system_transaction( + block_env: vm.BlockEnvironment, + target_address: Address, + data: Bytes, +) -> MessageCallOutput: + """ + Process a system transaction without checking if the contract contains code + or if the transaction fails. + + Parameters + ---------- + block_env : + The block scoped environment. + target_address : + Address of the contract to call. + data : + Data to pass to the contract. + + Returns + ------- + system_tx_output : `MessageCallOutput` + Output of processing the system transaction. + """ + system_contract_code = get_account(block_env.state, target_address).code + return process_system_transaction( + block_env, + target_address, + system_contract_code, + data, + ) + + +def apply_body( + block_env: vm.BlockEnvironment, + transactions: Tuple[LegacyTransaction | Bytes, ...], + withdrawals: Tuple[Withdrawal, ...], +) -> vm.BlockOutput: + """ + Executes a block. + + Many of the contents of a block are stored in data structures called + tries. There is a transactions trie which is similar to a ledger of the + transactions stored in the current block. There is also a receipts trie + which stores the results of executing a transaction, like the post state + and gas used. This function creates and executes the block that is to be + added to the chain. + + Parameters + ---------- + block_env : + The block scoped environment. + transactions : + Transactions included in the block. + withdrawals : + Withdrawals to be processed in the current block. + + Returns + ------- + block_output : + The block output for the current block. + """ + block_output = vm.BlockOutput() + + process_unchecked_system_transaction( + block_env=block_env, + target_address=BEACON_ROOTS_ADDRESS, + data=block_env.parent_beacon_block_root, + ) + + process_unchecked_system_transaction( + block_env=block_env, + target_address=HISTORY_STORAGE_ADDRESS, + data=block_env.block_hashes[-1], # The parent hash + ) + + for i, tx in enumerate(map(decode_transaction, transactions)): + process_transaction(block_env, block_output, tx, Uint(i)) + + process_withdrawals(block_env, block_output, withdrawals) + + process_general_purpose_requests( + block_env=block_env, + block_output=block_output, + ) + + return block_output + + +def process_general_purpose_requests( + block_env: vm.BlockEnvironment, + block_output: vm.BlockOutput, +) -> None: + """ + Process all the requests in the block. + + Parameters + ---------- + block_env : + The execution environment for the Block. + block_output : + The block output for the current block. + """ + # Requests are to be in ascending order of request type + deposit_requests = parse_deposit_requests(block_output) + requests_from_execution = block_output.requests + if len(deposit_requests) > 0: + requests_from_execution.append(DEPOSIT_REQUEST_TYPE + deposit_requests) + + system_withdrawal_tx_output = process_checked_system_transaction( + block_env=block_env, + target_address=WITHDRAWAL_REQUEST_PREDEPLOY_ADDRESS, + data=b"", + ) + + if len(system_withdrawal_tx_output.return_data) > 0: + requests_from_execution.append( + WITHDRAWAL_REQUEST_TYPE + system_withdrawal_tx_output.return_data + ) + + system_consolidation_tx_output = process_checked_system_transaction( + block_env=block_env, + target_address=CONSOLIDATION_REQUEST_PREDEPLOY_ADDRESS, + data=b"", + ) + + if len(system_consolidation_tx_output.return_data) > 0: + requests_from_execution.append( + CONSOLIDATION_REQUEST_TYPE + + system_consolidation_tx_output.return_data + ) + + +def process_transaction( + block_env: vm.BlockEnvironment, + block_output: vm.BlockOutput, + tx: Transaction, + index: Uint, +) -> None: + """ + Execute a transaction against the provided environment. + + This function processes the actions needed to execute a transaction. + It decrements the sender's account after calculating the gas fee and + refunds them the proper amount after execution. Calling contracts, + deploying code, and incrementing nonces are all examples of actions that + happen within this function or from a call made within this function. + + Accounts that are marked for deletion are processed and destroyed after + execution. + + Parameters + ---------- + block_env : + Environment for the Ethereum Virtual Machine. + block_output : + The block output for the current block. + tx : + Transaction to execute. + index: + Index of the transaction in the block. + """ + trie_set( + block_output.transactions_trie, + rlp.encode(index), + encode_transaction(tx), + ) + + intrinsic_gas, calldata_floor_gas_cost = validate_transaction(tx) + + ( + sender, + effective_gas_price, + blob_versioned_hashes, + tx_blob_gas_used, + ) = check_transaction( + block_env=block_env, + block_output=block_output, + tx=tx, + ) + + sender_account = get_account(block_env.state, sender) + + if isinstance(tx, BlobTransaction): + blob_gas_fee = calculate_data_fee(block_env.excess_blob_gas, tx) + else: + blob_gas_fee = Uint(0) + + effective_gas_fee = tx.gas * effective_gas_price + + gas = tx.gas - intrinsic_gas + increment_nonce(block_env.state, sender) + + sender_balance_after_gas_fee = ( + Uint(sender_account.balance) - effective_gas_fee - blob_gas_fee + ) + set_account_balance( + block_env.state, sender, U256(sender_balance_after_gas_fee) + ) + + access_list_addresses = set() + access_list_storage_keys = set() + access_list_addresses.add(block_env.coinbase) + if isinstance( + tx, + ( + AccessListTransaction, + FeeMarketTransaction, + BlobTransaction, + SetCodeTransaction, + ), + ): + for access in tx.access_list: + access_list_addresses.add(access.account) + for slot in access.slots: + access_list_storage_keys.add((access.account, slot)) + + authorizations: Tuple[Authorization, ...] = () + if isinstance(tx, SetCodeTransaction): + authorizations = tx.authorizations + + tx_env = vm.TransactionEnvironment( + origin=sender, + gas_price=effective_gas_price, + gas=gas, + access_list_addresses=access_list_addresses, + access_list_storage_keys=access_list_storage_keys, + transient_storage=TransientStorage(), + blob_versioned_hashes=blob_versioned_hashes, + authorizations=authorizations, + index_in_block=index, + tx_hash=get_transaction_hash(encode_transaction(tx)), + traces=[], + ) + + message = prepare_message(block_env, tx_env, tx) + + tx_output = process_message_call(message) + + # For EIP-7623 we first calculate the execution_gas_used, which includes + # the execution gas refund. + tx_gas_used_before_refund = tx.gas - tx_output.gas_left + tx_gas_refund = min( + tx_gas_used_before_refund // Uint(5), Uint(tx_output.refund_counter) + ) + tx_gas_used_after_refund = tx_gas_used_before_refund - tx_gas_refund + + # Transactions with less execution_gas_used than the floor pay at the + # floor cost. + tx_gas_used_after_refund = max( + tx_gas_used_after_refund, calldata_floor_gas_cost + ) + + tx_gas_left = tx.gas - tx_gas_used_after_refund + gas_refund_amount = tx_gas_left * effective_gas_price + + # For non-1559 transactions effective_gas_price == tx.gas_price + priority_fee_per_gas = effective_gas_price - block_env.base_fee_per_gas + transaction_fee = tx_gas_used_after_refund * priority_fee_per_gas + + # refund gas + sender_balance_after_refund = get_account( + block_env.state, sender + ).balance + U256(gas_refund_amount) + set_account_balance(block_env.state, sender, sender_balance_after_refund) + + # transfer miner fees + coinbase_balance_after_mining_fee = get_account( + block_env.state, block_env.coinbase + ).balance + U256(transaction_fee) + if coinbase_balance_after_mining_fee != 0: + set_account_balance( + block_env.state, + block_env.coinbase, + coinbase_balance_after_mining_fee, + ) + elif account_exists_and_is_empty(block_env.state, block_env.coinbase): + destroy_account(block_env.state, block_env.coinbase) + + for address in tx_output.accounts_to_delete: + destroy_account(block_env.state, address) + + block_output.block_gas_used += tx_gas_used_after_refund + block_output.blob_gas_used += tx_blob_gas_used + + receipt = make_receipt( + tx, tx_output.error, block_output.block_gas_used, tx_output.logs + ) + + receipt_key = rlp.encode(Uint(index)) + block_output.receipt_keys += (receipt_key,) + + trie_set( + block_output.receipts_trie, + receipt_key, + receipt, + ) + + block_output.block_logs += tx_output.logs + + +def process_withdrawals( + block_env: vm.BlockEnvironment, + block_output: vm.BlockOutput, + withdrawals: Tuple[Withdrawal, ...], +) -> None: + """ + Increase the balance of the withdrawing account. + """ + + def increase_recipient_balance(recipient: Account) -> None: + recipient.balance += wd.amount * U256(10**9) + + for i, wd in enumerate(withdrawals): + trie_set( + block_output.withdrawals_trie, + rlp.encode(Uint(i)), + rlp.encode(wd), + ) + + modify_state(block_env.state, wd.address, increase_recipient_balance) + + if account_exists_and_is_empty(block_env.state, wd.address): + destroy_account(block_env.state, wd.address) + + +def check_gas_limit(gas_limit: Uint, parent_gas_limit: Uint) -> bool: + """ + Validates the gas limit for a block. + + The bounds of the gas limit, ``max_adjustment_delta``, is set as the + quotient of the parent block's gas limit and the + ``GAS_LIMIT_ADJUSTMENT_FACTOR``. Therefore, if the gas limit that is + passed through as a parameter is greater than or equal to the *sum* of + the parent's gas and the adjustment delta then the limit for gas is too + high and fails this function's check. Similarly, if the limit is less + than or equal to the *difference* of the parent's gas and the adjustment + delta *or* the predefined ``GAS_LIMIT_MINIMUM`` then this function's + check fails because the gas limit doesn't allow for a sufficient or + reasonable amount of gas to be used on a block. + + Parameters + ---------- + gas_limit : + Gas limit to validate. + + parent_gas_limit : + Gas limit of the parent block. + + Returns + ------- + check : `bool` + True if gas limit constraints are satisfied, False otherwise. + """ + max_adjustment_delta = parent_gas_limit // GAS_LIMIT_ADJUSTMENT_FACTOR + if gas_limit >= parent_gas_limit + max_adjustment_delta: + return False + if gas_limit <= parent_gas_limit - max_adjustment_delta: + return False + if gas_limit < GAS_LIMIT_MINIMUM: + return False + + return True diff --git a/src/ethereum/osaka/fork_types.py b/src/ethereum/osaka/fork_types.py new file mode 100644 index 0000000000..74cf6c83cb --- /dev/null +++ b/src/ethereum/osaka/fork_types.py @@ -0,0 +1,79 @@ +""" +Ethereum Types +^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Types re-used throughout the specification, which are specific to Ethereum. +""" + +from dataclasses import dataclass + +from ethereum_rlp import rlp +from ethereum_types.bytes import Bytes, Bytes20, Bytes256 +from ethereum_types.frozen import slotted_freezable +from ethereum_types.numeric import U8, U64, U256, Uint + +from ..crypto.hash import Hash32, keccak256 + +Address = Bytes20 +Root = Hash32 +VersionedHash = Hash32 + +Bloom = Bytes256 + + +@slotted_freezable +@dataclass +class Account: + """ + State associated with an address. + """ + + nonce: Uint + balance: U256 + code: Bytes + + +EMPTY_ACCOUNT = Account( + nonce=Uint(0), + balance=U256(0), + code=bytearray(), +) + + +def encode_account(raw_account_data: Account, storage_root: Bytes) -> Bytes: + """ + Encode `Account` dataclass. + + Storage is not stored in the `Account` dataclass, so `Accounts` cannot be + encoded without providing a storage root. + """ + return rlp.encode( + ( + raw_account_data.nonce, + raw_account_data.balance, + storage_root, + keccak256(raw_account_data.code), + ) + ) + + +@slotted_freezable +@dataclass +class Authorization: + """ + The authorization for a set code transaction. + """ + + chain_id: U256 + address: Address + nonce: U64 + y_parity: U8 + r: U256 + s: U256 diff --git a/src/ethereum/osaka/requests.py b/src/ethereum/osaka/requests.py new file mode 100644 index 0000000000..6ed423188f --- /dev/null +++ b/src/ethereum/osaka/requests.py @@ -0,0 +1,190 @@ +""" +Requests were introduced in EIP-7685 as a a general purpose framework for +storing contract-triggered requests. It extends the execution header and +body with a single field each to store the request information. +This inherently exposes the requests to the consensus layer, which can +then process each one. + +[EIP-7685]: https://eips.ethereum.org/EIPS/eip-7685 +""" + +from hashlib import sha256 +from typing import List + +from ethereum_types.bytes import Bytes +from ethereum_types.numeric import Uint, ulen + +from ethereum.exceptions import InvalidBlock +from ethereum.utils.hexadecimal import hex_to_bytes32 + +from .blocks import decode_receipt +from .trie import trie_get +from .utils.hexadecimal import hex_to_address +from .vm import BlockOutput + +DEPOSIT_CONTRACT_ADDRESS = hex_to_address( + "0x00000000219ab540356cbb839cbe05303d7705fa" +) +DEPOSIT_EVENT_SIGNATURE_HASH = hex_to_bytes32( + "0x649bbc62d0e31342afea4e5cd82d4049e7e1ee912fc0889aa790803be39038c5" +) +DEPOSIT_REQUEST_TYPE = b"\x00" +WITHDRAWAL_REQUEST_TYPE = b"\x01" +CONSOLIDATION_REQUEST_TYPE = b"\x02" + + +DEPOSIT_EVENT_LENGTH = Uint(576) + +PUBKEY_OFFSET = Uint(160) +WITHDRAWAL_CREDENTIALS_OFFSET = Uint(256) +AMOUNT_OFFSET = Uint(320) +SIGNATURE_OFFSET = Uint(384) +INDEX_OFFSET = Uint(512) + +PUBKEY_SIZE = Uint(48) +WITHDRAWAL_CREDENTIALS_SIZE = Uint(32) +AMOUNT_SIZE = Uint(8) +SIGNATURE_SIZE = Uint(96) +INDEX_SIZE = Uint(8) + + +def extract_deposit_data(data: Bytes) -> Bytes: + """ + Extracts Deposit Request from the DepositContract.DepositEvent data. + + Raises + ------ + InvalidBlock : + If the deposit contract did not produce a valid log. + """ + if ulen(data) != DEPOSIT_EVENT_LENGTH: + raise InvalidBlock("Invalid deposit event data length") + + # Check that all the offsets are in order + pubkey_offset = Uint.from_be_bytes(data[0:32]) + if pubkey_offset != PUBKEY_OFFSET: + raise InvalidBlock("Invalid pubkey offset in deposit log") + + withdrawal_credentials_offset = Uint.from_be_bytes(data[32:64]) + if withdrawal_credentials_offset != WITHDRAWAL_CREDENTIALS_OFFSET: + raise InvalidBlock( + "Invalid withdrawal credentials offset in deposit log" + ) + + amount_offset = Uint.from_be_bytes(data[64:96]) + if amount_offset != AMOUNT_OFFSET: + raise InvalidBlock("Invalid amount offset in deposit log") + + signature_offset = Uint.from_be_bytes(data[96:128]) + if signature_offset != SIGNATURE_OFFSET: + raise InvalidBlock("Invalid signature offset in deposit log") + + index_offset = Uint.from_be_bytes(data[128:160]) + if index_offset != INDEX_OFFSET: + raise InvalidBlock("Invalid index offset in deposit log") + + # Check that all the sizes are in order + pubkey_size = Uint.from_be_bytes( + data[pubkey_offset : pubkey_offset + Uint(32)] + ) + if pubkey_size != PUBKEY_SIZE: + raise InvalidBlock("Invalid pubkey size in deposit log") + + pubkey = data[ + pubkey_offset + Uint(32) : pubkey_offset + Uint(32) + PUBKEY_SIZE + ] + + withdrawal_credentials_size = Uint.from_be_bytes( + data[ + withdrawal_credentials_offset : withdrawal_credentials_offset + + Uint(32) + ], + ) + if withdrawal_credentials_size != WITHDRAWAL_CREDENTIALS_SIZE: + raise InvalidBlock( + "Invalid withdrawal credentials size in deposit log" + ) + + withdrawal_credentials = data[ + withdrawal_credentials_offset + + Uint(32) : withdrawal_credentials_offset + + Uint(32) + + WITHDRAWAL_CREDENTIALS_SIZE + ] + + amount_size = Uint.from_be_bytes( + data[amount_offset : amount_offset + Uint(32)] + ) + if amount_size != AMOUNT_SIZE: + raise InvalidBlock("Invalid amount size in deposit log") + + amount = data[ + amount_offset + Uint(32) : amount_offset + Uint(32) + AMOUNT_SIZE + ] + + signature_size = Uint.from_be_bytes( + data[signature_offset : signature_offset + Uint(32)] + ) + if signature_size != SIGNATURE_SIZE: + raise InvalidBlock("Invalid signature size in deposit log") + + signature = data[ + signature_offset + + Uint(32) : signature_offset + + Uint(32) + + SIGNATURE_SIZE + ] + + index_size = Uint.from_be_bytes( + data[index_offset : index_offset + Uint(32)] + ) + if index_size != INDEX_SIZE: + raise InvalidBlock("Invalid index size in deposit log") + + index = data[ + index_offset + Uint(32) : index_offset + Uint(32) + INDEX_SIZE + ] + + return pubkey + withdrawal_credentials + amount + signature + index + + +def parse_deposit_requests(block_output: BlockOutput) -> Bytes: + """ + Parse deposit requests from the block output. + """ + deposit_requests: Bytes = b"" + for key in block_output.receipt_keys: + receipt = trie_get(block_output.receipts_trie, key) + assert receipt is not None + decoded_receipt = decode_receipt(receipt) + for log in decoded_receipt.logs: + if log.address == DEPOSIT_CONTRACT_ADDRESS: + if ( + len(log.topics) > 0 + and log.topics[0] == DEPOSIT_EVENT_SIGNATURE_HASH + ): + request = extract_deposit_data(log.data) + deposit_requests += request + + return deposit_requests + + +def compute_requests_hash(requests: List[Bytes]) -> Bytes: + """ + Get the hash of the requests using the SHA2-256 algorithm. + + Parameters + ---------- + requests : Bytes + The requests to hash. + + Returns + ------- + requests_hash : Bytes + The hash of the requests. + """ + m = sha256() + for request in requests: + m.update(sha256(request).digest()) + + return m.digest() diff --git a/src/ethereum/osaka/state.py b/src/ethereum/osaka/state.py new file mode 100644 index 0000000000..b067ed2286 --- /dev/null +++ b/src/ethereum/osaka/state.py @@ -0,0 +1,659 @@ +""" +State +^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +The state contains all information that is preserved between transactions. + +It consists of a main account trie and storage tries for each contract. + +There is a distinction between an account that does not exist and +`EMPTY_ACCOUNT`. +""" + +from dataclasses import dataclass, field +from typing import Callable, Dict, List, Optional, Set, Tuple + +from ethereum_types.bytes import Bytes, Bytes32 +from ethereum_types.frozen import modify +from ethereum_types.numeric import U256, Uint + +from .fork_types import EMPTY_ACCOUNT, Account, Address, Root +from .trie import EMPTY_TRIE_ROOT, Trie, copy_trie, root, trie_get, trie_set + + +@dataclass +class State: + """ + Contains all information that is preserved between transactions. + """ + + _main_trie: Trie[Address, Optional[Account]] = field( + default_factory=lambda: Trie(secured=True, default=None) + ) + _storage_tries: Dict[Address, Trie[Bytes32, U256]] = field( + default_factory=dict + ) + _snapshots: List[ + Tuple[ + Trie[Address, Optional[Account]], + Dict[Address, Trie[Bytes32, U256]], + ] + ] = field(default_factory=list) + created_accounts: Set[Address] = field(default_factory=set) + + +@dataclass +class TransientStorage: + """ + Contains all information that is preserved between message calls + within a transaction. + """ + + _tries: Dict[Address, Trie[Bytes32, U256]] = field(default_factory=dict) + _snapshots: List[Dict[Address, Trie[Bytes32, U256]]] = field( + default_factory=list + ) + + +def close_state(state: State) -> None: + """ + Free resources held by the state. Used by optimized implementations to + release file descriptors. + """ + del state._main_trie + del state._storage_tries + del state._snapshots + del state.created_accounts + + +def begin_transaction( + state: State, transient_storage: TransientStorage +) -> None: + """ + Start a state transaction. + + Transactions are entirely implicit and can be nested. It is not possible to + calculate the state root during a transaction. + + Parameters + ---------- + state : State + The state. + transient_storage : TransientStorage + The transient storage of the transaction. + """ + state._snapshots.append( + ( + copy_trie(state._main_trie), + {k: copy_trie(t) for (k, t) in state._storage_tries.items()}, + ) + ) + transient_storage._snapshots.append( + {k: copy_trie(t) for (k, t) in transient_storage._tries.items()} + ) + + +def commit_transaction( + state: State, transient_storage: TransientStorage +) -> None: + """ + Commit a state transaction. + + Parameters + ---------- + state : State + The state. + transient_storage : TransientStorage + The transient storage of the transaction. + """ + state._snapshots.pop() + if not state._snapshots: + state.created_accounts.clear() + + transient_storage._snapshots.pop() + + +def rollback_transaction( + state: State, transient_storage: TransientStorage +) -> None: + """ + Rollback a state transaction, resetting the state to the point when the + corresponding `start_transaction()` call was made. + + Parameters + ---------- + state : State + The state. + transient_storage : TransientStorage + The transient storage of the transaction. + """ + state._main_trie, state._storage_tries = state._snapshots.pop() + if not state._snapshots: + state.created_accounts.clear() + + transient_storage._tries = transient_storage._snapshots.pop() + + +def get_account(state: State, address: Address) -> Account: + """ + Get the `Account` object at an address. Returns `EMPTY_ACCOUNT` if there + is no account at the address. + + Use `get_account_optional()` if you care about the difference between a + non-existent account and `EMPTY_ACCOUNT`. + + Parameters + ---------- + state: `State` + The state + address : `Address` + Address to lookup. + + Returns + ------- + account : `Account` + Account at address. + """ + account = get_account_optional(state, address) + if isinstance(account, Account): + return account + else: + return EMPTY_ACCOUNT + + +def get_account_optional(state: State, address: Address) -> Optional[Account]: + """ + Get the `Account` object at an address. Returns `None` (rather than + `EMPTY_ACCOUNT`) if there is no account at the address. + + Parameters + ---------- + state: `State` + The state + address : `Address` + Address to lookup. + + Returns + ------- + account : `Account` + Account at address. + """ + account = trie_get(state._main_trie, address) + return account + + +def set_account( + state: State, address: Address, account: Optional[Account] +) -> None: + """ + Set the `Account` object at an address. Setting to `None` deletes + the account (but not its storage, see `destroy_account()`). + + Parameters + ---------- + state: `State` + The state + address : `Address` + Address to set. + account : `Account` + Account to set at address. + """ + trie_set(state._main_trie, address, account) + + +def destroy_account(state: State, address: Address) -> None: + """ + Completely remove the account at `address` and all of its storage. + + This function is made available exclusively for the `SELFDESTRUCT` + opcode. It is expected that `SELFDESTRUCT` will be disabled in a future + hardfork and this function will be removed. + + Parameters + ---------- + state: `State` + The state + address : `Address` + Address of account to destroy. + """ + destroy_storage(state, address) + set_account(state, address, None) + + +def destroy_storage(state: State, address: Address) -> None: + """ + Completely remove the storage at `address`. + + Parameters + ---------- + state: `State` + The state + address : `Address` + Address of account whose storage is to be deleted. + """ + if address in state._storage_tries: + del state._storage_tries[address] + + +def mark_account_created(state: State, address: Address) -> None: + """ + Mark an account as having been created in the current transaction. + This information is used by `get_storage_original()` to handle an obscure + edgecase, and to respect the constraints added to SELFDESTRUCT by + EIP-6780. + + The marker is not removed even if the account creation reverts. Since the + account cannot have had code prior to its creation and can't call + `get_storage_original()`, this is harmless. + + Parameters + ---------- + state: `State` + The state + address : `Address` + Address of the account that has been created. + """ + state.created_accounts.add(address) + + +def get_storage(state: State, address: Address, key: Bytes32) -> U256: + """ + Get a value at a storage key on an account. Returns `U256(0)` if the + storage key has not been set previously. + + Parameters + ---------- + state: `State` + The state + address : `Address` + Address of the account. + key : `Bytes` + Key to lookup. + + Returns + ------- + value : `U256` + Value at the key. + """ + trie = state._storage_tries.get(address) + if trie is None: + return U256(0) + + value = trie_get(trie, key) + + assert isinstance(value, U256) + return value + + +def set_storage( + state: State, address: Address, key: Bytes32, value: U256 +) -> None: + """ + Set a value at a storage key on an account. Setting to `U256(0)` deletes + the key. + + Parameters + ---------- + state: `State` + The state + address : `Address` + Address of the account. + key : `Bytes` + Key to set. + value : `U256` + Value to set at the key. + """ + assert trie_get(state._main_trie, address) is not None + + trie = state._storage_tries.get(address) + if trie is None: + trie = Trie(secured=True, default=U256(0)) + state._storage_tries[address] = trie + trie_set(trie, key, value) + if trie._data == {}: + del state._storage_tries[address] + + +def storage_root(state: State, address: Address) -> Root: + """ + Calculate the storage root of an account. + + Parameters + ---------- + state: + The state + address : + Address of the account. + + Returns + ------- + root : `Root` + Storage root of the account. + """ + assert not state._snapshots + if address in state._storage_tries: + return root(state._storage_tries[address]) + else: + return EMPTY_TRIE_ROOT + + +def state_root(state: State) -> Root: + """ + Calculate the state root. + + Parameters + ---------- + state: + The current state. + + Returns + ------- + root : `Root` + The state root. + """ + assert not state._snapshots + + def get_storage_root(address: Address) -> Root: + return storage_root(state, address) + + return root(state._main_trie, get_storage_root=get_storage_root) + + +def account_exists(state: State, address: Address) -> bool: + """ + Checks if an account exists in the state trie + + Parameters + ---------- + state: + The state + address: + Address of the account that needs to be checked. + + Returns + ------- + account_exists : `bool` + True if account exists in the state trie, False otherwise + """ + return get_account_optional(state, address) is not None + + +def account_has_code_or_nonce(state: State, address: Address) -> bool: + """ + Checks if an account has non zero nonce or non empty code + + Parameters + ---------- + state: + The state + address: + Address of the account that needs to be checked. + + Returns + ------- + has_code_or_nonce : `bool` + True if the account has non zero nonce or non empty code, + False otherwise. + """ + account = get_account(state, address) + return account.nonce != Uint(0) or account.code != b"" + + +def account_has_storage(state: State, address: Address) -> bool: + """ + Checks if an account has storage. + + Parameters + ---------- + state: + The state + address: + Address of the account that needs to be checked. + + Returns + ------- + has_storage : `bool` + True if the account has storage, False otherwise. + """ + return address in state._storage_tries + + +def account_exists_and_is_empty(state: State, address: Address) -> bool: + """ + Checks if an account exists and has zero nonce, empty code and zero + balance. + + Parameters + ---------- + state: + The state + address: + Address of the account that needs to be checked. + + Returns + ------- + exists_and_is_empty : `bool` + True if an account exists and has zero nonce, empty code and zero + balance, False otherwise. + """ + account = get_account_optional(state, address) + return ( + account is not None + and account.nonce == Uint(0) + and account.code == b"" + and account.balance == 0 + ) + + +def is_account_alive(state: State, address: Address) -> bool: + """ + Check whether is an account is both in the state and non empty. + + Parameters + ---------- + state: + The state + address: + Address of the account that needs to be checked. + + Returns + ------- + is_alive : `bool` + True if the account is alive. + """ + account = get_account_optional(state, address) + return account is not None and account != EMPTY_ACCOUNT + + +def modify_state( + state: State, address: Address, f: Callable[[Account], None] +) -> None: + """ + Modify an `Account` in the `State`. + """ + set_account(state, address, modify(get_account(state, address), f)) + if account_exists_and_is_empty(state, address): + destroy_account(state, address) + + +def move_ether( + state: State, + sender_address: Address, + recipient_address: Address, + amount: U256, +) -> None: + """ + Move funds between accounts. + """ + + def reduce_sender_balance(sender: Account) -> None: + if sender.balance < amount: + raise AssertionError + sender.balance -= amount + + def increase_recipient_balance(recipient: Account) -> None: + recipient.balance += amount + + modify_state(state, sender_address, reduce_sender_balance) + modify_state(state, recipient_address, increase_recipient_balance) + + +def set_account_balance(state: State, address: Address, amount: U256) -> None: + """ + Sets the balance of an account. + + Parameters + ---------- + state: + The current state. + + address: + Address of the account whose nonce needs to be incremented. + + amount: + The amount that needs to set in balance. + """ + + def set_balance(account: Account) -> None: + account.balance = amount + + modify_state(state, address, set_balance) + + +def increment_nonce(state: State, address: Address) -> None: + """ + Increments the nonce of an account. + + Parameters + ---------- + state: + The current state. + + address: + Address of the account whose nonce needs to be incremented. + """ + + def increase_nonce(sender: Account) -> None: + sender.nonce += Uint(1) + + modify_state(state, address, increase_nonce) + + +def set_code(state: State, address: Address, code: Bytes) -> None: + """ + Sets Account code. + + Parameters + ---------- + state: + The current state. + + address: + Address of the account whose code needs to be update. + + code: + The bytecode that needs to be set. + """ + + def write_code(sender: Account) -> None: + sender.code = code + + modify_state(state, address, write_code) + + +def get_storage_original(state: State, address: Address, key: Bytes32) -> U256: + """ + Get the original value in a storage slot i.e. the value before the current + transaction began. This function reads the value from the snapshots taken + before executing the transaction. + + Parameters + ---------- + state: + The current state. + address: + Address of the account to read the value from. + key: + Key of the storage slot. + """ + # In the transaction where an account is created, its preexisting storage + # is ignored. + if address in state.created_accounts: + return U256(0) + + _, original_trie = state._snapshots[0] + original_account_trie = original_trie.get(address) + + if original_account_trie is None: + original_value = U256(0) + else: + original_value = trie_get(original_account_trie, key) + + assert isinstance(original_value, U256) + + return original_value + + +def get_transient_storage( + transient_storage: TransientStorage, address: Address, key: Bytes32 +) -> U256: + """ + Get a value at a storage key on an account from transient storage. + Returns `U256(0)` if the storage key has not been set previously. + Parameters + ---------- + transient_storage: `TransientStorage` + The transient storage + address : `Address` + Address of the account. + key : `Bytes` + Key to lookup. + Returns + ------- + value : `U256` + Value at the key. + """ + trie = transient_storage._tries.get(address) + if trie is None: + return U256(0) + + value = trie_get(trie, key) + + assert isinstance(value, U256) + return value + + +def set_transient_storage( + transient_storage: TransientStorage, + address: Address, + key: Bytes32, + value: U256, +) -> None: + """ + Set a value at a storage key on an account. Setting to `U256(0)` deletes + the key. + Parameters + ---------- + transient_storage: `TransientStorage` + The transient storage + address : `Address` + Address of the account. + key : `Bytes` + Key to set. + value : `U256` + Value to set at the key. + """ + trie = transient_storage._tries.get(address) + if trie is None: + trie = Trie(secured=True, default=U256(0)) + transient_storage._tries[address] = trie + trie_set(trie, key, value) + if trie._data == {}: + del transient_storage._tries[address] diff --git a/src/ethereum/osaka/transactions.py b/src/ethereum/osaka/transactions.py new file mode 100644 index 0000000000..90b1deecd7 --- /dev/null +++ b/src/ethereum/osaka/transactions.py @@ -0,0 +1,886 @@ +""" +Transactions are atomic units of work created externally to Ethereum and +submitted to be executed. If Ethereum is viewed as a state machine, +transactions are the events that move between states. +""" +from dataclasses import dataclass +from typing import Tuple + +from ethereum_rlp import rlp +from ethereum_types.bytes import Bytes, Bytes0, Bytes32 +from ethereum_types.frozen import slotted_freezable +from ethereum_types.numeric import U64, U256, Uint, ulen + +from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover +from ethereum.crypto.hash import Hash32, keccak256 +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) + +from .exceptions import ( + InitCodeTooLargeError, + TransactionGasLimitExceededError, + TransactionTypeError, +) +from .fork_types import Address, Authorization, VersionedHash + +TX_BASE_COST = Uint(21000) +""" +Base cost of a transaction in gas units. This is the minimum amount of gas +required to execute a transaction. +""" + +FLOOR_CALLDATA_COST = Uint(10) +""" +Minimum gas cost per byte of calldata as per [EIP-7623]. Used to calculate +the minimum gas cost for transactions that include calldata. + +[EIP-7623]: https://eips.ethereum.org/EIPS/eip-7623 +""" + +STANDARD_CALLDATA_TOKEN_COST = Uint(4) +""" +Gas cost per byte of calldata as per [EIP-7623]. Used to calculate the +gas cost for transactions that include calldata. + +[EIP-7623]: https://eips.ethereum.org/EIPS/eip-7623 +""" + +TX_CREATE_COST = Uint(32000) +""" +Additional gas cost for creating a new contract. +""" + +TX_ACCESS_LIST_ADDRESS_COST = Uint(2400) +""" +Gas cost for including an address in the access list of a transaction. +""" + +TX_ACCESS_LIST_STORAGE_KEY_COST = Uint(1900) +""" +Gas cost for including a storage key in the access list of a transaction. +""" + +TX_MAX_GAS_LIMIT = Uint(16_777_216) + + +@slotted_freezable +@dataclass +class LegacyTransaction: + """ + Atomic operation performed on the block chain. This represents the original + transaction format used before [EIP-1559], [EIP-2930], [EIP-4844], + and [EIP-7702]. + + [EIP-1559]: https://eips.ethereum.org/EIPS/eip-1559 + [EIP-2930]: https://eips.ethereum.org/EIPS/eip-2930 + [EIP-4844]: https://eips.ethereum.org/EIPS/eip-4844 + [EIP-7702]: https://eips.ethereum.org/EIPS/eip-7702 + """ + + nonce: U256 + """ + A scalar value equal to the number of transactions sent by the sender. + """ + + gas_price: Uint + """ + The price of gas for this transaction, in wei. + """ + + gas: Uint + """ + The maximum amount of gas that can be used by this transaction. + """ + + to: Bytes0 | Address + """ + The address of the recipient. If empty, the transaction is a contract + creation. + """ + + value: U256 + """ + The amount of ether (in wei) to send with this transaction. + """ + + data: Bytes + """ + The data payload of the transaction, which can be used to call functions + on contracts or to create new contracts. + """ + + v: U256 + """ + The recovery id of the signature. + """ + + r: U256 + """ + The first part of the signature. + """ + + s: U256 + """ + The second part of the signature. + """ + + +@slotted_freezable +@dataclass +class Access: + """ + A mapping from account address to storage slots that are pre-warmed as part + of a transaction. + """ + + account: Address + """ + The address of the account that is accessed. + """ + + slots: Tuple[Bytes32, ...] + """ + A tuple of storage slots that are accessed in the account. + """ + + +@slotted_freezable +@dataclass +class AccessListTransaction: + """ + The transaction type added in [EIP-2930] to support access lists. + + This transaction type extends the legacy transaction with an access list + and chain ID. The access list specifies which addresses and storage slots + the transaction will access. + + [EIP-2930]: https://eips.ethereum.org/EIPS/eip-2930 + """ + + chain_id: U64 + """ + The ID of the chain on which this transaction is executed. + """ + + nonce: U256 + """ + A scalar value equal to the number of transactions sent by the sender. + """ + + gas_price: Uint + """ + The price of gas for this transaction. + """ + + gas: Uint + """ + The maximum amount of gas that can be used by this transaction. + """ + + to: Bytes0 | Address + """ + The address of the recipient. If empty, the transaction is a contract + creation. + """ + + value: U256 + """ + The amount of ether (in wei) to send with this transaction. + """ + + data: Bytes + """ + The data payload of the transaction, which can be used to call functions + on contracts or to create new contracts. + """ + + access_list: Tuple[Access, ...] + """ + A tuple of `Access` objects that specify which addresses and storage slots + are accessed in the transaction. + """ + + y_parity: U256 + """ + The recovery id of the signature. + """ + + r: U256 + """ + The first part of the signature. + """ + + s: U256 + """ + The second part of the signature. + """ + + +@slotted_freezable +@dataclass +class FeeMarketTransaction: + """ + The transaction type added in [EIP-1559]. + + This transaction type introduces a new fee market mechanism with two gas + price parameters: max_priority_fee_per_gas and max_fee_per_gas. + + [EIP-1559]: https://eips.ethereum.org/EIPS/eip-1559 + """ + + chain_id: U64 + """ + The ID of the chain on which this transaction is executed. + """ + + nonce: U256 + """ + A scalar value equal to the number of transactions sent by the sender. + """ + + max_priority_fee_per_gas: Uint + """ + The maximum priority fee per gas that the sender is willing to pay. + """ + + max_fee_per_gas: Uint + """ + The maximum fee per gas that the sender is willing to pay, including the + base fee and priority fee. + """ + + gas: Uint + """ + The maximum amount of gas that can be used by this transaction. + """ + + to: Bytes0 | Address + """ + The address of the recipient. If empty, the transaction is a contract + creation. + """ + + value: U256 + """ + The amount of ether (in wei) to send with this transaction. + """ + + data: Bytes + """ + The data payload of the transaction, which can be used to call functions + on contracts or to create new contracts. + """ + + access_list: Tuple[Access, ...] + """ + A tuple of `Access` objects that specify which addresses and storage slots + are accessed in the transaction. + """ + + y_parity: U256 + """ + The recovery id of the signature. + """ + + r: U256 + """ + The first part of the signature. + """ + + s: U256 + """ + The second part of the signature. + """ + + +@slotted_freezable +@dataclass +class BlobTransaction: + """ + The transaction type added in [EIP-4844]. + + This transaction type extends the fee market transaction to support + blob-carrying transactions. + + [EIP-4844]: https://eips.ethereum.org/EIPS/eip-4844 + """ + + chain_id: U64 + """ + The ID of the chain on which this transaction is executed. + """ + + nonce: U256 + """ + A scalar value equal to the number of transactions sent by the sender. + """ + + max_priority_fee_per_gas: Uint + """ + The maximum priority fee per gas that the sender is willing to pay. + """ + + max_fee_per_gas: Uint + """ + The maximum fee per gas that the sender is willing to pay, including the + base fee and priority fee. + """ + + gas: Uint + """ + The maximum amount of gas that can be used by this transaction. + """ + + to: Address + """ + The address of the recipient. If empty, the transaction is a contract + creation. + """ + + value: U256 + """ + The amount of ether (in wei) to send with this transaction. + """ + + data: Bytes + """ + The data payload of the transaction, which can be used to call functions + on contracts or to create new contracts. + """ + + access_list: Tuple[Access, ...] + """ + A tuple of `Access` objects that specify which addresses and storage slots + are accessed in the transaction. + """ + + max_fee_per_blob_gas: U256 + """ + The maximum fee per blob gas that the sender is willing to pay. + """ + + blob_versioned_hashes: Tuple[VersionedHash, ...] + """ + A tuple of objects that represent the versioned hashes of the blobs + included in the transaction. + """ + + y_parity: U256 + """ + The recovery id of the signature. + """ + + r: U256 + """ + The first part of the signature. + """ + + s: U256 + """ + The second part of the signature. + """ + + +@slotted_freezable +@dataclass +class SetCodeTransaction: + """ + The transaction type added in [EIP-7702]. + + This transaction type allows Ethereum Externally Owned Accounts (EOAs) + to set code on their account, enabling them to act as smart contracts. + + [EIP-7702]: https://eips.ethereum.org/EIPS/eip-7702 + """ + + chain_id: U64 + """ + The ID of the chain on which this transaction is executed. + """ + + nonce: U64 + """ + A scalar value equal to the number of transactions sent by the sender. + """ + + max_priority_fee_per_gas: Uint + """ + The maximum priority fee per gas that the sender is willing to pay. + """ + + max_fee_per_gas: Uint + """ + The maximum fee per gas that the sender is willing to pay, including the + base fee and priority fee. + """ + + gas: Uint + """ + The maximum amount of gas that can be used by this transaction. + """ + + to: Address + """ + The address of the recipient. If empty, the transaction is a contract + creation. + """ + + value: U256 + """ + The amount of ether (in wei) to send with this transaction. + """ + + data: Bytes + """ + The data payload of the transaction, which can be used to call functions + on contracts or to create new contracts. + """ + + access_list: Tuple[Access, ...] + """ + A tuple of `Access` objects that specify which addresses and storage slots + are accessed in the transaction. + """ + + authorizations: Tuple[Authorization, ...] + """ + A tuple of `Authorization` objects that specify what code the signer + desires to execute in the context of their EOA. + """ + + y_parity: U256 + """ + The recovery id of the signature. + """ + + r: U256 + """ + The first part of the signature. + """ + + s: U256 + """ + The second part of the signature. + """ + + +Transaction = ( + LegacyTransaction + | AccessListTransaction + | FeeMarketTransaction + | BlobTransaction + | SetCodeTransaction +) +""" +Union type representing any valid transaction type. +""" + + +def encode_transaction(tx: Transaction) -> LegacyTransaction | Bytes: + """ + Encode a transaction into its RLP or typed transaction format. + Needed because non-legacy transactions aren't RLP. + + Legacy transactions are returned as-is, while other transaction types + are prefixed with their type identifier and RLP encoded. + """ + if isinstance(tx, LegacyTransaction): + return tx + elif isinstance(tx, AccessListTransaction): + return b"\x01" + rlp.encode(tx) + elif isinstance(tx, FeeMarketTransaction): + return b"\x02" + rlp.encode(tx) + elif isinstance(tx, BlobTransaction): + return b"\x03" + rlp.encode(tx) + elif isinstance(tx, SetCodeTransaction): + return b"\x04" + rlp.encode(tx) + else: + raise Exception(f"Unable to encode transaction of type {type(tx)}") + + +def decode_transaction(tx: LegacyTransaction | Bytes) -> Transaction: + """ + Decode a transaction from its RLP or typed transaction format. + Needed because non-legacy transactions aren't RLP. + + Legacy transactions are returned as-is, while other transaction types + are decoded based on their type identifier prefix. + """ + if isinstance(tx, Bytes): + if tx[0] == 1: + return rlp.decode_to(AccessListTransaction, tx[1:]) + elif tx[0] == 2: + return rlp.decode_to(FeeMarketTransaction, tx[1:]) + elif tx[0] == 3: + return rlp.decode_to(BlobTransaction, tx[1:]) + elif tx[0] == 4: + return rlp.decode_to(SetCodeTransaction, tx[1:]) + else: + raise TransactionTypeError(tx[0]) + else: + return tx + + +def validate_transaction(tx: Transaction) -> Tuple[Uint, Uint]: + """ + Verifies a transaction. + + The gas in a transaction gets used to pay for the intrinsic cost of + operations, therefore if there is insufficient gas then it would not + be possible to execute a transaction and it will be declared invalid. + + Additionally, the nonce of a transaction must not equal or exceed the + limit defined in [EIP-2681]. + In practice, defining the limit as ``2**64-1`` has no impact because + sending ``2**64-1`` transactions is improbable. It's not strictly + impossible though, ``2**64-1`` transactions is the entire capacity of the + Ethereum blockchain at 2022 gas limits for a little over 22 years. + + Also, the code size of a contract creation transaction must be within + limits of the protocol. + + This function takes a transaction as a parameter and returns the intrinsic + gas cost and the minimum calldata gas cost for the transaction after + validation. It throws an `InsufficientTransactionGasError` exception if + the transaction does not provide enough gas to cover the intrinsic cost, + and a `NonceOverflowError` exception if the nonce is greater than + `2**64 - 2`. It also raises an `InitCodeTooLargeError` if the code size of + a contract creation transaction exceeds the maximum allowed size. + + [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 + [EIP-7623]: https://eips.ethereum.org/EIPS/eip-7623 + """ + from .vm.interpreter import MAX_INIT_CODE_SIZE + + intrinsic_gas, calldata_floor_gas_cost = calculate_intrinsic_cost(tx) + if max(intrinsic_gas, calldata_floor_gas_cost) > tx.gas: + raise InsufficientTransactionGasError("Insufficient gas") + if U256(tx.nonce) >= U256(U64.MAX_VALUE): + raise NonceOverflowError("Nonce too high") + if tx.to == Bytes0(b"") and len(tx.data) > MAX_INIT_CODE_SIZE: + raise InitCodeTooLargeError("Code size too large") + if tx.gas > TX_MAX_GAS_LIMIT: + raise TransactionGasLimitExceededError("Gas limit too high") + + return intrinsic_gas, calldata_floor_gas_cost + + +def calculate_intrinsic_cost(tx: Transaction) -> Tuple[Uint, Uint]: + """ + Calculates the gas that is charged before execution is started. + + The intrinsic cost of the transaction is charged before execution has + begun. Functions/operations in the EVM cost money to execute so this + intrinsic cost is for the operations that need to be paid for as part of + the transaction. Data transfer, for example, is part of this intrinsic + cost. It costs ether to send data over the wire and that ether is + accounted for in the intrinsic cost calculated in this function. This + intrinsic cost must be calculated and paid for before execution in order + for all operations to be implemented. + + The intrinsic cost includes: + 1. Base cost (`TX_BASE_COST`) + 2. Cost for data (zero and non-zero bytes) + 3. Cost for contract creation (if applicable) + 4. Cost for access list entries (if applicable) + 5. Cost for authorizations (if applicable) + + + This function takes a transaction as a parameter and returns the intrinsic + gas cost of the transaction and the minimum gas cost used by the + transaction based on the calldata size. + """ + from .vm.eoa_delegation import PER_EMPTY_ACCOUNT_COST + from .vm.gas import init_code_cost + + zero_bytes = 0 + for byte in tx.data: + if byte == 0: + zero_bytes += 1 + + tokens_in_calldata = Uint(zero_bytes + (len(tx.data) - zero_bytes) * 4) + # EIP-7623 floor price (note: no EVM costs) + calldata_floor_gas_cost = ( + tokens_in_calldata * FLOOR_CALLDATA_COST + TX_BASE_COST + ) + + data_cost = tokens_in_calldata * STANDARD_CALLDATA_TOKEN_COST + + if tx.to == Bytes0(b""): + create_cost = TX_CREATE_COST + init_code_cost(ulen(tx.data)) + else: + create_cost = Uint(0) + + access_list_cost = Uint(0) + if isinstance( + tx, + ( + AccessListTransaction, + FeeMarketTransaction, + BlobTransaction, + SetCodeTransaction, + ), + ): + for access in tx.access_list: + access_list_cost += TX_ACCESS_LIST_ADDRESS_COST + access_list_cost += ( + ulen(access.slots) * TX_ACCESS_LIST_STORAGE_KEY_COST + ) + + auth_cost = Uint(0) + if isinstance(tx, SetCodeTransaction): + auth_cost += Uint(PER_EMPTY_ACCOUNT_COST * len(tx.authorizations)) + + return ( + Uint( + TX_BASE_COST + + data_cost + + create_cost + + access_list_cost + + auth_cost + ), + calldata_floor_gas_cost, + ) + + +def recover_sender(chain_id: U64, tx: Transaction) -> Address: + """ + Extracts the sender address from a transaction. + + The v, r, and s values are the three parts that make up the signature + of a transaction. In order to recover the sender of a transaction the two + components needed are the signature (``v``, ``r``, and ``s``) and the + signing hash of the transaction. The sender's public key can be obtained + with these two values and therefore the sender address can be retrieved. + + This function takes chain_id and a transaction as parameters and returns + the address of the sender of the transaction. It raises an + `InvalidSignatureError` if the signature values (r, s, v) are invalid. + """ + r, s = tx.r, tx.s + if U256(0) >= r or r >= SECP256K1N: + raise InvalidSignatureError("bad r") + if U256(0) >= s or s > SECP256K1N // U256(2): + raise InvalidSignatureError("bad s") + + if isinstance(tx, LegacyTransaction): + v = tx.v + if v == 27 or v == 28: + public_key = secp256k1_recover( + r, s, v - U256(27), signing_hash_pre155(tx) + ) + else: + chain_id_x2 = U256(chain_id) * U256(2) + if v != U256(35) + chain_id_x2 and v != U256(36) + chain_id_x2: + raise InvalidSignatureError("bad v") + public_key = secp256k1_recover( + r, + s, + v - U256(35) - chain_id_x2, + signing_hash_155(tx, chain_id), + ) + elif isinstance(tx, AccessListTransaction): + if tx.y_parity not in (U256(0), U256(1)): + raise InvalidSignatureError("bad y_parity") + public_key = secp256k1_recover( + r, s, tx.y_parity, signing_hash_2930(tx) + ) + elif isinstance(tx, FeeMarketTransaction): + if tx.y_parity not in (U256(0), U256(1)): + raise InvalidSignatureError("bad y_parity") + public_key = secp256k1_recover( + r, s, tx.y_parity, signing_hash_1559(tx) + ) + elif isinstance(tx, BlobTransaction): + if tx.y_parity not in (U256(0), U256(1)): + raise InvalidSignatureError("bad y_parity") + public_key = secp256k1_recover( + r, s, tx.y_parity, signing_hash_4844(tx) + ) + elif isinstance(tx, SetCodeTransaction): + if tx.y_parity not in (U256(0), U256(1)): + raise InvalidSignatureError("bad y_parity") + public_key = secp256k1_recover( + r, s, tx.y_parity, signing_hash_7702(tx) + ) + + return Address(keccak256(public_key)[12:32]) + + +def signing_hash_pre155(tx: LegacyTransaction) -> Hash32: + """ + Compute the hash of a transaction used in a legacy (pre [EIP-155]) + signature. + + This function takes a legacy transaction as a parameter and returns the + signing hash of the transaction. + + [EIP-155]: https://eips.ethereum.org/EIPS/eip-155 + """ + return keccak256( + rlp.encode( + ( + tx.nonce, + tx.gas_price, + tx.gas, + tx.to, + tx.value, + tx.data, + ) + ) + ) + + +def signing_hash_155(tx: LegacyTransaction, chain_id: U64) -> Hash32: + """ + Compute the hash of a transaction used in a [EIP-155] signature. + + This function takes a legacy transaction and a chain ID as parameters + and returns the hash of the transaction used in an [EIP-155] signature. + + [EIP-155]: https://eips.ethereum.org/EIPS/eip-155 + """ + return keccak256( + rlp.encode( + ( + tx.nonce, + tx.gas_price, + tx.gas, + tx.to, + tx.value, + tx.data, + chain_id, + Uint(0), + Uint(0), + ) + ) + ) + + +def signing_hash_2930(tx: AccessListTransaction) -> Hash32: + """ + Compute the hash of a transaction used in a [EIP-2930] signature. + + This function takes an access list transaction as a parameter + and returns the hash of the transaction used in an [EIP-2930] signature. + + [EIP-2930]: https://eips.ethereum.org/EIPS/eip-2930 + """ + return keccak256( + b"\x01" + + rlp.encode( + ( + tx.chain_id, + tx.nonce, + tx.gas_price, + tx.gas, + tx.to, + tx.value, + tx.data, + tx.access_list, + ) + ) + ) + + +def signing_hash_1559(tx: FeeMarketTransaction) -> Hash32: + """ + Compute the hash of a transaction used in an [EIP-1559] signature. + + This function takes a fee market transaction as a parameter + and returns the hash of the transaction used in an [EIP-1559] signature. + + [EIP-1559]: https://eips.ethereum.org/EIPS/eip-1559 + """ + return keccak256( + b"\x02" + + rlp.encode( + ( + tx.chain_id, + tx.nonce, + tx.max_priority_fee_per_gas, + tx.max_fee_per_gas, + tx.gas, + tx.to, + tx.value, + tx.data, + tx.access_list, + ) + ) + ) + + +def signing_hash_4844(tx: BlobTransaction) -> Hash32: + """ + Compute the hash of a transaction used in an [EIP-4844] signature. + + This function takes a transaction as a parameter and returns the + signing hash of the transaction used in an [EIP-4844] signature. + + [EIP-4844]: https://eips.ethereum.org/EIPS/eip-4844 + """ + return keccak256( + b"\x03" + + rlp.encode( + ( + tx.chain_id, + tx.nonce, + tx.max_priority_fee_per_gas, + tx.max_fee_per_gas, + tx.gas, + tx.to, + tx.value, + tx.data, + tx.access_list, + tx.max_fee_per_blob_gas, + tx.blob_versioned_hashes, + ) + ) + ) + + +def signing_hash_7702(tx: SetCodeTransaction) -> Hash32: + """ + Compute the hash of a transaction used in a [EIP-7702] signature. + + This function takes a transaction as a parameter and returns the + signing hash of the transaction used in a [EIP-7702] signature. + + [EIP-7702]: https://eips.ethereum.org/EIPS/eip-7702 + """ + return keccak256( + b"\x04" + + rlp.encode( + ( + tx.chain_id, + tx.nonce, + tx.max_priority_fee_per_gas, + tx.max_fee_per_gas, + tx.gas, + tx.to, + tx.value, + tx.data, + tx.access_list, + tx.authorizations, + ) + ) + ) + + +def get_transaction_hash(tx: Bytes | LegacyTransaction) -> Hash32: + """ + Compute the hash of a transaction. + + This function takes a transaction as a parameter and returns the + keccak256 hash of the transaction. It can handle both legacy transactions + and typed transactions (`AccessListTransaction`, `FeeMarketTransaction`, + etc.). + """ + assert isinstance(tx, (LegacyTransaction, Bytes)) + if isinstance(tx, LegacyTransaction): + return keccak256(rlp.encode(tx)) + else: + return keccak256(tx) diff --git a/src/ethereum/osaka/trie.py b/src/ethereum/osaka/trie.py new file mode 100644 index 0000000000..0b25cee74a --- /dev/null +++ b/src/ethereum/osaka/trie.py @@ -0,0 +1,500 @@ +""" +State Trie +^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +The state trie is the structure responsible for storing +`.fork_types.Account` objects. +""" + +import copy +from dataclasses import dataclass, field +from typing import ( + Callable, + Dict, + Generic, + List, + Mapping, + MutableMapping, + Optional, + Sequence, + Tuple, + TypeVar, + cast, +) + +from ethereum_rlp import Extended, rlp +from ethereum_types.bytes import Bytes +from ethereum_types.frozen import slotted_freezable +from ethereum_types.numeric import U256, Uint +from typing_extensions import assert_type + +from ethereum.crypto.hash import keccak256 +from ethereum.prague import trie as previous_trie +from ethereum.utils.hexadecimal import hex_to_bytes + +from .blocks import Receipt, Withdrawal +from .fork_types import Account, Address, Root, encode_account +from .transactions import LegacyTransaction + +# note: an empty trie (regardless of whether it is secured) has root: +# +# keccak256(RLP(b'')) +# == +# 56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421 # noqa: E501,SC10 +# +# also: +# +# keccak256(RLP(())) +# == +# 1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347 # noqa: E501,SC10 +# +# which is the sha3Uncles hash in block header with no uncles +EMPTY_TRIE_ROOT = Root( + hex_to_bytes( + "56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421" + ) +) + +Node = ( + Account + | Bytes + | LegacyTransaction + | Receipt + | Uint + | U256 + | Withdrawal + | None +) +K = TypeVar("K", bound=Bytes) +V = TypeVar( + "V", + Optional[Account], + Optional[Bytes], + Bytes, + Optional[LegacyTransaction | Bytes], + Optional[Receipt | Bytes], + Optional[Withdrawal | Bytes], + Uint, + U256, +) + + +@slotted_freezable +@dataclass +class LeafNode: + """Leaf node in the Merkle Trie""" + + rest_of_key: Bytes + value: Extended + + +@slotted_freezable +@dataclass +class ExtensionNode: + """Extension node in the Merkle Trie""" + + key_segment: Bytes + subnode: Extended + + +BranchSubnodes = Tuple[ + Extended, + Extended, + Extended, + Extended, + Extended, + Extended, + Extended, + Extended, + Extended, + Extended, + Extended, + Extended, + Extended, + Extended, + Extended, + Extended, +] + + +@slotted_freezable +@dataclass +class BranchNode: + """Branch node in the Merkle Trie""" + + subnodes: BranchSubnodes + value: Extended + + +InternalNode = LeafNode | ExtensionNode | BranchNode + + +def encode_internal_node(node: Optional[InternalNode]) -> Extended: + """ + Encodes a Merkle Trie node into its RLP form. The RLP will then be + serialized into a `Bytes` and hashed unless it is less that 32 bytes + when serialized. + + This function also accepts `None`, representing the absence of a node, + which is encoded to `b""`. + + Parameters + ---------- + node : Optional[InternalNode] + The node to encode. + + Returns + ------- + encoded : `Extended` + The node encoded as RLP. + """ + unencoded: Extended + if node is None: + unencoded = b"" + elif isinstance(node, LeafNode): + unencoded = ( + nibble_list_to_compact(node.rest_of_key, True), + node.value, + ) + elif isinstance(node, ExtensionNode): + unencoded = ( + nibble_list_to_compact(node.key_segment, False), + node.subnode, + ) + elif isinstance(node, BranchNode): + unencoded = list(node.subnodes) + [node.value] + else: + raise AssertionError(f"Invalid internal node type {type(node)}!") + + encoded = rlp.encode(unencoded) + if len(encoded) < 32: + return unencoded + else: + return keccak256(encoded) + + +def encode_node(node: Node, storage_root: Optional[Bytes] = None) -> Bytes: + """ + Encode a Node for storage in the Merkle Trie. + + Currently mostly an unimplemented stub. + """ + if isinstance(node, Account): + assert storage_root is not None + return encode_account(node, storage_root) + elif isinstance(node, (LegacyTransaction, Receipt, Withdrawal, U256)): + return rlp.encode(node) + elif isinstance(node, Bytes): + return node + else: + return previous_trie.encode_node(node, storage_root) + + +@dataclass +class Trie(Generic[K, V]): + """ + The Merkle Trie. + """ + + secured: bool + default: V + _data: Dict[K, V] = field(default_factory=dict) + + +def copy_trie(trie: Trie[K, V]) -> Trie[K, V]: + """ + Create a copy of `trie`. Since only frozen objects may be stored in tries, + the contents are reused. + + Parameters + ---------- + trie: `Trie` + Trie to copy. + + Returns + ------- + new_trie : `Trie[K, V]` + A copy of the trie. + """ + return Trie(trie.secured, trie.default, copy.copy(trie._data)) + + +def trie_set(trie: Trie[K, V], key: K, value: V) -> None: + """ + Stores an item in a Merkle Trie. + + This method deletes the key if `value == trie.default`, because the Merkle + Trie represents the default value by omitting it from the trie. + + Parameters + ---------- + trie: `Trie` + Trie to store in. + key : `Bytes` + Key to lookup. + value : `V` + Node to insert at `key`. + """ + if value == trie.default: + if key in trie._data: + del trie._data[key] + else: + trie._data[key] = value + + +def trie_get(trie: Trie[K, V], key: K) -> V: + """ + Gets an item from the Merkle Trie. + + This method returns `trie.default` if the key is missing. + + Parameters + ---------- + trie: + Trie to lookup in. + key : + Key to lookup. + + Returns + ------- + node : `V` + Node at `key` in the trie. + """ + return trie._data.get(key, trie.default) + + +def common_prefix_length(a: Sequence, b: Sequence) -> int: + """ + Find the longest common prefix of two sequences. + """ + for i in range(len(a)): + if i >= len(b) or a[i] != b[i]: + return i + return len(a) + + +def nibble_list_to_compact(x: Bytes, is_leaf: bool) -> Bytes: + """ + Compresses nibble-list into a standard byte array with a flag. + + A nibble-list is a list of byte values no greater than `15`. The flag is + encoded in high nibble of the highest byte. The flag nibble can be broken + down into two two-bit flags. + + Highest nibble:: + + +---+---+----------+--------+ + | _ | _ | is_leaf | parity | + +---+---+----------+--------+ + 3 2 1 0 + + + The lowest bit of the nibble encodes the parity of the length of the + remaining nibbles -- `0` when even and `1` when odd. The second lowest bit + is used to distinguish leaf and extension nodes. The other two bits are not + used. + + Parameters + ---------- + x : + Array of nibbles. + is_leaf : + True if this is part of a leaf node, or false if it is an extension + node. + + Returns + ------- + compressed : `bytearray` + Compact byte array. + """ + compact = bytearray() + + if len(x) % 2 == 0: # ie even length + compact.append(16 * (2 * is_leaf)) + for i in range(0, len(x), 2): + compact.append(16 * x[i] + x[i + 1]) + else: + compact.append(16 * ((2 * is_leaf) + 1) + x[0]) + for i in range(1, len(x), 2): + compact.append(16 * x[i] + x[i + 1]) + + return Bytes(compact) + + +def bytes_to_nibble_list(bytes_: Bytes) -> Bytes: + """ + Converts a `Bytes` into to a sequence of nibbles (bytes with value < 16). + + Parameters + ---------- + bytes_: + The `Bytes` to convert. + + Returns + ------- + nibble_list : `Bytes` + The `Bytes` in nibble-list format. + """ + nibble_list = bytearray(2 * len(bytes_)) + for byte_index, byte in enumerate(bytes_): + nibble_list[byte_index * 2] = (byte & 0xF0) >> 4 + nibble_list[byte_index * 2 + 1] = byte & 0x0F + return Bytes(nibble_list) + + +def _prepare_trie( + trie: Trie[K, V], + get_storage_root: Optional[Callable[[Address], Root]] = None, +) -> Mapping[Bytes, Bytes]: + """ + Prepares the trie for root calculation. Removes values that are empty, + hashes the keys (if `secured == True`) and encodes all the nodes. + + Parameters + ---------- + trie : + The `Trie` to prepare. + get_storage_root : + Function to get the storage root of an account. Needed to encode + `Account` objects. + + Returns + ------- + out : `Mapping[ethereum.base_types.Bytes, Node]` + Object with keys mapped to nibble-byte form. + """ + mapped: MutableMapping[Bytes, Bytes] = {} + + for preimage, value in trie._data.items(): + if isinstance(value, Account): + assert get_storage_root is not None + address = Address(preimage) + encoded_value = encode_node(value, get_storage_root(address)) + else: + encoded_value = encode_node(value) + if encoded_value == b"": + raise AssertionError + key: Bytes + if trie.secured: + # "secure" tries hash keys once before construction + key = keccak256(preimage) + else: + key = preimage + mapped[bytes_to_nibble_list(key)] = encoded_value + + return mapped + + +def root( + trie: Trie[K, V], + get_storage_root: Optional[Callable[[Address], Root]] = None, +) -> Root: + """ + Computes the root of a modified merkle patricia trie (MPT). + + Parameters + ---------- + trie : + `Trie` to get the root of. + get_storage_root : + Function to get the storage root of an account. Needed to encode + `Account` objects. + + + Returns + ------- + root : `.fork_types.Root` + MPT root of the underlying key-value pairs. + """ + obj = _prepare_trie(trie, get_storage_root) + + root_node = encode_internal_node(patricialize(obj, Uint(0))) + if len(rlp.encode(root_node)) < 32: + return keccak256(rlp.encode(root_node)) + else: + assert isinstance(root_node, Bytes) + return Root(root_node) + + +def patricialize( + obj: Mapping[Bytes, Bytes], level: Uint +) -> Optional[InternalNode]: + """ + Structural composition function. + + Used to recursively patricialize and merkleize a dictionary. Includes + memoization of the tree structure and hashes. + + Parameters + ---------- + obj : + Underlying trie key-value pairs, with keys in nibble-list format. + level : + Current trie level. + + Returns + ------- + node : `ethereum.base_types.Bytes` + Root node of `obj`. + """ + if len(obj) == 0: + return None + + arbitrary_key = next(iter(obj)) + + # if leaf node + if len(obj) == 1: + leaf = LeafNode(arbitrary_key[level:], obj[arbitrary_key]) + return leaf + + # prepare for extension node check by finding max j such that all keys in + # obj have the same key[i:j] + substring = arbitrary_key[level:] + prefix_length = len(substring) + for key in obj: + prefix_length = min( + prefix_length, common_prefix_length(substring, key[level:]) + ) + + # finished searching, found another key at the current level + if prefix_length == 0: + break + + # if extension node + if prefix_length > 0: + prefix = arbitrary_key[int(level) : int(level) + prefix_length] + return ExtensionNode( + prefix, + encode_internal_node( + patricialize(obj, level + Uint(prefix_length)) + ), + ) + + branches: List[MutableMapping[Bytes, Bytes]] = [] + for _ in range(16): + branches.append({}) + value = b"" + for key in obj: + if len(key) == level: + # shouldn't ever have an account or receipt in an internal node + if isinstance(obj[key], (Account, Receipt, Uint)): + raise AssertionError + value = obj[key] + else: + branches[key[level]][key] = obj[key] + + subnodes = tuple( + encode_internal_node(patricialize(branches[k], level + Uint(1))) + for k in range(16) + ) + return BranchNode( + cast(BranchSubnodes, assert_type(subnodes, Tuple[Extended, ...])), + value, + ) diff --git a/src/ethereum/osaka/utils/__init__.py b/src/ethereum/osaka/utils/__init__.py new file mode 100644 index 0000000000..224a4d269b --- /dev/null +++ b/src/ethereum/osaka/utils/__init__.py @@ -0,0 +1,3 @@ +""" +Utility functions unique to this particular fork. +""" diff --git a/src/ethereum/osaka/utils/address.py b/src/ethereum/osaka/utils/address.py new file mode 100644 index 0000000000..5d3713df66 --- /dev/null +++ b/src/ethereum/osaka/utils/address.py @@ -0,0 +1,91 @@ +""" +Hardfork Utility Functions For Addresses +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Address specific functions used in this osaka version of +specification. +""" +from ethereum_rlp import rlp +from ethereum_types.bytes import Bytes32 +from ethereum_types.numeric import U256, Uint + +from ethereum.crypto.hash import keccak256 +from ethereum.utils.byte import left_pad_zero_bytes + +from ..fork_types import Address + + +def to_address_masked(data: Uint | U256) -> Address: + """ + Convert a Uint or U256 value to a valid address (20 bytes). + + Parameters + ---------- + data : + The string to be converted to bytes. + + Returns + ------- + address : `Address` + The obtained address. + """ + return Address(data.to_be_bytes32()[-20:]) + + +def compute_contract_address(address: Address, nonce: Uint) -> Address: + """ + Computes address of the new account that needs to be created. + + Parameters + ---------- + address : + The address of the account that wants to create the new account. + nonce : + The transaction count of the account that wants to create the new + account. + + Returns + ------- + address: `Address` + The computed address of the new account. + """ + computed_address = keccak256(rlp.encode([address, nonce])) + canonical_address = computed_address[-20:] + padded_address = left_pad_zero_bytes(canonical_address, 20) + return Address(padded_address) + + +def compute_create2_contract_address( + address: Address, salt: Bytes32, call_data: bytearray +) -> Address: + """ + Computes address of the new account that needs to be created, which is + based on the sender address, salt and the call data as well. + + Parameters + ---------- + address : + The address of the account that wants to create the new account. + salt : + Address generation salt. + call_data : + The code of the new account which is to be created. + + Returns + ------- + address: `ethereum.osaka.fork_types.Address` + The computed address of the new account. + """ + preimage = b"\xff" + address + salt + keccak256(call_data) + computed_address = keccak256(preimage) + canonical_address = computed_address[-20:] + padded_address = left_pad_zero_bytes(canonical_address, 20) + + return Address(padded_address) diff --git a/src/ethereum/osaka/utils/hexadecimal.py b/src/ethereum/osaka/utils/hexadecimal.py new file mode 100644 index 0000000000..bc6761178b --- /dev/null +++ b/src/ethereum/osaka/utils/hexadecimal.py @@ -0,0 +1,53 @@ +""" +Utility Functions For Hexadecimal Strings +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Hexadecimal utility functions used in this specification, specific to +Osaka types. +""" +from ethereum_types.bytes import Bytes + +from ethereum.utils.hexadecimal import remove_hex_prefix + +from ..fork_types import Address, Root + + +def hex_to_root(hex_string: str) -> Root: + """ + Convert hex string to trie root. + + Parameters + ---------- + hex_string : + The hexadecimal string to be converted to trie root. + + Returns + ------- + root : `Root` + Trie root obtained from the given hexadecimal string. + """ + return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) + + +def hex_to_address(hex_string: str) -> Address: + """ + Convert hex string to Address (20 bytes). + + Parameters + ---------- + hex_string : + The hexadecimal string to be converted to Address. + + Returns + ------- + address : `Address` + The address obtained from the given hexadecimal string. + """ + return Address(Bytes.fromhex(remove_hex_prefix(hex_string).rjust(40, "0"))) diff --git a/src/ethereum/osaka/utils/message.py b/src/ethereum/osaka/utils/message.py new file mode 100644 index 0000000000..13074443c2 --- /dev/null +++ b/src/ethereum/osaka/utils/message.py @@ -0,0 +1,91 @@ +""" +Hardfork Utility Functions For The Message Data-structure +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Message specific functions used in this osaka 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.osaka.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), + disable_precompiles=False, + warm_code_addresses=set(), + parent_evm=None, + ) diff --git a/src/ethereum/osaka/vm/__init__.py b/src/ethereum/osaka/vm/__init__.py new file mode 100644 index 0000000000..f6632bf648 --- /dev/null +++ b/src/ethereum/osaka/vm/__init__.py @@ -0,0 +1,194 @@ +""" +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, Authorization, 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. + requests : `Bytes` + Hash of all the requests 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) + requests: List[Bytes] = field(default_factory=list) + + +@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, ...] + authorizations: Tuple[Authorization, ...] + index_in_block: Optional[Uint] + tx_hash: Optional[Hash32] + traces: List[dict] + + +@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]] + disable_precompiles: bool + warm_code_addresses: Set[Address] + 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]] + warm_code_addresses: Set[Address] + + +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) + evm.warm_code_addresses.update(child_evm.warm_code_addresses) + + +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 diff --git a/src/ethereum/osaka/vm/eoa_delegation.py b/src/ethereum/osaka/vm/eoa_delegation.py new file mode 100644 index 0000000000..00f8c9f412 --- /dev/null +++ b/src/ethereum/osaka/vm/eoa_delegation.py @@ -0,0 +1,211 @@ +""" +Set EOA account code. +""" + + +from typing import Optional, Tuple + +from ethereum_rlp import rlp +from ethereum_types.bytes import Bytes +from ethereum_types.numeric import U64, U256, Uint + +from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover +from ethereum.crypto.hash import keccak256 +from ethereum.exceptions import InvalidBlock, InvalidSignatureError + +from ..fork_types import Address, Authorization +from ..state import account_exists, get_account, increment_nonce, set_code +from ..utils.hexadecimal import hex_to_address +from ..vm.gas import GAS_COLD_ACCOUNT_ACCESS, GAS_WARM_ACCESS, code_access_cost +from . import Evm, Message + +SET_CODE_TX_MAGIC = b"\x05" +EOA_DELEGATION_MARKER = b"\xEF\x01\x00" +EOA_DELEGATION_MARKER_LENGTH = len(EOA_DELEGATION_MARKER) +EOA_DELEGATED_CODE_LENGTH = 23 +PER_EMPTY_ACCOUNT_COST = 25000 +PER_AUTH_BASE_COST = 12500 +NULL_ADDRESS = hex_to_address("0x0000000000000000000000000000000000000000") + + +def is_valid_delegation(code: bytes) -> bool: + """ + Whether the code is a valid delegation designation. + + Parameters + ---------- + code: `bytes` + The code to check. + + Returns + ------- + valid : `bool` + True if the code is a valid delegation designation, + False otherwise. + """ + if ( + len(code) == EOA_DELEGATED_CODE_LENGTH + and code[:EOA_DELEGATION_MARKER_LENGTH] == EOA_DELEGATION_MARKER + ): + return True + return False + + +def get_delegated_code_address(code: bytes) -> Optional[Address]: + """ + Get the address to which the code delegates. + + Parameters + ---------- + code: `bytes` + The code to get the address from. + + Returns + ------- + address : `Optional[Address]` + The address of the delegated code. + """ + if is_valid_delegation(code): + return Address(code[EOA_DELEGATION_MARKER_LENGTH:]) + return None + + +def recover_authority(authorization: Authorization) -> Address: + """ + Recover the authority address from the authorization. + + Parameters + ---------- + authorization + The authorization to recover the authority from. + + Raises + ------ + InvalidSignatureError + If the signature is invalid. + + Returns + ------- + authority : `Address` + The recovered authority address. + """ + y_parity, r, s = authorization.y_parity, authorization.r, authorization.s + if y_parity not in (0, 1): + raise InvalidSignatureError("Invalid y_parity in authorization") + if U256(0) >= r or r >= SECP256K1N: + raise InvalidSignatureError("Invalid r value in authorization") + if U256(0) >= s or s > SECP256K1N // U256(2): + raise InvalidSignatureError("Invalid s value in authorization") + + signing_hash = keccak256( + SET_CODE_TX_MAGIC + + rlp.encode( + ( + authorization.chain_id, + authorization.address, + authorization.nonce, + ) + ) + ) + + public_key = secp256k1_recover(r, s, U256(y_parity), signing_hash) + return Address(keccak256(public_key)[12:32]) + + +def access_delegation( + evm: Evm, address: Address +) -> Tuple[bool, Address, Bytes, Uint]: + """ + Get the delegation address, code, and the cost of access from the address. + + Parameters + ---------- + evm : `Evm` + The execution frame. + address : `Address` + The address to get the delegation from. + + Returns + ------- + delegation : `Tuple[bool, Address, Bytes, Uint]` + The delegation address, code, and access gas cost. + """ + state = evm.message.block_env.state + code = get_account(state, address).code + if not is_valid_delegation(code): + return False, address, code, Uint(0) + + address = Address(code[EOA_DELEGATION_MARKER_LENGTH:]) + code = get_account(state, address).code + if address in evm.accessed_addresses: + access_gas_cost = GAS_WARM_ACCESS + else: + evm.accessed_addresses.add(address) + access_gas_cost = GAS_COLD_ACCOUNT_ACCESS + + if address not in evm.warm_code_addresses: + evm.warm_code_addresses.add(address) + access_gas_cost += code_access_cost(code) + + return True, address, code, access_gas_cost + + +def set_delegation(message: Message) -> U256: + """ + Set the delegation code for the authorities in the message. + + Parameters + ---------- + message : + Transaction specific items. + env : + External items required for EVM execution. + + Returns + ------- + refund_counter: `U256` + Refund from authority which already exists in state. + """ + state = message.block_env.state + refund_counter = U256(0) + for auth in message.tx_env.authorizations: + if auth.chain_id not in (message.block_env.chain_id, U256(0)): + continue + + if auth.nonce >= U64.MAX_VALUE: + continue + + try: + authority = recover_authority(auth) + except InvalidSignatureError: + continue + + message.accessed_addresses.add(authority) + + authority_account = get_account(state, authority) + authority_code = authority_account.code + + if authority_code and not is_valid_delegation(authority_code): + continue + + authority_nonce = authority_account.nonce + if authority_nonce != auth.nonce: + continue + + if account_exists(state, authority): + refund_counter += U256(PER_EMPTY_ACCOUNT_COST - PER_AUTH_BASE_COST) + + if auth.address == NULL_ADDRESS: + code_to_set = b"" + else: + code_to_set = EOA_DELEGATION_MARKER + auth.address + set_code(state, authority, code_to_set) + + increment_nonce(state, authority) + + if message.code_address is None: + raise InvalidBlock("Invalid type 4 transaction: no target") + + message.code = get_account(state, message.code_address).code + + return refund_counter diff --git a/src/ethereum/osaka/vm/exceptions.py b/src/ethereum/osaka/vm/exceptions.py new file mode 100644 index 0000000000..2a4f2d2f65 --- /dev/null +++ b/src/ethereum/osaka/vm/exceptions.py @@ -0,0 +1,140 @@ +""" +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 diff --git a/src/ethereum/osaka/vm/gas.py b/src/ethereum/osaka/vm/gas.py new file mode 100644 index 0000000000..761bf4cf01 --- /dev/null +++ b/src/ethereum/osaka/vm/gas.py @@ -0,0 +1,417 @@ +""" +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.bytes import Bytes +from ethereum_types.numeric import U64, U256, Uint + +from ethereum.trace import GasAndRefund, evm_trace +from ethereum.utils.numeric import ceil32, taylor_exponential + +from ..blocks import Header +from ..transactions import BlobTransaction, Transaction +from . import Evm +from .exceptions import OutOfGasError + +GAS_JUMPDEST = Uint(1) +GAS_BASE = Uint(2) +GAS_VERY_LOW = Uint(3) +GAS_STORAGE_SET = Uint(20000) +GAS_STORAGE_UPDATE = Uint(5000) +GAS_STORAGE_CLEAR_REFUND = Uint(4800) +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_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_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) +GAS_ECRECOVER = Uint(3000) +GAS_P256VERIFY = Uint(6900) +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) +GAS_FAST_STEP = Uint(5) +GAS_BLAKE2_PER_ROUND = Uint(1) +GAS_COLD_SLOAD = Uint(2100) +GAS_COLD_ACCOUNT_ACCESS = Uint(2600) +GAS_WARM_ACCESS = Uint(100) +GAS_INIT_CODE_WORD_COST = Uint(2) +GAS_BLOBHASH_OPCODE = Uint(3) +GAS_POINT_EVALUATION = Uint(50000) + +TARGET_BLOB_GAS_PER_BLOCK = U64(786432) +BLOB_BASE_COST = Uint(2**13) +BLOB_SCHEDULE_MAX = U64(9) +BLOB_SCHEDULE_TARGET = U64(6) +GAS_PER_BLOB = U64(2**17) +MIN_BLOB_GASPRICE = Uint(1) +BLOB_BASE_FEE_UPDATE_FRACTION = Uint(5007716) + +GAS_BLS_G1_ADD = Uint(375) +GAS_BLS_G1_MUL = Uint(12000) +GAS_BLS_G1_MAP = Uint(5500) +GAS_BLS_G2_ADD = Uint(600) +GAS_BLS_G2_MUL = Uint(22500) +GAS_BLS_G2_MAP = Uint(23800) + + +@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: + raise OutOfGasError + + +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)) + + +def init_code_cost(init_code_length: Uint) -> Uint: + """ + Calculates the gas to be charged for the init code in CREAT* + opcodes as well as create transactions. + + Parameters + ---------- + init_code_length : + The length of the init code provided to the opcode + or a create transaction + + Returns + ------- + init_code_gas: `ethereum.base_types.Uint` + The gas to be charged for the init code. + """ + return GAS_INIT_CODE_WORD_COST * ceil32(init_code_length) // Uint(32) + + +def code_access_cost(code: Bytes) -> Uint: + """ + Calculates the gas to be charged for loading contract code. + + Parameters + ---------- + code : + The contract code. + + Returns + ------- + code_access_gas: `ethereum.base_types.Uint` + The gas to be charged for loading the code. + """ + from .interpreter import MAX_CODE_SIZE_WITH_NO_ACCESS_COST + + excess_contract_size = max( + 0, len(code) - MAX_CODE_SIZE_WITH_NO_ACCESS_COST + ) + if excess_contract_size == 0: + return Uint(0) + + return ( + GAS_INIT_CODE_WORD_COST + * ceil32(Uint(excess_contract_size)) + // Uint(32) + ) + + +def calculate_excess_blob_gas(parent_header: Header) -> U64: + """ + Calculated the excess blob gas for the current block based + on the gas used in the parent block. + + Parameters + ---------- + parent_header : + The parent block of the current block. + + Returns + ------- + excess_blob_gas: `ethereum.base_types.U64` + The excess blob gas for the current block. + """ + # At the fork block, these are defined as zero. + excess_blob_gas = U64(0) + blob_gas_used = U64(0) + base_fee_per_gas = Uint(0) + + if isinstance(parent_header, Header): + # After the fork block, read them from the parent header. + excess_blob_gas = parent_header.excess_blob_gas + blob_gas_used = parent_header.blob_gas_used + base_fee_per_gas = parent_header.base_fee_per_gas + + parent_blob_gas = excess_blob_gas + blob_gas_used + if parent_blob_gas < TARGET_BLOB_GAS_PER_BLOCK: + return U64(0) + + target_blob_gas_price = Uint(GAS_PER_BLOB) + target_blob_gas_price *= calculate_blob_gas_price(excess_blob_gas) + + base_blob_tx_price = BLOB_BASE_COST * base_fee_per_gas + if base_blob_tx_price > target_blob_gas_price: + blob_schedule_delta = BLOB_SCHEDULE_MAX - BLOB_SCHEDULE_TARGET + return ( + excess_blob_gas + + blob_gas_used * blob_schedule_delta // BLOB_SCHEDULE_MAX + ) + + return parent_blob_gas - TARGET_BLOB_GAS_PER_BLOCK + + +def calculate_total_blob_gas(tx: Transaction) -> U64: + """ + Calculate the total blob gas for a transaction. + + Parameters + ---------- + tx : + The transaction for which the blob gas is to be calculated. + + Returns + ------- + total_blob_gas: `ethereum.base_types.Uint` + The total blob gas for the transaction. + """ + if isinstance(tx, BlobTransaction): + return GAS_PER_BLOB * U64(len(tx.blob_versioned_hashes)) + else: + return U64(0) + + +def calculate_blob_gas_price(excess_blob_gas: U64) -> Uint: + """ + Calculate the blob gasprice for a block. + + Parameters + ---------- + excess_blob_gas : + The excess blob gas for the block. + + Returns + ------- + blob_gasprice: `Uint` + The blob gasprice. + """ + return taylor_exponential( + MIN_BLOB_GASPRICE, + Uint(excess_blob_gas), + BLOB_BASE_FEE_UPDATE_FRACTION, + ) + + +def calculate_data_fee(excess_blob_gas: U64, tx: Transaction) -> Uint: + """ + Calculate the blob data fee for a transaction. + + Parameters + ---------- + excess_blob_gas : + The excess_blob_gas for the execution. + tx : + The transaction for which the blob data fee is to be calculated. + + Returns + ------- + data_fee: `Uint` + The blob data fee. + """ + return Uint(calculate_total_blob_gas(tx)) * calculate_blob_gas_price( + excess_blob_gas + ) diff --git a/src/ethereum/osaka/vm/instructions/__init__.py b/src/ethereum/osaka/vm/instructions/__init__.py new file mode 100644 index 0000000000..9cc30668e7 --- /dev/null +++ b/src/ethereum/osaka/vm/instructions/__init__.py @@ -0,0 +1,368 @@ +""" +EVM Instruction Encoding (Opcodes) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Machine readable representations of EVM instructions, and a mapping to their +implementations. +""" + +import enum +from typing import Callable, Dict + +from . import arithmetic as arithmetic_instructions +from . import bitwise as bitwise_instructions +from . import block as block_instructions +from . import comparison as comparison_instructions +from . import control_flow as control_flow_instructions +from . import environment as environment_instructions +from . import keccak as keccak_instructions +from . import log as log_instructions +from . import memory as memory_instructions +from . import stack as stack_instructions +from . import storage as storage_instructions +from . import system as system_instructions + + +class Ops(enum.Enum): + """ + Enum for EVM Opcodes + """ + + # Arithmetic Ops + ADD = 0x01 + MUL = 0x02 + SUB = 0x03 + DIV = 0x04 + SDIV = 0x05 + MOD = 0x06 + SMOD = 0x07 + ADDMOD = 0x08 + MULMOD = 0x09 + EXP = 0x0A + SIGNEXTEND = 0x0B + + # Comparison Ops + LT = 0x10 + GT = 0x11 + SLT = 0x12 + SGT = 0x13 + EQ = 0x14 + ISZERO = 0x15 + + # Bitwise Ops + AND = 0x16 + OR = 0x17 + XOR = 0x18 + NOT = 0x19 + BYTE = 0x1A + SHL = 0x1B + SHR = 0x1C + SAR = 0x1D + CLZ = 0x1E + + # Keccak Op + KECCAK = 0x20 + + # Environmental Ops + ADDRESS = 0x30 + BALANCE = 0x31 + ORIGIN = 0x32 + CALLER = 0x33 + CALLVALUE = 0x34 + CALLDATALOAD = 0x35 + CALLDATASIZE = 0x36 + CALLDATACOPY = 0x37 + CODESIZE = 0x38 + CODECOPY = 0x39 + GASPRICE = 0x3A + EXTCODESIZE = 0x3B + EXTCODECOPY = 0x3C + RETURNDATASIZE = 0x3D + RETURNDATACOPY = 0x3E + EXTCODEHASH = 0x3F + + # Block Ops + BLOCKHASH = 0x40 + COINBASE = 0x41 + TIMESTAMP = 0x42 + NUMBER = 0x43 + PREVRANDAO = 0x44 + GASLIMIT = 0x45 + CHAINID = 0x46 + SELFBALANCE = 0x47 + BASEFEE = 0x48 + BLOBHASH = 0x49 + BLOBBASEFEE = 0x4A + + # Control Flow Ops + STOP = 0x00 + JUMP = 0x56 + JUMPI = 0x57 + PC = 0x58 + GAS = 0x5A + JUMPDEST = 0x5B + + # Storage Ops + SLOAD = 0x54 + SSTORE = 0x55 + TLOAD = 0x5C + TSTORE = 0x5D + + # Pop Operation + POP = 0x50 + + # Push Operations + PUSH0 = 0x5F + PUSH1 = 0x60 + PUSH2 = 0x61 + PUSH3 = 0x62 + PUSH4 = 0x63 + PUSH5 = 0x64 + PUSH6 = 0x65 + PUSH7 = 0x66 + PUSH8 = 0x67 + PUSH9 = 0x68 + PUSH10 = 0x69 + PUSH11 = 0x6A + PUSH12 = 0x6B + PUSH13 = 0x6C + PUSH14 = 0x6D + PUSH15 = 0x6E + PUSH16 = 0x6F + PUSH17 = 0x70 + PUSH18 = 0x71 + PUSH19 = 0x72 + PUSH20 = 0x73 + PUSH21 = 0x74 + PUSH22 = 0x75 + PUSH23 = 0x76 + PUSH24 = 0x77 + PUSH25 = 0x78 + PUSH26 = 0x79 + PUSH27 = 0x7A + PUSH28 = 0x7B + PUSH29 = 0x7C + PUSH30 = 0x7D + PUSH31 = 0x7E + PUSH32 = 0x7F + + # Dup operations + DUP1 = 0x80 + DUP2 = 0x81 + DUP3 = 0x82 + DUP4 = 0x83 + DUP5 = 0x84 + DUP6 = 0x85 + DUP7 = 0x86 + DUP8 = 0x87 + DUP9 = 0x88 + DUP10 = 0x89 + DUP11 = 0x8A + DUP12 = 0x8B + DUP13 = 0x8C + DUP14 = 0x8D + DUP15 = 0x8E + DUP16 = 0x8F + + # Swap operations + SWAP1 = 0x90 + SWAP2 = 0x91 + SWAP3 = 0x92 + SWAP4 = 0x93 + SWAP5 = 0x94 + SWAP6 = 0x95 + SWAP7 = 0x96 + SWAP8 = 0x97 + SWAP9 = 0x98 + SWAP10 = 0x99 + SWAP11 = 0x9A + SWAP12 = 0x9B + SWAP13 = 0x9C + SWAP14 = 0x9D + SWAP15 = 0x9E + SWAP16 = 0x9F + + # Memory Operations + MLOAD = 0x51 + MSTORE = 0x52 + MSTORE8 = 0x53 + MSIZE = 0x59 + MCOPY = 0x5E + + # Log Operations + LOG0 = 0xA0 + LOG1 = 0xA1 + LOG2 = 0xA2 + LOG3 = 0xA3 + LOG4 = 0xA4 + + # System Operations + CREATE = 0xF0 + CALL = 0xF1 + CALLCODE = 0xF2 + RETURN = 0xF3 + DELEGATECALL = 0xF4 + CREATE2 = 0xF5 + STATICCALL = 0xFA + REVERT = 0xFD + SELFDESTRUCT = 0xFF + + +op_implementation: Dict[Ops, Callable] = { + Ops.STOP: control_flow_instructions.stop, + Ops.ADD: arithmetic_instructions.add, + Ops.MUL: arithmetic_instructions.mul, + Ops.SUB: arithmetic_instructions.sub, + Ops.DIV: arithmetic_instructions.div, + Ops.SDIV: arithmetic_instructions.sdiv, + Ops.MOD: arithmetic_instructions.mod, + Ops.SMOD: arithmetic_instructions.smod, + Ops.ADDMOD: arithmetic_instructions.addmod, + Ops.MULMOD: arithmetic_instructions.mulmod, + Ops.EXP: arithmetic_instructions.exp, + Ops.SIGNEXTEND: arithmetic_instructions.signextend, + Ops.LT: comparison_instructions.less_than, + Ops.GT: comparison_instructions.greater_than, + Ops.SLT: comparison_instructions.signed_less_than, + Ops.SGT: comparison_instructions.signed_greater_than, + Ops.EQ: comparison_instructions.equal, + Ops.ISZERO: comparison_instructions.is_zero, + Ops.AND: bitwise_instructions.bitwise_and, + Ops.OR: bitwise_instructions.bitwise_or, + Ops.XOR: bitwise_instructions.bitwise_xor, + Ops.NOT: bitwise_instructions.bitwise_not, + Ops.BYTE: bitwise_instructions.get_byte, + Ops.SHL: bitwise_instructions.bitwise_shl, + Ops.SHR: bitwise_instructions.bitwise_shr, + Ops.SAR: bitwise_instructions.bitwise_sar, + Ops.CLZ: bitwise_instructions.count_leading_zeros, + Ops.KECCAK: keccak_instructions.keccak, + Ops.SLOAD: storage_instructions.sload, + Ops.BLOCKHASH: block_instructions.block_hash, + Ops.COINBASE: block_instructions.coinbase, + Ops.TIMESTAMP: block_instructions.timestamp, + Ops.NUMBER: block_instructions.number, + Ops.PREVRANDAO: block_instructions.prev_randao, + Ops.GASLIMIT: block_instructions.gas_limit, + Ops.CHAINID: block_instructions.chain_id, + Ops.MLOAD: memory_instructions.mload, + Ops.MSTORE: memory_instructions.mstore, + Ops.MSTORE8: memory_instructions.mstore8, + Ops.MSIZE: memory_instructions.msize, + Ops.MCOPY: memory_instructions.mcopy, + Ops.ADDRESS: environment_instructions.address, + Ops.BALANCE: environment_instructions.balance, + Ops.ORIGIN: environment_instructions.origin, + Ops.CALLER: environment_instructions.caller, + Ops.CALLVALUE: environment_instructions.callvalue, + Ops.CALLDATALOAD: environment_instructions.calldataload, + Ops.CALLDATASIZE: environment_instructions.calldatasize, + Ops.CALLDATACOPY: environment_instructions.calldatacopy, + Ops.CODESIZE: environment_instructions.codesize, + Ops.CODECOPY: environment_instructions.codecopy, + Ops.GASPRICE: environment_instructions.gasprice, + Ops.EXTCODESIZE: environment_instructions.extcodesize, + Ops.EXTCODECOPY: environment_instructions.extcodecopy, + Ops.RETURNDATASIZE: environment_instructions.returndatasize, + Ops.RETURNDATACOPY: environment_instructions.returndatacopy, + Ops.EXTCODEHASH: environment_instructions.extcodehash, + Ops.SELFBALANCE: environment_instructions.self_balance, + Ops.BASEFEE: environment_instructions.base_fee, + Ops.BLOBHASH: environment_instructions.blob_hash, + Ops.BLOBBASEFEE: environment_instructions.blob_base_fee, + Ops.SSTORE: storage_instructions.sstore, + Ops.TLOAD: storage_instructions.tload, + Ops.TSTORE: storage_instructions.tstore, + Ops.JUMP: control_flow_instructions.jump, + Ops.JUMPI: control_flow_instructions.jumpi, + Ops.PC: control_flow_instructions.pc, + Ops.GAS: control_flow_instructions.gas_left, + Ops.JUMPDEST: control_flow_instructions.jumpdest, + Ops.POP: stack_instructions.pop, + Ops.PUSH0: stack_instructions.push0, + Ops.PUSH1: stack_instructions.push1, + Ops.PUSH2: stack_instructions.push2, + Ops.PUSH3: stack_instructions.push3, + Ops.PUSH4: stack_instructions.push4, + Ops.PUSH5: stack_instructions.push5, + Ops.PUSH6: stack_instructions.push6, + Ops.PUSH7: stack_instructions.push7, + Ops.PUSH8: stack_instructions.push8, + Ops.PUSH9: stack_instructions.push9, + Ops.PUSH10: stack_instructions.push10, + Ops.PUSH11: stack_instructions.push11, + Ops.PUSH12: stack_instructions.push12, + Ops.PUSH13: stack_instructions.push13, + Ops.PUSH14: stack_instructions.push14, + Ops.PUSH15: stack_instructions.push15, + Ops.PUSH16: stack_instructions.push16, + Ops.PUSH17: stack_instructions.push17, + Ops.PUSH18: stack_instructions.push18, + Ops.PUSH19: stack_instructions.push19, + Ops.PUSH20: stack_instructions.push20, + Ops.PUSH21: stack_instructions.push21, + Ops.PUSH22: stack_instructions.push22, + Ops.PUSH23: stack_instructions.push23, + Ops.PUSH24: stack_instructions.push24, + Ops.PUSH25: stack_instructions.push25, + Ops.PUSH26: stack_instructions.push26, + Ops.PUSH27: stack_instructions.push27, + Ops.PUSH28: stack_instructions.push28, + Ops.PUSH29: stack_instructions.push29, + Ops.PUSH30: stack_instructions.push30, + Ops.PUSH31: stack_instructions.push31, + Ops.PUSH32: stack_instructions.push32, + Ops.DUP1: stack_instructions.dup1, + Ops.DUP2: stack_instructions.dup2, + Ops.DUP3: stack_instructions.dup3, + Ops.DUP4: stack_instructions.dup4, + Ops.DUP5: stack_instructions.dup5, + Ops.DUP6: stack_instructions.dup6, + Ops.DUP7: stack_instructions.dup7, + Ops.DUP8: stack_instructions.dup8, + Ops.DUP9: stack_instructions.dup9, + Ops.DUP10: stack_instructions.dup10, + Ops.DUP11: stack_instructions.dup11, + Ops.DUP12: stack_instructions.dup12, + Ops.DUP13: stack_instructions.dup13, + Ops.DUP14: stack_instructions.dup14, + Ops.DUP15: stack_instructions.dup15, + Ops.DUP16: stack_instructions.dup16, + Ops.SWAP1: stack_instructions.swap1, + Ops.SWAP2: stack_instructions.swap2, + Ops.SWAP3: stack_instructions.swap3, + Ops.SWAP4: stack_instructions.swap4, + Ops.SWAP5: stack_instructions.swap5, + Ops.SWAP6: stack_instructions.swap6, + Ops.SWAP7: stack_instructions.swap7, + Ops.SWAP8: stack_instructions.swap8, + Ops.SWAP9: stack_instructions.swap9, + Ops.SWAP10: stack_instructions.swap10, + Ops.SWAP11: stack_instructions.swap11, + Ops.SWAP12: stack_instructions.swap12, + Ops.SWAP13: stack_instructions.swap13, + Ops.SWAP14: stack_instructions.swap14, + Ops.SWAP15: stack_instructions.swap15, + Ops.SWAP16: stack_instructions.swap16, + Ops.LOG0: log_instructions.log0, + Ops.LOG1: log_instructions.log1, + Ops.LOG2: log_instructions.log2, + Ops.LOG3: log_instructions.log3, + Ops.LOG4: log_instructions.log4, + Ops.CREATE: system_instructions.create, + Ops.RETURN: system_instructions.return_, + Ops.CALL: system_instructions.call, + Ops.CALLCODE: system_instructions.callcode, + Ops.DELEGATECALL: system_instructions.delegatecall, + Ops.SELFDESTRUCT: system_instructions.selfdestruct, + Ops.STATICCALL: system_instructions.staticcall, + Ops.REVERT: system_instructions.revert, + Ops.CREATE2: system_instructions.create2, +} diff --git a/src/ethereum/osaka/vm/instructions/arithmetic.py b/src/ethereum/osaka/vm/instructions/arithmetic.py new file mode 100644 index 0000000000..28c97db189 --- /dev/null +++ b/src/ethereum/osaka/vm/instructions/arithmetic.py @@ -0,0 +1,374 @@ +""" +Ethereum Virtual Machine (EVM) Arithmetic Instructions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementations of the EVM Arithmetic instructions. +""" + +from ethereum_types.bytes import Bytes +from ethereum_types.numeric import U256, Uint + +from ethereum.utils.numeric import get_sign + +from .. import Evm +from ..gas import ( + GAS_EXPONENTIATION, + GAS_EXPONENTIATION_PER_BYTE, + GAS_LOW, + GAS_MID, + GAS_VERY_LOW, + charge_gas, +) +from ..stack import pop, push + + +def add(evm: Evm) -> None: + """ + Adds the top two elements of the stack together, and pushes the result back + on the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + x = pop(evm.stack) + y = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + result = x.wrapping_add(y) + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def sub(evm: Evm) -> None: + """ + Subtracts the top two elements of the stack, and pushes the result back + on the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + x = pop(evm.stack) + y = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + result = x.wrapping_sub(y) + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def mul(evm: Evm) -> None: + """ + Multiply the top two elements of the stack, and pushes the result back + on the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + x = pop(evm.stack) + y = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_LOW) + + # OPERATION + result = x.wrapping_mul(y) + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def div(evm: Evm) -> None: + """ + Integer division of the top two elements of the stack. Pushes the result + back on the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + dividend = pop(evm.stack) + divisor = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_LOW) + + # OPERATION + if divisor == 0: + quotient = U256(0) + else: + quotient = dividend // divisor + + push(evm.stack, quotient) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +U255_CEIL_VALUE = 2**255 + + +def sdiv(evm: Evm) -> None: + """ + Signed integer division of the top two elements of the stack. Pushes the + result back on the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + dividend = pop(evm.stack).to_signed() + divisor = pop(evm.stack).to_signed() + + # GAS + charge_gas(evm, GAS_LOW) + + # OPERATION + if divisor == 0: + quotient = 0 + elif dividend == -U255_CEIL_VALUE and divisor == -1: + quotient = -U255_CEIL_VALUE + else: + sign = get_sign(dividend * divisor) + quotient = sign * (abs(dividend) // abs(divisor)) + + push(evm.stack, U256.from_signed(quotient)) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def mod(evm: Evm) -> None: + """ + Modulo remainder of the top two elements of the stack. Pushes the result + back on the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + x = pop(evm.stack) + y = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_LOW) + + # OPERATION + if y == 0: + remainder = U256(0) + else: + remainder = x % y + + push(evm.stack, remainder) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def smod(evm: Evm) -> None: + """ + Signed modulo remainder of the top two elements of the stack. Pushes the + result back on the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + x = pop(evm.stack).to_signed() + y = pop(evm.stack).to_signed() + + # GAS + charge_gas(evm, GAS_LOW) + + # OPERATION + if y == 0: + remainder = 0 + else: + remainder = get_sign(x) * (abs(x) % abs(y)) + + push(evm.stack, U256.from_signed(remainder)) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def addmod(evm: Evm) -> None: + """ + Modulo addition of the top 2 elements with the 3rd element. Pushes the + result back on the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + x = Uint(pop(evm.stack)) + y = Uint(pop(evm.stack)) + z = Uint(pop(evm.stack)) + + # GAS + charge_gas(evm, GAS_MID) + + # OPERATION + if z == 0: + result = U256(0) + else: + result = U256((x + y) % z) + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def mulmod(evm: Evm) -> None: + """ + Modulo multiplication of the top 2 elements with the 3rd element. Pushes + the result back on the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + x = Uint(pop(evm.stack)) + y = Uint(pop(evm.stack)) + z = Uint(pop(evm.stack)) + + # GAS + charge_gas(evm, GAS_MID) + + # OPERATION + if z == 0: + result = U256(0) + else: + result = U256((x * y) % z) + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def exp(evm: Evm) -> None: + """ + Exponential operation of the top 2 elements. Pushes the result back on + the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + base = Uint(pop(evm.stack)) + exponent = Uint(pop(evm.stack)) + + # GAS + # This is equivalent to 1 + floor(log(y, 256)). But in python the log + # function is inaccurate leading to wrong results. + exponent_bits = exponent.bit_length() + exponent_bytes = (exponent_bits + Uint(7)) // Uint(8) + charge_gas( + evm, GAS_EXPONENTIATION + GAS_EXPONENTIATION_PER_BYTE * exponent_bytes + ) + + # OPERATION + result = U256(pow(base, exponent, Uint(U256.MAX_VALUE) + Uint(1))) + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def signextend(evm: Evm) -> None: + """ + Sign extend operation. In other words, extend a signed number which + fits in N bytes to 32 bytes. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + byte_num = pop(evm.stack) + value = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_LOW) + + # OPERATION + if byte_num > U256(31): + # Can't extend any further + result = value + else: + # U256(0).to_be_bytes() gives b'' instead b'\x00'. + value_bytes = Bytes(value.to_be_bytes32()) + # Now among the obtained value bytes, consider only + # N `least significant bytes`, where N is `byte_num + 1`. + value_bytes = value_bytes[31 - int(byte_num) :] + sign_bit = value_bytes[0] >> 7 + if sign_bit == 0: + result = U256.from_be_bytes(value_bytes) + else: + num_bytes_prepend = U256(32) - (byte_num + U256(1)) + result = U256.from_be_bytes( + bytearray([0xFF] * num_bytes_prepend) + value_bytes + ) + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) diff --git a/src/ethereum/osaka/vm/instructions/bitwise.py b/src/ethereum/osaka/vm/instructions/bitwise.py new file mode 100644 index 0000000000..cc96b9da0e --- /dev/null +++ b/src/ethereum/osaka/vm/instructions/bitwise.py @@ -0,0 +1,268 @@ +""" +Ethereum Virtual Machine (EVM) Bitwise Instructions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementations of the EVM bitwise instructions. +""" + +from ethereum_types.numeric import U256, Uint + +from .. import Evm +from ..gas import GAS_LOW, GAS_VERY_LOW, charge_gas +from ..stack import pop, push + + +def bitwise_and(evm: Evm) -> None: + """ + Bitwise AND operation of the top 2 elements of the stack. Pushes the + result back on the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + x = pop(evm.stack) + y = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + push(evm.stack, x & y) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def bitwise_or(evm: Evm) -> None: + """ + Bitwise OR operation of the top 2 elements of the stack. Pushes the + result back on the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + x = pop(evm.stack) + y = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + push(evm.stack, x | y) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def bitwise_xor(evm: Evm) -> None: + """ + Bitwise XOR operation of the top 2 elements of the stack. Pushes the + result back on the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + x = pop(evm.stack) + y = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + push(evm.stack, x ^ y) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def bitwise_not(evm: Evm) -> None: + """ + Bitwise NOT operation of the top element of the stack. Pushes the + result back on the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + x = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + push(evm.stack, ~x) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def get_byte(evm: Evm) -> None: + """ + For a word (defined by next top element of the stack), retrieve the + Nth byte (0-indexed and defined by top element of stack) from the + left (most significant) to right (least significant). + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + byte_index = pop(evm.stack) + word = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + if byte_index >= U256(32): + result = U256(0) + else: + extra_bytes_to_right = U256(31) - byte_index + # Remove the extra bytes in the right + word = word >> (extra_bytes_to_right * U256(8)) + # Remove the extra bytes in the left + word = word & U256(0xFF) + result = word + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def bitwise_shl(evm: Evm) -> None: + """ + Logical shift left (SHL) operation of the top 2 elements of the stack. + Pushes the result back on the stack. + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + shift = Uint(pop(evm.stack)) + value = Uint(pop(evm.stack)) + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + if shift < Uint(256): + result = U256((value << shift) & Uint(U256.MAX_VALUE)) + else: + result = U256(0) + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def bitwise_shr(evm: Evm) -> None: + """ + Logical shift right (SHR) operation of the top 2 elements of the stack. + Pushes the result back on the stack. + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + shift = pop(evm.stack) + value = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + if shift < U256(256): + result = value >> shift + else: + result = U256(0) + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def bitwise_sar(evm: Evm) -> None: + """ + Arithmetic shift right (SAR) operation of the top 2 elements of the stack. + Pushes the result back on the stack. + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + shift = int(pop(evm.stack)) + signed_value = pop(evm.stack).to_signed() + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + if shift < 256: + result = U256.from_signed(signed_value >> shift) + elif signed_value >= 0: + result = U256(0) + else: + result = U256.MAX_VALUE + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def count_leading_zeros(evm: Evm) -> None: + """ + Count the number of leading zero bits in a 256-bit word. + + Pops one value from the stack and pushes the number of leading zero bits. + If the input is zero, pushes 256. + + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + x = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_LOW) + + # OPERATION + bit_length = U256(x.bit_length()) + result = U256(256) - bit_length + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) diff --git a/src/ethereum/osaka/vm/instructions/block.py b/src/ethereum/osaka/vm/instructions/block.py new file mode 100644 index 0000000000..80644000fd --- /dev/null +++ b/src/ethereum/osaka/vm/instructions/block.py @@ -0,0 +1,255 @@ +""" +Ethereum Virtual Machine (EVM) Block Instructions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementations of the EVM block instructions. +""" + +from ethereum_types.numeric import U256, Uint + +from .. import Evm +from ..gas import GAS_BASE, GAS_BLOCK_HASH, charge_gas +from ..stack import pop, push + + +def block_hash(evm: Evm) -> None: + """ + Push the hash of one of the 256 most recent complete blocks onto the + stack. The block number to hash is present at the top of the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + Raises + ------ + :py:class:`~ethereum.osaka.vm.exceptions.StackUnderflowError` + If `len(stack)` is less than `1`. + :py:class:`~ethereum.osaka.vm.exceptions.OutOfGasError` + If `evm.gas_left` is less than `20`. + """ + # STACK + block_number = Uint(pop(evm.stack)) + + # GAS + charge_gas(evm, GAS_BLOCK_HASH) + + # OPERATION + max_block_number = block_number + Uint(256) + current_block_number = evm.message.block_env.number + if ( + current_block_number <= block_number + or current_block_number > max_block_number + ): + # Default hash to 0, if the block of interest is not yet on the chain + # (including the block which has the current executing transaction), + # or if the block's age is more than 256. + hash = b"\x00" + else: + hash = evm.message.block_env.block_hashes[ + -(current_block_number - block_number) + ] + + push(evm.stack, U256.from_be_bytes(hash)) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def coinbase(evm: Evm) -> None: + """ + Push the current block's beneficiary address (address of the block miner) + onto the stack. + + Here the current block refers to the block in which the currently + executing transaction/call resides. + + Parameters + ---------- + evm : + The current EVM frame. + + Raises + ------ + :py:class:`~ethereum.osaka.vm.exceptions.StackOverflowError` + If `len(stack)` is equal to `1024`. + :py:class:`~ethereum.osaka.vm.exceptions.OutOfGasError` + If `evm.gas_left` is less than `2`. + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, U256.from_be_bytes(evm.message.block_env.coinbase)) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def timestamp(evm: Evm) -> None: + """ + Push the current block's timestamp onto the stack. Here the timestamp + being referred is actually the unix timestamp in seconds. + + Here the current block refers to the block in which the currently + executing transaction/call resides. + + Parameters + ---------- + evm : + The current EVM frame. + + Raises + ------ + :py:class:`~ethereum.osaka.vm.exceptions.StackOverflowError` + If `len(stack)` is equal to `1024`. + :py:class:`~ethereum.osaka.vm.exceptions.OutOfGasError` + If `evm.gas_left` is less than `2`. + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, evm.message.block_env.time) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def number(evm: Evm) -> None: + """ + Push the current block's number onto the stack. + + Here the current block refers to the block in which the currently + executing transaction/call resides. + + Parameters + ---------- + evm : + The current EVM frame. + + Raises + ------ + :py:class:`~ethereum.osaka.vm.exceptions.StackOverflowError` + If `len(stack)` is equal to `1024`. + :py:class:`~ethereum.osaka.vm.exceptions.OutOfGasError` + If `evm.gas_left` is less than `2`. + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, U256(evm.message.block_env.number)) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def prev_randao(evm: Evm) -> None: + """ + Push the `prev_randao` value onto the stack. + + The `prev_randao` value is the random output of the beacon chain's + randomness oracle for the previous block. + + Parameters + ---------- + evm : + The current EVM frame. + + Raises + ------ + :py:class:`~ethereum.osaka.vm.exceptions.StackOverflowError` + If `len(stack)` is equal to `1024`. + :py:class:`~ethereum.osaka.vm.exceptions.OutOfGasError` + If `evm.gas_left` is less than `2`. + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, U256.from_be_bytes(evm.message.block_env.prev_randao)) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def gas_limit(evm: Evm) -> None: + """ + Push the current block's gas limit onto the stack. + + Here the current block refers to the block in which the currently + executing transaction/call resides. + + Parameters + ---------- + evm : + The current EVM frame. + + Raises + ------ + :py:class:`~ethereum.osaka.vm.exceptions.StackOverflowError` + If `len(stack)` is equal to `1024`. + :py:class:`~ethereum.osaka.vm.exceptions.OutOfGasError` + If `evm.gas_left` is less than `2`. + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, U256(evm.message.block_env.block_gas_limit)) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def chain_id(evm: Evm) -> None: + """ + Push the chain id onto the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + Raises + ------ + :py:class:`~ethereum.osaka.vm.exceptions.StackOverflowError` + If `len(stack)` is equal to `1024`. + :py:class:`~ethereum.osaka.vm.exceptions.OutOfGasError` + If `evm.gas_left` is less than `2`. + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, U256(evm.message.block_env.chain_id)) + + # PROGRAM COUNTER + evm.pc += Uint(1) diff --git a/src/ethereum/osaka/vm/instructions/comparison.py b/src/ethereum/osaka/vm/instructions/comparison.py new file mode 100644 index 0000000000..275455ba53 --- /dev/null +++ b/src/ethereum/osaka/vm/instructions/comparison.py @@ -0,0 +1,178 @@ +""" +Ethereum Virtual Machine (EVM) Comparison Instructions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementations of the EVM Comparison instructions. +""" + +from ethereum_types.numeric import U256, Uint + +from .. import Evm +from ..gas import GAS_VERY_LOW, charge_gas +from ..stack import pop, push + + +def less_than(evm: Evm) -> None: + """ + Checks if the top element is less than the next top element. Pushes the + result back on the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + left = pop(evm.stack) + right = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + result = U256(left < right) + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def signed_less_than(evm: Evm) -> None: + """ + Signed less-than comparison. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + left = pop(evm.stack).to_signed() + right = pop(evm.stack).to_signed() + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + result = U256(left < right) + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def greater_than(evm: Evm) -> None: + """ + Checks if the top element is greater than the next top element. Pushes + the result back on the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + left = pop(evm.stack) + right = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + result = U256(left > right) + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def signed_greater_than(evm: Evm) -> None: + """ + Signed greater-than comparison. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + left = pop(evm.stack).to_signed() + right = pop(evm.stack).to_signed() + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + result = U256(left > right) + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def equal(evm: Evm) -> None: + """ + Checks if the top element is equal to the next top element. Pushes + the result back on the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + left = pop(evm.stack) + right = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + result = U256(left == right) + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def is_zero(evm: Evm) -> None: + """ + Checks if the top element is equal to 0. Pushes the result back on the + stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + x = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + result = U256(x == 0) + + push(evm.stack, result) + + # PROGRAM COUNTER + evm.pc += Uint(1) diff --git a/src/ethereum/osaka/vm/instructions/control_flow.py b/src/ethereum/osaka/vm/instructions/control_flow.py new file mode 100644 index 0000000000..7722661f79 --- /dev/null +++ b/src/ethereum/osaka/vm/instructions/control_flow.py @@ -0,0 +1,171 @@ +""" +Ethereum Virtual Machine (EVM) Control Flow Instructions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementations of the EVM control flow instructions. +""" + +from ethereum_types.numeric import U256, Uint + +from ...vm.gas import GAS_BASE, GAS_HIGH, GAS_JUMPDEST, GAS_MID, charge_gas +from .. import Evm +from ..exceptions import InvalidJumpDestError +from ..stack import pop, push + + +def stop(evm: Evm) -> None: + """ + Stop further execution of EVM code. + + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + pass + + # GAS + pass + + # OPERATION + evm.running = False + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def jump(evm: Evm) -> None: + """ + Alter the program counter to the location specified by the top of the + stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + jump_dest = Uint(pop(evm.stack)) + + # GAS + charge_gas(evm, GAS_MID) + + # OPERATION + if jump_dest not in evm.valid_jump_destinations: + raise InvalidJumpDestError + + # PROGRAM COUNTER + evm.pc = Uint(jump_dest) + + +def jumpi(evm: Evm) -> None: + """ + Alter the program counter to the specified location if and only if a + condition is true. If the condition is not true, then the program counter + would increase only by 1. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + jump_dest = Uint(pop(evm.stack)) + conditional_value = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_HIGH) + + # OPERATION + if conditional_value == 0: + destination = evm.pc + Uint(1) + elif jump_dest not in evm.valid_jump_destinations: + raise InvalidJumpDestError + else: + destination = jump_dest + + # PROGRAM COUNTER + evm.pc = destination + + +def pc(evm: Evm) -> None: + """ + Push onto the stack the value of the program counter after reaching the + current instruction and without increasing it for the next instruction. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, U256(evm.pc)) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def gas_left(evm: Evm) -> None: + """ + Push the amount of available gas (including the corresponding reduction + for the cost of this instruction) onto the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, U256(evm.gas_left)) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def jumpdest(evm: Evm) -> None: + """ + Mark a valid destination for jumps. This is a noop, present only + to be used by `JUMP` and `JUMPI` opcodes to verify that their jump is + valid. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_JUMPDEST) + + # OPERATION + pass + + # PROGRAM COUNTER + evm.pc += Uint(1) diff --git a/src/ethereum/osaka/vm/instructions/environment.py b/src/ethereum/osaka/vm/instructions/environment.py new file mode 100644 index 0000000000..0fe631b508 --- /dev/null +++ b/src/ethereum/osaka/vm/instructions/environment.py @@ -0,0 +1,604 @@ +""" +Ethereum Virtual Machine (EVM) Environmental Instructions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementations of the EVM environment related instructions. +""" + +from ethereum_types.bytes import Bytes32 +from ethereum_types.numeric import U256, Uint, ulen + +from ethereum.crypto.hash import keccak256 +from ethereum.utils.numeric import ceil32 + +from ...fork_types import EMPTY_ACCOUNT +from ...state import get_account +from ...utils.address import to_address_masked +from ...vm.memory import buffer_read, memory_write +from .. import Evm +from ..exceptions import OutOfBoundsRead +from ..gas import ( + GAS_BASE, + GAS_BLOBHASH_OPCODE, + GAS_COLD_ACCOUNT_ACCESS, + GAS_COPY, + GAS_FAST_STEP, + GAS_RETURN_DATA_COPY, + GAS_VERY_LOW, + GAS_WARM_ACCESS, + calculate_blob_gas_price, + calculate_gas_extend_memory, + charge_gas, + code_access_cost, +) +from ..stack import pop, push + + +def address(evm: Evm) -> None: + """ + Pushes the address of the current executing account to the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, U256.from_be_bytes(evm.message.current_target)) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def balance(evm: Evm) -> None: + """ + Pushes the balance of the given account onto the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + address = to_address_masked(pop(evm.stack)) + + # GAS + if address in evm.accessed_addresses: + charge_gas(evm, GAS_WARM_ACCESS) + else: + evm.accessed_addresses.add(address) + charge_gas(evm, GAS_COLD_ACCOUNT_ACCESS) + + # OPERATION + # Non-existent accounts default to EMPTY_ACCOUNT, which has balance 0. + balance = get_account(evm.message.block_env.state, address).balance + + push(evm.stack, balance) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def origin(evm: Evm) -> None: + """ + Pushes the address of the original transaction sender to the stack. + The origin address can only be an EOA. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, U256.from_be_bytes(evm.message.tx_env.origin)) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def caller(evm: Evm) -> None: + """ + Pushes the address of the caller onto the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, U256.from_be_bytes(evm.message.caller)) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def callvalue(evm: Evm) -> None: + """ + Push the value (in wei) sent with the call onto the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, evm.message.value) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def calldataload(evm: Evm) -> None: + """ + Push a word (32 bytes) of the input data belonging to the current + environment onto the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + start_index = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + value = buffer_read(evm.message.data, start_index, U256(32)) + + push(evm.stack, U256.from_be_bytes(value)) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def calldatasize(evm: Evm) -> None: + """ + Push the size of input data in current environment onto the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, U256(len(evm.message.data))) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def calldatacopy(evm: Evm) -> None: + """ + Copy a portion of the input data in current environment to memory. + + This will also expand the memory, in case that the memory is insufficient + to store the data. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + memory_start_index = pop(evm.stack) + data_start_index = pop(evm.stack) + size = pop(evm.stack) + + # GAS + words = ceil32(Uint(size)) // Uint(32) + copy_gas_cost = GAS_COPY * words + extend_memory = calculate_gas_extend_memory( + evm.memory, [(memory_start_index, size)] + ) + charge_gas(evm, GAS_VERY_LOW + copy_gas_cost + extend_memory.cost) + + # OPERATION + evm.memory += b"\x00" * extend_memory.expand_by + value = buffer_read(evm.message.data, data_start_index, size) + memory_write(evm.memory, memory_start_index, value) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def codesize(evm: Evm) -> None: + """ + Push the size of code running in current environment onto the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, U256(len(evm.code))) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def codecopy(evm: Evm) -> None: + """ + Copy a portion of the code in current environment to memory. + + This will also expand the memory, in case that the memory is insufficient + to store the data. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + memory_start_index = pop(evm.stack) + code_start_index = pop(evm.stack) + size = pop(evm.stack) + + # GAS + words = ceil32(Uint(size)) // Uint(32) + copy_gas_cost = GAS_COPY * words + extend_memory = calculate_gas_extend_memory( + evm.memory, [(memory_start_index, size)] + ) + charge_gas(evm, GAS_VERY_LOW + copy_gas_cost + extend_memory.cost) + + # OPERATION + evm.memory += b"\x00" * extend_memory.expand_by + value = buffer_read(evm.code, code_start_index, size) + memory_write(evm.memory, memory_start_index, value) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def gasprice(evm: Evm) -> None: + """ + Push the gas price used in current environment onto the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, U256(evm.message.tx_env.gas_price)) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def extcodesize(evm: Evm) -> None: + """ + Push the code size of a given account onto the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + address = to_address_masked(pop(evm.stack)) + + # GAS + if address in evm.accessed_addresses: + access_gas_cost = GAS_WARM_ACCESS + else: + evm.accessed_addresses.add(address) + access_gas_cost = GAS_COLD_ACCOUNT_ACCESS + + charge_gas(evm, access_gas_cost) + + # OPERATION + code = get_account(evm.message.block_env.state, address).code + + codesize = U256(len(code)) + push(evm.stack, codesize) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def extcodecopy(evm: Evm) -> None: + """ + Copy a portion of an account's code to memory. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + address = to_address_masked(pop(evm.stack)) + memory_start_index = pop(evm.stack) + code_start_index = pop(evm.stack) + size = pop(evm.stack) + + # GAS + words = ceil32(Uint(size)) // Uint(32) + copy_gas_cost = GAS_COPY * words + extend_memory = calculate_gas_extend_memory( + evm.memory, [(memory_start_index, size)] + ) + + if address in evm.accessed_addresses: + access_gas_cost = GAS_WARM_ACCESS + else: + evm.accessed_addresses.add(address) + access_gas_cost = GAS_COLD_ACCOUNT_ACCESS + + if address not in evm.warm_code_addresses: + evm.warm_code_addresses.add(address) + access_gas_cost += code_access_cost( + get_account(evm.message.block_env.state, address).code + ) + + charge_gas(evm, access_gas_cost + copy_gas_cost + extend_memory.cost) + + # OPERATION + evm.memory += b"\x00" * extend_memory.expand_by + code = get_account(evm.message.block_env.state, address).code + + value = buffer_read(code, code_start_index, size) + memory_write(evm.memory, memory_start_index, value) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def returndatasize(evm: Evm) -> None: + """ + Pushes the size of the return data buffer onto the stack. + + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, U256(len(evm.return_data))) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def returndatacopy(evm: Evm) -> None: + """ + Copies data from the return data buffer code to memory + + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + memory_start_index = pop(evm.stack) + return_data_start_position = pop(evm.stack) + size = pop(evm.stack) + + # GAS + words = ceil32(Uint(size)) // Uint(32) + copy_gas_cost = GAS_RETURN_DATA_COPY * words + extend_memory = calculate_gas_extend_memory( + evm.memory, [(memory_start_index, size)] + ) + charge_gas(evm, GAS_VERY_LOW + copy_gas_cost + extend_memory.cost) + if Uint(return_data_start_position) + Uint(size) > ulen(evm.return_data): + raise OutOfBoundsRead + + evm.memory += b"\x00" * extend_memory.expand_by + value = evm.return_data[ + return_data_start_position : return_data_start_position + size + ] + memory_write(evm.memory, memory_start_index, value) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def extcodehash(evm: Evm) -> None: + """ + Returns the keccak256 hash of a contract’s bytecode + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + address = to_address_masked(pop(evm.stack)) + + # GAS + if address in evm.accessed_addresses: + access_gas_cost = GAS_WARM_ACCESS + else: + evm.accessed_addresses.add(address) + access_gas_cost = GAS_COLD_ACCOUNT_ACCESS + + charge_gas(evm, access_gas_cost) + + # OPERATION + account = get_account(evm.message.block_env.state, address) + + if account == EMPTY_ACCOUNT: + codehash = U256(0) + else: + code = account.code + codehash = U256.from_be_bytes(keccak256(code)) + + push(evm.stack, codehash) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def self_balance(evm: Evm) -> None: + """ + Pushes the balance of the current address to the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_FAST_STEP) + + # OPERATION + # Non-existent accounts default to EMPTY_ACCOUNT, which has balance 0. + balance = get_account( + evm.message.block_env.state, evm.message.current_target + ).balance + + push(evm.stack, balance) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def base_fee(evm: Evm) -> None: + """ + Pushes the base fee of the current block on to the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, U256(evm.message.block_env.base_fee_per_gas)) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def blob_hash(evm: Evm) -> None: + """ + Pushes the versioned hash at a particular index on to the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + index = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_BLOBHASH_OPCODE) + + # OPERATION + if int(index) < len(evm.message.tx_env.blob_versioned_hashes): + blob_hash = evm.message.tx_env.blob_versioned_hashes[index] + else: + blob_hash = Bytes32(b"\x00" * 32) + push(evm.stack, U256.from_be_bytes(blob_hash)) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def blob_base_fee(evm: Evm) -> None: + """ + Pushes the blob base fee on to the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + blob_base_fee = calculate_blob_gas_price( + evm.message.block_env.excess_blob_gas + ) + push(evm.stack, U256(blob_base_fee)) + + # PROGRAM COUNTER + evm.pc += Uint(1) diff --git a/src/ethereum/osaka/vm/instructions/keccak.py b/src/ethereum/osaka/vm/instructions/keccak.py new file mode 100644 index 0000000000..830d368277 --- /dev/null +++ b/src/ethereum/osaka/vm/instructions/keccak.py @@ -0,0 +1,64 @@ +""" +Ethereum Virtual Machine (EVM) Keccak Instructions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementations of the EVM keccak instructions. +""" + +from ethereum_types.numeric import U256, Uint + +from ethereum.crypto.hash import keccak256 +from ethereum.utils.numeric import ceil32 + +from .. import Evm +from ..gas import ( + GAS_KECCAK256, + GAS_KECCAK256_WORD, + calculate_gas_extend_memory, + charge_gas, +) +from ..memory import memory_read_bytes +from ..stack import pop, push + + +def keccak(evm: Evm) -> None: + """ + Pushes to the stack the Keccak-256 hash of a region of memory. + + This also expands the memory, in case the memory is insufficient to + access the data's memory location. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + memory_start_index = pop(evm.stack) + size = pop(evm.stack) + + # GAS + words = ceil32(Uint(size)) // Uint(32) + word_gas_cost = GAS_KECCAK256_WORD * words + extend_memory = calculate_gas_extend_memory( + evm.memory, [(memory_start_index, size)] + ) + charge_gas(evm, GAS_KECCAK256 + word_gas_cost + extend_memory.cost) + + # OPERATION + evm.memory += b"\x00" * extend_memory.expand_by + data = memory_read_bytes(evm.memory, memory_start_index, size) + hash = keccak256(data) + + push(evm.stack, U256.from_be_bytes(hash)) + + # PROGRAM COUNTER + evm.pc += Uint(1) diff --git a/src/ethereum/osaka/vm/instructions/log.py b/src/ethereum/osaka/vm/instructions/log.py new file mode 100644 index 0000000000..87c06ed6be --- /dev/null +++ b/src/ethereum/osaka/vm/instructions/log.py @@ -0,0 +1,88 @@ +""" +Ethereum Virtual Machine (EVM) Logging Instructions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementations of the EVM logging instructions. +""" +from functools import partial + +from ethereum_types.numeric import Uint + +from ...blocks import Log +from .. import Evm +from ..exceptions import WriteInStaticContext +from ..gas import ( + GAS_LOG, + GAS_LOG_DATA, + GAS_LOG_TOPIC, + calculate_gas_extend_memory, + charge_gas, +) +from ..memory import memory_read_bytes +from ..stack import pop + + +def log_n(evm: Evm, num_topics: int) -> None: + """ + Appends a log entry, having `num_topics` topics, to the evm logs. + + This will also expand the memory if the data (required by the log entry) + corresponding to the memory is not accessible. + + Parameters + ---------- + evm : + The current EVM frame. + num_topics : + The number of topics to be included in the log entry. + + """ + # STACK + memory_start_index = pop(evm.stack) + size = pop(evm.stack) + + topics = [] + for _ in range(num_topics): + topic = pop(evm.stack).to_be_bytes32() + topics.append(topic) + + # GAS + extend_memory = calculate_gas_extend_memory( + evm.memory, [(memory_start_index, size)] + ) + charge_gas( + evm, + GAS_LOG + + GAS_LOG_DATA * Uint(size) + + GAS_LOG_TOPIC * Uint(num_topics) + + extend_memory.cost, + ) + + # OPERATION + evm.memory += b"\x00" * extend_memory.expand_by + if evm.message.is_static: + raise WriteInStaticContext + log_entry = Log( + address=evm.message.current_target, + topics=tuple(topics), + data=memory_read_bytes(evm.memory, memory_start_index, size), + ) + + evm.logs = evm.logs + (log_entry,) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +log0 = partial(log_n, num_topics=0) +log1 = partial(log_n, num_topics=1) +log2 = partial(log_n, num_topics=2) +log3 = partial(log_n, num_topics=3) +log4 = partial(log_n, num_topics=4) diff --git a/src/ethereum/osaka/vm/instructions/memory.py b/src/ethereum/osaka/vm/instructions/memory.py new file mode 100644 index 0000000000..89533af37e --- /dev/null +++ b/src/ethereum/osaka/vm/instructions/memory.py @@ -0,0 +1,177 @@ +""" +Ethereum Virtual Machine (EVM) Memory Instructions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementations of the EVM Memory instructions. +""" +from ethereum_types.bytes import Bytes +from ethereum_types.numeric import U256, Uint + +from ethereum.utils.numeric import ceil32 + +from .. import Evm +from ..gas import ( + GAS_BASE, + GAS_COPY, + GAS_VERY_LOW, + calculate_gas_extend_memory, + charge_gas, +) +from ..memory import memory_read_bytes, memory_write +from ..stack import pop, push + + +def mstore(evm: Evm) -> None: + """ + Stores a word to memory. + This also expands the memory, if the memory is + insufficient to store the word. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + start_position = pop(evm.stack) + value = pop(evm.stack).to_be_bytes32() + + # GAS + extend_memory = calculate_gas_extend_memory( + evm.memory, [(start_position, U256(len(value)))] + ) + + charge_gas(evm, GAS_VERY_LOW + extend_memory.cost) + + # OPERATION + evm.memory += b"\x00" * extend_memory.expand_by + memory_write(evm.memory, start_position, value) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def mstore8(evm: Evm) -> None: + """ + Stores a byte to memory. + This also expands the memory, if the memory is + insufficient to store the word. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + start_position = pop(evm.stack) + value = pop(evm.stack) + + # GAS + extend_memory = calculate_gas_extend_memory( + evm.memory, [(start_position, U256(1))] + ) + + charge_gas(evm, GAS_VERY_LOW + extend_memory.cost) + + # OPERATION + evm.memory += b"\x00" * extend_memory.expand_by + normalized_bytes_value = Bytes([value & U256(0xFF)]) + memory_write(evm.memory, start_position, normalized_bytes_value) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def mload(evm: Evm) -> None: + """ + Load word from memory. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + start_position = pop(evm.stack) + + # GAS + extend_memory = calculate_gas_extend_memory( + evm.memory, [(start_position, U256(32))] + ) + charge_gas(evm, GAS_VERY_LOW + extend_memory.cost) + + # OPERATION + evm.memory += b"\x00" * extend_memory.expand_by + value = U256.from_be_bytes( + memory_read_bytes(evm.memory, start_position, U256(32)) + ) + push(evm.stack, value) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def msize(evm: Evm) -> None: + """ + Push the size of active memory in bytes onto the stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + push(evm.stack, U256(len(evm.memory))) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def mcopy(evm: Evm) -> None: + """ + Copy the bytes in memory from one location to another. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + destination = pop(evm.stack) + source = pop(evm.stack) + length = pop(evm.stack) + + # GAS + words = ceil32(Uint(length)) // Uint(32) + copy_gas_cost = GAS_COPY * words + + extend_memory = calculate_gas_extend_memory( + evm.memory, [(source, length), (destination, length)] + ) + charge_gas(evm, GAS_VERY_LOW + copy_gas_cost + extend_memory.cost) + + # OPERATION + evm.memory += b"\x00" * extend_memory.expand_by + value = memory_read_bytes(evm.memory, source, length) + memory_write(evm.memory, destination, value) + + # PROGRAM COUNTER + evm.pc += Uint(1) diff --git a/src/ethereum/osaka/vm/instructions/stack.py b/src/ethereum/osaka/vm/instructions/stack.py new file mode 100644 index 0000000000..2e8a492412 --- /dev/null +++ b/src/ethereum/osaka/vm/instructions/stack.py @@ -0,0 +1,209 @@ +""" +Ethereum Virtual Machine (EVM) Stack Instructions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementations of the EVM stack related instructions. +""" + +from functools import partial + +from ethereum_types.numeric import U256, Uint + +from .. import Evm, stack +from ..exceptions import StackUnderflowError +from ..gas import GAS_BASE, GAS_VERY_LOW, charge_gas +from ..memory import buffer_read + + +def pop(evm: Evm) -> None: + """ + Remove item from stack. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + stack.pop(evm.stack) + + # GAS + charge_gas(evm, GAS_BASE) + + # OPERATION + pass + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def push_n(evm: Evm, num_bytes: int) -> None: + """ + Pushes a N-byte immediate onto the stack. Push zero if num_bytes is zero. + + Parameters + ---------- + evm : + The current EVM frame. + + num_bytes : + The number of immediate bytes to be read from the code and pushed to + the stack. Push zero if num_bytes is zero. + + """ + # STACK + pass + + # GAS + if num_bytes == 0: + charge_gas(evm, GAS_BASE) + else: + charge_gas(evm, GAS_VERY_LOW) + + # OPERATION + data_to_push = U256.from_be_bytes( + buffer_read(evm.code, U256(evm.pc + Uint(1)), U256(num_bytes)) + ) + stack.push(evm.stack, data_to_push) + + # PROGRAM COUNTER + evm.pc += Uint(1) + Uint(num_bytes) + + +def dup_n(evm: Evm, item_number: int) -> None: + """ + Duplicate the Nth stack item (from top of the stack) to the top of stack. + + Parameters + ---------- + evm : + The current EVM frame. + + item_number : + The stack item number (0-indexed from top of stack) to be duplicated + to the top of stack. + + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_VERY_LOW) + if item_number >= len(evm.stack): + raise StackUnderflowError + data_to_duplicate = evm.stack[len(evm.stack) - 1 - item_number] + stack.push(evm.stack, data_to_duplicate) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def swap_n(evm: Evm, item_number: int) -> None: + """ + Swap the top and the `item_number` element of the stack, where + the top of the stack is position zero. + + If `item_number` is zero, this function does nothing (which should not be + possible, since there is no `SWAP0` instruction). + + Parameters + ---------- + evm : + The current EVM frame. + + item_number : + The stack item number (0-indexed from top of stack) to be swapped + with the top of stack element. + + """ + # STACK + pass + + # GAS + charge_gas(evm, GAS_VERY_LOW) + if item_number >= len(evm.stack): + raise StackUnderflowError + evm.stack[-1], evm.stack[-1 - item_number] = ( + evm.stack[-1 - item_number], + evm.stack[-1], + ) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +push0 = partial(push_n, num_bytes=0) +push1 = partial(push_n, num_bytes=1) +push2 = partial(push_n, num_bytes=2) +push3 = partial(push_n, num_bytes=3) +push4 = partial(push_n, num_bytes=4) +push5 = partial(push_n, num_bytes=5) +push6 = partial(push_n, num_bytes=6) +push7 = partial(push_n, num_bytes=7) +push8 = partial(push_n, num_bytes=8) +push9 = partial(push_n, num_bytes=9) +push10 = partial(push_n, num_bytes=10) +push11 = partial(push_n, num_bytes=11) +push12 = partial(push_n, num_bytes=12) +push13 = partial(push_n, num_bytes=13) +push14 = partial(push_n, num_bytes=14) +push15 = partial(push_n, num_bytes=15) +push16 = partial(push_n, num_bytes=16) +push17 = partial(push_n, num_bytes=17) +push18 = partial(push_n, num_bytes=18) +push19 = partial(push_n, num_bytes=19) +push20 = partial(push_n, num_bytes=20) +push21 = partial(push_n, num_bytes=21) +push22 = partial(push_n, num_bytes=22) +push23 = partial(push_n, num_bytes=23) +push24 = partial(push_n, num_bytes=24) +push25 = partial(push_n, num_bytes=25) +push26 = partial(push_n, num_bytes=26) +push27 = partial(push_n, num_bytes=27) +push28 = partial(push_n, num_bytes=28) +push29 = partial(push_n, num_bytes=29) +push30 = partial(push_n, num_bytes=30) +push31 = partial(push_n, num_bytes=31) +push32 = partial(push_n, num_bytes=32) + +dup1 = partial(dup_n, item_number=0) +dup2 = partial(dup_n, item_number=1) +dup3 = partial(dup_n, item_number=2) +dup4 = partial(dup_n, item_number=3) +dup5 = partial(dup_n, item_number=4) +dup6 = partial(dup_n, item_number=5) +dup7 = partial(dup_n, item_number=6) +dup8 = partial(dup_n, item_number=7) +dup9 = partial(dup_n, item_number=8) +dup10 = partial(dup_n, item_number=9) +dup11 = partial(dup_n, item_number=10) +dup12 = partial(dup_n, item_number=11) +dup13 = partial(dup_n, item_number=12) +dup14 = partial(dup_n, item_number=13) +dup15 = partial(dup_n, item_number=14) +dup16 = partial(dup_n, item_number=15) + +swap1 = partial(swap_n, item_number=1) +swap2 = partial(swap_n, item_number=2) +swap3 = partial(swap_n, item_number=3) +swap4 = partial(swap_n, item_number=4) +swap5 = partial(swap_n, item_number=5) +swap6 = partial(swap_n, item_number=6) +swap7 = partial(swap_n, item_number=7) +swap8 = partial(swap_n, item_number=8) +swap9 = partial(swap_n, item_number=9) +swap10 = partial(swap_n, item_number=10) +swap11 = partial(swap_n, item_number=11) +swap12 = partial(swap_n, item_number=12) +swap13 = partial(swap_n, item_number=13) +swap14 = partial(swap_n, item_number=14) +swap15 = partial(swap_n, item_number=15) +swap16 = partial(swap_n, item_number=16) diff --git a/src/ethereum/osaka/vm/instructions/storage.py b/src/ethereum/osaka/vm/instructions/storage.py new file mode 100644 index 0000000000..65a0d5a9b6 --- /dev/null +++ b/src/ethereum/osaka/vm/instructions/storage.py @@ -0,0 +1,184 @@ +""" +Ethereum Virtual Machine (EVM) Storage Instructions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementations of the EVM storage related instructions. +""" +from ethereum_types.numeric import Uint + +from ...state import ( + get_storage, + get_storage_original, + get_transient_storage, + set_storage, + set_transient_storage, +) +from .. import Evm +from ..exceptions import OutOfGasError, WriteInStaticContext +from ..gas import ( + GAS_CALL_STIPEND, + GAS_COLD_SLOAD, + GAS_STORAGE_CLEAR_REFUND, + GAS_STORAGE_SET, + GAS_STORAGE_UPDATE, + GAS_WARM_ACCESS, + charge_gas, +) +from ..stack import pop, push + + +def sload(evm: Evm) -> None: + """ + Loads to the stack, the value corresponding to a certain key from the + storage of the current account. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + key = pop(evm.stack).to_be_bytes32() + + # GAS + if (evm.message.current_target, key) in evm.accessed_storage_keys: + charge_gas(evm, GAS_WARM_ACCESS) + else: + evm.accessed_storage_keys.add((evm.message.current_target, key)) + charge_gas(evm, GAS_COLD_SLOAD) + + # OPERATION + value = get_storage( + evm.message.block_env.state, evm.message.current_target, key + ) + + push(evm.stack, value) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def sstore(evm: Evm) -> None: + """ + Stores a value at a certain key in the current context's storage. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + # STACK + key = pop(evm.stack).to_be_bytes32() + new_value = pop(evm.stack) + if evm.gas_left <= GAS_CALL_STIPEND: + raise OutOfGasError + + state = evm.message.block_env.state + original_value = get_storage_original( + state, evm.message.current_target, key + ) + current_value = get_storage(state, evm.message.current_target, key) + + gas_cost = Uint(0) + + if (evm.message.current_target, key) not in evm.accessed_storage_keys: + evm.accessed_storage_keys.add((evm.message.current_target, key)) + gas_cost += GAS_COLD_SLOAD + + if original_value == current_value and current_value != new_value: + if original_value == 0: + gas_cost += GAS_STORAGE_SET + else: + gas_cost += GAS_STORAGE_UPDATE - GAS_COLD_SLOAD + else: + gas_cost += GAS_WARM_ACCESS + + # Refund Counter Calculation + if current_value != new_value: + if original_value != 0 and current_value != 0 and new_value == 0: + # Storage is cleared for the first time in the transaction + evm.refund_counter += int(GAS_STORAGE_CLEAR_REFUND) + + if original_value != 0 and current_value == 0: + # Gas refund issued earlier to be reversed + evm.refund_counter -= int(GAS_STORAGE_CLEAR_REFUND) + + if original_value == new_value: + # Storage slot being restored to its original value + if original_value == 0: + # Slot was originally empty and was SET earlier + evm.refund_counter += int(GAS_STORAGE_SET - GAS_WARM_ACCESS) + else: + # Slot was originally non-empty and was UPDATED earlier + evm.refund_counter += int( + GAS_STORAGE_UPDATE - GAS_COLD_SLOAD - GAS_WARM_ACCESS + ) + + charge_gas(evm, gas_cost) + if evm.message.is_static: + raise WriteInStaticContext + set_storage(state, evm.message.current_target, key, new_value) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def tload(evm: Evm) -> None: + """ + Loads to the stack, the value corresponding to a certain key from the + transient storage of the current account. + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + key = pop(evm.stack).to_be_bytes32() + + # GAS + charge_gas(evm, GAS_WARM_ACCESS) + + # OPERATION + value = get_transient_storage( + evm.message.tx_env.transient_storage, evm.message.current_target, key + ) + push(evm.stack, value) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def tstore(evm: Evm) -> None: + """ + Stores a value at a certain key in the current context's transient storage. + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + key = pop(evm.stack).to_be_bytes32() + new_value = pop(evm.stack) + + # GAS + charge_gas(evm, GAS_WARM_ACCESS) + if evm.message.is_static: + raise WriteInStaticContext + set_transient_storage( + evm.message.tx_env.transient_storage, + evm.message.current_target, + key, + new_value, + ) + + # PROGRAM COUNTER + evm.pc += Uint(1) diff --git a/src/ethereum/osaka/vm/instructions/system.py b/src/ethereum/osaka/vm/instructions/system.py new file mode 100644 index 0000000000..b9b02b00ab --- /dev/null +++ b/src/ethereum/osaka/vm/instructions/system.py @@ -0,0 +1,769 @@ +""" +Ethereum Virtual Machine (EVM) System Instructions +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementations of the EVM system related instructions. +""" + +from ethereum_types.bytes import Bytes, Bytes0 +from ethereum_types.numeric import U256, Uint + +from ethereum.utils.numeric import ceil32 + +from ...fork_types import Address +from ...state import ( + account_has_code_or_nonce, + account_has_storage, + get_account, + increment_nonce, + is_account_alive, + move_ether, + set_account_balance, +) +from ...utils.address import ( + compute_contract_address, + compute_create2_contract_address, + to_address_masked, +) +from ...vm.eoa_delegation import access_delegation +from .. import ( + Evm, + Message, + incorporate_child_on_error, + incorporate_child_on_success, +) +from ..exceptions import OutOfGasError, Revert, WriteInStaticContext +from ..gas import ( + GAS_CALL_VALUE, + GAS_COLD_ACCOUNT_ACCESS, + GAS_CREATE, + GAS_KECCAK256_WORD, + GAS_NEW_ACCOUNT, + GAS_SELF_DESTRUCT, + GAS_SELF_DESTRUCT_NEW_ACCOUNT, + GAS_WARM_ACCESS, + GAS_ZERO, + calculate_gas_extend_memory, + calculate_message_call_gas, + charge_gas, + code_access_cost, + init_code_cost, + max_message_call_gas, +) +from ..memory import memory_read_bytes, memory_write +from ..stack import pop, push + + +def generic_create( + evm: Evm, + endowment: U256, + contract_address: Address, + memory_start_position: U256, + memory_size: U256, +) -> None: + """ + Core logic used by the `CREATE*` family of opcodes. + """ + # This import causes a circular import error + # if it's not moved inside this method + from ...vm.interpreter import ( + MAX_INIT_CODE_SIZE, + STACK_DEPTH_LIMIT, + process_create_message, + ) + + call_data = memory_read_bytes( + evm.memory, memory_start_position, memory_size + ) + if len(call_data) > MAX_INIT_CODE_SIZE: + raise OutOfGasError + + create_message_gas = max_message_call_gas(Uint(evm.gas_left)) + evm.gas_left -= create_message_gas + if evm.message.is_static: + raise WriteInStaticContext + evm.return_data = b"" + + sender_address = evm.message.current_target + sender = get_account(evm.message.block_env.state, sender_address) + + if ( + sender.balance < endowment + or sender.nonce == Uint(2**64 - 1) + or evm.message.depth + Uint(1) > STACK_DEPTH_LIMIT + ): + evm.gas_left += create_message_gas + push(evm.stack, U256(0)) + return + + evm.accessed_addresses.add(contract_address) + + if account_has_code_or_nonce( + evm.message.block_env.state, contract_address + ) or account_has_storage(evm.message.block_env.state, contract_address): + increment_nonce( + evm.message.block_env.state, evm.message.current_target + ) + push(evm.stack, U256(0)) + return + + increment_nonce(evm.message.block_env.state, evm.message.current_target) + + child_message = Message( + block_env=evm.message.block_env, + tx_env=evm.message.tx_env, + caller=evm.message.current_target, + target=Bytes0(), + gas=create_message_gas, + value=endowment, + data=b"", + code=call_data, + current_target=contract_address, + depth=evm.message.depth + Uint(1), + code_address=None, + should_transfer_value=True, + is_static=False, + accessed_addresses=evm.accessed_addresses.copy(), + accessed_storage_keys=evm.accessed_storage_keys.copy(), + disable_precompiles=False, + warm_code_addresses=evm.warm_code_addresses.copy(), + parent_evm=evm, + ) + child_evm = process_create_message(child_message) + + if child_evm.error: + incorporate_child_on_error(evm, child_evm) + evm.return_data = child_evm.output + push(evm.stack, U256(0)) + else: + incorporate_child_on_success(evm, child_evm) + evm.return_data = b"" + push(evm.stack, U256.from_be_bytes(child_evm.message.current_target)) + + +def create(evm: Evm) -> None: + """ + Creates a new account with associated code. + + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + endowment = pop(evm.stack) + memory_start_position = pop(evm.stack) + memory_size = pop(evm.stack) + + # GAS + extend_memory = calculate_gas_extend_memory( + evm.memory, [(memory_start_position, memory_size)] + ) + init_code_gas = init_code_cost(Uint(memory_size)) + + charge_gas(evm, GAS_CREATE + extend_memory.cost + init_code_gas) + + # OPERATION + evm.memory += b"\x00" * extend_memory.expand_by + contract_address = compute_contract_address( + evm.message.current_target, + get_account( + evm.message.block_env.state, evm.message.current_target + ).nonce, + ) + + generic_create( + evm, + endowment, + contract_address, + memory_start_position, + memory_size, + ) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def create2(evm: Evm) -> None: + """ + Creates a new account with associated code. + + It's similar to CREATE opcode except that the address of new account + depends on the init_code instead of the nonce of sender. + + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + endowment = pop(evm.stack) + memory_start_position = pop(evm.stack) + memory_size = pop(evm.stack) + salt = pop(evm.stack).to_be_bytes32() + + # GAS + extend_memory = calculate_gas_extend_memory( + evm.memory, [(memory_start_position, memory_size)] + ) + call_data_words = ceil32(Uint(memory_size)) // Uint(32) + init_code_gas = init_code_cost(Uint(memory_size)) + charge_gas( + evm, + GAS_CREATE + + GAS_KECCAK256_WORD * call_data_words + + extend_memory.cost + + init_code_gas, + ) + + # OPERATION + evm.memory += b"\x00" * extend_memory.expand_by + contract_address = compute_create2_contract_address( + evm.message.current_target, + salt, + memory_read_bytes(evm.memory, memory_start_position, memory_size), + ) + + generic_create( + evm, + endowment, + contract_address, + memory_start_position, + memory_size, + ) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def return_(evm: Evm) -> None: + """ + Halts execution returning output data. + + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + memory_start_position = pop(evm.stack) + memory_size = pop(evm.stack) + + # GAS + extend_memory = calculate_gas_extend_memory( + evm.memory, [(memory_start_position, memory_size)] + ) + + charge_gas(evm, GAS_ZERO + extend_memory.cost) + + # OPERATION + evm.memory += b"\x00" * extend_memory.expand_by + evm.output = memory_read_bytes( + evm.memory, memory_start_position, memory_size + ) + + evm.running = False + + # PROGRAM COUNTER + pass + + +def generic_call( + evm: Evm, + gas: Uint, + value: U256, + caller: Address, + to: Address, + code_address: Address, + should_transfer_value: bool, + is_staticcall: bool, + memory_input_start_position: U256, + memory_input_size: U256, + memory_output_start_position: U256, + memory_output_size: U256, + code: Bytes, + disable_precompiles: bool, +) -> None: + """ + Perform the core logic of the `CALL*` family of opcodes. + """ + from ...vm.interpreter import STACK_DEPTH_LIMIT, process_message + + evm.return_data = b"" + + if evm.message.depth + Uint(1) > STACK_DEPTH_LIMIT: + evm.gas_left += gas + push(evm.stack, U256(0)) + return + + call_data = memory_read_bytes( + evm.memory, memory_input_start_position, memory_input_size + ) + + child_message = Message( + block_env=evm.message.block_env, + tx_env=evm.message.tx_env, + caller=caller, + target=to, + gas=gas, + value=value, + data=call_data, + code=code, + current_target=to, + depth=evm.message.depth + Uint(1), + code_address=code_address, + should_transfer_value=should_transfer_value, + is_static=True if is_staticcall else evm.message.is_static, + accessed_addresses=evm.accessed_addresses.copy(), + accessed_storage_keys=evm.accessed_storage_keys.copy(), + disable_precompiles=disable_precompiles, + warm_code_addresses=evm.warm_code_addresses.copy(), + parent_evm=evm, + ) + child_evm = process_message(child_message) + + if child_evm.error: + incorporate_child_on_error(evm, child_evm) + evm.return_data = child_evm.output + push(evm.stack, U256(0)) + else: + incorporate_child_on_success(evm, child_evm) + evm.return_data = child_evm.output + push(evm.stack, U256(1)) + + actual_output_size = min(memory_output_size, U256(len(child_evm.output))) + memory_write( + evm.memory, + memory_output_start_position, + child_evm.output[:actual_output_size], + ) + + +def call(evm: Evm) -> None: + """ + Message-call into an account. + + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + gas = Uint(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) + value = pop(evm.stack) + memory_input_start_position = pop(evm.stack) + memory_input_size = pop(evm.stack) + memory_output_start_position = pop(evm.stack) + memory_output_size = pop(evm.stack) + + # GAS + extend_memory = calculate_gas_extend_memory( + evm.memory, + [ + (memory_input_start_position, memory_input_size), + (memory_output_start_position, memory_output_size), + ], + ) + + if to in evm.accessed_addresses: + access_gas_cost = GAS_WARM_ACCESS + else: + evm.accessed_addresses.add(to) + access_gas_cost = GAS_COLD_ACCOUNT_ACCESS + + if to not in evm.warm_code_addresses: + evm.warm_code_addresses.add(to) + access_gas_cost += code_access_cost( + get_account(evm.message.block_env.state, to).code + ) + + code_address = to + ( + disable_precompiles, + code_address, + code, + delegated_access_gas_cost, + ) = access_delegation(evm, code_address) + access_gas_cost += delegated_access_gas_cost + + create_gas_cost = GAS_NEW_ACCOUNT + if value == 0 or is_account_alive(evm.message.block_env.state, to): + create_gas_cost = Uint(0) + transfer_gas_cost = Uint(0) if value == 0 else GAS_CALL_VALUE + message_call_gas = calculate_message_call_gas( + value, + gas, + Uint(evm.gas_left), + extend_memory.cost, + access_gas_cost + create_gas_cost + transfer_gas_cost, + ) + charge_gas(evm, message_call_gas.cost + extend_memory.cost) + if evm.message.is_static and value != U256(0): + raise WriteInStaticContext + evm.memory += b"\x00" * extend_memory.expand_by + sender_balance = get_account( + evm.message.block_env.state, evm.message.current_target + ).balance + if sender_balance < value: + push(evm.stack, U256(0)) + evm.return_data = b"" + evm.gas_left += message_call_gas.sub_call + else: + generic_call( + evm, + message_call_gas.sub_call, + value, + evm.message.current_target, + to, + code_address, + True, + False, + memory_input_start_position, + memory_input_size, + memory_output_start_position, + memory_output_size, + code, + disable_precompiles, + ) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def callcode(evm: Evm) -> None: + """ + Message-call into this account with alternative account’s code. + + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + gas = Uint(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) + value = pop(evm.stack) + memory_input_start_position = pop(evm.stack) + memory_input_size = pop(evm.stack) + memory_output_start_position = pop(evm.stack) + memory_output_size = pop(evm.stack) + + # GAS + to = evm.message.current_target + + extend_memory = calculate_gas_extend_memory( + evm.memory, + [ + (memory_input_start_position, memory_input_size), + (memory_output_start_position, memory_output_size), + ], + ) + + if code_address in evm.accessed_addresses: + access_gas_cost = GAS_WARM_ACCESS + else: + evm.accessed_addresses.add(code_address) + access_gas_cost = GAS_COLD_ACCOUNT_ACCESS + + if code_address not in evm.warm_code_addresses: + evm.warm_code_addresses.add(code_address) + access_gas_cost += code_access_cost( + get_account(evm.message.block_env.state, code_address).code + ) + + ( + disable_precompiles, + code_address, + code, + delegated_access_gas_cost, + ) = access_delegation(evm, code_address) + access_gas_cost += delegated_access_gas_cost + + transfer_gas_cost = Uint(0) if value == 0 else GAS_CALL_VALUE + message_call_gas = calculate_message_call_gas( + value, + gas, + Uint(evm.gas_left), + extend_memory.cost, + access_gas_cost + transfer_gas_cost, + ) + charge_gas(evm, message_call_gas.cost + extend_memory.cost) + + # OPERATION + evm.memory += b"\x00" * extend_memory.expand_by + sender_balance = get_account( + evm.message.block_env.state, evm.message.current_target + ).balance + if sender_balance < value: + push(evm.stack, U256(0)) + evm.return_data = b"" + evm.gas_left += message_call_gas.sub_call + else: + generic_call( + evm, + message_call_gas.sub_call, + value, + evm.message.current_target, + to, + code_address, + True, + False, + memory_input_start_position, + memory_input_size, + memory_output_start_position, + memory_output_size, + code, + disable_precompiles, + ) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def selfdestruct(evm: Evm) -> None: + """ + Halt execution and register account for later deletion. + + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + beneficiary = to_address_masked(pop(evm.stack)) + + # GAS + gas_cost = GAS_SELF_DESTRUCT + if beneficiary not in evm.accessed_addresses: + evm.accessed_addresses.add(beneficiary) + gas_cost += GAS_COLD_ACCOUNT_ACCESS + + if ( + not is_account_alive(evm.message.block_env.state, beneficiary) + and get_account( + evm.message.block_env.state, evm.message.current_target + ).balance + != 0 + ): + gas_cost += GAS_SELF_DESTRUCT_NEW_ACCOUNT + + charge_gas(evm, gas_cost) + if evm.message.is_static: + raise WriteInStaticContext + + originator = evm.message.current_target + originator_balance = get_account( + evm.message.block_env.state, originator + ).balance + + move_ether( + evm.message.block_env.state, + originator, + beneficiary, + originator_balance, + ) + + # register account for deletion only if it was created + # in the same transaction + if originator in evm.message.block_env.state.created_accounts: + # If beneficiary is the same as originator, then + # the ether is burnt. + set_account_balance(evm.message.block_env.state, originator, U256(0)) + evm.accounts_to_delete.add(originator) + + # HALT the execution + evm.running = False + + # PROGRAM COUNTER + pass + + +def delegatecall(evm: Evm) -> None: + """ + Message-call into an account. + + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + gas = Uint(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) + memory_input_start_position = pop(evm.stack) + memory_input_size = pop(evm.stack) + memory_output_start_position = pop(evm.stack) + memory_output_size = pop(evm.stack) + + # GAS + extend_memory = calculate_gas_extend_memory( + evm.memory, + [ + (memory_input_start_position, memory_input_size), + (memory_output_start_position, memory_output_size), + ], + ) + + if code_address in evm.accessed_addresses: + access_gas_cost = GAS_WARM_ACCESS + else: + evm.accessed_addresses.add(code_address) + access_gas_cost = GAS_COLD_ACCOUNT_ACCESS + + if code_address not in evm.warm_code_addresses: + evm.warm_code_addresses.add(code_address) + access_gas_cost += code_access_cost( + get_account(evm.message.block_env.state, code_address).code + ) + + ( + disable_precompiles, + code_address, + code, + delegated_access_gas_cost, + ) = access_delegation(evm, code_address) + access_gas_cost += delegated_access_gas_cost + + message_call_gas = calculate_message_call_gas( + U256(0), gas, Uint(evm.gas_left), extend_memory.cost, access_gas_cost + ) + charge_gas(evm, message_call_gas.cost + extend_memory.cost) + + # OPERATION + evm.memory += b"\x00" * extend_memory.expand_by + generic_call( + evm, + message_call_gas.sub_call, + evm.message.value, + evm.message.caller, + evm.message.current_target, + code_address, + False, + False, + memory_input_start_position, + memory_input_size, + memory_output_start_position, + memory_output_size, + code, + disable_precompiles, + ) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def staticcall(evm: Evm) -> None: + """ + Message-call into an account. + + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + gas = Uint(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) + memory_input_start_position = pop(evm.stack) + memory_input_size = pop(evm.stack) + memory_output_start_position = pop(evm.stack) + memory_output_size = pop(evm.stack) + + # GAS + extend_memory = calculate_gas_extend_memory( + evm.memory, + [ + (memory_input_start_position, memory_input_size), + (memory_output_start_position, memory_output_size), + ], + ) + + if to in evm.accessed_addresses: + access_gas_cost = GAS_WARM_ACCESS + else: + evm.accessed_addresses.add(to) + access_gas_cost = GAS_COLD_ACCOUNT_ACCESS + + if to not in evm.warm_code_addresses: + evm.warm_code_addresses.add(to) + access_gas_cost += code_access_cost( + get_account(evm.message.block_env.state, to).code + ) + + code_address = to + ( + disable_precompiles, + code_address, + code, + delegated_access_gas_cost, + ) = access_delegation(evm, code_address) + access_gas_cost += delegated_access_gas_cost + + message_call_gas = calculate_message_call_gas( + U256(0), + gas, + Uint(evm.gas_left), + extend_memory.cost, + access_gas_cost, + ) + charge_gas(evm, message_call_gas.cost + extend_memory.cost) + + # OPERATION + evm.memory += b"\x00" * extend_memory.expand_by + generic_call( + evm, + message_call_gas.sub_call, + U256(0), + evm.message.current_target, + to, + code_address, + True, + True, + memory_input_start_position, + memory_input_size, + memory_output_start_position, + memory_output_size, + code, + disable_precompiles, + ) + + # PROGRAM COUNTER + evm.pc += Uint(1) + + +def revert(evm: Evm) -> None: + """ + Stop execution and revert state changes, without consuming all provided gas + and also has the ability to return a reason + Parameters + ---------- + evm : + The current EVM frame. + """ + # STACK + memory_start_index = pop(evm.stack) + size = pop(evm.stack) + + # GAS + extend_memory = calculate_gas_extend_memory( + evm.memory, [(memory_start_index, size)] + ) + + charge_gas(evm, extend_memory.cost) + + # OPERATION + evm.memory += b"\x00" * extend_memory.expand_by + output = memory_read_bytes(evm.memory, memory_start_index, size) + evm.output = Bytes(output) + raise Revert + + # PROGRAM COUNTER + # no-op diff --git a/src/ethereum/osaka/vm/interpreter.py b/src/ethereum/osaka/vm/interpreter.py new file mode 100644 index 0000000000..e6eab97ee9 --- /dev/null +++ b/src/ethereum/osaka/vm/interpreter.py @@ -0,0 +1,323 @@ +""" +Ethereum Virtual Machine (EVM) Interpreter +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +A straightforward interpreter that executes EVM code. +""" + +from dataclasses import dataclass +from typing import Optional, Set, Tuple + +from ethereum_types.bytes import Bytes, Bytes0 +from ethereum_types.numeric import U256, Uint, ulen + +from ethereum.exceptions import EthereumException +from ethereum.trace import ( + EvmStop, + OpEnd, + OpException, + OpStart, + PrecompileEnd, + PrecompileStart, + TransactionEnd, + evm_trace, +) + +from ..blocks import Log +from ..fork_types import Address +from ..state import ( + account_has_code_or_nonce, + account_has_storage, + begin_transaction, + commit_transaction, + destroy_storage, + get_account, + increment_nonce, + mark_account_created, + move_ether, + rollback_transaction, + set_code, +) +from ..vm import Message +from ..vm.eoa_delegation import get_delegated_code_address, set_delegation +from ..vm.gas import GAS_CODE_DEPOSIT, charge_gas +from ..vm.precompiled_contracts.mapping import PRE_COMPILED_CONTRACTS +from . import Evm +from .exceptions import ( + AddressCollision, + ExceptionalHalt, + InvalidContractPrefix, + InvalidOpcode, + OutOfGasError, + Revert, + StackDepthLimitError, +) +from .instructions import Ops, op_implementation +from .runtime import get_valid_jump_destinations + +STACK_DEPTH_LIMIT = Uint(1024) +MAX_CODE_SIZE_WITH_NO_ACCESS_COST = 0x6000 +MAX_CODE_SIZE = 0x40000 +MAX_INIT_CODE_SIZE = 0x80000 + + +@dataclass +class MessageCallOutput: + """ + Output of a particular message call + + Contains the following: + + 1. `gas_left`: remaining gas after execution. + 2. `refund_counter`: gas to refund after execution. + 3. `logs`: list of `Log` generated during execution. + 4. `accounts_to_delete`: Contracts which have self-destructed. + 5. `error`: The error from the execution if any. + 6. `return_data`: The output of the execution. + """ + + gas_left: Uint + refund_counter: U256 + logs: Tuple[Log, ...] + accounts_to_delete: Set[Address] + error: Optional[EthereumException] + return_data: Bytes + + +def process_message_call(message: Message) -> MessageCallOutput: + """ + If `message.current` is empty then it creates a smart contract + else it executes a call from the `message.caller` to the `message.target`. + + Parameters + ---------- + message : + Transaction specific items. + + Returns + ------- + output : `MessageCallOutput` + Output of the message call + """ + block_env = message.block_env + refund_counter = U256(0) + if message.target == Bytes0(b""): + is_collision = account_has_code_or_nonce( + block_env.state, message.current_target + ) or account_has_storage(block_env.state, message.current_target) + if is_collision: + return MessageCallOutput( + Uint(0), + U256(0), + tuple(), + set(), + AddressCollision(), + Bytes(b""), + ) + else: + evm = process_create_message(message) + else: + if message.tx_env.authorizations != (): + refund_counter += set_delegation(message) + + delegated_address = get_delegated_code_address(message.code) + if delegated_address is not None: + message.disable_precompiles = True + message.accessed_addresses.add(delegated_address) + message.code = get_account(block_env.state, delegated_address).code + message.code_address = delegated_address + + evm = process_message(message) + + if evm.error: + logs: Tuple[Log, ...] = () + accounts_to_delete = set() + else: + logs = evm.logs + accounts_to_delete = evm.accounts_to_delete + refund_counter += U256(evm.refund_counter) + + tx_end = TransactionEnd( + int(message.gas) - int(evm.gas_left), evm.output, evm.error + ) + evm_trace(evm, tx_end) + + return MessageCallOutput( + gas_left=evm.gas_left, + refund_counter=refund_counter, + logs=logs, + accounts_to_delete=accounts_to_delete, + error=evm.error, + return_data=evm.output, + ) + + +def process_create_message(message: Message) -> Evm: + """ + Executes a call to create a smart contract. + + Parameters + ---------- + message : + Transaction specific items. + + Returns + ------- + evm: :py:class:`~ethereum.osaka.vm.Evm` + Items containing execution specific objects. + """ + state = message.block_env.state + transient_storage = message.tx_env.transient_storage + # take snapshot of state before processing the message + begin_transaction(state, transient_storage) + + # If the address where the account is being created has storage, it is + # destroyed. This can only happen in the following highly unlikely + # circumstances: + # * The address created by a `CREATE` call collides with a subsequent + # `CREATE` or `CREATE2` call. + # * The first `CREATE` happened before Spurious Dragon and left empty + # code. + destroy_storage(state, message.current_target) + + # In the previously mentioned edge case the preexisting storage is ignored + # for gas refund purposes. In order to do this we must track created + # accounts. This tracking is also needed to respect the constraints + # added to SELFDESTRUCT by EIP-6780. + mark_account_created(state, message.current_target) + + increment_nonce(state, message.current_target) + evm = process_message(message) + if not evm.error: + contract_code = evm.output + contract_code_gas = Uint(len(contract_code)) * GAS_CODE_DEPOSIT + try: + if len(contract_code) > 0: + if contract_code[0] == 0xEF: + raise InvalidContractPrefix + charge_gas(evm, contract_code_gas) + if len(contract_code) > MAX_CODE_SIZE: + raise OutOfGasError + except ExceptionalHalt as error: + rollback_transaction(state, transient_storage) + evm.gas_left = Uint(0) + evm.output = b"" + evm.error = error + else: + set_code(state, message.current_target, contract_code) + commit_transaction(state, transient_storage) + else: + rollback_transaction(state, transient_storage) + return evm + + +def process_message(message: Message) -> Evm: + """ + Move ether and execute the relevant code. + + Parameters + ---------- + message : + Transaction specific items. + + Returns + ------- + evm: :py:class:`~ethereum.osaka.vm.Evm` + Items containing execution specific objects + """ + state = message.block_env.state + transient_storage = message.tx_env.transient_storage + if message.depth > STACK_DEPTH_LIMIT: + raise StackDepthLimitError("Stack depth limit reached") + + # take snapshot of state before processing the message + begin_transaction(state, transient_storage) + + if message.should_transfer_value and message.value != 0: + move_ether( + state, message.caller, message.current_target, message.value + ) + + evm = execute_code(message) + if evm.error: + # revert state to the last saved checkpoint + # since the message call resulted in an error + rollback_transaction(state, transient_storage) + else: + commit_transaction(state, transient_storage) + return evm + + +def execute_code(message: Message) -> Evm: + """ + Executes bytecode present in the `message`. + + Parameters + ---------- + message : + Transaction specific items. + + Returns + ------- + evm: `ethereum.vm.EVM` + Items containing execution specific objects + """ + code = message.code + valid_jump_destinations = get_valid_jump_destinations(code) + + evm = Evm( + pc=Uint(0), + stack=[], + memory=bytearray(), + code=code, + gas_left=message.gas, + valid_jump_destinations=valid_jump_destinations, + logs=(), + refund_counter=0, + running=True, + message=message, + output=b"", + accounts_to_delete=set(), + return_data=b"", + error=None, + accessed_addresses=message.accessed_addresses, + accessed_storage_keys=message.accessed_storage_keys, + warm_code_addresses=message.warm_code_addresses, + ) + try: + if evm.message.code_address in PRE_COMPILED_CONTRACTS: + if message.disable_precompiles: + return evm + evm_trace(evm, PrecompileStart(evm.message.code_address)) + PRE_COMPILED_CONTRACTS[evm.message.code_address](evm) + evm_trace(evm, PrecompileEnd()) + return evm + + while evm.running and evm.pc < ulen(evm.code): + try: + op = Ops(evm.code[evm.pc]) + except ValueError: + raise InvalidOpcode(evm.code[evm.pc]) + + evm_trace(evm, OpStart(op)) + op_implementation[op](evm) + evm_trace(evm, OpEnd()) + + evm_trace(evm, EvmStop(Ops.STOP)) + + except ExceptionalHalt as error: + evm_trace(evm, OpException(error)) + evm.gas_left = Uint(0) + evm.output = b"" + evm.error = error + except Revert as error: + evm_trace(evm, OpException(error)) + evm.error = error + return evm diff --git a/src/ethereum/osaka/vm/memory.py b/src/ethereum/osaka/vm/memory.py new file mode 100644 index 0000000000..aa2e7fdd57 --- /dev/null +++ b/src/ethereum/osaka/vm/memory.py @@ -0,0 +1,81 @@ +""" +Ethereum Virtual Machine (EVM) Memory +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +EVM memory operations. +""" +from ethereum_types.bytes import Bytes +from ethereum_types.numeric import U256, Uint + +from ethereum.utils.byte import right_pad_zero_bytes + + +def memory_write( + memory: bytearray, start_position: U256, value: Bytes +) -> None: + """ + Writes to memory. + + Parameters + ---------- + memory : + Memory contents of the EVM. + start_position : + Starting pointer to the memory. + value : + Data to write to memory. + """ + memory[start_position : int(start_position) + len(value)] = value + + +def memory_read_bytes( + memory: bytearray, start_position: U256, size: U256 +) -> bytearray: + """ + Read bytes from memory. + + Parameters + ---------- + memory : + Memory contents of the EVM. + start_position : + Starting pointer to the memory. + size : + Size of the data that needs to be read from `start_position`. + + Returns + ------- + data_bytes : + Data read from memory. + """ + return memory[start_position : Uint(start_position) + Uint(size)] + + +def buffer_read(buffer: Bytes, start_position: U256, size: U256) -> Bytes: + """ + Read bytes from a buffer. Padding with zeros if necessary. + + Parameters + ---------- + buffer : + Memory contents of the EVM. + start_position : + Starting pointer to the memory. + size : + Size of the data that needs to be read from `start_position`. + + Returns + ------- + data_bytes : + Data read from memory. + """ + return right_pad_zero_bytes( + buffer[start_position : Uint(start_position) + Uint(size)], size + ) diff --git a/src/ethereum/osaka/vm/precompiled_contracts/__init__.py b/src/ethereum/osaka/vm/precompiled_contracts/__init__.py new file mode 100644 index 0000000000..f6a8cbbc12 --- /dev/null +++ b/src/ethereum/osaka/vm/precompiled_contracts/__init__.py @@ -0,0 +1,56 @@ +""" +Precompiled Contract Addresses +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Addresses of precompiled contracts and mappings to their +implementations. +""" + +from ...utils.hexadecimal import hex_to_address + +__all__ = ( + "ECRECOVER_ADDRESS", + "SHA256_ADDRESS", + "RIPEMD160_ADDRESS", + "IDENTITY_ADDRESS", + "MODEXP_ADDRESS", + "ALT_BN128_ADD_ADDRESS", + "ALT_BN128_MUL_ADDRESS", + "ALT_BN128_PAIRING_CHECK_ADDRESS", + "BLAKE2F_ADDRESS", + "POINT_EVALUATION_ADDRESS", + "BLS12_G1_ADD_ADDRESS", + "BLS12_G1_MSM_ADDRESS", + "BLS12_G2_ADD_ADDRESS", + "BLS12_G2_MSM_ADDRESS", + "BLS12_PAIRING_ADDRESS", + "BLS12_MAP_FP_TO_G1_ADDRESS", + "BLS12_MAP_FP2_TO_G2_ADDRESS", + "P256VERIFY_ADDRESS", +) + +ECRECOVER_ADDRESS = hex_to_address("0x01") +SHA256_ADDRESS = hex_to_address("0x02") +RIPEMD160_ADDRESS = hex_to_address("0x03") +IDENTITY_ADDRESS = hex_to_address("0x04") +MODEXP_ADDRESS = hex_to_address("0x05") +ALT_BN128_ADD_ADDRESS = hex_to_address("0x06") +ALT_BN128_MUL_ADDRESS = hex_to_address("0x07") +ALT_BN128_PAIRING_CHECK_ADDRESS = hex_to_address("0x08") +BLAKE2F_ADDRESS = hex_to_address("0x09") +POINT_EVALUATION_ADDRESS = hex_to_address("0x0a") +BLS12_G1_ADD_ADDRESS = hex_to_address("0x0b") +BLS12_G1_MSM_ADDRESS = hex_to_address("0x0c") +BLS12_G2_ADD_ADDRESS = hex_to_address("0x0d") +BLS12_G2_MSM_ADDRESS = hex_to_address("0x0e") +BLS12_PAIRING_ADDRESS = hex_to_address("0x0f") +BLS12_MAP_FP_TO_G1_ADDRESS = hex_to_address("0x10") +BLS12_MAP_FP2_TO_G2_ADDRESS = hex_to_address("0x11") +P256VERIFY_ADDRESS = hex_to_address("0x100") diff --git a/src/ethereum/osaka/vm/precompiled_contracts/alt_bn128.py b/src/ethereum/osaka/vm/precompiled_contracts/alt_bn128.py new file mode 100644 index 0000000000..0c82ec5588 --- /dev/null +++ b/src/ethereum/osaka/vm/precompiled_contracts/alt_bn128.py @@ -0,0 +1,225 @@ +""" +Ethereum Virtual Machine (EVM) ALT_BN128 CONTRACTS +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementation of the ALT_BN128 precompiled contracts. +""" +from ethereum_types.bytes import Bytes +from ethereum_types.numeric import U256, Uint +from py_ecc.optimized_bn128.optimized_curve import ( + FQ, + FQ2, + FQ12, + add, + b, + b2, + curve_order, + field_modulus, + is_inf, + is_on_curve, + multiply, + normalize, +) +from py_ecc.optimized_bn128.optimized_pairing import pairing +from py_ecc.typing import Optimized_Point3D as Point3D + +from ...vm import Evm +from ...vm.gas import charge_gas +from ...vm.memory import buffer_read +from ..exceptions import InvalidParameter, OutOfGasError + + +def bytes_to_g1(data: Bytes) -> Point3D[FQ]: + """ + Decode 64 bytes to a point on the curve. + + Parameters + ---------- + data : + The bytes data to decode. + + Returns + ------- + point : Point3D + A point on the curve. + + Raises + ------ + InvalidParameter + Either a field element is invalid or the point is not on the curve. + """ + if len(data) != 64: + raise InvalidParameter("Input should be 64 bytes long") + + x_bytes = buffer_read(data, U256(0), U256(32)) + x = int(U256.from_be_bytes(x_bytes)) + y_bytes = buffer_read(data, U256(32), U256(32)) + y = int(U256.from_be_bytes(y_bytes)) + + if x >= field_modulus: + raise InvalidParameter("Invalid field element") + if y >= field_modulus: + raise InvalidParameter("Invalid field element") + + z = 1 + if x == 0 and y == 0: + z = 0 + + point = (FQ(x), FQ(y), FQ(z)) + + # Check if the point is on the curve + if not is_on_curve(point, b): + raise InvalidParameter("Point is not on curve") + + return point + + +def bytes_to_g2(data: Bytes) -> Point3D[FQ2]: + """ + Decode 128 bytes to a G2 point. + + Parameters + ---------- + data : + The bytes data to decode. + + Returns + ------- + point : Point2D + A point on the curve. + + Raises + ------ + InvalidParameter + Either a field element is invalid or the point is not on the curve. + """ + if len(data) != 128: + raise InvalidParameter("G2 should be 128 bytes long") + + x0_bytes = buffer_read(data, U256(0), U256(32)) + x0 = int(U256.from_be_bytes(x0_bytes)) + x1_bytes = buffer_read(data, U256(32), U256(32)) + x1 = int(U256.from_be_bytes(x1_bytes)) + + y0_bytes = buffer_read(data, U256(64), U256(32)) + y0 = int(U256.from_be_bytes(y0_bytes)) + y1_bytes = buffer_read(data, U256(96), U256(32)) + y1 = int(U256.from_be_bytes(y1_bytes)) + + if x0 >= field_modulus or x1 >= field_modulus: + raise InvalidParameter("Invalid field element") + if y0 >= field_modulus or y1 >= field_modulus: + raise InvalidParameter("Invalid field element") + + x = FQ2((x1, x0)) + y = FQ2((y1, y0)) + + z = (1, 0) + if x == FQ2((0, 0)) and y == FQ2((0, 0)): + z = (0, 0) + + point = (x, y, FQ2(z)) + + # Check if the point is on the curve + if not is_on_curve(point, b2): + raise InvalidParameter("Point is not on curve") + + return point + + +def alt_bn128_add(evm: Evm) -> None: + """ + The ALT_BN128 addition precompiled contract. + + Parameters + ---------- + evm : + The current EVM frame. + """ + data = evm.message.data + + # GAS + charge_gas(evm, Uint(150)) + + # OPERATION + try: + p0 = bytes_to_g1(buffer_read(data, U256(0), U256(64))) + p1 = bytes_to_g1(buffer_read(data, U256(64), U256(64))) + except InvalidParameter as e: + raise OutOfGasError from e + + p = add(p0, p1) + x, y = normalize(p) + + evm.output = Uint(x).to_be_bytes32() + Uint(y).to_be_bytes32() + + +def alt_bn128_mul(evm: Evm) -> None: + """ + The ALT_BN128 multiplication precompiled contract. + + Parameters + ---------- + evm : + The current EVM frame. + """ + data = evm.message.data + + # GAS + charge_gas(evm, Uint(6000)) + + # OPERATION + try: + p0 = bytes_to_g1(buffer_read(data, U256(0), U256(64))) + except InvalidParameter as e: + raise OutOfGasError from e + n = int(U256.from_be_bytes(buffer_read(data, U256(64), U256(32)))) + + p = multiply(p0, n) + x, y = normalize(p) + + evm.output = Uint(x).to_be_bytes32() + Uint(y).to_be_bytes32() + + +def alt_bn128_pairing_check(evm: Evm) -> None: + """ + The ALT_BN128 pairing check precompiled contract. + + Parameters + ---------- + evm : + The current EVM frame. + """ + data = evm.message.data + + # GAS + charge_gas(evm, Uint(34000 * (len(data) // 192) + 45000)) + + # OPERATION + if len(data) % 192 != 0: + raise OutOfGasError + result = FQ12.one() + for i in range(len(data) // 192): + try: + p = bytes_to_g1(buffer_read(data, U256(192 * i), U256(64))) + q = bytes_to_g2(buffer_read(data, U256(192 * i + 64), U256(128))) + except InvalidParameter as e: + raise OutOfGasError from e + if not is_inf(multiply(p, curve_order)): + raise OutOfGasError + if not is_inf(multiply(q, curve_order)): + raise OutOfGasError + + result *= pairing(q, p) + + if result == FQ12.one(): + evm.output = U256(1).to_be_bytes32() + else: + evm.output = U256(0).to_be_bytes32() diff --git a/src/ethereum/osaka/vm/precompiled_contracts/blake2f.py b/src/ethereum/osaka/vm/precompiled_contracts/blake2f.py new file mode 100644 index 0000000000..0d86ba6e85 --- /dev/null +++ b/src/ethereum/osaka/vm/precompiled_contracts/blake2f.py @@ -0,0 +1,41 @@ +""" +Ethereum Virtual Machine (EVM) Blake2 PRECOMPILED CONTRACT +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementation of the `Blake2` precompiled contract. +""" +from ethereum.crypto.blake2 import Blake2b + +from ...vm import Evm +from ...vm.gas import GAS_BLAKE2_PER_ROUND, charge_gas +from ..exceptions import InvalidParameter + + +def blake2f(evm: Evm) -> None: + """ + Writes the Blake2 hash to output. + + Parameters + ---------- + evm : + The current EVM frame. + """ + data = evm.message.data + if len(data) != 213: + raise InvalidParameter + + blake2b = Blake2b() + rounds, h, m, t_0, t_1, f = blake2b.get_blake2_parameters(data) + + charge_gas(evm, GAS_BLAKE2_PER_ROUND * rounds) + if f not in [0, 1]: + raise InvalidParameter + + evm.output = blake2b.compress(rounds, h, m, t_0, t_1, f) diff --git a/src/ethereum/osaka/vm/precompiled_contracts/bls12_381/__init__.py b/src/ethereum/osaka/vm/precompiled_contracts/bls12_381/__init__.py new file mode 100644 index 0000000000..fe50f9249f --- /dev/null +++ b/src/ethereum/osaka/vm/precompiled_contracts/bls12_381/__init__.py @@ -0,0 +1,577 @@ +""" +BLS12 381 Precompile +^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Precompile for BLS12-381 curve operations. +""" + +from typing import Tuple + +from ethereum_types.bytes import Bytes +from ethereum_types.numeric import U256, Uint +from py_ecc.optimized_bls12_381.optimized_curve import ( + FQ, + FQ2, + b, + b2, + curve_order, + is_inf, + is_on_curve, +) +from py_ecc.optimized_bls12_381.optimized_curve import ( + multiply as bls12_multiply, +) +from py_ecc.optimized_bls12_381.optimized_curve import normalize +from py_ecc.typing import Optimized_Point3D as Point3D + +from ....vm.memory import buffer_read +from ...exceptions import InvalidParameter + +G1_K_DISCOUNT = [ + 1000, + 949, + 848, + 797, + 764, + 750, + 738, + 728, + 719, + 712, + 705, + 698, + 692, + 687, + 682, + 677, + 673, + 669, + 665, + 661, + 658, + 654, + 651, + 648, + 645, + 642, + 640, + 637, + 635, + 632, + 630, + 627, + 625, + 623, + 621, + 619, + 617, + 615, + 613, + 611, + 609, + 608, + 606, + 604, + 603, + 601, + 599, + 598, + 596, + 595, + 593, + 592, + 591, + 589, + 588, + 586, + 585, + 584, + 582, + 581, + 580, + 579, + 577, + 576, + 575, + 574, + 573, + 572, + 570, + 569, + 568, + 567, + 566, + 565, + 564, + 563, + 562, + 561, + 560, + 559, + 558, + 557, + 556, + 555, + 554, + 553, + 552, + 551, + 550, + 549, + 548, + 547, + 547, + 546, + 545, + 544, + 543, + 542, + 541, + 540, + 540, + 539, + 538, + 537, + 536, + 536, + 535, + 534, + 533, + 532, + 532, + 531, + 530, + 529, + 528, + 528, + 527, + 526, + 525, + 525, + 524, + 523, + 522, + 522, + 521, + 520, + 520, + 519, +] + +G2_K_DISCOUNT = [ + 1000, + 1000, + 923, + 884, + 855, + 832, + 812, + 796, + 782, + 770, + 759, + 749, + 740, + 732, + 724, + 717, + 711, + 704, + 699, + 693, + 688, + 683, + 679, + 674, + 670, + 666, + 663, + 659, + 655, + 652, + 649, + 646, + 643, + 640, + 637, + 634, + 632, + 629, + 627, + 624, + 622, + 620, + 618, + 615, + 613, + 611, + 609, + 607, + 606, + 604, + 602, + 600, + 598, + 597, + 595, + 593, + 592, + 590, + 589, + 587, + 586, + 584, + 583, + 582, + 580, + 579, + 578, + 576, + 575, + 574, + 573, + 571, + 570, + 569, + 568, + 567, + 566, + 565, + 563, + 562, + 561, + 560, + 559, + 558, + 557, + 556, + 555, + 554, + 553, + 552, + 552, + 551, + 550, + 549, + 548, + 547, + 546, + 545, + 545, + 544, + 543, + 542, + 541, + 541, + 540, + 539, + 538, + 537, + 537, + 536, + 535, + 535, + 534, + 533, + 532, + 532, + 531, + 530, + 530, + 529, + 528, + 528, + 527, + 526, + 526, + 525, + 524, + 524, +] + +G1_MAX_DISCOUNT = 519 +G2_MAX_DISCOUNT = 524 +MULTIPLIER = Uint(1000) + + +def bytes_to_g1( + data: Bytes, +) -> Point3D[FQ]: + """ + Decode 128 bytes to a G1 point. Does not perform sub-group check. + + Parameters + ---------- + data : + The bytes data to decode. + + Returns + ------- + point : Point3D[FQ] + The G1 point. + + Raises + ------ + InvalidParameter + Either a field element is invalid or the point is not on the curve. + """ + if len(data) != 128: + raise InvalidParameter("Input should be 128 bytes long") + + x = bytes_to_fq(data[:64]) + y = bytes_to_fq(data[64:]) + + if x >= FQ.field_modulus: + raise InvalidParameter("x >= field modulus") + if y >= FQ.field_modulus: + raise InvalidParameter("y >= field modulus") + + z = 1 + if x == 0 and y == 0: + z = 0 + point = FQ(x), FQ(y), FQ(z) + + if not is_on_curve(point, b): + raise InvalidParameter("Point is not on curve") + + return point + + +def g1_to_bytes( + g1_point: Point3D[FQ], +) -> Bytes: + """ + Encode a G1 point to 128 bytes. + + Parameters + ---------- + g1_point : + The G1 point to encode. + + Returns + ------- + data : Bytes + The encoded data. + """ + g1_normalized = normalize(g1_point) + x, y = g1_normalized + return b"".join([int(x).to_bytes(64, "big"), int(y).to_bytes(64, "big")]) + + +def decode_g1_scalar_pair( + data: Bytes, +) -> Tuple[Point3D[FQ], int]: + """ + Decode 160 bytes to a G1 point and a scalar. + + Parameters + ---------- + data : + The bytes data to decode. + + Returns + ------- + point : Tuple[Point3D[FQ], int] + The G1 point and the scalar. + + Raises + ------ + InvalidParameter + If the sub-group check failed. + """ + if len(data) != 160: + InvalidParameter("Input should be 160 bytes long") + + point = bytes_to_g1(data[:128]) + if not is_inf(bls12_multiply(point, curve_order)): + raise InvalidParameter("Sub-group check failed.") + + m = int.from_bytes(buffer_read(data, U256(128), U256(32)), "big") + + return point, m + + +def bytes_to_fq(data: Bytes) -> FQ: + """ + Decode 64 bytes to a FQ element. + + Parameters + ---------- + data : + The bytes data to decode. + + Returns + ------- + fq : FQ + The FQ element. + + Raises + ------ + InvalidParameter + If the field element is invalid. + """ + if len(data) != 64: + raise InvalidParameter("FQ should be 64 bytes long") + + c = int.from_bytes(data[:64], "big") + + if c >= FQ.field_modulus: + raise InvalidParameter("Invalid field element") + + return FQ(c) + + +def bytes_to_fq2(data: Bytes) -> FQ2: + """ + Decode 128 bytes to an FQ2 element. + + Parameters + ---------- + data : + The bytes data to decode. + + Returns + ------- + fq2 : FQ2 + The FQ2 element. + + Raises + ------ + InvalidParameter + If the field element is invalid. + """ + if len(data) != 128: + raise InvalidParameter("FQ2 input should be 128 bytes long") + c_0 = int.from_bytes(data[:64], "big") + c_1 = int.from_bytes(data[64:], "big") + + if c_0 >= FQ.field_modulus: + raise InvalidParameter("Invalid field element") + if c_1 >= FQ.field_modulus: + raise InvalidParameter("Invalid field element") + + return FQ2((c_0, c_1)) + + +def bytes_to_g2( + data: Bytes, +) -> Point3D[FQ2]: + """ + Decode 256 bytes to a G2 point. Does not perform sub-group check. + + Parameters + ---------- + data : + The bytes data to decode. + + Returns + ------- + point : Point3D[FQ2] + The G2 point. + + Raises + ------ + InvalidParameter + Either a field element is invalid or the point is not on the curve. + """ + if len(data) != 256: + raise InvalidParameter("G2 should be 256 bytes long") + + x = bytes_to_fq2(data[:128]) + y = bytes_to_fq2(data[128:]) + + z = (1, 0) + if x == FQ2((0, 0)) and y == FQ2((0, 0)): + z = (0, 0) + + point = x, y, FQ2(z) + + # Check if the point is on the curve + if not is_on_curve(point, b2): + raise InvalidParameter("Point is not on curve") + + return point + + +def FQ2_to_bytes(fq2: FQ2) -> Bytes: + """ + Encode a FQ2 point to 128 bytes. + + Parameters + ---------- + fq2 : + The FQ2 point to encode. + + Returns + ------- + data : Bytes + The encoded data. + """ + coord0, coord1 = fq2.coeffs + return b"".join( + [ + int(coord0).to_bytes(64, "big"), + int(coord1).to_bytes(64, "big"), + ] + ) + + +def g2_to_bytes( + g2_point: Point3D[FQ2], +) -> Bytes: + """ + Encode a G2 point to 256 bytes. + + Parameters + ---------- + g2_point : + The G2 point to encode. + + Returns + ------- + data : Bytes + The encoded data. + """ + x_coords, y_coords = normalize(g2_point) + return b"".join([FQ2_to_bytes(x_coords), FQ2_to_bytes(y_coords)]) + + +def decode_g2_scalar_pair( + data: Bytes, +) -> Tuple[Point3D[FQ2], int]: + """ + Decode 288 bytes to a G2 point and a scalar. + + Parameters + ---------- + data : + The bytes data to decode. + + Returns + ------- + point : Tuple[Point3D[FQ2], int] + The G2 point and the scalar. + + Raises + ------ + InvalidParameter + If the sub-group check failed. + """ + if len(data) != 288: + InvalidParameter("Input should be 288 bytes long") + + point = bytes_to_g2(data[:256]) + + if not is_inf(bls12_multiply(point, curve_order)): + raise InvalidParameter("Point failed sub-group check.") + + n = int.from_bytes(data[256 : 256 + 32], "big") + + return point, n diff --git a/src/ethereum/osaka/vm/precompiled_contracts/bls12_381/bls12_381_g1.py b/src/ethereum/osaka/vm/precompiled_contracts/bls12_381/bls12_381_g1.py new file mode 100644 index 0000000000..da6a984ace --- /dev/null +++ b/src/ethereum/osaka/vm/precompiled_contracts/bls12_381/bls12_381_g1.py @@ -0,0 +1,149 @@ +""" +Ethereum Virtual Machine (EVM) BLS12 381 CONTRACTS +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementation of pre-compiles in G1 (curve over base prime field). +""" + +from ethereum_types.numeric import U256, Uint +from py_ecc.bls.hash_to_curve import clear_cofactor_G1, map_to_curve_G1 +from py_ecc.optimized_bls12_381.optimized_curve import FQ +from py_ecc.optimized_bls12_381.optimized_curve import add as bls12_add +from py_ecc.optimized_bls12_381.optimized_curve import ( + multiply as bls12_multiply, +) + +from ....vm import Evm +from ....vm.gas import ( + GAS_BLS_G1_ADD, + GAS_BLS_G1_MAP, + GAS_BLS_G1_MUL, + charge_gas, +) +from ....vm.memory import buffer_read +from ...exceptions import InvalidParameter +from . import ( + G1_K_DISCOUNT, + G1_MAX_DISCOUNT, + MULTIPLIER, + bytes_to_g1, + decode_g1_scalar_pair, + g1_to_bytes, +) + +LENGTH_PER_PAIR = 160 + + +def bls12_g1_add(evm: Evm) -> None: + """ + The bls12_381 G1 point addition precompile. + + Parameters + ---------- + evm : + The current EVM frame. + + Raises + ------ + InvalidParameter + If the input length is invalid. + """ + data = evm.message.data + if len(data) != 256: + raise InvalidParameter("Invalid Input Length") + + # GAS + charge_gas(evm, Uint(GAS_BLS_G1_ADD)) + + # OPERATION + p1 = bytes_to_g1(buffer_read(data, U256(0), U256(128))) + p2 = bytes_to_g1(buffer_read(data, U256(128), U256(128))) + + result = bls12_add(p1, p2) + + evm.output = g1_to_bytes(result) + + +def bls12_g1_msm(evm: Evm) -> None: + """ + The bls12_381 G1 multi-scalar multiplication precompile. + Note: This uses the naive approach to multi-scalar multiplication + which is not suitably optimized for production clients. Clients are + required to implement a more efficient algorithm such as the Pippenger + algorithm. + + Parameters + ---------- + evm : + The current EVM frame. + + Raises + ------ + InvalidParameter + If the input length is invalid. + """ + data = evm.message.data + if len(data) == 0 or len(data) % LENGTH_PER_PAIR != 0: + raise InvalidParameter("Invalid Input Length") + + # GAS + k = len(data) // LENGTH_PER_PAIR + if k <= 128: + discount = Uint(G1_K_DISCOUNT[k - 1]) + else: + discount = Uint(G1_MAX_DISCOUNT) + + gas_cost = Uint(k) * GAS_BLS_G1_MUL * discount // MULTIPLIER + charge_gas(evm, gas_cost) + + # OPERATION + for i in range(k): + start_index = i * LENGTH_PER_PAIR + end_index = start_index + LENGTH_PER_PAIR + + p, m = decode_g1_scalar_pair(data[start_index:end_index]) + product = bls12_multiply(p, m) + + if i == 0: + result = product + else: + result = bls12_add(result, product) + + evm.output = g1_to_bytes(result) + + +def bls12_map_fp_to_g1(evm: Evm) -> None: + """ + Precompile to map field element to G1. + + Parameters + ---------- + evm : + The current EVM frame. + + Raises + ------ + InvalidParameter + If the input length is invalid. + """ + data = evm.message.data + if len(data) != 64: + raise InvalidParameter("Invalid Input Length") + + # GAS + charge_gas(evm, Uint(GAS_BLS_G1_MAP)) + + # OPERATION + fp = int.from_bytes(data, "big") + if fp >= FQ.field_modulus: + raise InvalidParameter("coordinate >= field modulus") + + g1_optimized_3d = clear_cofactor_G1(map_to_curve_G1(FQ(fp))) + evm.output = g1_to_bytes(g1_optimized_3d) diff --git a/src/ethereum/osaka/vm/precompiled_contracts/bls12_381/bls12_381_g2.py b/src/ethereum/osaka/vm/precompiled_contracts/bls12_381/bls12_381_g2.py new file mode 100644 index 0000000000..7f5ee65e5a --- /dev/null +++ b/src/ethereum/osaka/vm/precompiled_contracts/bls12_381/bls12_381_g2.py @@ -0,0 +1,151 @@ +""" +Ethereum Virtual Machine (EVM) BLS12 381 G2 CONTRACTS +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementation of pre-compiles in G2 (curve over base prime field). +""" + +from ethereum_types.numeric import U256, Uint +from py_ecc.bls.hash_to_curve import clear_cofactor_G2, map_to_curve_G2 +from py_ecc.optimized_bls12_381.optimized_curve import FQ2 +from py_ecc.optimized_bls12_381.optimized_curve import add as bls12_add +from py_ecc.optimized_bls12_381.optimized_curve import ( + multiply as bls12_multiply, +) + +from ....vm import Evm +from ....vm.gas import ( + GAS_BLS_G2_ADD, + GAS_BLS_G2_MAP, + GAS_BLS_G2_MUL, + charge_gas, +) +from ....vm.memory import buffer_read +from ...exceptions import InvalidParameter +from . import ( + G2_K_DISCOUNT, + G2_MAX_DISCOUNT, + MULTIPLIER, + bytes_to_fq2, + bytes_to_g2, + decode_g2_scalar_pair, + g2_to_bytes, +) + +LENGTH_PER_PAIR = 288 + + +def bls12_g2_add(evm: Evm) -> None: + """ + The bls12_381 G2 point addition precompile. + + Parameters + ---------- + evm : + The current EVM frame. + + Raises + ------ + InvalidParameter + If the input length is invalid. + """ + data = evm.message.data + if len(data) != 512: + raise InvalidParameter("Invalid Input Length") + + # GAS + charge_gas(evm, Uint(GAS_BLS_G2_ADD)) + + # OPERATION + p1 = bytes_to_g2(buffer_read(data, U256(0), U256(256))) + p2 = bytes_to_g2(buffer_read(data, U256(256), U256(256))) + + result = bls12_add(p1, p2) + + evm.output = g2_to_bytes(result) + + +def bls12_g2_msm(evm: Evm) -> None: + """ + The bls12_381 G2 multi-scalar multiplication precompile. + Note: This uses the naive approach to multi-scalar multiplication + which is not suitably optimized for production clients. Clients are + required to implement a more efficient algorithm such as the Pippenger + algorithm. + + Parameters + ---------- + evm : + The current EVM frame. + + Raises + ------ + InvalidParameter + If the input length is invalid. + """ + data = evm.message.data + if len(data) == 0 or len(data) % LENGTH_PER_PAIR != 0: + raise InvalidParameter("Invalid Input Length") + + # GAS + k = len(data) // LENGTH_PER_PAIR + if k <= 128: + discount = Uint(G2_K_DISCOUNT[k - 1]) + else: + discount = Uint(G2_MAX_DISCOUNT) + + gas_cost = Uint(k) * GAS_BLS_G2_MUL * discount // MULTIPLIER + charge_gas(evm, gas_cost) + + # OPERATION + for i in range(k): + start_index = i * LENGTH_PER_PAIR + end_index = start_index + LENGTH_PER_PAIR + + p, m = decode_g2_scalar_pair(data[start_index:end_index]) + product = bls12_multiply(p, m) + + if i == 0: + result = product + else: + result = bls12_add(result, product) + + evm.output = g2_to_bytes(result) + + +def bls12_map_fp2_to_g2(evm: Evm) -> None: + """ + Precompile to map field element to G2. + + Parameters + ---------- + evm : + The current EVM frame. + + Raises + ------ + InvalidParameter + If the input length is invalid. + """ + data = evm.message.data + if len(data) != 128: + raise InvalidParameter("Invalid Input Length") + + # GAS + charge_gas(evm, Uint(GAS_BLS_G2_MAP)) + + # OPERATION + field_element = bytes_to_fq2(data) + assert isinstance(field_element, FQ2) + + fp2 = bytes_to_fq2(data) + g2_3d = clear_cofactor_G2(map_to_curve_G2(fp2)) + + evm.output = g2_to_bytes(g2_3d) diff --git a/src/ethereum/osaka/vm/precompiled_contracts/bls12_381/bls12_381_pairing.py b/src/ethereum/osaka/vm/precompiled_contracts/bls12_381/bls12_381_pairing.py new file mode 100644 index 0000000000..e8b25f6753 --- /dev/null +++ b/src/ethereum/osaka/vm/precompiled_contracts/bls12_381/bls12_381_pairing.py @@ -0,0 +1,68 @@ +""" +Ethereum Virtual Machine (EVM) BLS12 381 PAIRING PRE-COMPILE +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementation of the BLS12 381 pairing pre-compile. +""" + +from ethereum_types.numeric import Uint +from py_ecc.optimized_bls12_381 import FQ12, curve_order, is_inf +from py_ecc.optimized_bls12_381 import multiply as bls12_multiply +from py_ecc.optimized_bls12_381 import pairing + +from ....vm import Evm +from ....vm.gas import charge_gas +from ...exceptions import InvalidParameter +from . import bytes_to_g1, bytes_to_g2 + + +def bls12_pairing(evm: Evm) -> None: + """ + The bls12_381 pairing precompile. + + Parameters + ---------- + evm : + The current EVM frame. + + Raises + ------ + InvalidParameter + If the input length is invalid or if sub-group check fails. + """ + data = evm.message.data + if len(data) == 0 or len(data) % 384 != 0: + raise InvalidParameter("Invalid Input Length") + + # GAS + k = len(data) // 384 + gas_cost = Uint(32600 * k + 37700) + charge_gas(evm, gas_cost) + + # OPERATION + result = FQ12.one() + for i in range(k): + g1_start = Uint(384 * i) + g2_start = Uint(384 * i + 128) + + g1_point = bytes_to_g1(data[g1_start : g1_start + Uint(128)]) + if not is_inf(bls12_multiply(g1_point, curve_order)): + raise InvalidParameter("Sub-group check failed for G1 point.") + + g2_point = bytes_to_g2(data[g2_start : g2_start + Uint(256)]) + if not is_inf(bls12_multiply(g2_point, curve_order)): + raise InvalidParameter("Sub-group check failed for G2 point.") + + result *= pairing(g2_point, g1_point) + + if result == FQ12.one(): + evm.output = b"\x00" * 31 + b"\x01" + else: + evm.output = b"\x00" * 32 diff --git a/src/ethereum/osaka/vm/precompiled_contracts/ecrecover.py b/src/ethereum/osaka/vm/precompiled_contracts/ecrecover.py new file mode 100644 index 0000000000..1f047d3a44 --- /dev/null +++ b/src/ethereum/osaka/vm/precompiled_contracts/ecrecover.py @@ -0,0 +1,63 @@ +""" +Ethereum Virtual Machine (EVM) ECRECOVER PRECOMPILED CONTRACT +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementation of the ECRECOVER precompiled contract. +""" +from ethereum_types.numeric import U256 + +from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover +from ethereum.crypto.hash import Hash32, keccak256 +from ethereum.exceptions import InvalidSignatureError +from ethereum.utils.byte import left_pad_zero_bytes + +from ...vm import Evm +from ...vm.gas import GAS_ECRECOVER, charge_gas +from ...vm.memory import buffer_read + + +def ecrecover(evm: Evm) -> None: + """ + Decrypts the address using elliptic curve DSA recovery mechanism and writes + the address to output. + + Parameters + ---------- + evm : + The current EVM frame. + """ + data = evm.message.data + + # GAS + charge_gas(evm, GAS_ECRECOVER) + + # OPERATION + message_hash_bytes = buffer_read(data, U256(0), U256(32)) + message_hash = Hash32(message_hash_bytes) + v = U256.from_be_bytes(buffer_read(data, U256(32), U256(32))) + r = U256.from_be_bytes(buffer_read(data, U256(64), U256(32))) + s = U256.from_be_bytes(buffer_read(data, U256(96), U256(32))) + + if v != U256(27) and v != U256(28): + return + if U256(0) >= r or r >= SECP256K1N: + return + if U256(0) >= s or s >= SECP256K1N: + return + + try: + public_key = secp256k1_recover(r, s, v - U256(27), message_hash) + except InvalidSignatureError: + # unable to extract public key + return + + address = keccak256(public_key)[12:32] + padded_address = left_pad_zero_bytes(address, 32) + evm.output = padded_address diff --git a/src/ethereum/osaka/vm/precompiled_contracts/identity.py b/src/ethereum/osaka/vm/precompiled_contracts/identity.py new file mode 100644 index 0000000000..88729c96d7 --- /dev/null +++ b/src/ethereum/osaka/vm/precompiled_contracts/identity.py @@ -0,0 +1,38 @@ +""" +Ethereum Virtual Machine (EVM) IDENTITY PRECOMPILED CONTRACT +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementation of the `IDENTITY` precompiled contract. +""" +from ethereum_types.numeric import Uint + +from ethereum.utils.numeric import ceil32 + +from ...vm import Evm +from ...vm.gas import GAS_IDENTITY, GAS_IDENTITY_WORD, charge_gas + + +def identity(evm: Evm) -> None: + """ + Writes the message data to output. + + Parameters + ---------- + evm : + The current EVM frame. + """ + data = evm.message.data + + # GAS + word_count = ceil32(Uint(len(data))) // Uint(32) + charge_gas(evm, GAS_IDENTITY + GAS_IDENTITY_WORD * word_count) + + # OPERATION + evm.output = data diff --git a/src/ethereum/osaka/vm/precompiled_contracts/mapping.py b/src/ethereum/osaka/vm/precompiled_contracts/mapping.py new file mode 100644 index 0000000000..cf09f008ea --- /dev/null +++ b/src/ethereum/osaka/vm/precompiled_contracts/mapping.py @@ -0,0 +1,77 @@ +""" +Precompiled Contract Addresses +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Mapping of precompiled contracts their implementations. +""" +from typing import Callable, Dict + +from ...fork_types import Address +from . import ( + ALT_BN128_ADD_ADDRESS, + ALT_BN128_MUL_ADDRESS, + ALT_BN128_PAIRING_CHECK_ADDRESS, + BLAKE2F_ADDRESS, + BLS12_G1_ADD_ADDRESS, + BLS12_G1_MSM_ADDRESS, + BLS12_G2_ADD_ADDRESS, + BLS12_G2_MSM_ADDRESS, + BLS12_MAP_FP2_TO_G2_ADDRESS, + BLS12_MAP_FP_TO_G1_ADDRESS, + BLS12_PAIRING_ADDRESS, + ECRECOVER_ADDRESS, + IDENTITY_ADDRESS, + MODEXP_ADDRESS, + P256VERIFY_ADDRESS, + POINT_EVALUATION_ADDRESS, + RIPEMD160_ADDRESS, + SHA256_ADDRESS, +) +from .alt_bn128 import alt_bn128_add, alt_bn128_mul, alt_bn128_pairing_check +from .blake2f import blake2f +from .bls12_381.bls12_381_g1 import ( + bls12_g1_add, + bls12_g1_msm, + bls12_map_fp_to_g1, +) +from .bls12_381.bls12_381_g2 import ( + bls12_g2_add, + bls12_g2_msm, + bls12_map_fp2_to_g2, +) +from .bls12_381.bls12_381_pairing import bls12_pairing +from .ecrecover import ecrecover +from .identity import identity +from .modexp import modexp +from .p256verify import p256verify +from .point_evaluation import point_evaluation +from .ripemd160 import ripemd160 +from .sha256 import sha256 + +PRE_COMPILED_CONTRACTS: Dict[Address, Callable] = { + ECRECOVER_ADDRESS: ecrecover, + SHA256_ADDRESS: sha256, + RIPEMD160_ADDRESS: ripemd160, + IDENTITY_ADDRESS: identity, + MODEXP_ADDRESS: modexp, + ALT_BN128_ADD_ADDRESS: alt_bn128_add, + ALT_BN128_MUL_ADDRESS: alt_bn128_mul, + ALT_BN128_PAIRING_CHECK_ADDRESS: alt_bn128_pairing_check, + BLAKE2F_ADDRESS: blake2f, + POINT_EVALUATION_ADDRESS: point_evaluation, + BLS12_G1_ADD_ADDRESS: bls12_g1_add, + BLS12_G1_MSM_ADDRESS: bls12_g1_msm, + BLS12_G2_ADD_ADDRESS: bls12_g2_add, + BLS12_G2_MSM_ADDRESS: bls12_g2_msm, + BLS12_PAIRING_ADDRESS: bls12_pairing, + BLS12_MAP_FP_TO_G1_ADDRESS: bls12_map_fp_to_g1, + BLS12_MAP_FP2_TO_G2_ADDRESS: bls12_map_fp2_to_g2, + P256VERIFY_ADDRESS: p256verify, +} diff --git a/src/ethereum/osaka/vm/precompiled_contracts/modexp.py b/src/ethereum/osaka/vm/precompiled_contracts/modexp.py new file mode 100644 index 0000000000..3e217c402c --- /dev/null +++ b/src/ethereum/osaka/vm/precompiled_contracts/modexp.py @@ -0,0 +1,178 @@ +""" +Ethereum Virtual Machine (EVM) MODEXP PRECOMPILED CONTRACT +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementation of the `MODEXP` precompiled contract. +""" +from ethereum_types.bytes import Bytes +from ethereum_types.numeric import U256, Uint + +from ...vm import Evm +from ...vm.exceptions import ExceptionalHalt +from ...vm.gas import charge_gas +from ..memory import buffer_read + + +def modexp(evm: Evm) -> None: + """ + Calculates `(base**exp) % modulus` for arbitrary sized `base`, `exp` and. + `modulus`. The return value is the same length as the modulus. + """ + data = evm.message.data + + # GAS + base_length = U256.from_be_bytes(buffer_read(data, U256(0), U256(32))) + if base_length > U256(1024): + raise ExceptionalHalt("Mod-exp base length is too large") + + exp_length = U256.from_be_bytes(buffer_read(data, U256(32), U256(32))) + if exp_length > U256(1024): + raise ExceptionalHalt("Mod-exp exponent length is too large") + + modulus_length = U256.from_be_bytes(buffer_read(data, U256(64), U256(32))) + if modulus_length > U256(1024): + raise ExceptionalHalt("Mod-exp modulus length is too large") + + exp_start = U256(96) + base_length + + exp_head = U256.from_be_bytes( + buffer_read(data, exp_start, min(U256(32), exp_length)) + ) + + charge_gas( + evm, + gas_cost(base_length, modulus_length, exp_length, exp_head), + ) + + # OPERATION + if base_length == 0 and modulus_length == 0: + evm.output = Bytes() + return + + base = Uint.from_be_bytes(buffer_read(data, U256(96), base_length)) + exp = Uint.from_be_bytes(buffer_read(data, exp_start, exp_length)) + + modulus_start = exp_start + exp_length + modulus = Uint.from_be_bytes( + buffer_read(data, modulus_start, modulus_length) + ) + + if modulus == 0: + evm.output = Bytes(b"\x00") * modulus_length + else: + evm.output = pow(base, exp, modulus).to_bytes( + Uint(modulus_length), "big" + ) + + +def complexity(base_length: U256, modulus_length: U256) -> Uint: + """ + Estimate the complexity of performing a modular exponentiation. + + Parameters + ---------- + + base_length : + Length of the array representing the base integer. + + modulus_length : + Length of the array representing the modulus integer. + + Returns + ------- + + complexity : `Uint` + Complexity of performing the operation. + """ + max_length = max(Uint(base_length), Uint(modulus_length)) + words = (max_length + Uint(7)) // Uint(8) + complexity = Uint(16) + if max_length > Uint(32): + complexity = Uint(2) * words ** Uint(2) + return complexity + + +def iterations(exponent_length: U256, exponent_head: U256) -> Uint: + """ + Calculate the number of iterations required to perform a modular + exponentiation. + + Parameters + ---------- + + exponent_length : + Length of the array representing the exponent integer. + + exponent_head : + First 32 bytes of the exponent (with leading zero padding if it is + shorter than 32 bytes), as a U256. + + Returns + ------- + + iterations : `Uint` + Number of iterations. + """ + if exponent_length <= U256(32) and exponent_head == U256(0): + count = Uint(0) + elif exponent_length <= U256(32): + bit_length = exponent_head.bit_length() + + if bit_length > Uint(0): + bit_length -= Uint(1) + + count = bit_length + else: + length_part = Uint(16) * (Uint(exponent_length) - Uint(32)) + bits_part = exponent_head.bit_length() + + if bits_part > Uint(0): + bits_part -= Uint(1) + + count = length_part + bits_part + + return max(count, Uint(1)) + + +def gas_cost( + base_length: U256, + modulus_length: U256, + exponent_length: U256, + exponent_head: U256, +) -> Uint: + """ + Calculate the gas cost of performing a modular exponentiation. + + Parameters + ---------- + + base_length : + Length of the array representing the base integer. + + modulus_length : + Length of the array representing the modulus integer. + + exponent_length : + Length of the array representing the exponent integer. + + exponent_head : + First 32 bytes of the exponent (with leading zero padding if it is + shorter than 32 bytes), as a U256. + + Returns + ------- + + gas_cost : `Uint` + Gas required for performing the operation. + """ + multiplication_complexity = complexity(base_length, modulus_length) + iteration_count = iterations(exponent_length, exponent_head) + cost = multiplication_complexity * iteration_count + return max(Uint(500), cost) diff --git a/src/ethereum/osaka/vm/precompiled_contracts/p256verify.py b/src/ethereum/osaka/vm/precompiled_contracts/p256verify.py new file mode 100644 index 0000000000..4ea584bd66 --- /dev/null +++ b/src/ethereum/osaka/vm/precompiled_contracts/p256verify.py @@ -0,0 +1,84 @@ +""" +Ethereum Virtual Machine (EVM) P256VERIFY PRECOMPILED CONTRACT +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +.. contents:: Table of Contents + :backlinks: none + :local: +Introduction +------------ +Implementation of the P256VERIFY precompiled contract. +""" +from ethereum_types.numeric import U256 + +from ethereum.crypto.elliptic_curve import ( + SECP256R1N, + SECP256R1P, + is_on_curve_secp256r1, + secp256r1_verify, +) +from ethereum.crypto.hash import Hash32 +from ethereum.exceptions import InvalidSignatureError +from ethereum.utils.byte import left_pad_zero_bytes + +from ...vm import Evm +from ...vm.gas import GAS_P256VERIFY, charge_gas +from ...vm.memory import buffer_read + + +def p256verify(evm: Evm) -> None: + """ + Verifies a P-256 signature. + Parameters + ---------- + evm : + The current EVM frame. + """ + data = evm.message.data + + # GAS + charge_gas(evm, GAS_P256VERIFY) + + if len(data) != 160: + return + + # OPERATION + message_hash_bytes = buffer_read(data, U256(0), U256(32)) + message_hash = Hash32(message_hash_bytes) + r = U256.from_be_bytes(buffer_read(data, U256(32), U256(32))) + s = U256.from_be_bytes(buffer_read(data, U256(64), U256(32))) + public_key_x = U256.from_be_bytes( + buffer_read(data, U256(96), U256(32)) + ) # qx + public_key_y = U256.from_be_bytes( + buffer_read(data, U256(128), U256(32)) + ) # qy + + # Signature component bounds: + # Both r and s MUST satisfy 0 < r < n and 0 < s < n + if r <= U256(0) or r >= SECP256R1N: + return + if s <= U256(0) or s >= SECP256R1N: + return + + # Public key bounds: + # Both qx and qy MUST satisfy 0 ≤ qx < p and 0 ≤ qy < p + if public_key_x < U256(0) or public_key_x >= SECP256R1P: + return + if public_key_y < U256(0) or public_key_y >= SECP256R1P: + return + + # Point validity: The point (qx, qy) MUST satisfy the curve equation + # qy^2 ≡ qx^3 + a*qx + b (mod p) + if not is_on_curve_secp256r1(public_key_x, public_key_y): + return + + # Point should not be at infinity (represented as (0, 0)) + if public_key_x == U256(0) and public_key_y == U256(0): + return + + try: + secp256r1_verify(r, s, public_key_x, public_key_y, message_hash) + except InvalidSignatureError: + return + + evm.output = left_pad_zero_bytes(b"\x01", 32) diff --git a/src/ethereum/osaka/vm/precompiled_contracts/point_evaluation.py b/src/ethereum/osaka/vm/precompiled_contracts/point_evaluation.py new file mode 100644 index 0000000000..188f90f83f --- /dev/null +++ b/src/ethereum/osaka/vm/precompiled_contracts/point_evaluation.py @@ -0,0 +1,72 @@ +""" +Ethereum Virtual Machine (EVM) POINT EVALUATION PRECOMPILED CONTRACT +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementation of the POINT EVALUATION precompiled contract. +""" +from ethereum_types.bytes import Bytes, Bytes32, Bytes48 +from ethereum_types.numeric import U256 + +from ethereum.crypto.kzg import ( + KZGCommitment, + kzg_commitment_to_versioned_hash, + verify_kzg_proof, +) + +from ...vm import Evm +from ...vm.exceptions import KZGProofError +from ...vm.gas import GAS_POINT_EVALUATION, charge_gas + +FIELD_ELEMENTS_PER_BLOB = 4096 +BLS_MODULUS = 52435875175126190479447740508185965837690552500527637822603658699938581184513 # noqa: E501 +VERSIONED_HASH_VERSION_KZG = b"\x01" + + +def point_evaluation(evm: Evm) -> None: + """ + A pre-compile that verifies a KZG proof which claims that a blob + (represented by a commitment) evaluates to a given value at a given point. + + Parameters + ---------- + evm : + The current EVM frame. + + """ + data = evm.message.data + if len(data) != 192: + raise KZGProofError + + versioned_hash = data[:32] + z = Bytes32(data[32:64]) + y = Bytes32(data[64:96]) + commitment = KZGCommitment(data[96:144]) + proof = Bytes48(data[144:192]) + + # GAS + charge_gas(evm, GAS_POINT_EVALUATION) + if kzg_commitment_to_versioned_hash(commitment) != versioned_hash: + raise KZGProofError + + # Verify KZG proof with z and y in big endian format + try: + kzg_proof_verification = verify_kzg_proof(commitment, z, y, proof) + except Exception as e: + raise KZGProofError from e + + if not kzg_proof_verification: + raise KZGProofError + + # Return FIELD_ELEMENTS_PER_BLOB and BLS_MODULUS as padded + # 32 byte big endian values + evm.output = Bytes( + U256(FIELD_ELEMENTS_PER_BLOB).to_be_bytes32() + + U256(BLS_MODULUS).to_be_bytes32() + ) diff --git a/src/ethereum/osaka/vm/precompiled_contracts/ripemd160.py b/src/ethereum/osaka/vm/precompiled_contracts/ripemd160.py new file mode 100644 index 0000000000..6af1086a82 --- /dev/null +++ b/src/ethereum/osaka/vm/precompiled_contracts/ripemd160.py @@ -0,0 +1,43 @@ +""" +Ethereum Virtual Machine (EVM) RIPEMD160 PRECOMPILED CONTRACT +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementation of the `RIPEMD160` precompiled contract. +""" +import hashlib + +from ethereum_types.numeric import Uint + +from ethereum.utils.byte import left_pad_zero_bytes +from ethereum.utils.numeric import ceil32 + +from ...vm import Evm +from ...vm.gas import GAS_RIPEMD160, GAS_RIPEMD160_WORD, charge_gas + + +def ripemd160(evm: Evm) -> None: + """ + Writes the ripemd160 hash to output. + + Parameters + ---------- + evm : + The current EVM frame. + """ + data = evm.message.data + + # GAS + word_count = ceil32(Uint(len(data))) // Uint(32) + charge_gas(evm, GAS_RIPEMD160 + GAS_RIPEMD160_WORD * word_count) + + # OPERATION + hash_bytes = hashlib.new("ripemd160", data).digest() + padded_hash = left_pad_zero_bytes(hash_bytes, 32) + evm.output = padded_hash diff --git a/src/ethereum/osaka/vm/precompiled_contracts/sha256.py b/src/ethereum/osaka/vm/precompiled_contracts/sha256.py new file mode 100644 index 0000000000..db33a37967 --- /dev/null +++ b/src/ethereum/osaka/vm/precompiled_contracts/sha256.py @@ -0,0 +1,40 @@ +""" +Ethereum Virtual Machine (EVM) SHA256 PRECOMPILED CONTRACT +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementation of the `SHA256` precompiled contract. +""" +import hashlib + +from ethereum_types.numeric import Uint + +from ethereum.utils.numeric import ceil32 + +from ...vm import Evm +from ...vm.gas import GAS_SHA256, GAS_SHA256_WORD, charge_gas + + +def sha256(evm: Evm) -> None: + """ + Writes the sha256 hash to output. + + Parameters + ---------- + evm : + The current EVM frame. + """ + data = evm.message.data + + # GAS + word_count = ceil32(Uint(len(data))) // Uint(32) + charge_gas(evm, GAS_SHA256 + GAS_SHA256_WORD * word_count) + + # OPERATION + evm.output = hashlib.sha256(data).digest() diff --git a/src/ethereum/osaka/vm/runtime.py b/src/ethereum/osaka/vm/runtime.py new file mode 100644 index 0000000000..acead2be90 --- /dev/null +++ b/src/ethereum/osaka/vm/runtime.py @@ -0,0 +1,68 @@ +""" +Ethereum Virtual Machine (EVM) Runtime Operations +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Runtime related operations used while executing EVM code. +""" +from typing import Set + +from ethereum_types.bytes import Bytes +from ethereum_types.numeric import Uint, ulen + +from .instructions import Ops + + +def get_valid_jump_destinations(code: Bytes) -> Set[Uint]: + """ + Analyze the evm code to obtain the set of valid jump destinations. + + Valid jump destinations are defined as follows: + * 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. + + Note - Jump destinations are 0-indexed. + + Parameters + ---------- + code : + The EVM code which is to be executed. + + Returns + ------- + valid_jump_destinations: `Set[Uint]` + The set of valid jump destinations in the code. + """ + valid_jump_destinations = set() + pc = Uint(0) + + while pc < ulen(code): + try: + current_opcode = Ops(code[pc]) + except ValueError: + # Skip invalid opcodes, as they don't affect the jumpdest + # analysis. Nevertheless, such invalid opcodes would be caught + # and raised when the interpreter runs. + pc += Uint(1) + continue + + if current_opcode == Ops.JUMPDEST: + valid_jump_destinations.add(pc) + elif Ops.PUSH1.value <= current_opcode.value <= Ops.PUSH32.value: + # If PUSH-N opcodes are encountered, skip the current opcode along + # with the trailing data segment corresponding to the PUSH-N + # opcodes. + push_data_size = current_opcode.value - Ops.PUSH1.value + 1 + pc += Uint(push_data_size) + + pc += Uint(1) + + return valid_jump_destinations diff --git a/src/ethereum/osaka/vm/stack.py b/src/ethereum/osaka/vm/stack.py new file mode 100644 index 0000000000..f28a5b3b88 --- /dev/null +++ b/src/ethereum/osaka/vm/stack.py @@ -0,0 +1,59 @@ +""" +Ethereum Virtual Machine (EVM) Stack +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. contents:: Table of Contents + :backlinks: none + :local: + +Introduction +------------ + +Implementation of the stack operators for the EVM. +""" + +from typing import List + +from ethereum_types.numeric import U256 + +from .exceptions import StackOverflowError, StackUnderflowError + + +def pop(stack: List[U256]) -> U256: + """ + Pops the top item off of `stack`. + + Parameters + ---------- + stack : + EVM stack. + + Returns + ------- + value : `U256` + The top element on the stack. + + """ + if len(stack) == 0: + raise StackUnderflowError + + return stack.pop() + + +def push(stack: List[U256], value: U256) -> None: + """ + Pushes `value` onto `stack`. + + Parameters + ---------- + stack : + EVM stack. + + value : + Item to be pushed onto `stack`. + + """ + if len(stack) == 1024: + raise StackOverflowError + + return stack.append(value) diff --git a/src/ethereum/paris/state.py b/src/ethereum/paris/state.py index dc8422f03c..bc80ff282e 100644 --- a/src/ethereum/paris/state.py +++ b/src/ethereum/paris/state.py @@ -391,31 +391,6 @@ def account_has_storage(state: State, address: Address) -> bool: return address in state._storage_tries -def is_account_empty(state: State, address: Address) -> bool: - """ - Checks if an account has zero nonce, empty code and zero balance. - - Parameters - ---------- - state: - The state - address: - Address of the account that needs to be checked. - - Returns - ------- - is_empty : `bool` - True if an account has zero nonce, empty code and zero balance, - False otherwise. - """ - account = get_account(state, address) - return ( - account.nonce == Uint(0) - and account.code == b"" - and account.balance == 0 - ) - - def account_exists_and_is_empty(state: State, address: Address) -> bool: """ Checks if an account exists and has zero nonce, empty code and zero diff --git a/src/ethereum/paris/transactions.py b/src/ethereum/paris/transactions.py index bd857edcf6..751ed8fff7 100644 --- a/src/ethereum/paris/transactions.py +++ b/src/ethereum/paris/transactions.py @@ -13,7 +13,11 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) from .exceptions import TransactionTypeError from .fork_types import Address @@ -337,15 +341,17 @@ def validate_transaction(tx: Transaction) -> Uint: This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an - `InvalidTransaction` exception if the transaction is invalid. + `InsufficientTransactionGasError` exception if the transaction does not + provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` + exception if the nonce is greater than `2**64 - 2`. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 """ intrinsic_gas = calculate_intrinsic_cost(tx) if intrinsic_gas > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") + raise NonceOverflowError("Nonce too high") return intrinsic_gas diff --git a/src/ethereum/paris/utils/address.py b/src/ethereum/paris/utils/address.py index 3f1163547e..33ffe49643 100644 --- a/src/ethereum/paris/utils/address.py +++ b/src/ethereum/paris/utils/address.py @@ -22,7 +22,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/paris/utils/hexadecimal.py b/src/ethereum/paris/utils/hexadecimal.py index 4eadb75b47..1e1ae8a99b 100644 --- a/src/ethereum/paris/utils/hexadecimal.py +++ b/src/ethereum/paris/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/paris/vm/instructions/environment.py b/src/ethereum/paris/vm/instructions/environment.py index 172ce97d70..2dc640b449 100644 --- a/src/ethereum/paris/vm/instructions/environment.py +++ b/src/ethereum/paris/vm/instructions/environment.py @@ -19,7 +19,7 @@ from ...fork_types import EMPTY_ACCOUNT from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..exceptions import OutOfBoundsRead @@ -71,7 +71,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: @@ -336,7 +336,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: @@ -368,7 +368,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) @@ -464,7 +464,7 @@ def extcodehash(evm: Evm) -> None: The current EVM frame. """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: diff --git a/src/ethereum/paris/vm/instructions/system.py b/src/ethereum/paris/vm/instructions/system.py index dee9ab75c7..adc251acb9 100644 --- a/src/ethereum/paris/vm/instructions/system.py +++ b/src/ethereum/paris/vm/instructions/system.py @@ -29,7 +29,7 @@ from ...utils.address import ( compute_contract_address, compute_create2_contract_address, - to_address, + to_address_masked, ) from .. import ( Evm, @@ -328,7 +328,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -352,11 +352,9 @@ def call(evm: Evm) -> None: code_address = to - create_gas_cost = ( - Uint(0) - if is_account_alive(evm.message.block_env.state, to) or value == 0 - else GAS_NEW_ACCOUNT - ) + create_gas_cost = GAS_NEW_ACCOUNT + if value == 0 or is_account_alive(evm.message.block_env.state, to): + create_gas_cost = Uint(0) transfer_gas_cost = Uint(0) if value == 0 else GAS_CALL_VALUE message_call_gas = calculate_message_call_gas( value, @@ -407,7 +405,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -480,7 +478,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_SELF_DESTRUCT @@ -541,7 +539,7 @@ def delegatecall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) @@ -599,7 +597,7 @@ def staticcall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) diff --git a/src/ethereum/prague/exceptions.py b/src/ethereum/prague/exceptions.py index 6a13bf2c85..898d96beba 100644 --- a/src/ethereum/prague/exceptions.py +++ b/src/ethereum/prague/exceptions.py @@ -107,3 +107,9 @@ class EmptyAuthorizationListError(InvalidTransaction): """ The authorization list in the transaction is empty. """ + + +class InitCodeTooLargeError(InvalidTransaction): + """ + The init code of the transaction is too large. + """ diff --git a/src/ethereum/prague/fork.py b/src/ethereum/prague/fork.py index 815926feb1..14b9b401a7 100644 --- a/src/ethereum/prague/fork.py +++ b/src/ethereum/prague/fork.py @@ -109,7 +109,6 @@ HISTORY_STORAGE_ADDRESS = hex_to_address( "0x0000F90827F1C53a10cb7A02335B175320002935" ) -HISTORY_SERVE_WINDOW = 8192 @dataclass diff --git a/src/ethereum/prague/requests.py b/src/ethereum/prague/requests.py index 6ed423188f..8566459397 100644 --- a/src/ethereum/prague/requests.py +++ b/src/ethereum/prague/requests.py @@ -1,5 +1,5 @@ """ -Requests were introduced in EIP-7685 as a a general purpose framework for +Requests were introduced in EIP-7685 as a general purpose framework for storing contract-triggered requests. It extends the execution header and body with a single field each to store the request information. This inherently exposes the requests to the consensus layer, which can diff --git a/src/ethereum/prague/state.py b/src/ethereum/prague/state.py index 9378584196..b067ed2286 100644 --- a/src/ethereum/prague/state.py +++ b/src/ethereum/prague/state.py @@ -246,7 +246,8 @@ def mark_account_created(state: State, address: Address) -> None: """ Mark an account as having been created in the current transaction. This information is used by `get_storage_original()` to handle an obscure - edgecase. + edgecase, and to respect the constraints added to SELFDESTRUCT by + EIP-6780. The marker is not removed even if the account creation reverts. Since the account cannot have had code prior to its creation and can't call @@ -424,31 +425,6 @@ def account_has_storage(state: State, address: Address) -> bool: return address in state._storage_tries -def is_account_empty(state: State, address: Address) -> bool: - """ - Checks if an account has zero nonce, empty code and zero balance. - - Parameters - ---------- - state: - The state - address: - Address of the account that needs to be checked. - - Returns - ------- - is_empty : `bool` - True if an account has zero nonce, empty code and zero balance, - False otherwise. - """ - account = get_account(state, address) - return ( - account.nonce == Uint(0) - and account.code == b"" - and account.balance == 0 - ) - - def account_exists_and_is_empty(state: State, address: Address) -> bool: """ Checks if an account exists and has zero nonce, empty code and zero diff --git a/src/ethereum/prague/transactions.py b/src/ethereum/prague/transactions.py index 7b3ea49710..b4023f1fea 100644 --- a/src/ethereum/prague/transactions.py +++ b/src/ethereum/prague/transactions.py @@ -13,9 +13,13 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) -from .exceptions import TransactionTypeError +from .exceptions import InitCodeTooLargeError, TransactionTypeError from .fork_types import Address, Authorization, VersionedHash TX_BASE_COST = Uint(21000) @@ -534,21 +538,24 @@ def validate_transaction(tx: Transaction) -> Tuple[Uint, Uint]: This function takes a transaction as a parameter and returns the intrinsic gas cost and the minimum calldata gas cost for the transaction after - validation. It throws an `InvalidTransaction` exception - if the transaction is invalid. + validation. It throws an `InsufficientTransactionGasError` exception if + the transaction does not provide enough gas to cover the intrinsic cost, + and a `NonceOverflowError` exception if the nonce is greater than + `2**64 - 2`. It also raises an `InitCodeTooLargeError` if the code size of + a contract creation transaction exceeds the maximum allowed size. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 [EIP-7623]: https://eips.ethereum.org/EIPS/eip-7623 """ - from .vm.interpreter import MAX_CODE_SIZE + from .vm.interpreter import MAX_INIT_CODE_SIZE intrinsic_gas, calldata_floor_gas_cost = calculate_intrinsic_cost(tx) if max(intrinsic_gas, calldata_floor_gas_cost) > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") - if tx.to == Bytes0(b"") and len(tx.data) > 2 * MAX_CODE_SIZE: - raise InvalidTransaction("Code size too large") + raise NonceOverflowError("Nonce too high") + if tx.to == Bytes0(b"") and len(tx.data) > MAX_INIT_CODE_SIZE: + raise InitCodeTooLargeError("Code size too large") return intrinsic_gas, calldata_floor_gas_cost diff --git a/src/ethereum/prague/utils/address.py b/src/ethereum/prague/utils/address.py index 69c2ce52df..6de19b4d8a 100644 --- a/src/ethereum/prague/utils/address.py +++ b/src/ethereum/prague/utils/address.py @@ -22,7 +22,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/prague/utils/hexadecimal.py b/src/ethereum/prague/utils/hexadecimal.py index ea58c3ef3c..caadfb7423 100644 --- a/src/ethereum/prague/utils/hexadecimal.py +++ b/src/ethereum/prague/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/prague/vm/gas.py b/src/ethereum/prague/vm/gas.py index b3a96ef970..d1526a551a 100644 --- a/src/ethereum/prague/vm/gas.py +++ b/src/ethereum/prague/vm/gas.py @@ -304,8 +304,8 @@ def calculate_excess_blob_gas(parent_header: Header) -> U64: parent_blob_gas = excess_blob_gas + blob_gas_used if parent_blob_gas < TARGET_BLOB_GAS_PER_BLOCK: return U64(0) - else: - return parent_blob_gas - TARGET_BLOB_GAS_PER_BLOCK + + return parent_blob_gas - TARGET_BLOB_GAS_PER_BLOCK def calculate_total_blob_gas(tx: Transaction) -> U64: diff --git a/src/ethereum/prague/vm/instructions/environment.py b/src/ethereum/prague/vm/instructions/environment.py index 5ddd12dac8..226b3d3bb3 100644 --- a/src/ethereum/prague/vm/instructions/environment.py +++ b/src/ethereum/prague/vm/instructions/environment.py @@ -20,7 +20,7 @@ from ...fork_types import EMPTY_ACCOUNT from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..exceptions import OutOfBoundsRead @@ -74,7 +74,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: @@ -339,7 +339,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: @@ -371,7 +371,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) @@ -467,7 +467,7 @@ def extcodehash(evm: Evm) -> None: The current EVM frame. """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: diff --git a/src/ethereum/prague/vm/instructions/system.py b/src/ethereum/prague/vm/instructions/system.py index aa3ae789bd..d7308821bd 100644 --- a/src/ethereum/prague/vm/instructions/system.py +++ b/src/ethereum/prague/vm/instructions/system.py @@ -30,7 +30,7 @@ from ...utils.address import ( compute_contract_address, compute_create2_contract_address, - to_address, + to_address_masked, ) from ...vm.eoa_delegation import access_delegation from .. import ( @@ -73,7 +73,7 @@ def generic_create( # This import causes a circular import error # if it's not moved inside this method from ...vm.interpreter import ( - MAX_CODE_SIZE, + MAX_INIT_CODE_SIZE, STACK_DEPTH_LIMIT, process_create_message, ) @@ -81,7 +81,7 @@ def generic_create( call_data = memory_read_bytes( evm.memory, memory_start_position, memory_size ) - if len(call_data) > 2 * MAX_CODE_SIZE: + if len(call_data) > MAX_INIT_CODE_SIZE: raise OutOfGasError create_message_gas = max_message_call_gas(Uint(evm.gas_left)) @@ -354,7 +354,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -385,11 +385,9 @@ def call(evm: Evm) -> None: ) = access_delegation(evm, code_address) access_gas_cost += delegated_access_gas_cost - create_gas_cost = ( - Uint(0) - if is_account_alive(evm.message.block_env.state, to) or value == 0 - else GAS_NEW_ACCOUNT - ) + create_gas_cost = GAS_NEW_ACCOUNT + if value == 0 or is_account_alive(evm.message.block_env.state, to): + create_gas_cost = Uint(0) transfer_gas_cost = Uint(0) if value == 0 else GAS_CALL_VALUE message_call_gas = calculate_message_call_gas( value, @@ -442,7 +440,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -525,7 +523,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_SELF_DESTRUCT @@ -584,7 +582,7 @@ def delegatecall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) @@ -652,7 +650,7 @@ def staticcall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) diff --git a/src/ethereum/prague/vm/interpreter.py b/src/ethereum/prague/vm/interpreter.py index bd61d38c1f..342becba0e 100644 --- a/src/ethereum/prague/vm/interpreter.py +++ b/src/ethereum/prague/vm/interpreter.py @@ -64,6 +64,7 @@ STACK_DEPTH_LIMIT = Uint(1024) MAX_CODE_SIZE = 0x6000 +MAX_INIT_CODE_SIZE = 2 * MAX_CODE_SIZE @dataclass @@ -187,7 +188,8 @@ def process_create_message(message: Message) -> Evm: # In the previously mentioned edge case the preexisting storage is ignored # for gas refund purposes. In order to do this we must track created - # accounts. + # accounts. This tracking is also needed to respect the constraints + # added to SELFDESTRUCT by EIP-6780. mark_account_created(state, message.current_target) increment_nonce(state, message.current_target) diff --git a/src/ethereum/shanghai/exceptions.py b/src/ethereum/shanghai/exceptions.py index 59968e94e2..8dc6c4d0e1 100644 --- a/src/ethereum/shanghai/exceptions.py +++ b/src/ethereum/shanghai/exceptions.py @@ -56,3 +56,9 @@ class PriorityFeeGreaterThanMaxFeeError(InvalidTransaction): """ The priority fee is greater than the maximum fee per gas. """ + + +class InitCodeTooLargeError(InvalidTransaction): + """ + The init code of the transaction is too large. + """ diff --git a/src/ethereum/shanghai/state.py b/src/ethereum/shanghai/state.py index dc8422f03c..bc80ff282e 100644 --- a/src/ethereum/shanghai/state.py +++ b/src/ethereum/shanghai/state.py @@ -391,31 +391,6 @@ def account_has_storage(state: State, address: Address) -> bool: return address in state._storage_tries -def is_account_empty(state: State, address: Address) -> bool: - """ - Checks if an account has zero nonce, empty code and zero balance. - - Parameters - ---------- - state: - The state - address: - Address of the account that needs to be checked. - - Returns - ------- - is_empty : `bool` - True if an account has zero nonce, empty code and zero balance, - False otherwise. - """ - account = get_account(state, address) - return ( - account.nonce == Uint(0) - and account.code == b"" - and account.balance == 0 - ) - - def account_exists_and_is_empty(state: State, address: Address) -> bool: """ Checks if an account exists and has zero nonce, empty code and zero diff --git a/src/ethereum/shanghai/transactions.py b/src/ethereum/shanghai/transactions.py index 0347cb915d..1dff83bef2 100644 --- a/src/ethereum/shanghai/transactions.py +++ b/src/ethereum/shanghai/transactions.py @@ -13,9 +13,13 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) -from .exceptions import TransactionTypeError +from .exceptions import InitCodeTooLargeError, TransactionTypeError from .fork_types import Address TX_BASE_COST = Uint(21000) @@ -340,19 +344,23 @@ def validate_transaction(tx: Transaction) -> Uint: This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an - `InvalidTransaction` exception if the transaction is invalid. + `InsufficientTransactionGasError` exception if the transaction does not + provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` + exception if the nonce is greater than `2**64 - 2`. It also raises an + `InitCodeTooLargeError` if the code size of a contract creation transaction + exceeds the maximum allowed size. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 """ - from .vm.interpreter import MAX_CODE_SIZE + from .vm.interpreter import MAX_INIT_CODE_SIZE intrinsic_gas = calculate_intrinsic_cost(tx) if intrinsic_gas > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") - if tx.to == Bytes0(b"") and len(tx.data) > 2 * MAX_CODE_SIZE: - raise InvalidTransaction("Code size too large") + raise NonceOverflowError("Nonce too high") + if tx.to == Bytes0(b"") and len(tx.data) > MAX_INIT_CODE_SIZE: + raise InitCodeTooLargeError("Code size too large") return intrinsic_gas diff --git a/src/ethereum/shanghai/utils/address.py b/src/ethereum/shanghai/utils/address.py index 454157e402..225b29b678 100644 --- a/src/ethereum/shanghai/utils/address.py +++ b/src/ethereum/shanghai/utils/address.py @@ -22,7 +22,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/shanghai/utils/hexadecimal.py b/src/ethereum/shanghai/utils/hexadecimal.py index 47f6575f8a..8306e3da5b 100644 --- a/src/ethereum/shanghai/utils/hexadecimal.py +++ b/src/ethereum/shanghai/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/shanghai/vm/instructions/environment.py b/src/ethereum/shanghai/vm/instructions/environment.py index 172ce97d70..2dc640b449 100644 --- a/src/ethereum/shanghai/vm/instructions/environment.py +++ b/src/ethereum/shanghai/vm/instructions/environment.py @@ -19,7 +19,7 @@ from ...fork_types import EMPTY_ACCOUNT from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..exceptions import OutOfBoundsRead @@ -71,7 +71,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: @@ -336,7 +336,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: @@ -368,7 +368,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) @@ -464,7 +464,7 @@ def extcodehash(evm: Evm) -> None: The current EVM frame. """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS if address in evm.accessed_addresses: diff --git a/src/ethereum/shanghai/vm/instructions/system.py b/src/ethereum/shanghai/vm/instructions/system.py index 8d7e8b64f4..1c8d172d7e 100644 --- a/src/ethereum/shanghai/vm/instructions/system.py +++ b/src/ethereum/shanghai/vm/instructions/system.py @@ -29,7 +29,7 @@ from ...utils.address import ( compute_contract_address, compute_create2_contract_address, - to_address, + to_address_masked, ) from .. import ( Evm, @@ -71,7 +71,7 @@ def generic_create( # This import causes a circular import error # if it's not moved inside this method from ...vm.interpreter import ( - MAX_CODE_SIZE, + MAX_INIT_CODE_SIZE, STACK_DEPTH_LIMIT, process_create_message, ) @@ -79,7 +79,7 @@ def generic_create( call_data = memory_read_bytes( evm.memory, memory_start_position, memory_size ) - if len(call_data) > 2 * MAX_CODE_SIZE: + if len(call_data) > MAX_INIT_CODE_SIZE: raise OutOfGasError create_message_gas = max_message_call_gas(Uint(evm.gas_left)) @@ -348,7 +348,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -372,11 +372,9 @@ def call(evm: Evm) -> None: code_address = to - create_gas_cost = ( - Uint(0) - if is_account_alive(evm.message.block_env.state, to) or value == 0 - else GAS_NEW_ACCOUNT - ) + create_gas_cost = GAS_NEW_ACCOUNT + if value == 0 or is_account_alive(evm.message.block_env.state, to): + create_gas_cost = Uint(0) transfer_gas_cost = Uint(0) if value == 0 else GAS_CALL_VALUE message_call_gas = calculate_message_call_gas( value, @@ -427,7 +425,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -500,7 +498,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_SELF_DESTRUCT @@ -561,7 +559,7 @@ def delegatecall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) @@ -619,7 +617,7 @@ def staticcall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) diff --git a/src/ethereum/shanghai/vm/interpreter.py b/src/ethereum/shanghai/vm/interpreter.py index 4218e3b4ef..f962e6d1a1 100644 --- a/src/ethereum/shanghai/vm/interpreter.py +++ b/src/ethereum/shanghai/vm/interpreter.py @@ -62,6 +62,7 @@ STACK_DEPTH_LIMIT = Uint(1024) MAX_CODE_SIZE = 0x6000 +MAX_INIT_CODE_SIZE = 2 * MAX_CODE_SIZE @dataclass diff --git a/src/ethereum/spurious_dragon/state.py b/src/ethereum/spurious_dragon/state.py index 49c86fcc3d..8d14219bbe 100644 --- a/src/ethereum/spurious_dragon/state.py +++ b/src/ethereum/spurious_dragon/state.py @@ -365,31 +365,6 @@ def account_has_storage(state: State, address: Address) -> bool: return address in state._storage_tries -def is_account_empty(state: State, address: Address) -> bool: - """ - Checks if an account has zero nonce, empty code and zero balance. - - Parameters - ---------- - state: - The state - address: - Address of the account that needs to be checked. - - Returns - ------- - is_empty : `bool` - True if an account has zero nonce, empty code and zero balance, - False otherwise. - """ - account = get_account(state, address) - return ( - account.nonce == Uint(0) - and account.code == b"" - and account.balance == 0 - ) - - def account_exists_and_is_empty(state: State, address: Address) -> bool: """ Checks if an account exists and has zero nonce, empty code and zero diff --git a/src/ethereum/spurious_dragon/transactions.py b/src/ethereum/spurious_dragon/transactions.py index 5d84645388..7474ad74b6 100644 --- a/src/ethereum/spurious_dragon/transactions.py +++ b/src/ethereum/spurious_dragon/transactions.py @@ -12,7 +12,11 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) from .fork_types import Address @@ -110,15 +114,17 @@ def validate_transaction(tx: Transaction) -> Uint: This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an - `InvalidTransaction` exception if the transaction is invalid. + `InsufficientTransactionGasError` exception if the transaction does not + provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` + exception if the nonce is greater than `2**64 - 2`. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 """ intrinsic_gas = calculate_intrinsic_cost(tx) if intrinsic_gas > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") + raise NonceOverflowError("Nonce too high") return intrinsic_gas diff --git a/src/ethereum/spurious_dragon/utils/address.py b/src/ethereum/spurious_dragon/utils/address.py index 7d77d0ada9..1340256039 100644 --- a/src/ethereum/spurious_dragon/utils/address.py +++ b/src/ethereum/spurious_dragon/utils/address.py @@ -21,7 +21,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/spurious_dragon/utils/hexadecimal.py b/src/ethereum/spurious_dragon/utils/hexadecimal.py index 5ba33f706a..8ee17cb5c8 100644 --- a/src/ethereum/spurious_dragon/utils/hexadecimal.py +++ b/src/ethereum/spurious_dragon/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/spurious_dragon/vm/instructions/environment.py b/src/ethereum/spurious_dragon/vm/instructions/environment.py index 36215ecb1a..cb9d3d69c6 100644 --- a/src/ethereum/spurious_dragon/vm/instructions/environment.py +++ b/src/ethereum/spurious_dragon/vm/instructions/environment.py @@ -17,7 +17,7 @@ from ethereum.utils.numeric import ceil32 from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..gas import ( @@ -66,7 +66,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_BALANCE) @@ -327,7 +327,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_EXTERNAL) @@ -353,7 +353,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) diff --git a/src/ethereum/spurious_dragon/vm/instructions/system.py b/src/ethereum/spurious_dragon/vm/instructions/system.py index c5fc04760e..485ba9ce59 100644 --- a/src/ethereum/spurious_dragon/vm/instructions/system.py +++ b/src/ethereum/spurious_dragon/vm/instructions/system.py @@ -24,7 +24,7 @@ is_account_alive, set_account_balance, ) -from ...utils.address import compute_contract_address, to_address +from ...utils.address import compute_contract_address, to_address_masked from .. import ( Evm, Message, @@ -244,7 +244,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -262,11 +262,9 @@ def call(evm: Evm) -> None: code_address = to - create_gas_cost = ( - Uint(0) - if is_account_alive(evm.message.block_env.state, to) or value == 0 - else GAS_NEW_ACCOUNT - ) + create_gas_cost = GAS_NEW_ACCOUNT + if value == 0 or is_account_alive(evm.message.block_env.state, to): + create_gas_cost = Uint(0) transfer_gas_cost = Uint(0) if value == 0 else GAS_CALL_VALUE message_call_gas = calculate_message_call_gas( value, @@ -315,7 +313,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -379,7 +377,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_SELF_DESTRUCT @@ -448,7 +446,7 @@ def delegatecall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) diff --git a/src/ethereum/tangerine_whistle/transactions.py b/src/ethereum/tangerine_whistle/transactions.py index 777e9d8fdf..ca3591a720 100644 --- a/src/ethereum/tangerine_whistle/transactions.py +++ b/src/ethereum/tangerine_whistle/transactions.py @@ -12,7 +12,11 @@ from ethereum.crypto.elliptic_curve import SECP256K1N, secp256k1_recover from ethereum.crypto.hash import Hash32, keccak256 -from ethereum.exceptions import InvalidSignatureError, InvalidTransaction +from ethereum.exceptions import ( + InsufficientTransactionGasError, + InvalidSignatureError, + NonceOverflowError, +) from .fork_types import Address @@ -110,15 +114,17 @@ def validate_transaction(tx: Transaction) -> Uint: This function takes a transaction as a parameter and returns the intrinsic gas cost of the transaction after validation. It throws an - `InvalidTransaction` exception if the transaction is invalid. + `InsufficientTransactionGasError` exception if the transaction does not + provide enough gas to cover the intrinsic cost, and a `NonceOverflowError` + exception if the nonce is greater than `2**64 - 2`. [EIP-2681]: https://eips.ethereum.org/EIPS/eip-2681 """ intrinsic_gas = calculate_intrinsic_cost(tx) if intrinsic_gas > tx.gas: - raise InvalidTransaction("Insufficient gas") + raise InsufficientTransactionGasError("Insufficient gas") if U256(tx.nonce) >= U256(U64.MAX_VALUE): - raise InvalidTransaction("Nonce too high") + raise NonceOverflowError("Nonce too high") return intrinsic_gas diff --git a/src/ethereum/tangerine_whistle/utils/address.py b/src/ethereum/tangerine_whistle/utils/address.py index b553057e76..c7e43f0bdc 100644 --- a/src/ethereum/tangerine_whistle/utils/address.py +++ b/src/ethereum/tangerine_whistle/utils/address.py @@ -21,7 +21,7 @@ from ..fork_types import Address -def to_address(data: Uint | U256) -> Address: +def to_address_masked(data: Uint | U256) -> Address: """ Convert a Uint or U256 value to a valid address (20 bytes). diff --git a/src/ethereum/tangerine_whistle/utils/hexadecimal.py b/src/ethereum/tangerine_whistle/utils/hexadecimal.py index e37e6c5113..9b349999bd 100644 --- a/src/ethereum/tangerine_whistle/utils/hexadecimal.py +++ b/src/ethereum/tangerine_whistle/utils/hexadecimal.py @@ -16,7 +16,7 @@ from ethereum.utils.hexadecimal import remove_hex_prefix -from ..fork_types import Address, Bloom, Root +from ..fork_types import Address, Root def hex_to_root(hex_string: str) -> Root: @@ -36,23 +36,6 @@ def hex_to_root(hex_string: str) -> Root: return Root(Bytes.fromhex(remove_hex_prefix(hex_string))) -def hex_to_bloom(hex_string: str) -> Bloom: - """ - Convert hex string to bloom. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to bloom. - - Returns - ------- - bloom : `Bloom` - Bloom obtained from the given hexadecimal string. - """ - return Bloom(Bytes.fromhex(remove_hex_prefix(hex_string))) - - def hex_to_address(hex_string: str) -> Address: """ Convert hex string to Address (20 bytes). diff --git a/src/ethereum/tangerine_whistle/vm/instructions/environment.py b/src/ethereum/tangerine_whistle/vm/instructions/environment.py index 36215ecb1a..cb9d3d69c6 100644 --- a/src/ethereum/tangerine_whistle/vm/instructions/environment.py +++ b/src/ethereum/tangerine_whistle/vm/instructions/environment.py @@ -17,7 +17,7 @@ from ethereum.utils.numeric import ceil32 from ...state import get_account -from ...utils.address import to_address +from ...utils.address import to_address_masked from ...vm.memory import buffer_read, memory_write from .. import Evm from ..gas import ( @@ -66,7 +66,7 @@ def balance(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_BALANCE) @@ -327,7 +327,7 @@ def extcodesize(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) # GAS charge_gas(evm, GAS_EXTERNAL) @@ -353,7 +353,7 @@ def extcodecopy(evm: Evm) -> None: """ # STACK - address = to_address(pop(evm.stack)) + address = to_address_masked(pop(evm.stack)) memory_start_index = pop(evm.stack) code_start_index = pop(evm.stack) size = pop(evm.stack) diff --git a/src/ethereum/tangerine_whistle/vm/instructions/system.py b/src/ethereum/tangerine_whistle/vm/instructions/system.py index 78711a7cd3..3a1b648b9f 100644 --- a/src/ethereum/tangerine_whistle/vm/instructions/system.py +++ b/src/ethereum/tangerine_whistle/vm/instructions/system.py @@ -23,7 +23,7 @@ increment_nonce, set_account_balance, ) -from ...utils.address import compute_contract_address, to_address +from ...utils.address import compute_contract_address, to_address_masked from .. import ( Evm, Message, @@ -243,7 +243,7 @@ def call(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - to = to_address(pop(evm.stack)) + to = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -311,7 +311,7 @@ def callcode(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) value = pop(evm.stack) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) @@ -375,7 +375,7 @@ def selfdestruct(evm: Evm) -> None: The current EVM frame. """ # STACK - beneficiary = to_address(pop(evm.stack)) + beneficiary = to_address_masked(pop(evm.stack)) # GAS gas_cost = GAS_SELF_DESTRUCT @@ -435,7 +435,7 @@ def delegatecall(evm: Evm) -> None: """ # STACK gas = Uint(pop(evm.stack)) - code_address = to_address(pop(evm.stack)) + code_address = to_address_masked(pop(evm.stack)) memory_input_start_position = pop(evm.stack) memory_input_size = pop(evm.stack) memory_output_start_position = pop(evm.stack) diff --git a/src/ethereum/utils/hexadecimal.py b/src/ethereum/utils/hexadecimal.py index fb5090a957..27185898b2 100644 --- a/src/ethereum/utils/hexadecimal.py +++ b/src/ethereum/utils/hexadecimal.py @@ -11,7 +11,7 @@ Hexadecimal strings specific utility functions used in this specification. """ -from ethereum_types.bytes import Bytes, Bytes8, Bytes20, Bytes32, Bytes256 +from ethereum_types.bytes import Bytes, Bytes8, Bytes32, Bytes256 from ethereum_types.numeric import U8, U64, U256, Uint from ethereum.crypto.hash import Hash32 @@ -89,23 +89,6 @@ def hex_to_bytes8(hex_string: str) -> Bytes8: return Bytes8(Bytes.fromhex(remove_hex_prefix(hex_string).rjust(16, "0"))) -def hex_to_bytes20(hex_string: str) -> Bytes20: - """ - Convert hex string to 20 bytes. - - Parameters - ---------- - hex_string : - The hexadecimal string to be converted to 20 bytes. - - Returns - ------- - 20_byte_stream : `Bytes20` - 20-byte stream corresponding to the given hexadecimal string. - """ - return Bytes20(Bytes.fromhex(remove_hex_prefix(hex_string).rjust(20, "0"))) - - def hex_to_bytes32(hex_string: str) -> Bytes32: """ Convert hex string to 32 bytes. diff --git a/src/ethereum_spec_tools/cli_forks.py b/src/ethereum_spec_tools/cli_forks.py new file mode 100644 index 0000000000..ef213be925 --- /dev/null +++ b/src/ethereum_spec_tools/cli_forks.py @@ -0,0 +1,158 @@ +""" +CLI tool that queries Ethereum hardfork information +""" + +import argparse +import sys +from pathlib import Path +from typing import List, Optional + +try: + from ethereum_spec_tools.forks import Hardfork +except ImportError: + sys.path.insert(0, str(Path(__file__).parent.parent)) + from hardfork import Hardfork + + +def fork_by_index(forks: List[Hardfork], index: int) -> Optional[Hardfork]: + """ + Get fork by index, where 0 being Frontier and -1 being the most recent. + """ + if not forks: + return None + + if index < 0: + # Negative indexing: -1 is last, -2 is second last, etc. + if abs(index) <= len(forks): + return forks[index] + else: + return None + else: + # Positive indexing: 0 is first (Frontier), 1 is second, etc. + if index < len(forks): + return forks[index] + else: + return None + +def format_fork_info(fork: Hardfork, format_type: str) -> str: + """ + Format fork information based on the requested format type. + """ + if format_type == "name": + return fork.short_name + elif format_type == "title": + return fork.title_case_name + elif format_type == "full-name": + return fork.name + elif format_type == "test-name": + return f"test_{fork.short_name}" + elif format_type == "criteria": + return str(fork.criteria) + elif format_type == "consensus": + return fork.consensus.name.lower() + else: + return fork.short_name + + +def main() -> None: + """ + Main entry point for the CLI. + """ + parser = argparse.ArgumentParser( + prog="ethereum-spec-forks", + description="Query Ethereum hardfork information for testing and development", + ) + + group = parser.add_mutually_exclusive_group() + + group.add_argument( + "-n", "--fork-number", + type=int, + help="Fork number (0=Frontier, -1=most recent, etc.)", + ) + + # Format options (mutually exclusive) + format_group = parser.add_mutually_exclusive_group() + + format_group.add_argument( + "--name", + action="store_true", + help="Output short name (default)", + ) + + format_group.add_argument( + "--title", + action="store_true", + help="Output title case name", + ) + + format_group.add_argument( + "--full-name", + action="store_true", + help="Output full module name", + ) + + format_group.add_argument( + "--test-name", + action="store_true", + help="Output test name format", + ) + + format_group.add_argument( + "--criteria", + action="store_true", + help="Output fork criteria", + ) + + format_group.add_argument( + "--consensus", + action="store_true", + help="Output consensus type", + ) + + # Base path option for development + parser.add_argument( + "--base-path", + type=Path, + help="Base path to ethereum module (for development)", + ) + + args = parser.parse_args() + + try: + forks = Hardfork.discover(base=args.base_path) + except Exception as e: + print(f"Error discovering forks: {e}", file=sys.stderr) + sys.exit(1) + + if not forks: + print("No forks found", file=sys.stderr) + sys.exit(1) + + if args.fork_number is not None: + fork = fork_by_index(forks, args.fork_number) + if fork is None: + print(f"Fork index {args.fork_number} not found", file=sys.stderr) + sys.exit(1) + + if args.title: + format_type = "title" + elif args.full_name: + format_type = "full-name" + elif args.test_name: + format_type = "test-name" + elif args.criteria: + format_type = "criteria" + elif args.consensus: + format_type = "consensus" + else: + format_type = "name" + + print(format_fork_info(fork, format_type)) + return + + parser.print_help() + + +if __name__ == "__main__": + main() diff --git a/src/ethereum_spec_tools/evm_tools/loaders/fork_loader.py b/src/ethereum_spec_tools/evm_tools/loaders/fork_loader.py index e7899b3a85..fb88754c09 100644 --- a/src/ethereum_spec_tools/evm_tools/loaders/fork_loader.py +++ b/src/ethereum_spec_tools/evm_tools/loaders/fork_loader.py @@ -307,6 +307,31 @@ def TARGET_BLOB_GAS_PER_BLOCK(self) -> Any: """TARGET_BLOB_GAS_PER_BLOCK of the fork""" return self._module("vm.gas").TARGET_BLOB_GAS_PER_BLOCK + @property + def GAS_PER_BLOB(self) -> Any: + """GAS_PER_BLOB of the fork""" + return self._module("vm.gas").GAS_PER_BLOB + + @property + def BLOB_BASE_COST(self) -> Any: + """BLOB_BASE_COST of the fork""" + return self._module("vm.gas").BLOB_BASE_COST + + @property + def BLOB_SCHEDULE_MAX(self) -> Any: + """BLOB_SCHEDULE_MAX of the fork""" + return self._module("vm.gas").BLOB_SCHEDULE_MAX + + @property + def BLOB_SCHEDULE_TARGET(self) -> Any: + """BLOB_SCHEDULE_TARGET of the fork""" + return self._module("vm.gas").BLOB_SCHEDULE_TARGET + + @property + def calculate_blob_gas_price(self) -> Any: + """calculate_blob_gas_price of the fork""" + return self._module("vm.gas").calculate_blob_gas_price + @property def apply_dao(self) -> Any: """apply_dao function of the fork""" diff --git a/src/ethereum_spec_tools/evm_tools/t8n/env.py b/src/ethereum_spec_tools/evm_tools/t8n/env.py index 2b6dc58814..9a9a0bf7d4 100644 --- a/src/ethereum_spec_tools/evm_tools/t8n/env.py +++ b/src/ethereum_spec_tools/evm_tools/t8n/env.py @@ -102,7 +102,6 @@ def read_excess_blob_gas(self, data: Any, t8n: "T8N") -> None: self.excess_blob_gas = parse_hex_or_int( data["currentExcessBlobGas"], U64 ) - return if "parentExcessBlobGas" in data: self.parent_excess_blob_gas = parse_hex_or_int( @@ -114,15 +113,51 @@ def read_excess_blob_gas(self, data: Any, t8n: "T8N") -> None: data["parentBlobGasUsed"], U64 ) - excess_blob_gas = ( + if self.excess_blob_gas is not None: + return + + assert self.parent_excess_blob_gas is not None + assert self.parent_blob_gas_used is not None + + parent_blob_gas = ( self.parent_excess_blob_gas + self.parent_blob_gas_used ) target_blob_gas_per_block = t8n.fork.TARGET_BLOB_GAS_PER_BLOCK - self.excess_blob_gas = U64(0) - if excess_blob_gas >= target_blob_gas_per_block: - self.excess_blob_gas = excess_blob_gas - target_blob_gas_per_block + if parent_blob_gas < target_blob_gas_per_block: + self.excess_blob_gas = U64(0) + else: + self.excess_blob_gas = parent_blob_gas - target_blob_gas_per_block + + if t8n.fork.is_after_fork("ethereum.osaka"): + # Under certain conditions specified in EIP-7918, the + # the excess_blob_gas is calculated differently in osaka + assert self.parent_base_fee_per_gas is not None + + GAS_PER_BLOB = t8n.fork.GAS_PER_BLOB + BLOB_BASE_COST = t8n.fork.BLOB_BASE_COST + BLOB_SCHEDULE_MAX = t8n.fork.BLOB_SCHEDULE_MAX + BLOB_SCHEDULE_TARGET = t8n.fork.BLOB_SCHEDULE_TARGET + + target_blob_gas_price = Uint(GAS_PER_BLOB) + target_blob_gas_price *= t8n.fork.calculate_blob_gas_price( + self.parent_excess_blob_gas + ) + + base_blob_tx_price = ( + BLOB_BASE_COST * self.parent_base_fee_per_gas + ) + if base_blob_tx_price > target_blob_gas_price: + blob_schedule_delta = ( + BLOB_SCHEDULE_MAX - BLOB_SCHEDULE_TARGET + ) + self.excess_blob_gas = ( + self.parent_excess_blob_gas + + self.parent_blob_gas_used + * blob_schedule_delta + // BLOB_SCHEDULE_MAX + ) def read_base_fee_per_gas(self, data: Any, t8n: "T8N") -> None: """ @@ -139,16 +174,27 @@ def read_base_fee_per_gas(self, data: Any, t8n: "T8N") -> None: self.base_fee_per_gas = parse_hex_or_int( data["currentBaseFee"], Uint ) - else: + + if "parentGasUsed" in data: self.parent_gas_used = parse_hex_or_int( data["parentGasUsed"], Uint ) + + if "parentGasLimit" in data: self.parent_gas_limit = parse_hex_or_int( data["parentGasLimit"], Uint ) + + if "parentBaseFee" in data: self.parent_base_fee_per_gas = parse_hex_or_int( data["parentBaseFee"], Uint ) + + if self.base_fee_per_gas is None: + assert self.parent_gas_limit is not None + assert self.parent_gas_used is not None + assert self.parent_base_fee_per_gas is not None + parameters: List[object] = [ self.block_gas_limit, self.parent_gas_limit, diff --git a/src/ethereum_spec_tools/evm_tools/t8n/transition_tool.py b/src/ethereum_spec_tools/evm_tools/t8n/transition_tool.py new file mode 100644 index 0000000000..c84503cfb0 --- /dev/null +++ b/src/ethereum_spec_tools/evm_tools/t8n/transition_tool.py @@ -0,0 +1,128 @@ +""" +Implementation of the EELS T8N for execution-spec-tests. +""" + +import json +import tempfile +from io import StringIO +from typing import Any, Dict, Optional + +from ethereum_clis.clis.execution_specs import ExecutionSpecsExceptionMapper +from ethereum_clis.file_utils import dump_files_to_directory +from ethereum_clis.transition_tool import TransitionTool, model_dump_config +from ethereum_clis.types import TransitionToolOutput +from ethereum_test_forks import Fork + +import ethereum + +from .. import create_parser +from ..utils import get_supported_forks +from . import T8N + + +class EELST8N(TransitionTool): + """Implementation of the EELS T8N for execution-spec-tests.""" + + def __init__( + self, + *, + trace: bool = False, + ): + """Initialize the EELS Transition Tool interface.""" + self.exception_mapper = ExecutionSpecsExceptionMapper() + self.trace = trace + self._info_metadata: Optional[Dict[str, Any]] = {} + + def version(self) -> str: + """Version of the t8n tool.""" + return ethereum.__version__ + + def is_fork_supported(self, fork: Fork) -> bool: + """Return True if the fork is supported by the tool.""" + return fork.transition_tool_name() in get_supported_forks() + + def evaluate( + self, + *, + transition_tool_data: TransitionTool.TransitionToolData, + debug_output_path: str = "", + slow_request: bool = False, # noqa: U100, F841 + ) -> TransitionToolOutput: + """ + Evaluate using the EELS T8N entry point. + """ + request_data = transition_tool_data.get_request_data() + request_data_json = request_data.model_dump( + mode="json", **model_dump_config + ) + + t8n_args = [ + "t8n", + "--input.alloc=stdin", + "--input.env=stdin", + "--input.txs=stdin", + "--output.result=stdout", + "--output.body=stdout", + "--output.alloc=stdout", + f"--state.fork={request_data_json['state']['fork']}", + f"--state.chainid={request_data_json['state']['chainid']}", + f"--state.reward={request_data_json['state']['reward']}", + ] + + if transition_tool_data.state_test: + t8n_args.append("--state-test") + + temp_dir = tempfile.TemporaryDirectory() + if self.trace: + t8n_args.extend( + [ + "--trace", + "--trace.memory", + "--trace.returndata", + f"--output.basedir={temp_dir.name}", + ] + ) + + parser = create_parser() + t8n_options = parser.parse_args(t8n_args) + + out_stream = StringIO() + + in_stream = StringIO(json.dumps(request_data_json["input"])) + + t8n = T8N(t8n_options, out_stream, in_stream) + t8n.run() + + output_dict = json.loads(out_stream.getvalue()) + output: TransitionToolOutput = TransitionToolOutput.model_validate( + output_dict, context={"exception_mapper": self.exception_mapper} + ) + + if debug_output_path: + dump_files_to_directory( + debug_output_path, + { + "input/alloc.json": request_data.input.alloc, + "input/env.json": request_data.input.env, + "input/txs.json": [ + tx.model_dump(mode="json", **model_dump_config) + for tx in request_data.input.txs + ], + }, + ) + + dump_files_to_directory( + debug_output_path, + { + "output/alloc.json": output.alloc, + "output/result.json": output.result, + }, + ) + + if self.trace: + self.collect_traces( + output.result.receipts, temp_dir, debug_output_path + ) + temp_dir.cleanup() + + return output diff --git a/src/ethereum_spec_tools/evm_tools/utils.py b/src/ethereum_spec_tools/evm_tools/utils.py index fb4ea8870f..fe1225300b 100644 --- a/src/ethereum_spec_tools/evm_tools/utils.py +++ b/src/ethereum_spec_tools/evm_tools/utils.py @@ -81,17 +81,6 @@ class FatalException(Exception): pass -def ensure_success(f: Callable, *args: Any) -> Any: - """ - Ensure that the function call succeeds. - Raise a FatalException if it fails. - """ - try: - return f(*args) - except Exception as e: - raise FatalException(e) - - def get_module_name( forks: Sequence[Hardfork], options: Any, stdin: Any ) -> Tuple[str, int]: diff --git a/src/ethereum_spec_tools/sync.py b/src/ethereum_spec_tools/sync.py index fb4ad4df9c..78a62d8101 100644 --- a/src/ethereum_spec_tools/sync.py +++ b/src/ethereum_spec_tools/sync.py @@ -593,37 +593,6 @@ def make_block(self, json: Any, ommers: Any) -> Any: *extra_fields, ) - def download_chain_id(self) -> U64: - """ - Fetch the chain id of the executing chain from the rpc provider. - """ - call = [ - { - "jsonrpc": "2.0", - "id": hex(2), - "method": "eth_chainId", - "params": [], - } - ] - data = json.dumps(call).encode("utf-8") - - post = request.Request( - self.rpc_url, - data=data, - headers={ - "Content-Length": str(len(data)), - "Content-Type": "application/json", - "User-Agent": "ethereum-spec-sync", - }, - ) - - with request.urlopen(post) as response: - reply = json.load(response)[0] - assert reply["id"] == hex(2) - chain_id = U64(int(reply["result"], 16)) - - return chain_id - class Sync(ForkTracking): """ diff --git a/tests/berlin/test_rlp.py b/tests/berlin/test_rlp.py index c068736373..59e92f320e 100644 --- a/tests/berlin/test_rlp.py +++ b/tests/berlin/test_rlp.py @@ -25,7 +25,6 @@ address1 = hex_to_address("0x00000000219ab540356cbb839cbe05303d7705fa") address2 = hex_to_address("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2") -address3 = hex_to_address("0xbe0eb53f46cd790cd13851d5eff43d12404d33e8") bloom = hex_to_bytes256( "0x886480c00200620d84180d0470000c503081160044d05015808" diff --git a/tests/berlin/test_transaction.py b/tests/berlin/test_transaction.py index ce5fc68e21..8e2422201c 100644 --- a/tests/berlin/test_transaction.py +++ b/tests/berlin/test_transaction.py @@ -7,7 +7,7 @@ LegacyTransaction, validate_transaction, ) -from ethereum.exceptions import InvalidTransaction +from ethereum.exceptions import NonceOverflowError from ethereum.utils.hexadecimal import hex_to_uint from tests.helpers import TEST_FIXTURES @@ -33,7 +33,7 @@ def test_high_nonce(test_file_high_nonce: str) -> None: tx = rlp.decode_to(LegacyTransaction, test["tx_rlp"]) - with pytest.raises(InvalidTransaction): + with pytest.raises(NonceOverflowError): validate_transaction(tx) diff --git a/tests/byzantium/test_rlp.py b/tests/byzantium/test_rlp.py index fa0985ac9c..83a15b2e30 100644 --- a/tests/byzantium/test_rlp.py +++ b/tests/byzantium/test_rlp.py @@ -18,7 +18,6 @@ address1 = hex_to_address("0x00000000219ab540356cbb839cbe05303d7705fa") address2 = hex_to_address("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2") -address3 = hex_to_address("0xbe0eb53f46cd790cd13851d5eff43d12404d33e8") bloom = hex_to_bytes256( "0x886480c00200620d84180d0470000c503081160044d05015808" diff --git a/tests/byzantium/test_transaction.py b/tests/byzantium/test_transaction.py index acb3e9070c..357ad15d2c 100644 --- a/tests/byzantium/test_transaction.py +++ b/tests/byzantium/test_transaction.py @@ -4,7 +4,7 @@ from ethereum_rlp import rlp from ethereum.byzantium.transactions import Transaction, validate_transaction -from ethereum.exceptions import InvalidTransaction +from ethereum.exceptions import NonceOverflowError from ethereum.utils.hexadecimal import hex_to_uint from tests.helpers import TEST_FIXTURES @@ -32,7 +32,7 @@ def test_high_nonce(test_file_high_nonce: str) -> None: tx = rlp.decode_to(Transaction, test["tx_rlp"]) - with pytest.raises(InvalidTransaction): + with pytest.raises(NonceOverflowError): validate_transaction(tx) diff --git a/tests/cancun/test_rlp.py b/tests/cancun/test_rlp.py index df74a99b87..d0752de8ef 100644 --- a/tests/cancun/test_rlp.py +++ b/tests/cancun/test_rlp.py @@ -26,7 +26,6 @@ address1 = hex_to_address("0x00000000219ab540356cbb839cbe05303d7705fa") address2 = hex_to_address("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2") -address3 = hex_to_address("0xbe0eb53f46cd790cd13851d5eff43d12404d33e8") bloom = hex_to_bytes256( "0x886480c00200620d84180d0470000c503081160044d05015808" diff --git a/tests/constantinople/test_rlp.py b/tests/constantinople/test_rlp.py index bdb13cc502..f8e4312082 100644 --- a/tests/constantinople/test_rlp.py +++ b/tests/constantinople/test_rlp.py @@ -18,7 +18,6 @@ address1 = hex_to_address("0x00000000219ab540356cbb839cbe05303d7705fa") address2 = hex_to_address("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2") -address3 = hex_to_address("0xbe0eb53f46cd790cd13851d5eff43d12404d33e8") bloom = hex_to_bytes256( "0x886480c00200620d84180d0470000c503081160044d05015808" diff --git a/tests/constantinople/test_transaction.py b/tests/constantinople/test_transaction.py index b11626d45d..4a302fb14b 100644 --- a/tests/constantinople/test_transaction.py +++ b/tests/constantinople/test_transaction.py @@ -7,7 +7,7 @@ Transaction, validate_transaction, ) -from ethereum.exceptions import InvalidTransaction +from ethereum.exceptions import NonceOverflowError from ethereum.utils.hexadecimal import hex_to_uint from tests.helpers import TEST_FIXTURES @@ -35,7 +35,7 @@ def test_high_nonce(test_file_high_nonce: str) -> None: tx = rlp.decode_to(Transaction, test["tx_rlp"]) - with pytest.raises(InvalidTransaction): + with pytest.raises(NonceOverflowError): validate_transaction(tx) diff --git a/tests/evm_tools/test_b11r.py b/tests/evm_tools/test_b11r.py index 9764e25a32..6f13972a6a 100644 --- a/tests/evm_tools/test_b11r.py +++ b/tests/evm_tools/test_b11r.py @@ -38,13 +38,6 @@ def idfn(test_case: Dict) -> str: return test_case["name"] -def get_rejected_indices(rejected: Dict) -> List[int]: - rejected_indices = [] - for item in rejected: - rejected_indices.append(item["index"]) - return rejected_indices - - def b11r_tool_test(test_case: Dict) -> None: options = parser.parse_args(test_case["args"]) diff --git a/tests/frontier/test_rlp.py b/tests/frontier/test_rlp.py index c39b6ae15e..f7289e5c46 100644 --- a/tests/frontier/test_rlp.py +++ b/tests/frontier/test_rlp.py @@ -18,7 +18,6 @@ address1 = hex_to_address("0x00000000219ab540356cbb839cbe05303d7705fa") address2 = hex_to_address("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2") -address3 = hex_to_address("0xbe0eb53f46cd790cd13851d5eff43d12404d33e8") bloom = hex_to_bytes256( "0x886480c00200620d84180d0470000c503081160044d05015808" diff --git a/tests/frontier/test_transaction.py b/tests/frontier/test_transaction.py index a2e72140d4..628b9c1787 100644 --- a/tests/frontier/test_transaction.py +++ b/tests/frontier/test_transaction.py @@ -3,7 +3,7 @@ import pytest from ethereum_rlp import rlp -from ethereum.exceptions import InvalidTransaction +from ethereum.exceptions import NonceOverflowError from ethereum.frontier.transactions import Transaction, validate_transaction from ethereum.utils.hexadecimal import hex_to_uint from tests.helpers import TEST_FIXTURES @@ -30,7 +30,7 @@ def test_high_nonce(test_file_high_nonce: str) -> None: tx = rlp.decode_to(Transaction, test["tx_rlp"]) - with pytest.raises(InvalidTransaction): + with pytest.raises(NonceOverflowError): validate_transaction(tx) diff --git a/tests/helpers/__init__.py b/tests/helpers/__init__.py index e289a14b88..72644dedb0 100644 --- a/tests/helpers/__init__.py +++ b/tests/helpers/__init__.py @@ -26,8 +26,14 @@ class _FixtureSource(TypedDict): "url": "https://github.com/ethereum/execution-spec-tests/releases/download/v4.5.0/fixtures_stable.tar.gz", "fixture_path": "tests/fixtures/latest_fork_tests", }, + "osaka_tests": { + "url": "https://github.com/ethereum/execution-spec-tests/releases/download/fusaka-devnet-2%40v1.2.0/fixtures_fusaka-devnet-2.tar.gz", + "fixture_path": "tests/fixtures/osaka_tests", + }, } ETHEREUM_TESTS_PATH = TEST_FIXTURES["ethereum_tests"]["fixture_path"] EEST_TESTS_PATH = TEST_FIXTURES["latest_fork_tests"]["fixture_path"] + +OSAKA_TEST_PATH = TEST_FIXTURES["osaka_tests"]["fixture_path"] diff --git a/tests/helpers/load_vm_tests.py b/tests/helpers/load_vm_tests.py index 361c82bd83..6a10a14381 100644 --- a/tests/helpers/load_vm_tests.py +++ b/tests/helpers/load_vm_tests.py @@ -199,8 +199,6 @@ def json_to_state(self, raw: Any) -> Any: U256.from_be_bytes(hex_to_bytes32(v)), ) - self.set_account(state, addr, account) - return state def json_to_addrs(self, raw: Any) -> List[Any]: diff --git a/tests/homestead/test_rlp.py b/tests/homestead/test_rlp.py index 647ddcafc5..f73fb1c9cd 100644 --- a/tests/homestead/test_rlp.py +++ b/tests/homestead/test_rlp.py @@ -18,7 +18,6 @@ address1 = hex_to_address("0x00000000219ab540356cbb839cbe05303d7705fa") address2 = hex_to_address("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2") -address3 = hex_to_address("0xbe0eb53f46cd790cd13851d5eff43d12404d33e8") bloom = hex_to_bytes256( "0x886480c00200620d84180d0470000c503081160044d05015808" diff --git a/tests/homestead/test_transaction.py b/tests/homestead/test_transaction.py index 7562afa3d5..095f3a2331 100644 --- a/tests/homestead/test_transaction.py +++ b/tests/homestead/test_transaction.py @@ -3,7 +3,7 @@ import pytest from ethereum_rlp import rlp -from ethereum.exceptions import InvalidTransaction +from ethereum.exceptions import NonceOverflowError from ethereum.homestead.transactions import Transaction, validate_transaction from ethereum.utils.hexadecimal import hex_to_uint from tests.helpers import TEST_FIXTURES @@ -32,7 +32,7 @@ def test_high_nonce(test_file_high_nonce: str) -> None: tx = rlp.decode_to(Transaction, test["tx_rlp"]) - with pytest.raises(InvalidTransaction): + with pytest.raises(NonceOverflowError): validate_transaction(tx) diff --git a/tests/istanbul/test_rlp.py b/tests/istanbul/test_rlp.py index 3eb39041ac..07d13d423a 100644 --- a/tests/istanbul/test_rlp.py +++ b/tests/istanbul/test_rlp.py @@ -18,7 +18,6 @@ address1 = hex_to_address("0x00000000219ab540356cbb839cbe05303d7705fa") address2 = hex_to_address("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2") -address3 = hex_to_address("0xbe0eb53f46cd790cd13851d5eff43d12404d33e8") bloom = hex_to_bytes256( "0x886480c00200620d84180d0470000c503081160044d05015808" diff --git a/tests/istanbul/test_transaction.py b/tests/istanbul/test_transaction.py index 37a096445d..9b9bc6ce80 100644 --- a/tests/istanbul/test_transaction.py +++ b/tests/istanbul/test_transaction.py @@ -3,7 +3,7 @@ import pytest from ethereum_rlp import rlp -from ethereum.exceptions import InvalidTransaction +from ethereum.exceptions import NonceOverflowError from ethereum.istanbul.transactions import Transaction, validate_transaction from ethereum.utils.hexadecimal import hex_to_uint from tests.helpers import TEST_FIXTURES @@ -30,7 +30,7 @@ def test_high_nonce(test_file_high_nonce: str) -> None: tx = rlp.decode_to(Transaction, test["tx_rlp"]) - with pytest.raises(InvalidTransaction): + with pytest.raises(NonceOverflowError): validate_transaction(tx) diff --git a/tests/london/test_rlp.py b/tests/london/test_rlp.py index e598e11f8b..db85edb3ed 100644 --- a/tests/london/test_rlp.py +++ b/tests/london/test_rlp.py @@ -26,7 +26,6 @@ address1 = hex_to_address("0x00000000219ab540356cbb839cbe05303d7705fa") address2 = hex_to_address("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2") -address3 = hex_to_address("0xbe0eb53f46cd790cd13851d5eff43d12404d33e8") bloom = hex_to_bytes256( "0x886480c00200620d84180d0470000c503081160044d05015808" diff --git a/tests/london/test_transaction.py b/tests/london/test_transaction.py index 5925474afe..5b47ee2b22 100644 --- a/tests/london/test_transaction.py +++ b/tests/london/test_transaction.py @@ -3,7 +3,7 @@ import pytest from ethereum_rlp import rlp -from ethereum.exceptions import InvalidTransaction +from ethereum.exceptions import NonceOverflowError from ethereum.london.transactions import ( LegacyTransaction, validate_transaction, @@ -33,7 +33,7 @@ def test_high_nonce(test_file_high_nonce: str) -> None: tx = rlp.decode_to(LegacyTransaction, test["tx_rlp"]) - with pytest.raises(InvalidTransaction): + with pytest.raises(NonceOverflowError): validate_transaction(tx) diff --git a/tests/osaka/__init__.py b/tests/osaka/__init__.py new file mode 100644 index 0000000000..e69de29bb2 diff --git a/tests/osaka/test_evm_tools.py b/tests/osaka/test_evm_tools.py new file mode 100644 index 0000000000..2078846201 --- /dev/null +++ b/tests/osaka/test_evm_tools.py @@ -0,0 +1,64 @@ +from functools import partial +from typing import Dict + +import pytest + +from tests.helpers import ETHEREUM_TESTS_PATH, OSAKA_TEST_PATH +from tests.helpers.load_evm_tools_tests import ( + fetch_evm_tools_tests, + idfn, + load_evm_tools_test, +) + +ETHEREUM_STATE_TESTS_DIR = f"{ETHEREUM_TESTS_PATH}/GeneralStateTests/" +EEST_STATE_TESTS_DIR = f"{OSAKA_TEST_PATH}/fixtures/state_tests/" +FORK_NAME = "Osaka" + + +SLOW_TESTS = ( + "GeneralStateTests/stTimeConsuming/CALLBlake2f_MaxRounds.json::CALLBlake2f_MaxRounds-fork_[Cancun-Osaka]-d0g0v0", + "GeneralStateTests/VMTests/vmPerformance/loopExp.json::loopExp-fork_[Cancun-Osaka]-d[0-14]g0v0", + "GeneralStateTests/VMTests/vmPerformance/loopMul.json::loopMul-fork_[Cancun-Osaka]-d[0-2]g0v0", + "tests/osaka/eip2537_bls_12_381_precompiles/test_bls12_pairing.py::test_valid[fork_Osaka-state_test-bls_pairing_non-degeneracy-]", + "tests/osaka/eip2537_bls_12_381_precompiles/test_bls12_pairing.py::test_valid[fork_Osaka-state_test-bls_pairing_bilinearity-]", + "tests/osaka/eip2537_bls_12_381_precompiles/test_bls12_pairing.py::test_valid[fork_Osaka-state_test-bls_pairing_e(G1,-G2)=e(-G1,G2)-]", + "tests/osaka/eip2537_bls_12_381_precompiles/test_bls12_pairing.py::test_valid[fork_Osaka-state_test-bls_pairing_e(aG1,bG2)=e(abG1,G2)-]", + "tests/osaka/eip2537_bls_12_381_precompiles/test_bls12_pairing.py::test_valid[fork_Osaka-state_test-bls_pairing_e(aG1,bG2)=e(G1,abG2)-]", + "tests/osaka/eip2537_bls_12_381_precompiles/test_bls12_pairing.py::test_valid[fork_Osaka-state_test-inf_pair-]", + "tests/osaka/eip2537_bls_12_381_precompiles/test_bls12_pairing.py::test_valid[fork_Osaka-state_test-multi_inf_pair-]", +) + + +# Define tests +fetch_tests = partial( + fetch_evm_tools_tests, + fork_name=FORK_NAME, + slow_tests=SLOW_TESTS, +) + +run_tests = partial( + load_evm_tools_test, + fork_name=FORK_NAME, +) + + +# Run tests from ethereum/tests +@pytest.mark.evm_tools +@pytest.mark.parametrize( + "test_case", + fetch_tests(ETHEREUM_STATE_TESTS_DIR), + ids=idfn, +) +def test_ethereum_tests_evm_tools(test_case: Dict) -> None: + run_tests(test_case) + + +# Run EEST test fixtures +@pytest.mark.evm_tools +@pytest.mark.parametrize( + "test_case", + fetch_tests(EEST_STATE_TESTS_DIR), + ids=idfn, +) +def test_eest_evm_tools(test_case: Dict) -> None: + run_tests(test_case) diff --git a/tests/osaka/test_rlp.py b/tests/osaka/test_rlp.py new file mode 100644 index 0000000000..b33aaf404e --- /dev/null +++ b/tests/osaka/test_rlp.py @@ -0,0 +1,173 @@ +import pytest +from ethereum_rlp import rlp +from ethereum_types.bytes import Bytes, Bytes0, Bytes8, Bytes32 +from ethereum_types.numeric import U64, U256, Uint + +from ethereum.crypto.hash import keccak256 +from ethereum.osaka.blocks import Block, Header, Log, Receipt, Withdrawal +from ethereum.osaka.transactions import ( + Access, + AccessListTransaction, + FeeMarketTransaction, + LegacyTransaction, + Transaction, + decode_transaction, + encode_transaction, +) +from ethereum.osaka.utils.hexadecimal import hex_to_address +from ethereum.utils.hexadecimal import hex_to_bytes256 + +hash1 = keccak256(b"foo") +hash2 = keccak256(b"bar") +hash3 = keccak256(b"baz") +hash4 = keccak256(b"foobar") +hash5 = keccak256(b"quux") +hash6 = keccak256(b"foobarbaz") +hash7 = keccak256(b"quuxbaz") + +address1 = hex_to_address("0x00000000219ab540356cbb839cbe05303d7705fa") +address2 = hex_to_address("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2") + +bloom = hex_to_bytes256( + "0x886480c00200620d84180d0470000c503081160044d05015808" + "0037401107060120040105281100100104500414203040a208003" + "4814200610da1208a638d16e440c024880800301e1004c2b02285" + "0602000084c3249a0c084569c90c2002001586241041e8004035a" + "4400a0100938001e041180083180b0340661372060401428c0200" + "87410402b9484028100049481900c08034864314688d001548c30" + "00828e542284180280006402a28a0264da00ac223004006209609" + "83206603200084040122a4739080501251542082020a4087c0002" + "81c08800898d0900024047380000127038098e090801080000429" + "0c84201661040200201c0004b8490ad588804" +) + +legacy_transaction = LegacyTransaction( + U256(1), + Uint(2), + Uint(3), + Bytes0(), + U256(4), + Bytes(b"foo"), + U256(27), + U256(5), + U256(6), +) + +access_list_transaction = AccessListTransaction( + U64(1), + U256(1), + Uint(2), + Uint(3), + Bytes0(), + U256(4), + Bytes(b"bar"), + ( + Access(account=address1, slots=(hash1, hash2)), + Access(account=address2, slots=()), + ), + U256(27), + U256(5), + U256(6), +) + +transaction_1559 = FeeMarketTransaction( + U64(1), + U256(1), + Uint(7), + Uint(2), + Uint(3), + Bytes0(), + U256(4), + Bytes(b"bar"), + ( + Access(account=address1, slots=(hash1, hash2)), + Access(account=address2, slots=()), + ), + U256(27), + U256(5), + U256(6), +) + +withdrawal = Withdrawal(U64(0), U64(1), address1, U256(2)) + + +header = Header( + parent_hash=hash1, + ommers_hash=hash2, + coinbase=address1, + state_root=hash3, + transactions_root=hash4, + receipt_root=hash5, + bloom=bloom, + difficulty=Uint(1), + number=Uint(2), + gas_limit=Uint(3), + gas_used=Uint(4), + timestamp=U256(5), + extra_data=Bytes(b"foobar"), + prev_randao=Bytes32(b"1234567890abcdef1234567890abcdef"), + nonce=Bytes8(b"12345678"), + base_fee_per_gas=Uint(6), + withdrawals_root=hash6, + parent_beacon_block_root=Bytes32(b"1234567890abcdef1234567890abcdef"), + blob_gas_used=U64(7), + excess_blob_gas=U64(8), + requests_hash=hash7, +) + +block = Block( + header=header, + transactions=( + encode_transaction(legacy_transaction), + encode_transaction(access_list_transaction), + encode_transaction(transaction_1559), + ), + ommers=(), + withdrawals=(withdrawal,), +) + +log1 = Log( + address=address1, + topics=(hash1, hash2), + data=Bytes(b"foobar"), +) + +log2 = Log( + address=address1, + topics=(hash1,), + data=Bytes(b"quux"), +) + +receipt = Receipt( + succeeded=True, + cumulative_gas_used=Uint(1), + bloom=bloom, + logs=(log1, log2), +) + + +@pytest.mark.parametrize( + "rlp_object", + [ + legacy_transaction, + access_list_transaction, + transaction_1559, + header, + block, + log1, + log2, + receipt, + withdrawal, + ], +) +def test_cancun_rlp(rlp_object: rlp.Extended) -> None: + encoded = rlp.encode(rlp_object) + assert rlp.decode_to(type(rlp_object), encoded) == rlp_object + + +@pytest.mark.parametrize( + "tx", [legacy_transaction, access_list_transaction, transaction_1559] +) +def test_transaction_encoding(tx: Transaction) -> None: + encoded = encode_transaction(tx) + assert decode_transaction(encoded) == tx diff --git a/tests/osaka/test_state_transition.py b/tests/osaka/test_state_transition.py new file mode 100644 index 0000000000..49a32ee2a9 --- /dev/null +++ b/tests/osaka/test_state_transition.py @@ -0,0 +1,104 @@ +from functools import partial +from typing import Dict + +import pytest + +from tests.helpers import ETHEREUM_TESTS_PATH, OSAKA_TEST_PATH +from tests.helpers.load_state_tests import ( + Load, + fetch_state_test_files, + idfn, + run_blockchain_st_test, +) + +ETHEREUM_BLOCKCHAIN_TESTS_DIR = f"{ETHEREUM_TESTS_PATH}/BlockchainTests/" +EEST_BLOCKCHAIN_TESTS_DIR = f"{OSAKA_TEST_PATH}/fixtures/blockchain_tests/" +NETWORK = "Osaka" +PACKAGE = "osaka" + +SLOW_TESTS = ( + # GeneralStateTests + "stTimeConsuming/CALLBlake2f_MaxRounds.json", + "stTimeConsuming/static_Call50000_sha256.json", + "vmPerformance/loopExp.json", + "vmPerformance/loopMul.json", + "QuadraticComplexitySolidity_CallDataCopy_d0g1v0_Osaka", + "CALLBlake2f_d9g0v0_Osaka", + "CALLCODEBlake2f_d9g0v0", + # GeneralStateTests + "stRandom/randomStatetest177.json", + "stCreateTest/CreateOOGafterMaxCodesize.json", + # ValidBlockTest + "bcExploitTest/DelegateCallSpam.json", + # InvalidBlockTest + "bcUncleHeaderValidity/nonceWrong.json", + "bcUncleHeaderValidity/wrongMixHash.json", + "tests/osaka/eip2537_bls_12_381_precompiles/test_bls12_pairing\\.py\\:\\:test_valid\\[fork_Osaka-blockchain_test-bls_pairing_non-degeneracy-\\]", + "tests/osaka/eip2537_bls_12_381_precompiles/test_bls12_pairing\\.py\\:\\:test_valid\\[fork_Osaka-blockchain_test-bls_pairing_bilinearity-\\]", + "tests/osaka/eip2537_bls_12_381_precompiles/test_bls12_pairing\\.py\\:\\:test_valid\\[fork_Osaka-blockchain_test-bls_pairing_e\\(G1,-G2\\)=e\\(-G1,G2\\)-\\]", + "tests/osaka/eip2537_bls_12_381_precompiles/test_bls12_pairing\\.py\\:\\:test_valid\\[fork_Osaka-blockchain_test-bls_pairing_e\\(aG1,bG2\\)=e\\(abG1,G2\\)-\\]", + "tests/osaka/eip2537_bls_12_381_precompiles/test_bls12_pairing\\.py\\:\\:test_valid\\[fork_Osaka-blockchain_test-bls_pairing_e\\(aG1,bG2\\)=e\\(G1,abG2\\)-\\]", + "tests/osaka/eip2537_bls_12_381_precompiles/test_bls12_pairing\\.py\\:\\:test_valid\\[fork_Osaka-blockchain_test-inf_pair-\\]", + "tests/osaka/eip2537_bls_12_381_precompiles/test_bls12_pairing\\.py\\:\\:test_valid\\[fork_Osaka-blockchain_test-multi_inf_pair-\\]", + "tests/osaka/eip2935_historical_block_hashes_from_state/test_block_hashes\\.py\\:\\:test_block_hashes_history\\[fork_Osaka-blockchain_test-full_history_plus_one_check_blockhash_first\\]", +) + +# These are tests that are considered to be incorrect, +# Please provide an explanation when adding entries +IGNORE_TESTS = ( + # ValidBlockTest + "bcForkStressTest/ForkStressTest.json", + "bcGasPricerTest/RPC_API_Test.json", + "bcMultiChainTest", + "bcTotalDifficultyTest", + # InvalidBlockTest + "bcForgedTest", + "bcMultiChainTest", + "GasLimitHigherThan2p63m1_Osaka", +) + +# All tests that recursively create a large number of frames (50000) +BIG_MEMORY_TESTS = ( + # GeneralStateTests + "50000_", + "/stQuadraticComplexityTest/", + "/stRandom2/", + "/stRandom/", + "/stSpecialTest/", + "stTimeConsuming/", + "stBadOpcode/", + "stStaticCall/", +) + +# Define Tests +fetch_tests = partial( + fetch_state_test_files, + network=NETWORK, + ignore_list=IGNORE_TESTS, + slow_list=SLOW_TESTS, + big_memory_list=BIG_MEMORY_TESTS, +) + +FIXTURES_LOADER = Load(NETWORK, PACKAGE) + +run_tests = partial(run_blockchain_st_test, load=FIXTURES_LOADER) + + +# Run tests from ethereum/tests +@pytest.mark.parametrize( + "test_case", + fetch_tests(ETHEREUM_BLOCKCHAIN_TESTS_DIR), + ids=idfn, +) +def test_ethereum_tests(test_case: Dict) -> None: + run_tests(test_case) + + +# Run EEST test fixtures +@pytest.mark.parametrize( + "test_case", + fetch_tests(EEST_BLOCKCHAIN_TESTS_DIR), + ids=idfn, +) +def test_eest_tests(test_case: Dict) -> None: + run_tests(test_case) diff --git a/tests/osaka/test_trie.py b/tests/osaka/test_trie.py new file mode 100644 index 0000000000..04c86a1e08 --- /dev/null +++ b/tests/osaka/test_trie.py @@ -0,0 +1,89 @@ +import json +from typing import Any + +from ethereum.osaka.fork_types import Bytes +from ethereum.osaka.trie import Trie, root, trie_set +from ethereum.utils.hexadecimal import ( + has_hex_prefix, + hex_to_bytes, + remove_hex_prefix, +) +from tests.helpers import TEST_FIXTURES + +FIXTURE_PATH = TEST_FIXTURES["ethereum_tests"]["fixture_path"] + + +def to_bytes(data: str) -> Bytes: + if data is None: + return b"" + if has_hex_prefix(data): + return hex_to_bytes(data) + + return data.encode() + + +def test_trie_secure_hex() -> None: + tests = load_tests("hex_encoded_securetrie_test.json") + + for name, test in tests.items(): + st: Trie[Bytes, Bytes] = Trie(secured=True, default=b"") + for k, v in test.get("in").items(): + trie_set(st, to_bytes(k), to_bytes(v)) + result = root(st) + expected = remove_hex_prefix(test.get("root")) + assert result.hex() == expected, f"test {name} failed" + + +def test_trie_secure() -> None: + tests = load_tests("trietest_secureTrie.json") + + for name, test in tests.items(): + st: Trie[Bytes, Bytes] = Trie(secured=True, default=b"") + for t in test.get("in"): + trie_set(st, to_bytes(t[0]), to_bytes(t[1])) + result = root(st) + expected = remove_hex_prefix(test.get("root")) + assert result.hex() == expected, f"test {name} failed" + + +def test_trie_secure_any_order() -> None: + tests = load_tests("trieanyorder_secureTrie.json") + + for name, test in tests.items(): + st: Trie[Bytes, Bytes] = Trie(secured=True, default=b"") + for k, v in test.get("in").items(): + trie_set(st, to_bytes(k), to_bytes(v)) + result = root(st) + expected = remove_hex_prefix(test.get("root")) + assert result.hex() == expected, f"test {name} failed" + + +def test_trie() -> None: + tests = load_tests("trietest.json") + + for name, test in tests.items(): + st: Trie[Bytes, Bytes] = Trie(secured=False, default=b"") + for t in test.get("in"): + trie_set(st, to_bytes(t[0]), to_bytes(t[1])) + result = root(st) + expected = remove_hex_prefix(test.get("root")) + assert result.hex() == expected, f"test {name} failed" + + +def test_trie_any_order() -> None: + tests = load_tests("trieanyorder.json") + + for name, test in tests.items(): + st: Trie[Bytes, Bytes] = Trie(secured=False, default=b"") + for k, v in test.get("in").items(): + trie_set(st, to_bytes(k), to_bytes(v)) + result = root(st) + expected = remove_hex_prefix(test.get("root")) + assert result.hex() == expected, f"test {name} failed" + + +def load_tests(path: str) -> Any: + with open(f"{FIXTURE_PATH}/TrieTests/" + path) as f: + tests = json.load(f) + + return tests diff --git a/tests/paris/test_rlp.py b/tests/paris/test_rlp.py index 3e3cb5a718..65903f641e 100644 --- a/tests/paris/test_rlp.py +++ b/tests/paris/test_rlp.py @@ -26,7 +26,6 @@ address1 = hex_to_address("0x00000000219ab540356cbb839cbe05303d7705fa") address2 = hex_to_address("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2") -address3 = hex_to_address("0xbe0eb53f46cd790cd13851d5eff43d12404d33e8") bloom = hex_to_bytes256( "0x886480c00200620d84180d0470000c503081160044d05015808" diff --git a/tests/prague/test_rlp.py b/tests/prague/test_rlp.py index a305716436..b59726f7a0 100644 --- a/tests/prague/test_rlp.py +++ b/tests/prague/test_rlp.py @@ -27,7 +27,6 @@ address1 = hex_to_address("0x00000000219ab540356cbb839cbe05303d7705fa") address2 = hex_to_address("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2") -address3 = hex_to_address("0xbe0eb53f46cd790cd13851d5eff43d12404d33e8") bloom = hex_to_bytes256( "0x886480c00200620d84180d0470000c503081160044d05015808" diff --git a/tests/shanghai/test_rlp.py b/tests/shanghai/test_rlp.py index d3046c3710..ea63460814 100644 --- a/tests/shanghai/test_rlp.py +++ b/tests/shanghai/test_rlp.py @@ -26,7 +26,6 @@ address1 = hex_to_address("0x00000000219ab540356cbb839cbe05303d7705fa") address2 = hex_to_address("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2") -address3 = hex_to_address("0xbe0eb53f46cd790cd13851d5eff43d12404d33e8") bloom = hex_to_bytes256( "0x886480c00200620d84180d0470000c503081160044d05015808" diff --git a/tests/spurious_dragon/test_rlp.py b/tests/spurious_dragon/test_rlp.py index 05506ef6f1..8e660b0fe8 100644 --- a/tests/spurious_dragon/test_rlp.py +++ b/tests/spurious_dragon/test_rlp.py @@ -18,7 +18,6 @@ address1 = hex_to_address("0x00000000219ab540356cbb839cbe05303d7705fa") address2 = hex_to_address("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2") -address3 = hex_to_address("0xbe0eb53f46cd790cd13851d5eff43d12404d33e8") bloom = hex_to_bytes256( "0x886480c00200620d84180d0470000c503081160044d05015808" diff --git a/tests/spurious_dragon/test_transaction.py b/tests/spurious_dragon/test_transaction.py index 5e25d340ac..07773db878 100644 --- a/tests/spurious_dragon/test_transaction.py +++ b/tests/spurious_dragon/test_transaction.py @@ -3,7 +3,7 @@ import pytest from ethereum_rlp import rlp -from ethereum.exceptions import InvalidTransaction +from ethereum.exceptions import NonceOverflowError from ethereum.spurious_dragon.transactions import ( Transaction, validate_transaction, @@ -35,7 +35,7 @@ def test_high_nonce(test_file_high_nonce: str) -> None: tx = rlp.decode_to(Transaction, test["tx_rlp"]) - with pytest.raises(InvalidTransaction): + with pytest.raises(NonceOverflowError): validate_transaction(tx) diff --git a/tests/tangerine_whistle/test_rlp.py b/tests/tangerine_whistle/test_rlp.py index 3a4a30074a..697269caca 100644 --- a/tests/tangerine_whistle/test_rlp.py +++ b/tests/tangerine_whistle/test_rlp.py @@ -18,7 +18,6 @@ address1 = hex_to_address("0x00000000219ab540356cbb839cbe05303d7705fa") address2 = hex_to_address("0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2") -address3 = hex_to_address("0xbe0eb53f46cd790cd13851d5eff43d12404d33e8") bloom = hex_to_bytes256( "0x886480c00200620d84180d0470000c503081160044d05015808" diff --git a/tests/tangerine_whistle/test_transaction.py b/tests/tangerine_whistle/test_transaction.py index 455630e8a3..548dba328f 100644 --- a/tests/tangerine_whistle/test_transaction.py +++ b/tests/tangerine_whistle/test_transaction.py @@ -3,7 +3,7 @@ import pytest from ethereum_rlp import rlp -from ethereum.exceptions import InvalidTransaction +from ethereum.exceptions import NonceOverflowError from ethereum.tangerine_whistle.transactions import ( Transaction, validate_transaction, @@ -35,7 +35,7 @@ def test_high_nonce(test_file_high_nonce: str) -> None: tx = rlp.decode_to(Transaction, test["tx_rlp"]) - with pytest.raises(InvalidTransaction): + with pytest.raises(NonceOverflowError): validate_transaction(tx) diff --git a/tox.ini b/tox.ini index da16c8a3a6..817297ecf2 100644 --- a/tox.ini +++ b/tox.ini @@ -1,6 +1,6 @@ [tox] min_version = 2.0 -envlist = py3,pypy3,static +envlist = py3,pypy3_unix,pypy3_win,py3_eest_unix,py3_eest_win,static [testenv:static] extras = @@ -9,12 +9,12 @@ extras = test doc commands = - isort src tests setup.py --check --diff --skip-glob "tests/fixtures/*" - black src tests setup.py --check --diff --exclude "tests/fixtures/*" - flake8 src tests setup.py - mypy src tests setup.py --exclude "tests/fixtures/*" --namespace-packages + isort src tests --check --diff --skip-glob "tests/fixtures/*" + black src tests --check --diff --exclude "tests/fixtures/*" + flake8 src tests + mypy src tests --exclude "tests/fixtures/*" --namespace-packages ethereum-spec-lint - vulture src tests setup.py --exclude "*/tests/fixtures/*" --min-confidence 100 + vulture src tests vulture_whitelist.py --exclude "*/tests/fixtures/*" --ignore-names "pytest_*" [testenv:py3] extras = @@ -30,22 +30,89 @@ commands = --no-cov-on-fail \ --cov-branch \ --ignore-glob='tests/fixtures/*' \ - --basetemp="{temp_dir}/pytest" + --basetemp="{temp_dir}/pytest" \ + tests -[testenv:pypy3] +[testenv:py3_eest_unix] +platform = linux|darwin extras = test +allowlist_externals = + bash +commands = + fill \ + -m "not slow and not zkevm and not benchmark" \ + -n auto --maxprocesses 6 \ + --basetemp="{temp_dir}/pytest" \ + --clean \ + eest_tests/execution-spec-tests/tests + bash -c 'fill \ + -m "not slow and not zkevm and not benchmark" \ + -n auto --maxprocesses 6 \ + --basetemp="{temp_dir}/pytest" \ + --clean \ + --fork "$(ethereum-spec-forks -n -1 --title)" \ + "eest_tests/execution-spec-tests/tests/$(ethereum-spec-forks -n -1 --name)"' + +[testenv:py3_eest_win] +platform = win32 +extras = test +allowlist_externals = + powershell +commands = + fill \ + -m "not slow and not zkevm and not benchmark" \ + -n auto --maxprocesses 6 \ + --basetemp="{temp_dir}/pytest" \ + --clean \ + eest_tests/execution-spec-tests/tests + powershell -c "$title = ethereum-spec-forks -n -1 --title; $name = ethereum-spec-forks -n -1 --name; fill -m 'not slow and not zkevm and not benchmark' -n auto --maxprocesses 6 --basetemp='{temp_dir}/pytest' --clean --fork \"$title\" \"eest_tests/execution-spec-tests/tests/$name\"" + +[testenv:pypy3_unix] +platform = linux|darwin +extras = + test +allowlist_externals = + bash passenv = PYPY_GC_MAX commands = - pytest \ + fill \ --tb=no \ --show-capture=no \ --disable-warnings \ - -m "not slow" \ - -n auto --maxprocesses 5 \ - --ignore-glob='tests/fixtures/*' \ - --basetemp="{temp_dir}/pytest" + -m "not slow and not zkevm and not benchmark" \ + -n auto --maxprocesses 3 \ + --basetemp="{temp_dir}/pytest" \ + --clean \ + eest_tests/execution-spec-tests/tests + bash -c 'fill \ + --tb=no \ + --show-capture=no \ + --disable-warnings \ + -m "not slow and not zkevm and not benchmark" \ + -n auto --maxprocesses 3 \ + --basetemp="{temp_dir}/pytest" \ + --clean \ + --fork "$(ethereum-spec-forks -n -1 --title)" \ + "eest_tests/execution-spec-tests/tests/$(ethereum-spec-forks -n -1 --name)"' + +[testenv:pypy3_win] +platform = win32 +extras = + test +passenv = + PYPY_GC_MAX +allowlist_externals = + powershell +commands = + fill \ + -m "not slow and not zkevm and not benchmark" \ + -n auto --maxprocesses 3 \ + --basetemp="{temp_dir}/pytest" \ + --clean \ + eest_tests/execution-spec-tests/tests + powershell -c "$title = ethereum-spec-forks -n -1 --title; $name = ethereum-spec-forks -n -1 --name; fill --tb=no --show-capture=no --disable-warnings -m 'not slow and not zkevm and not benchmark' -n auto --maxprocesses 6 --basetemp='{temp_dir}/pytest' --clean --fork \"$title\" \"eest_tests/execution-spec-tests/tests/$name\"" [testenv:optimized] extras = @@ -60,7 +127,8 @@ commands = --ignore-glob='tests/fixtures/*' \ --ignore-glob='tests/test_t8n.py' \ --basetemp="{temp_dir}/pytest" \ - --optimized + --optimized \ + tests [testenv:doc] basepython = python3 diff --git a/vulture_whitelist.py b/vulture_whitelist.py new file mode 100644 index 0000000000..ae8bcbe564 --- /dev/null +++ b/vulture_whitelist.py @@ -0,0 +1,107 @@ +from ethereum.cancun.blocks import Withdrawal +from ethereum.ethash import * +from ethereum.fork_criteria import Unscheduled +from ethereum_optimized.state_db import State +from ethereum_spec_tools.docc import * +from ethereum_spec_tools.evm_tools.daemon import _EvmToolHandler +from ethereum_spec_tools.evm_tools.loaders.fixture_loader import Load +from ethereum_spec_tools.evm_tools.loaders.transaction_loader import ( + TransactionLoad, +) +from ethereum_spec_tools.evm_tools.t8n.env import Ommer +from ethereum_spec_tools.evm_tools.t8n.evm_trace import Trace, FinalTrace +from ethereum_spec_tools.evm_tools.t8n.transition_tool import EELST8N +from ethereum_spec_tools.lint.lints.glacier_forks_hygiene import ( + GlacierForksHygiene, +) +from ethereum_spec_tools.lint.lints.import_hygiene import ImportHygiene +from ethereum.trace import EvmTracer + +# src/ethereum/cancun/blocks.py +Withdrawal.validator_index + +# src/ethereum/fork_criteria.py +Unscheduled + +# src/ethereum/ethash.py +ethash.generate_dataset + +# src/ethereum/trace.py +EvmTracer.__call__ + +# src/ethereum/optimized/state_db.py +State.rollback_db_transaction + +# src/ethereum_spec_tools/docc.py +docc.EthereumDiscover +docc.EthereumBuilder +docc.DiffSource.show_in_listing +docc.FixIndexTransform +docc.FixIndexTransform.transform +docc.MinimizeDiffsTransform +docc.MinimizeDiffsTransform.transform +docc._FixIndexVisitor.enter +docc._DoccAdapter.shallow_equals +docc._DoccAdapter.shallow_hash +docc._DoccApply.ascend +docc._DoccApply.descend +docc._DoccApply.insert +docc._HardenVisitor.enter +docc._MinimizeDiffsVisitor.enter +docc.render_diff +docc.render_before_after + +# src/ethereum_spec_tools/evm_tools/daemon.py +_EvmToolHandler.do_POST +_EvmToolHandler.log_request + +# src/ethereum_spec_tools/evm_tools/transition_tool.py +EELST8N +EELST8N._info_metadata +EELST8N.version +EELST8N.is_fork_supported +EELST8N.evaluate + +# src/ethereum_spec_tools/loaders/fixture_loader.py +Load._network + +# src/ethereum_spec_tools/loaders/transaction_loader.py +TransactionLoad.json_to_authorizations +TransactionLoad.json_to_chain_id +TransactionLoad.json_to_nonce +TransactionLoad.json_to_gas +TransactionLoad.json_to_to +TransactionLoad.json_to_value +TransactionLoad.json_to_data +TransactionLoad.json_to_access_list +TransactionLoad.json_to_gas_price +TransactionLoad.json_to_max_fee_per_gas +TransactionLoad.json_to_max_priority_fee_per_gas +TransactionLoad.json_to_max_fee_per_blob_gas +TransactionLoad.json_to_blob_versioned_hashes +TransactionLoad.json_to_v +TransactionLoad.json_to_y_parity +TransactionLoad.json_to_r +TransactionLoad.json_to_s + +# src/ethereum_spec_tools/evm_tools/t8n/env.py +Ommer.delta + +# src/ethereum_spec_tools/evm_tools/t8n/evm_trace.py +Trace.gasCost +Trace.memSize +Trace.returnData +Trace.refund +Trace.opName +FinalTrace.gasUsed + +# src/ethereum_spec_tools/lint/lints/glacier_forks_hygiene.py +GlacierForksHygiene +GlacierForksHygiene.visit_AnnAssign + +# src/ethereum_spec_tools/lint/lints/glacier_forks_hygiene.py +ImportHygiene +ImportHygiene.visit_AnnAssign + + +_children # unused attribute (src/ethereum_spec_tools/docc.py:751) diff --git a/whitelist.txt b/whitelist.txt index adaa359513..7edf451b1b 100644 --- a/whitelist.txt +++ b/whitelist.txt @@ -475,3 +475,26 @@ eoa blockchain listdir precompiles + +asn1 +backends +Der +ECDSA +Prehashed +pubnum +P256VERIFY +p256verify +qx +qy +SECP256R1 +SECP256R1A +SECP256R1B +SECP256R1N +SECP256R1P +secp256r1 +sig + +CLZ +EELST8N +clis +T8 \ No newline at end of file