refactor: move rlp_utils to block_access_lists; bal -> block_access_lists

fselmo · fselmo · commit 2c4b60e02256 · 2025-09-23T09:47:10.000-06:00
diff --git a/pyproject.toml b/pyproject.toml
@@ -517,6 +517,12 @@ ignore = [
 "src/ethereum/forks/amsterdam/blocks.py" = [
     "E501"          # Line too long - needed for long ref links
 ]
+ "src/ethereum/forks/amsterdam/block_access_lists/builder.py" = [
+    "E501"          # Line too long - needed for long ref links
+ ]
+"src/ethereum/forks/amsterdam/block_access_lists/rlp_utils.py" = [
+    "E501"          # Line too long - needed for long ref links
+ ]
 
 [tool.ruff.lint.mccabe]
 # Set the maximum allowed cyclomatic complexity. C901 default is 10.
diff --git a/src/ethereum/forks/amsterdam/block_access_lists/builder.py b/src/ethereum/forks/amsterdam/block_access_lists/builder.py
@@ -23,7 +23,7 @@
 from ethereum_types.numeric import U64, U256
 
 from ..fork_types import Address
-from ..rlp_types import (
+from .rlp_types import (
     AccountChanges,
     BalanceChange,
     BlockAccessIndex,
diff --git a/src/ethereum/forks/amsterdam/block_access_lists/rlp_types.py b/src/ethereum/forks/amsterdam/block_access_lists/rlp_types.py
diff --git a/src/ethereum/forks/amsterdam/block_access_lists/rlp_utils.py b/src/ethereum/forks/amsterdam/block_access_lists/rlp_utils.py
@@ -24,8 +24,8 @@
 
 from ethereum.crypto.hash import Hash32, keccak256
 
-from ..rlp_types import MAX_CODE_SIZE, MAX_TXS, BlockAccessList
 from .builder import BlockAccessListBuilder
+from .rlp_types import MAX_CODE_SIZE, MAX_TXS, BlockAccessList
 
 
 def compute_block_access_list_hash(
diff --git a/src/ethereum/forks/amsterdam/block_access_lists/tracker.py b/src/ethereum/forks/amsterdam/block_access_lists/tracker.py
@@ -22,7 +22,6 @@
 from ethereum_types.numeric import U64, U256, Uint
 
 from ..fork_types import Address
-from ..rlp_types import BlockAccessIndex
 from .builder import (
     BlockAccessListBuilder,
     add_balance_change,
@@ -32,6 +31,7 @@
     add_storage_write,
     add_touched_account,
 )
+from .rlp_types import BlockAccessIndex
 
 if TYPE_CHECKING:
     from ..state import State  # noqa: F401
diff --git a/src/ethereum/forks/amsterdam/blocks.py b/src/ethereum/forks/amsterdam/blocks.py
@@ -18,8 +18,8 @@
 
 from ethereum.crypto.hash import Hash32
 
+from .block_access_lists.rlp_types import BlockAccessList
 from .fork_types import Address, Bloom, Root
-from .rlp_types import BlockAccessList
 from .transactions import (
     AccessListTransaction,
     BlobTransaction,
@@ -242,7 +242,7 @@ class Header:
     [SHA2-256]: https://en.wikipedia.org/wiki/SHA-2
     """
 
-    bal_hash: Hash32
+    block_access_list_hash: Hash32
     """
     [SHA2-256] hash of the Block Access List containing all accounts and
     storage locations accessed during block execution. Introduced in
diff --git a/src/ethereum/forks/amsterdam/fork.py b/src/ethereum/forks/amsterdam/fork.py
@@ -271,7 +271,7 @@ def state_transition(chain: BlockChain, block: Block) -> None:
         raise InvalidBlock
     if requests_hash != block.header.requests_hash:
         raise InvalidBlock
-    if computed_block_access_list_hash != block.header.bal_hash:
+    if computed_block_access_list_hash != block.header.block_access_list_hash:
         raise InvalidBlock("Invalid block access list hash")
 
     chain.blocks.append(block)
@@ -765,7 +765,7 @@ def apply_body(
     block_output = vm.BlockOutput()
 
     # Set system transaction index for pre-execution system contracts
-    # EIP-7928: System contracts use bal_index 0
+    # EIP-7928: System contracts use block_access_index 0
     set_transaction_index(block_env.state.change_tracker, Uint(0))
 
     process_unchecked_system_transaction(
@@ -783,7 +783,7 @@ def apply_body(
     for i, tx in enumerate(map(decode_transaction, transactions)):
         process_transaction(block_env, block_output, tx, Uint(i))
 
-    # EIP-7928: Post-execution uses bal_index len(transactions) + 1
+    # EIP-7928: Post-execution uses block_access_index len(transactions) + 1
     post_execution_index = ulen(transactions) + Uint(1)
     set_transaction_index(block_env.state.change_tracker, post_execution_index)
 
@@ -873,7 +873,7 @@ def process_transaction(
     index:
         Index of the transaction in the block.
     """
-    # EIP-7928: Transactions use bal_index 1 to len(transactions)
+    # EIP-7928: Transactions use block_access_index 1 to len(transactions)
     set_transaction_index(block_env.state.change_tracker, index + Uint(1))
 
     trie_set(
diff --git a/src/ethereum/forks/amsterdam/vm/__init__.py b/src/ethereum/forks/amsterdam/vm/__init__.py
@@ -22,9 +22,9 @@
 from ethereum.crypto.hash import Hash32
 from ethereum.exceptions import EthereumException
 
+from ..block_access_lists.rlp_types import BlockAccessList
 from ..blocks import Log, Receipt, Withdrawal
 from ..fork_types import Address, Authorization, VersionedHash
-from ..rlp_types import BlockAccessList
 from ..state import State, TransientStorage
 from ..transactions import LegacyTransaction
 from ..trie import Trie
diff --git a/src/ethereum/genesis.py b/src/ethereum/genesis.py
@@ -259,8 +259,8 @@ def add_genesis_block(
     if has_field(hardfork.Header, "requests_hash"):
         fields["requests_hash"] = Hash32(b"\0" * 32)
 
-    if has_field(hardfork.Header, "bal_hash"):
-        fields["bal_hash"] = Hash32(b"\0" * 32)
+    if has_field(hardfork.Header, "block_access_list_hash"):
+        fields["block_access_list_hash"] = Hash32(b"\0" * 32)
 
     genesis_header = hardfork.Header(**fields)
 
diff --git a/src/ethereum_spec_tools/evm_tools/t8n/t8n_types.py b/src/ethereum_spec_tools/evm_tools/t8n/t8n_types.py
@@ -333,7 +333,7 @@ def update(self, t8n: "T8N", block_env: Any, block_output: Any) -> None:
                 )
             )
 
-    def _bal_to_json(self, bal: Any) -> Any:
+    def _block_access_list_to_json(self, bal: Any) -> Any:
         """
         Convert BlockAccessList to JSON format matching the Pydantic models.
         """
@@ -475,7 +475,9 @@ def to_json(self) -> Any:
 
         if self.block_access_list is not None:
             # Convert BAL to JSON format
-            data["blockAccessList"] = self._bal_to_json(self.block_access_list)
+            data["blockAccessList"] = self._block_access_list_to_json(
+                self.block_access_list
+            )
 
         if self.block_access_list_hash is not None:
             data["blockAccessListHash"] = encode_to_hex(
diff --git a/tests/amsterdam/test_bal_implementation.py b/tests/amsterdam/test_bal_implementation.py
@@ -33,7 +33,7 @@
     track_nonce_change,
     track_storage_write,
 )
-from ethereum.forks.amsterdam.rlp_types import (
+from ethereum.forks.amsterdam.block_access_lists.rlp_types import (
     MAX_CODE_CHANGES,
     BlockAccessIndex,
     BlockAccessList,
@@ -43,12 +43,12 @@
 class TestBALCore:
     """Test core BAL functionality."""
 
-    def test_bal_builder_initialization(self) -> None:
+    def test_block_access_list_builder_initialization(self) -> None:
         """Test BAL builder initializes correctly."""
         builder = BlockAccessListBuilder()
         assert builder.accounts == {}
 
-    def test_bal_builder_add_storage_write(self) -> None:
+    def test_block_access_list_builder_add_storage_write(self) -> None:
         """Test adding storage writes to BAL builder."""
         builder = BlockAccessListBuilder()
         address = Bytes20(b"\x01" * 20)
@@ -65,7 +65,7 @@ def test_bal_builder_add_storage_write(self) -> None:
         assert change.block_access_index == 0
         assert change.new_value == value
 
-    def test_bal_builder_add_storage_read(self) -> None:
+    def test_block_access_list_builder_add_storage_read(self) -> None:
         """Test adding storage reads to BAL builder."""
         builder = BlockAccessListBuilder()
         address = Bytes20(b"\x01" * 20)
@@ -76,7 +76,7 @@ def test_bal_builder_add_storage_read(self) -> None:
         assert address in builder.accounts
         assert slot in builder.accounts[address].storage_reads
 
-    def test_bal_builder_add_balance_change(self) -> None:
+    def test_block_access_list_builder_add_balance_change(self) -> None:
         """Test adding balance changes to BAL builder."""
         builder = BlockAccessListBuilder()
         address = Bytes20(b"\x01" * 20)
@@ -91,7 +91,7 @@ def test_bal_builder_add_balance_change(self) -> None:
         assert change.block_access_index == 0
         assert change.post_balance == balance
 
-    def test_bal_builder_add_nonce_change(self) -> None:
+    def test_block_access_list_builder_add_nonce_change(self) -> None:
         """Test adding nonce changes to BAL builder."""
         builder = BlockAccessListBuilder()
         address = Bytes20(b"\x01" * 20)
@@ -106,7 +106,7 @@ def test_bal_builder_add_nonce_change(self) -> None:
         assert change.block_access_index == 0
         assert change.new_nonce == U64(42)
 
-    def test_bal_builder_add_code_change(self) -> None:
+    def test_block_access_list_builder_add_code_change(self) -> None:
         """Test adding code changes to BAL builder."""
         builder = BlockAccessListBuilder()
         address = Bytes20(b"\x01" * 20)
@@ -121,7 +121,7 @@ def test_bal_builder_add_code_change(self) -> None:
         assert change.block_access_index == 0
         assert change.new_code == code
 
-    def test_bal_builder_touched_account(self) -> None:
+    def test_block_access_list_builder_touched_account(self) -> None:
         """Test adding touched accounts without changes."""
         builder = BlockAccessListBuilder()
         address = Bytes20(b"\x01" * 20)
@@ -135,7 +135,7 @@ def test_bal_builder_touched_account(self) -> None:
         assert builder.accounts[address].nonce_changes == []
         assert builder.accounts[address].code_changes == []
 
-    def test_bal_builder_build_complete(self) -> None:
+    def test_block_access_list_builder_build_complete(self) -> None:
         """Test building a complete BlockAccessList."""
         builder = BlockAccessListBuilder()
 
@@ -482,7 +482,7 @@ def test_rlp_encode_simple_bal(self) -> None:
         assert isinstance(encoded, (bytes, Bytes))
         assert len(encoded) > 0
 
-    def test_bal_hash_computation(self) -> None:
+    def test_block_access_list_hash_computation(self) -> None:
         """Test BAL hash computation using RLP."""
         from ethereum.forks.amsterdam.block_access_lists import (
             compute_block_access_list_hash,
diff --git a/tests/amsterdam/test_rlp.py b/tests/amsterdam/test_rlp.py
@@ -4,7 +4,7 @@
 from ethereum_types.numeric import U64, U256, Uint
 
 from ethereum.forks.amsterdam.blocks import Block, Header, Log, Receipt, Withdrawal
-from ethereum.forks.amsterdam.rlp_types import BlockAccessList
+from ethereum.forks.amsterdam.block_access_lists.rlp_types import BlockAccessList
 from ethereum.forks.amsterdam.transactions import (
     Access,
     AccessListTransaction,
@@ -114,7 +114,7 @@
     blob_gas_used=U64(7),
     excess_blob_gas=U64(8),
     requests_hash=hash7,
-    bal_hash=hash1,  # Added missing bal_hash
+    block_access_list_hash=hash1,  # Added missing block_access_list_hash
 )
 
 block = Block(
diff --git a/whitelist.txt b/whitelist.txt
@@ -508,8 +508,6 @@ whitelist
 AccountT
 uint
 
-bal
-BAL
 slot1
 slot2
 lexicographically
