Use eth.default_account for tests, in the age of no eth_coinbase

This commit updates the tests to set ``w3.eth.default_account`` to the
first account and use it in place of ``w3.eth.coinbase``, since
``eth_coinbase`` was removed in clients like geth. Using
``w3.eth.accounts[0]`` is not a very user-friendly API to keep calling
across all tests.

Author: fselmo

conftest.py

@@ -70,14 +70,17 @@ def _wait_for_transaction(w3, txn_hash, timeout=120):
     return _wait_for_transaction
 
 
-@pytest.fixture()
+@pytest.fixture
 def w3():
-    return Web3(EthereumTesterProvider())
+    w3 = Web3(EthereumTesterProvider())
+    w3.eth.default_account = w3.eth.accounts[0]
+    return w3
 
 
 @pytest.fixture(scope="module")
 def w3_non_strict_abi():
     w3 = Web3(EthereumTesterProvider())
+    w3.eth.default_account = w3.eth.accounts[0]
     w3.strict_bytes_type_checking = False
     return w3
 

tests/core/contracts/conftest.py

@@ -230,9 +230,7 @@ def event_contract(
     wait_for_block(w3)
 
     event_contract_factory = w3.eth.contract(**EVENT_CONTRACT_DATA)
-    deploy_txn_hash = event_contract_factory.constructor().transact(
-        {"from": w3.eth.accounts[0], "gas": 1000000}
-    )
+    deploy_txn_hash = event_contract_factory.constructor().transact({"gas": 1000000})
     deploy_receipt = wait_for_transaction(w3, deploy_txn_hash)
     contract_address = address_conversion_func(deploy_receipt["contractAddress"])
 
@@ -251,7 +249,7 @@ def indexed_event_contract(
 
     indexed_event_contract_factory = w3.eth.contract(**INDEXED_EVENT_CONTRACT_DATA)
     deploy_txn_hash = indexed_event_contract_factory.constructor().transact(
-        {"from": w3.eth.accounts[0], "gas": 1000000}
+        {"gas": 1000000}
     )
     deploy_receipt = wait_for_transaction(w3, deploy_txn_hash)
     contract_address = address_conversion_func(deploy_receipt["contractAddress"])

tests/core/contracts/test_contract_constructor.py

@@ -218,10 +218,10 @@ def test_contract_constructor_build_transaction_no_constructor(
     w3, math_contract_factory, address_conversion_func
 ):
     txn_hash = math_contract_factory.constructor().transact(
-        {"from": address_conversion_func(w3.eth.accounts[0])}
+        {"from": address_conversion_func(w3.eth.default_account)}
     )
     txn = w3.eth.get_transaction(txn_hash)
-    nonce = w3.eth.get_transaction_count(w3.eth.accounts[0])
+    nonce = w3.eth.get_transaction_count(w3.eth.default_account)
     unsent_txn = math_contract_factory.constructor().build_transaction({"nonce": nonce})
     assert txn["input"] == HexBytes(unsent_txn["data"])
 
@@ -235,10 +235,10 @@ def test_contract_constructor_build_transaction_without_arguments(
     w3, math_contract_factory, address_conversion_func
 ):
     txn_hash = math_contract_factory.constructor().transact(
-        {"from": address_conversion_func(w3.eth.accounts[0])}
+        {"from": address_conversion_func(w3.eth.default_account)}
     )
     txn = w3.eth.get_transaction(txn_hash)
-    nonce = w3.eth.get_transaction_count(w3.eth.accounts[0])
+    nonce = w3.eth.get_transaction_count(w3.eth.default_account)
     unsent_txn = math_contract_factory.constructor().build_transaction({"nonce": nonce})
     assert txn["input"] == HexBytes(unsent_txn["data"])
 
@@ -266,10 +266,10 @@ def test_contract_constructor_build_transaction_with_arguments(
 ):
     txn_hash = non_strict_contract_with_constructor_args_factory.constructor(
         *constructor_args, **constructor_kwargs
-    ).transact({"from": address_conversion_func(w3_non_strict_abi.eth.accounts[0])})
+    ).transact({"from": address_conversion_func(w3_non_strict_abi.eth.default_account)})
     txn = w3_non_strict_abi.eth.get_transaction(txn_hash)
     nonce = w3_non_strict_abi.eth.get_transaction_count(
-        w3_non_strict_abi.eth.accounts[0]
+        w3_non_strict_abi.eth.default_account
     )
     unsent_txn = non_strict_contract_with_constructor_args_factory.constructor(
         *constructor_args, **constructor_kwargs
@@ -523,12 +523,11 @@ async def test_async_contract_constructor_build_transaction_to_field_error(
 async def test_async_contract_constructor_build_transaction_no_constructor(
     async_w3, async_math_contract_factory, address_conversion_func
 ):
-    async_w3_accounts = await async_w3.eth.accounts
     txn_hash = await async_math_contract_factory.constructor().transact(
-        {"from": address_conversion_func(async_w3_accounts[0])}
+        {"from": address_conversion_func(async_w3.eth.default_account)}
     )
     txn = await async_w3.eth.get_transaction(txn_hash)
-    nonce = await async_w3.eth.get_transaction_count(async_w3_accounts[0])
+    nonce = await async_w3.eth.get_transaction_count(async_w3.eth.default_account)
     unsent_txn = await async_math_contract_factory.constructor().build_transaction(
         {"nonce": nonce}
     )
@@ -544,12 +543,11 @@ async def test_async_contract_constructor_build_transaction_no_constructor(
 async def test_async_contract_constructor_build_transaction_without_arguments(
     async_w3, async_math_contract_factory, address_conversion_func
 ):
-    async_w3_accounts = await async_w3.eth.accounts
     txn_hash = await async_math_contract_factory.constructor().transact(
-        {"from": address_conversion_func(async_w3_accounts[0])}
+        {"from": address_conversion_func(async_w3.eth.default_account)}
     )
     txn = await async_w3.eth.get_transaction(txn_hash)
-    nonce = await async_w3.eth.get_transaction_count(async_w3_accounts[0])
+    nonce = await async_w3.eth.get_transaction_count(async_w3.eth.default_account)
     unsent_txn = await async_math_contract_factory.constructor().build_transaction(
         {"nonce": nonce}
     )
@@ -578,15 +576,20 @@ async def test_async_contract_constructor_build_transaction_with_arguments(
     constructor_kwargs,
     address_conversion_func,
 ):
-    async_w3_accounts = await async_w3_non_strict_abi.eth.accounts
     txn_hash = (
         await async_non_strict_constructor_with_args_contract_factory.constructor(
             *constructor_args, **constructor_kwargs
-        ).transact({"from": address_conversion_func(async_w3_accounts[0])})
+        ).transact(
+            {
+                "from": address_conversion_func(
+                    async_w3_non_strict_abi.eth.default_account
+                )
+            }
+        )
     )
     txn = await async_w3_non_strict_abi.eth.get_transaction(txn_hash)
     nonce = await async_w3_non_strict_abi.eth.get_transaction_count(
-        async_w3_accounts[0]
+        async_w3_non_strict_abi.eth.default_account
     )
     unsent_txn = (
         await async_non_strict_constructor_with_args_contract_factory.constructor(

tests/core/contracts/test_contract_example.py

@@ -149,9 +149,6 @@ async def async_foo_contract(async_w3):
     #
     # }
 
-    async_eth_tester_accounts = await async_w3.eth.accounts
-    deploy_address = async_eth_tester_accounts[0]
-
     abi = """[{"anonymous":false,"inputs":[{"indexed":false,"name":"_bar","type":"string"}],"name":"barred","type":"event"},{"constant":false,"inputs":[{"name":"_bar","type":"string"}],"name":"setBar","outputs":[],"payable":false,"stateMutability":"nonpayable","type":"function"},{"inputs":[],"payable":false,"stateMutability":"nonpayable","type":"constructor"},{"constant":true,"inputs":[],"name":"bar","outputs":[{"name":"","type":"string"}],"payable":false,"stateMutability":"view","type":"function"}]"""  # noqa: E501
     # This bytecode is the output of compiling with
     # solc version:0.5.3+commit.10d17f24.Emscripten.clang
@@ -162,13 +159,13 @@ async def async_foo_contract(async_w3):
     # issue a transaction to deploy the contract.
     tx_hash = await FooContract.constructor().transact(
         {
-            "from": deploy_address,
+            "from": async_w3.eth.default_account,
         }
     )
     # wait for the transaction to be mined
     tx_receipt = await async_w3.eth.wait_for_transaction_receipt(tx_hash, 180)
     # instantiate and return an instance of our contract.
-    return FooContract(tx_receipt.contractAddress)
+    return FooContract(tx_receipt["contractAddress"])
 
 
 @pytest.mark.asyncio
@@ -179,13 +176,11 @@ async def test_async_initial_greeting(async_foo_contract):
 
 @pytest.mark.asyncio
 async def test_async_can_update_greeting(async_w3, async_foo_contract):
-    async_eth_tester_accounts = await async_w3.eth.accounts
-    # send transaction that updates the greeting
     tx_hash = await async_foo_contract.functions.setBar(
         "testing contracts is easy",
     ).transact(
         {
-            "from": async_eth_tester_accounts[1],
+            "from": async_w3.eth.default_account,
         }
     )
     await async_w3.eth.wait_for_transaction_receipt(tx_hash, 180)
@@ -197,13 +192,12 @@ async def test_async_can_update_greeting(async_w3, async_foo_contract):
 
 @pytest.mark.asyncio
 async def test_async_updating_greeting_emits_event(async_w3, async_foo_contract):
-    async_eth_tester_accounts = await async_w3.eth.accounts
     # send transaction that updates the greeting
     tx_hash = await async_foo_contract.functions.setBar(
         "testing contracts is easy",
     ).transact(
         {
-            "from": async_eth_tester_accounts[1],
+            "from": async_w3.eth.default_account,
         }
     )
     receipt = await async_w3.eth.wait_for_transaction_receipt(tx_hash, 180)

tests/core/contracts/test_contract_init.py

@@ -14,7 +14,7 @@
 def math_addr(math_contract_factory, address_conversion_func):
     w3 = math_contract_factory.w3
     deploy_txn = math_contract_factory.constructor().transact(
-        {"from": w3.eth.accounts[0]}
+        {"from": w3.eth.default_account}
     )
     deploy_receipt = w3.eth.wait_for_transaction_receipt(deploy_txn)
     assert deploy_receipt is not None
@@ -30,7 +30,7 @@ def test_contract_with_unset_address(math_contract_factory):
 def test_contract_with_name_address(math_contract_factory, math_addr):
     with contract_ens_addresses(math_contract_factory, [("thedao.eth", math_addr)]):
         mc = math_contract_factory(address="thedao.eth")
-        caller = mc.w3.eth.accounts[0]
+        caller = mc.w3.eth.default_account
         assert mc.address == "thedao.eth"
         assert mc.functions.return13().call({"from": caller}) == 13
 
@@ -50,17 +50,16 @@ def test_contract_with_name_address_from_eth_contract(
             bytecode_runtime=math_contract_runtime,
         )
 
-        caller = mc.w3.eth.accounts[0]
         assert mc.address == "thedao.eth"
-        assert mc.functions.return13().call({"from": caller}) == 13
+        assert mc.functions.return13().call({"from": mc.w3.eth.default_account}) == 13
 
 
 def test_contract_with_name_address_changing(math_contract_factory, math_addr):
     # Contract address is validated once on creation
     with contract_ens_addresses(math_contract_factory, [("thedao.eth", math_addr)]):
         mc = math_contract_factory(address="thedao.eth")
 
-    caller = mc.w3.eth.accounts[0]
+    caller = mc.w3.eth.default_account
     assert mc.address == "thedao.eth"
 
     # what happens when name returns no address at all

tests/core/contracts/test_contract_transact_interface.py

@@ -89,7 +89,7 @@ def test_transacting_with_contract_with_arguments(
 
 
 def test_deploy_when_default_account_is_set(w3, string_contract_data):
-    w3.eth.default_account = w3.eth.accounts[1]
+    # default account for tests is set as the first account
     assert w3.eth.default_account is not empty
 
     StringContract = w3.eth.contract(**string_contract_data)
@@ -101,7 +101,7 @@ def test_deploy_when_default_account_is_set(w3, string_contract_data):
 
 
 def test_transact_when_default_account_is_set(w3, math_contract, transact):
-    w3.eth.default_account = w3.eth.accounts[1]
+    # default account for tests is set as the first account
     assert w3.eth.default_account is not empty
 
     txn_hash = transact(contract=math_contract, contract_function="incrementCounter")
@@ -392,8 +392,7 @@ async def test_async_transacting_with_contract_with_arguments(
 
 @pytest.mark.asyncio
 async def test_async_deploy_when_default_account_is_set(async_w3, string_contract_data):
-    async_w3_accounts = await async_w3.eth.accounts
-    async_w3.eth.default_account = async_w3_accounts[1]
+    # default account for tests is set as the first account
     assert async_w3.eth.default_account is not empty
 
     StringContract = async_w3.eth.contract(**string_contract_data)
@@ -408,8 +407,7 @@ async def test_async_deploy_when_default_account_is_set(async_w3, string_contrac
 async def test_async_transact_when_default_account_is_set(
     async_w3, async_math_contract, async_transact
 ):
-    async_w3_accounts = await async_w3.eth.accounts
-    async_w3.eth.default_account = async_w3_accounts[1]
+    # default account for tests is set as the first account
     assert async_w3.eth.default_account is not empty
 
     txn_hash = await async_transact(

tests/core/eth-module/test_accounts.py

@@ -27,6 +27,9 @@
     AsyncWeb3,
     Web3,
 )
+from web3._utils.empty import (
+    Empty,
+)
 from web3.eth import (
     BaseEth,
 )
@@ -100,6 +103,10 @@ def w3():
     return Web3(EthereumTesterProvider())
 
 
+def test_eth_default_account_is_empty_by_default(w3):
+    assert isinstance(w3.eth.default_account, Empty)
+
+
 def test_eth_account_create_variation(acct):
     account1 = acct.create()
     account2 = acct.create()

tests/core/eth-module/test_default_account_api.py

@@ -7,6 +7,8 @@ def wait_for_first_block(w3, wait_for_block):
 
 
 def test_uses_default_account_when_set(w3, wait_for_transaction):
+    current_default = w3.eth.default_account
+
     w3.eth.default_account = None
     assert w3.eth.default_account is None
 
@@ -25,6 +27,8 @@ def test_uses_default_account_when_set(w3, wait_for_transaction):
     txn = w3.eth.get_transaction(txn_hash)
     assert txn["from"] == w3.eth.accounts[3]
 
+    w3.eth.default_account = current_default
+
 
 def test_uses_given_from_address_when_provided(w3, wait_for_transaction):
     w3.eth.default_account = w3.eth.accounts[3]

tests/core/eth-module/test_transactions.py

@@ -184,7 +184,7 @@ def test_unmined_transaction_wait_for_receipt(w3, request_mocker):
 
     txn_hash = w3.eth.send_transaction(
         {
-            "from": w3.eth.accounts[0],
+            "from": w3.eth.default_account,
             "to": "0xd3CdA913deB6f67967B99D67aCDFa1712C293601",
             "value": 123457,
         }

tests/core/filtering/conftest.py

@@ -64,13 +64,13 @@ def create_filter(request):
 # --- async --- #
 
 
-@pytest.fixture(
+@pytest_asyncio.fixture(
     scope="function",
     params=[True, False],
     ids=["LocalFilterMiddleware", "node_based_filter"],
 )
-def async_w3(request):
-    return _async_w3_fixture_logic(request)
+async def async_w3(request):
+    return await _async_w3_fixture_logic(request)
 
 
 @pytest.fixture

tests/core/filtering/test_contract_data_filters.py

@@ -279,13 +279,13 @@ def event_loop():
     loop.close()
 
 
-@pytest.fixture(
+@pytest_asyncio.fixture(
     scope="module",
     params=[True, False],
     ids=["LocalFilterMiddleware", "node_based_filter"],
 )
-def async_w3(request):
-    return _async_w3_fixture_logic(request)
+async def async_w3(request):
+    return await _async_w3_fixture_logic(request)
 
 
 @pytest.fixture(scope="module")

tests/core/filtering/test_contract_topic_filters.py

@@ -260,13 +260,13 @@ def event_loop():
     loop.close()
 
 
-@pytest.fixture(
+@pytest_asyncio.fixture(
     scope="module",
     params=[True, False],
     ids=["LocalFilterMiddleware", "node_based_filter"],
 )
-def async_w3(request):
-    return _async_w3_fixture_logic(request)
+async def async_w3(request):
+    return await _async_w3_fixture_logic(request)
 
 
 @pytest_asyncio.fixture(scope="module")