Merge pull request #300 from spencer-tb/assert-no-empty-accounts

improvement: Deprecate empty accounts within framework.

Author: marioevz

src/ethereum_test_tools/common/types.py

@@ -684,6 +684,17 @@ def check_alloc(self: "Account", address: str, alloc: dict):
             actual_storage = Storage(alloc["storage"]) if "storage" in alloc else Storage({})
             expected_storage.must_be_equal(address=address, other=actual_storage)
 
+    def is_empty(self: "Account") -> bool:
+        """
+        Returns true if an account deemed empty.
+        """
+        return (
+            (self.nonce == 0 or self.nonce is None)
+            and (self.balance == 0 or self.balance is None)
+            and (not self.code and self.code is None)
+            and (not self.storage or self.storage == {} or self.storage is None)
+        )
+
     @classmethod
     def from_dict(cls: Type, data: "Dict | Account") -> "Account":
         """
@@ -734,7 +745,9 @@ def __init__(self, d: Mapping[FixedSizeBytesConvertible, Account | Dict] = {}):
         for address, account in d.items():
             address = Address(address)
             assert address not in self, f"Duplicate address in alloc: {address}"
-            self[address] = Account.from_dict(account)
+            account = Account.from_dict(account)
+            assert not account.is_empty(), f"Empty account: {account} for address: {address}"
+            self[address] = account
 
     @classmethod
     def merge(cls, alloc_1: "Alloc", alloc_2: "Alloc") -> "Alloc":

tests/cancun/eip4788_beacon_root/conftest.py

@@ -189,17 +189,19 @@ def pre(
     Prepares the pre state of all test cases, by setting the balance of the
     source account of all test transactions, and the contract caller account.
     """
-    return {
+    pre_alloc = {
         TestAddress: Account(
             nonce=0,
             balance=0x10**10,
         ),
         caller_address: contract_call_account,
-        SYSTEM_ADDRESS: Account(
+    }
+    if system_address_balance > 0:
+        pre_alloc[to_address(SYSTEM_ADDRESS)] = Account(
             nonce=0,
             balance=system_address_balance,
-        ),
-    }
+        )
+    return pre_alloc
 
 
 @pytest.fixture

tests/cancun/eip4788_beacon_root/test_blocks_beacon_root_contract.py

@@ -104,7 +104,6 @@ def test_multi_block_beacon_root_timestamp_calls(
     tx: Transaction,
     call_gas: int,
     call_value: int,
-    system_address_balance: int,
 ):
     """
     Tests multiple blocks where each block writes a timestamp to storage and contains one
@@ -125,10 +124,6 @@ def test_multi_block_beacon_root_timestamp_calls(
             nonce=0,
             balance=0x10**10,
         ),
-        SYSTEM_ADDRESS: Account(
-            nonce=0,
-            balance=system_address_balance,
-        ),
     }
     post = {}
 
@@ -235,7 +230,6 @@ def test_beacon_root_transition(
     tx: Transaction,
     call_gas: int,
     call_value: int,
-    system_address_balance: int,
     fork: Fork,
 ):
     """
@@ -248,10 +242,6 @@ def test_beacon_root_transition(
             nonce=0,
             balance=0x10**10,
         ),
-        SYSTEM_ADDRESS: Account(
-            nonce=0,
-            balance=system_address_balance,
-        ),
     }
     post = {}
 

tests/shanghai/eip4895_withdrawals/test_withdrawals.py

@@ -109,7 +109,7 @@ def post(self, test_case: str) -> Dict:  # noqa: D102
         if test_case == "tx_in_withdrawals_block":
             return {}
         if test_case == "tx_after_withdrawals_block":
-            return {TestAddress: Account(balance=ONE_GWEI)}
+            return {TestAddress: Account(balance=ONE_GWEI + 1)}
         raise Exception("Invalid test case.")
 
     def test_use_value_in_tx(
@@ -121,7 +121,7 @@ def test_use_value_in_tx(
         """
         Test sending withdrawal value in a transaction.
         """
-        pre = {TestAddress: Account(balance=0)}
+        pre = {TestAddress: Account(balance=1)}
         blockchain_test(pre=pre, post=post, blocks=blocks)
 
 
@@ -137,7 +137,7 @@ def test_use_value_in_contract(blockchain_test: BlockchainTestFiller):
     pre = {
         TestAddress: Account(balance=1000000000000000000000, nonce=0),
         to_address(0x100): Account(balance=0, code=SEND_ONE_GWEI),
-        to_address(0x200): Account(balance=0),
+        to_address(0x200): Account(balance=1),
     }
     tx = Transaction(
         # Transaction sent from the `TestAddress`, which has 0 balance at start
@@ -172,7 +172,7 @@ def test_use_value_in_contract(blockchain_test: BlockchainTestFiller):
             }
         ),
         to_address(0x200): Account(
-            balance=ONE_GWEI,
+            balance=ONE_GWEI + 1,
         ),
     }
 
@@ -384,7 +384,7 @@ def test_self_destructing_account(blockchain_test: BlockchainTestFiller):
             balance=(100 * ONE_GWEI),
         ),
         to_address(0x200): Account(
-            balance=0,
+            balance=1,
         ),
     }
 
@@ -417,7 +417,7 @@ def test_self_destructing_account(blockchain_test: BlockchainTestFiller):
         ),
         to_address(0x200): Account(
             code=None,
-            balance=(100 * ONE_GWEI),
+            balance=(100 * ONE_GWEI) + 1,
         ),
     }