Feature/async geth admin (#2329)

* Added BaseGethPersonal to geth.py

* Added AsyncGethPersonal and test

* Added Docs

* lint fixes

* news fragment update

* removed import_raw_key test for now

* mypy typing issues

* typo

* Added AsyncGethAdmin and BaseGethAdmin. Also, fixed test due to typing

* made suggested changes

* made suggested changes

* fixed spelling errors

* added test and docs

* newsfragment

* merge conflict

* remove setSolc

* copy in suggested test

* forgot to check liniting before commit

* linting

* linting

Author: dbfreem

docs/providers.rst

@@ -393,7 +393,8 @@ AsyncHTTPProvider
         ...         'net': (AsyncNet,),
         ...         'geth': (Geth,
         ...             {'txpool': (AsyncGethTxPool,),
-        ...              'personal': (AsyncGethPersonal,)})
+        ...              'personal': (AsyncGethPersonal,),
+        ...              'admin' : (AsyncGethAdmin,)})
         ...         },
         ...     middlewares=[])  # See supported middleware section below for middleware options
 
@@ -440,6 +441,14 @@ Net
 
 Geth
 ****
+- :meth:`web3.geth.admin.add_peer() <web3.geth.admin.add_peer>`
+- :meth:`web3.geth.admin.datadir() <web3.geth.admin.datadir>`
+- :meth:`web3.geth.admin.node_info() <web3.geth.admin.node_info>`
+- :meth:`web3.geth.admin.peers() <web3.geth.admin.peers>`
+- :meth:`web3.geth.admin.start_rpc() <web3.geth.admin.start_rpc>`
+- :meth:`web3.geth.admin.start_ws() <web3.geth.admin.start_ws>`
+- :meth:`web3.geth.admin.stop_rpc() <web3.geth.admin.stop_rpc>`
+- :meth:`web3.geth.admin.stop_ws() <web3.geth.admin.stop_ws>`
 - :meth:`web3.geth.personal.ec_recover()`
 - :meth:`web3.geth.personal.import_raw_key() <web3.geth.personal.import_raw_key>`
 - :meth:`web3.geth.personal.list_accounts() <web3.geth.personal.list_accounts>`

docs/web3.geth.rst

@@ -122,10 +122,6 @@ The ``web3.geth.admin`` object exposes methods to interact with the RPC APIs und
 
     .. warning:: Deprecated: This method is deprecated in favor of :meth:`~web3.geth.admin.add_peer()`
 
-.. py:method:: setSolc(solc_path)
-
-    .. Warning:: This method has been removed from Geth
-
 .. py:method:: start_rpc(host='localhost', port=8545, cors="", apis="eth,net,web3")
 
     * Delegates to ``admin_startRPC`` RPC Method

newsfragments/1413.feature.rst

@@ -0,0 +1 @@
+Added Async functions for Geth Personal and Admin modules

newsfragments/2299.feature.rst

@@ -4,13 +4,17 @@
     get_open_port,
 )
 from web3 import Web3
+from web3._utils.module_testing.go_ethereum_admin_module import (
+    GoEthereumAsyncAdminModuleTest,
+)
 from web3._utils.module_testing.go_ethereum_personal_module import (
     GoEthereumAsyncPersonalModuleTest,
 )
 from web3.eth import (
     AsyncEth,
 )
 from web3.geth import (
+    AsyncGethAdmin,
     AsyncGethPersonal,
     AsyncGethTxPool,
     Geth,
@@ -104,7 +108,8 @@ async def async_w3(geth_process, endpoint_uri):
                  'async_net': AsyncNet,
                  'geth': (Geth,
                           {'txpool': (AsyncGethTxPool,),
-                           'personal': (AsyncGethPersonal,)}
+                           'personal': (AsyncGethPersonal,),
+                           'admin': (AsyncGethAdmin,)}
                           )
                  }
     )
@@ -131,6 +136,25 @@ def test_admin_start_stop_ws(self, web3: "Web3") -> None:
         super().test_admin_start_stop_ws(web3)
 
 
+class TestGoEthereumAsyncAdminModuleTest(GoEthereumAsyncAdminModuleTest):
+    @pytest.mark.asyncio
+    @pytest.mark.xfail(reason="running geth with the --nodiscover flag doesn't allow peer addition")
+    async def test_admin_peers(self, web3: "Web3") -> None:
+        await super().test_admin_peers(web3)
+
+    @pytest.mark.asyncio
+    async def test_admin_start_stop_rpc(self, web3: "Web3") -> None:
+        # This test causes all tests after it to fail on CI if it's allowed to run
+        pytest.xfail(reason='Only one RPC endpoint is allowed to be active at any time')
+        await super().test_admin_start_stop_rpc(web3)
+
+    @pytest.mark.asyncio
+    async def test_admin_start_stop_ws(self, web3: "Web3") -> None:
+        # This test causes all tests after it to fail on CI if it's allowed to run
+        pytest.xfail(reason='Only one WS endpoint is allowed to be active at any time')
+        await super().test_admin_start_stop_ws(web3)
+
+
 class TestGoEthereumEthModuleTest(GoEthereumEthModuleTest):
     pass
 

tests/integration/go_ethereum/test_goethereum_http.py

@@ -1,6 +1,7 @@
 import pytest
 from typing import (
     TYPE_CHECKING,
+    List,
 )
 
 from web3.datastructures import (
@@ -80,7 +81,7 @@ def test_admin_start_stop_ws(self, web3: "Web3") -> None:
     def test_admin_addPeer(self, web3: "Web3") -> None:
         with pytest.warns(DeprecationWarning):
             result = web3.geth.admin.addPeer(
-                'enode://f1a6b0bdbf014355587c3018454d070ac57801f05d3b39fe85da574f002a32e929f683d72aa5a8318382e4d3c7a05c9b91687b0d997a39619fb8a6e7ad88e512@1.1.1.1:30303',  # noqa: E501
+                EnodeURI('enode://f1a6b0bdbf014355587c3018454d070ac57801f05d3b39fe85da574f002a32e929f683d72aa5a8318382e4d3c7a05c9b91687b0d997a39619fb8a6e7ad88e512@1.1.1.1:30303'),  # noqa: E501
             )
             assert result is True
 
@@ -98,3 +99,44 @@ def test_admin_nodeInfo(self, web3: "Web3") -> None:
             })
             # Test that result gives at least the keys that are listed in `expected`
             assert not set(expected.keys()).difference(result.keys())
+
+
+class GoEthereumAsyncAdminModuleTest:
+
+    @pytest.mark.asyncio
+    async def test_async_datadir(self, async_w3: "Web3") -> None:
+        datadir = await async_w3.geth.admin.datadir()  # type: ignore
+        assert isinstance(datadir, str)
+
+    @pytest.mark.asyncio
+    async def test_async_nodeinfo(self, async_w3: "Web3") -> None:
+        node_info = await async_w3.geth.admin.node_info()  # type: ignore
+        assert "Geth" in node_info["name"]
+
+    @pytest.mark.asyncio
+    async def test_async_nodes(self, async_w3: "Web3") -> None:
+        nodes = await async_w3.geth.admin.peers()  # type: ignore
+        assert isinstance(nodes, List)
+
+    @pytest.mark.asyncio
+    async def test_admin_peers(self, web3: "Web3") -> None:
+        enode = await web3.geth.admin.node_info()['enode']  # type: ignore
+        web3.geth.admin.add_peer(enode)
+        result = await web3.geth.admin.peers()  # type: ignore
+        assert len(result) == 1
+
+    @pytest.mark.asyncio
+    async def test_admin_start_stop_rpc(self, web3: "Web3") -> None:
+        stop = await web3.geth.admin.stop_rpc()  # type: ignore
+        assert stop is True
+
+        start = await web3.geth.admin.start_rpc()  # type: ignore
+        assert start is True
+
+    @pytest.mark.asyncio
+    async def test_admin_start_stop_ws(self, web3: "Web3") -> None:
+        stop = await web3.geth.admin.stop_ws()  # type: ignore
+        assert stop is True
+
+        start = await web3.geth.admin.start_ws()  # type: ignore
+        assert start is True

web3/_utils/module_testing/go_ethereum_admin_module.py

@@ -77,7 +77,10 @@
     Module,
 )
 from web3.types import (
+    EnodeURI,
     GethWallet,
+    NodeInfo,
+    Peer,
     TxParams,
     TxPoolContent,
     TxPoolInspect,
@@ -258,25 +261,123 @@ async def status(self) -> Awaitable[Any]:
         return await self._status()  # type: ignore
 
 
-class GethAdmin(Module):
+class BaseGethAdmin(Module):
     """
     https://github.com/ethereum/go-ethereum/wiki/Management-APIs#admin
     """
-    add_peer = add_peer
-    node_info = node_info
-    start_rpc = start_rpc
-    start_ws = start_ws
-    stop_ws = stop_ws
-    stop_rpc = stop_rpc
+    _add_peer = add_peer
+    _datadir = datadir
+    _node_info = node_info
+    _peers = peers
+    _start_rpc = start_rpc
+    _start_ws = start_ws
+    _stop_ws = stop_ws
+    _stop_rpc = stop_rpc
     # deprecated
-    addPeer = addPeer
-    datadir = datadir
-    nodeInfo = nodeInfo
-    peers = peers
-    startRPC = startRPC
-    startWS = startWS
-    stopRPC = stopRPC
-    stopWS = stopWS
+    _addPeer = addPeer
+    _nodeInfo = nodeInfo
+    _startRPC = startRPC
+    _startWS = startWS
+    _stopRPC = stopRPC
+    _stopWS = stopWS
+
+
+class GethAdmin(BaseGethAdmin):
+    is_async = False
+
+    def add_peer(self, node_url: EnodeURI) -> bool:
+        return self._add_peer(node_url)
+
+    def datadir(self) -> str:
+        return self._datadir()
+
+    def node_info(self) -> NodeInfo:
+        return self._node_info()
+
+    def peers(self) -> List[Peer]:
+        return self._peers()
+
+    def start_rpc(self,
+                  host: str = "localhost",
+                  port: int = 8546,
+                  cors: str = "",
+                  apis: str = "eth,net,web3") -> bool:
+        return self._start_rpc(host, port, cors, apis)
+
+    def start_ws(self,
+                 host: str = "localhost",
+                 port: int = 8546,
+                 cors: str = "",
+                 apis: str = "eth,net,web3") -> bool:
+        return self._start_ws(host, port, cors, apis)
+
+    def stop_rpc(self) -> bool:
+        return self._stop_rpc()
+
+    def stop_ws(self) -> bool:
+        return self._stop_ws()
+
+    def addPeer(self, node_url: EnodeURI) -> bool:
+        return self._addPeer(node_url)
+
+    def nodeInfo(self) -> NodeInfo:
+        return self._nodeInfo()
+
+    def startRPC(self,
+                 host: str = "localhost",
+                 port: int = 8546,
+                 cors: str = "",
+                 apis: str = "eth,net,web3") -> bool:
+        return self._startRPC(host, port, cors, apis)
+
+    def startWS(self,
+                host: str = "localhost",
+                port: int = 8546,
+                cors: str = "",
+                apis: str = "eth,net,web3") -> bool:
+        return self._startWS(host, port, cors, apis)
+
+    def stopRPC(self) -> bool:
+        return self._stopRPC()
+
+    def stopWS(self) -> bool:
+        return self._stopWS()
+
+
+class AsyncGethAdmin(BaseGethAdmin):
+    is_async = True
+
+    async def add_peer(self, node_url: EnodeURI) -> Awaitable[bool]:
+        return await self._add_peer(node_url)  # type: ignore
+
+    async def datadir(self) -> Awaitable[str]:
+        return await self._datadir()  # type: ignore
+
+    async def node_info(self) -> Awaitable[NodeInfo]:
+        return await self._node_info()  # type: ignore
+
+    async def peers(self) -> Awaitable[List[Peer]]:
+        return await self._peers()  # type: ignore
+
+    async def start_rpc(self,
+                        host: str = "localhost",
+                        port: int = 8546,
+                        cors: str = "",
+                        apis: str = "eth,net,web3") -> Awaitable[bool]:
+        return await self._start_rpc(host, port, cors, apis)  # type: ignore
+
+    async def start_ws(self,
+                       host: str = "localhost",
+                       port: int = 8546,
+                       cors: str = "",
+                       apis: str = "eth,net,web3") -> Awaitable[bool]:
+        return await self._start_ws(host, port, cors, apis)  # type: ignore
+
+    async def stop_rpc(self) -> Awaitable[bool]:
+        return await self._stop_rpc()  # type: ignore
+
+    async def stop_ws(self) -> Awaitable[bool]:
+        return await self._stop_ws()  # type: ignore
 
 
 class GethMiner(Module):