Additional cleanup for geth --dev`` test fixture

Author: reedsa

tests/integration/generate_fixtures/common.py

@@ -68,8 +68,8 @@
     "timestamp": "0x0",
     "parentHash": constants.HASH_ZERO,
     "extraData": "0x3535353535353535353535353535353535353535353535353535353535353535",
-    "difficulty": "0x1",
-    "gasLimit": "0x1c9c380",
+    "gasLimit": "0x3b9aca00",  # 1,000,000,000
+    "difficulty": "0x10000",
     "mixhash": constants.HASH_ZERO,
     "coinbase": COINBASE,
 }

tests/integration/generate_fixtures/go_ethereum.py

@@ -85,16 +85,18 @@ def get_geth_process(geth_binary, datadir, genesis_file_path, geth_port, keyfile
 
     run_geth_command = (
         geth_binary,
-        "--datadir",  # data dir for the db
+        "--datadir",
         datadir,
         "--dev",
         "--dev.period",
         "1",
         "--port",
         geth_port,
+        "--miner.etherbase",
+        common.COINBASE[2:],
         "--password",
         keyfile_pw,
-        "--rpc.enabledeprecatedpersonal",  # Enables the (deprecated) personal namespace
+        "--rpc.enabledeprecatedpersonal",
     )
 
     popen_proc = subprocess.Popen(

tests/integration/geth-1.13.9-fixture.zip

@@ -96,7 +96,7 @@ def base_geth_command_arguments(geth_binary, datadir):
         str(datadir),
         "--dev",
         "--dev.period",
-        "5",
+        "5",  # dev.period > 1 for tests which require pending blocks
         "--password",
         os.path.join(datadir, "keystore", "pw.txt"),
     )

tests/integration/go_ethereum/conftest.py

@@ -63,6 +63,7 @@
 )
 from web3._utils.module_testing.utils import (
     RequestMocker,
+    flaky_geth_dev_mining,
 )
 from web3._utils.type_conversion import (
     to_hex_if_bytes,
@@ -2070,6 +2071,7 @@ async def test_async_eth_sign_ens_names(
             assert is_bytes(signature)
             assert len(signature) == 32 + 32 + 1
 
+    @flaky_geth_dev_mining
     @pytest.mark.asyncio
     async def test_async_eth_replace_transaction_legacy(
         self, async_w3: "AsyncWeb3", async_unlocked_account_dual_type: ChecksumAddress
@@ -2097,6 +2099,7 @@ async def test_async_eth_replace_transaction_legacy(
         assert replace_txn["gas"] == 21000
         assert replace_txn["gasPrice"] == txn_params["gasPrice"]
 
+    @flaky_geth_dev_mining
     @pytest.mark.asyncio
     async def test_async_eth_replace_transaction(
         self, async_w3: "AsyncWeb3", async_unlocked_account_dual_type: ChecksumAddress
@@ -2131,6 +2134,7 @@ async def test_async_eth_replace_transaction(
         assert replace_txn["maxFeePerGas"] == three_gwei_in_wei
         assert replace_txn["maxPriorityFeePerGas"] == two_gwei_in_wei
 
+    @flaky_geth_dev_mining
     @pytest.mark.asyncio
     async def test_async_eth_replace_transaction_underpriced(
         self, async_w3: "AsyncWeb3", async_unlocked_account_dual_type: ChecksumAddress
@@ -2152,6 +2156,7 @@ async def test_async_eth_replace_transaction_underpriced(
         with pytest.raises(ValueError, match="replacement transaction underpriced"):
             await async_w3.eth.replace_transaction(txn_hash, txn_params)
 
+    @flaky_geth_dev_mining
     @pytest.mark.asyncio
     async def test_async_eth_replace_transaction_non_existing_transaction(
         self, async_w3: "AsyncWeb3", async_unlocked_account_dual_type: ChecksumAddress
@@ -2172,6 +2177,7 @@ async def test_async_eth_replace_transaction_non_existing_transaction(
                 txn_params,
             )
 
+    @flaky_geth_dev_mining
     @pytest.mark.asyncio
     async def test_async_eth_replace_transaction_already_mined(
         self, async_w3: "AsyncWeb3", async_unlocked_account_dual_type: ChecksumAddress
@@ -2192,6 +2198,7 @@ async def test_async_eth_replace_transaction_already_mined(
         with pytest.raises(ValueError, match="Supplied transaction with hash"):
             await async_w3.eth.replace_transaction(txn_hash, txn_params)
 
+    @flaky_geth_dev_mining
     @pytest.mark.asyncio
     async def test_async_eth_replace_transaction_incorrect_nonce(
         self, async_w3: "AsyncWeb3", async_unlocked_account: ChecksumAddress
@@ -2213,6 +2220,7 @@ async def test_async_eth_replace_transaction_incorrect_nonce(
         with pytest.raises(ValueError):
             await async_w3.eth.replace_transaction(txn_hash, txn_params)
 
+    @flaky_geth_dev_mining
     @pytest.mark.asyncio
     async def test_async_eth_replace_transaction_gas_price_too_low(
         self, async_w3: "AsyncWeb3", async_unlocked_account_dual_type: ChecksumAddress
@@ -2230,6 +2238,7 @@ async def test_async_eth_replace_transaction_gas_price_too_low(
         with pytest.raises(ValueError):
             await async_w3.eth.replace_transaction(txn_hash, txn_params)
 
+    @flaky_geth_dev_mining
     @pytest.mark.asyncio
     async def test_async_eth_replace_transaction_gas_price_defaulting_minimum(
         self, async_w3: "AsyncWeb3", async_unlocked_account: ChecksumAddress
@@ -2253,6 +2262,7 @@ async def test_async_eth_replace_transaction_gas_price_defaulting_minimum(
             gas_price * 1.125
         )  # minimum gas price
 
+    @flaky_geth_dev_mining
     @pytest.mark.asyncio
     async def test_async_eth_replace_transaction_gas_price_defaulting_strategy_higher(
         self, async_w3: "AsyncWeb3", async_unlocked_account: ChecksumAddress
@@ -2281,6 +2291,7 @@ def higher_gas_price_strategy(async_w3: "AsyncWeb3", txn: TxParams) -> Wei:
         )  # Strategy provides higher gas price
         async_w3.eth.set_gas_price_strategy(None)  # reset strategy
 
+    @flaky_geth_dev_mining
     @pytest.mark.asyncio
     async def test_async_eth_replace_transaction_gas_price_defaulting_strategy_lower(
         self, async_w3: "AsyncWeb3", async_unlocked_account: ChecksumAddress
@@ -3254,6 +3265,7 @@ def gas_price_strategy(_w3: "Web3", _txn: TxParams) -> str:
         assert txn["gasPrice"] == two_gwei_in_wei
         w3.eth.set_gas_price_strategy(None)  # reset strategy
 
+    @flaky_geth_dev_mining
     def test_eth_replace_transaction_legacy(
         self, w3: "Web3", unlocked_account_dual_type: ChecksumAddress
     ) -> None:
@@ -3282,6 +3294,7 @@ def test_eth_replace_transaction_legacy(
         assert replace_txn["gas"] == 21000
         assert replace_txn["gasPrice"] == txn_params["gasPrice"]
 
+    @flaky_geth_dev_mining
     def test_eth_replace_transaction(
         self, w3: "Web3", unlocked_account_dual_type: ChecksumAddress
     ) -> None:
@@ -3315,6 +3328,7 @@ def test_eth_replace_transaction(
         assert replace_txn["maxFeePerGas"] == three_gwei_in_wei
         assert replace_txn["maxPriorityFeePerGas"] == two_gwei_in_wei
 
+    @flaky_geth_dev_mining
     def test_eth_replace_transaction_underpriced(
         self, w3: "Web3", unlocked_account_dual_type: ChecksumAddress
     ) -> None:
@@ -3335,6 +3349,7 @@ def test_eth_replace_transaction_underpriced(
         with pytest.raises(ValueError, match="replacement transaction underpriced"):
             w3.eth.replace_transaction(txn_hash, txn_params)
 
+    @flaky_geth_dev_mining
     def test_eth_replace_transaction_non_existing_transaction(
         self, w3: "Web3", unlocked_account_dual_type: ChecksumAddress
     ) -> None:
@@ -3354,6 +3369,7 @@ def test_eth_replace_transaction_non_existing_transaction(
                 txn_params,
             )
 
+    @flaky_geth_dev_mining
     def test_eth_replace_transaction_already_mined(
         self, w3: "Web3", unlocked_account_dual_type: ChecksumAddress
     ) -> None:
@@ -3373,6 +3389,7 @@ def test_eth_replace_transaction_already_mined(
         with pytest.raises(ValueError, match="Supplied transaction with hash"):
             w3.eth.replace_transaction(txn_hash, txn_params)
 
+    @flaky_geth_dev_mining
     def test_eth_replace_transaction_incorrect_nonce(
         self, w3: "Web3", unlocked_account: ChecksumAddress
     ) -> None:
@@ -3393,6 +3410,7 @@ def test_eth_replace_transaction_incorrect_nonce(
         with pytest.raises(ValueError):
             w3.eth.replace_transaction(txn_hash, txn_params)
 
+    @flaky_geth_dev_mining
     def test_eth_replace_transaction_gas_price_too_low(
         self, w3: "Web3", unlocked_account_dual_type: ChecksumAddress
     ) -> None:
@@ -3409,6 +3427,7 @@ def test_eth_replace_transaction_gas_price_too_low(
         with pytest.raises(ValueError):
             w3.eth.replace_transaction(txn_hash, txn_params)
 
+    @flaky_geth_dev_mining
     def test_eth_replace_transaction_gas_price_defaulting_minimum(
         self, w3: "Web3", unlocked_account: ChecksumAddress
     ) -> None:
@@ -3431,6 +3450,7 @@ def test_eth_replace_transaction_gas_price_defaulting_minimum(
             gas_price * 1.125
         )  # minimum gas price
 
+    @flaky_geth_dev_mining
     def test_eth_replace_transaction_gas_price_defaulting_strategy_higher(
         self, w3: "Web3", unlocked_account: ChecksumAddress
     ) -> None:
@@ -3458,6 +3478,7 @@ def higher_gas_price_strategy(w3: "Web3", txn: TxParams) -> Wei:
         )  # Strategy provides higher gas price
         w3.eth.set_gas_price_strategy(None)  # reset strategy
 
+    @flaky_geth_dev_mining
     def test_eth_replace_transaction_gas_price_defaulting_strategy_lower(
         self, w3: "Web3", unlocked_account: ChecksumAddress
     ) -> None:

web3/_utils/module_testing/eth_module.py

@@ -10,6 +10,9 @@
     cast,
 )
 
+from flaky import (
+    flaky,
+)
 from toolz import (
     merge,
 )
@@ -30,6 +33,14 @@
     )
 
 
+"""
+flaky_geth_dev_mining decorator for tests requiring a pending block
+for the duration of the test. This behavior can be flaky
+due to timing of the test running as a block is mined.
+"""
+flaky_geth_dev_mining = flaky(max_runs=3)
+
+
 class RequestMocker:
     """
     Context manager to mock requests made by a web3 instance. This is meant to be used