add async eth.chain_id and test

ethereum · Dec 14, 2021 · f007c44 · f007c44
1 parent 0268d79
commit f007c44
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 6 deletions.
diff --git a/docs/providers.rst b/docs/providers.rst
@@ -399,8 +399,10 @@ Supported Methods
 Eth
 ***
 - :meth:`web3.eth.block_number <web3.eth.Eth.block_number>`
+- :meth:`web3.eth.chain_id <web3.eth.Eth.chain_id>`
 - :meth:`web3.eth.coinbase <web3.eth.Eth.coinbase>`
 - :meth:`web3.eth.gas_price <web3.eth.Eth.gas_price>`
+- :meth:`web3.eth.hashrate <web3.eth.Eth.hashrate>`
 - :meth:`web3.eth.max_priority_fee <web3.eth.Eth.max_priority_fee>`
 - :meth:`web3.eth.call() <web3.eth.Eth.call>`
 - :meth:`web3.eth.estimate_gas() <web3.eth.Eth.estimate_gas>`
@@ -414,7 +416,6 @@ Eth
 - :meth:`web3.eth.get_transaction_count() <web3.eth.Eth.get_transaction_count>`
 - :meth:`web3.eth.send_transaction() <web3.eth.Eth.send_transaction>`
 - :meth:`web3.eth.send_raw_transaction() <web3.eth.Eth.send_raw_transaction>`
-- :meth:`web3.eth.hashrate <web3.eth.Eth.hashrate>`
 
 Net
 ***

diff --git a/newsfragments/2251.feature.rst b/newsfragments/2251.feature.rst
@@ -0,0 +1 @@
+Add async ``eth.chain_id`` method
diff --git a/web3/_utils/module_testing/eth_module.py b/web3/_utils/module_testing/eth_module.py
@@ -688,6 +688,15 @@ async def test_async_eth_hashrate(
         assert is_integer(hashrate)
         assert hashrate >= 0
 
+    @pytest.mark.asyncio
+    async def test_async_eth_chain_id(
+        self,
+        async_w3: "Web3"
+    ) -> None:
+        chain_id = await async_w3.eth.chain_id  # type: ignore
+        # chain id value from geth fixture genesis file
+        assert chain_id == 131277322940537
+
 
 class EthModuleTest:
     def test_eth_protocol_version(self, web3: "Web3") -> None:

diff --git a/web3/eth.py b/web3/eth.py
@@ -267,6 +267,11 @@ def call_munger(
         mungers=None,
     )
 
+    _chain_id: Method[Callable[[], int]] = Method(
+        RPC.eth_chainId,
+        mungers=None,
+    )
+
 
 class AsyncEth(BaseEth):
     is_async = True
@@ -344,6 +349,10 @@ async def coinbase(self) -> ChecksumAddress:
     async def hashrate(self) -> int:
         return await self._get_hashrate()  # type: ignore
 
+    @property
+    async def chain_id(self) -> int:
+        return await self._chain_id()  # type: ignore
+
     _get_balance: Method[Callable[..., Awaitable[Wei]]] = Method(
         RPC.eth_getBalance,
         mungers=[BaseEth.block_id_munger],
@@ -485,11 +494,6 @@ def blockNumber(self) -> BlockNumber:
         )
         return self.block_number
 
-    _chain_id: Method[Callable[[], int]] = Method(
-        RPC.eth_chainId,
-        mungers=None,
-    )
-
     @property
     def chain_id(self) -> int:
         return self._chain_id()