Remove EthereumClientProvider

- That solution was very hacky, typing was not working correctly
- Create a new `get_auto_ethereum_client`
- Refactor code to use the new method

gnosis/eth/__init__.py

@@ -1,7 +1,6 @@
 # flake8: noqa F401
 from .ethereum_client import (
     EthereumClient,
-    EthereumClientProvider,
     EthereumTxSent,
     FromAddressNotFound,
     GasLimitExceeded,
@@ -15,13 +14,14 @@
     TransactionQueueLimitReached,
     TxSpeed,
     UnknownAccount,
+    get_auto_ethereum_client,
 )
 from .ethereum_network import EthereumNetwork, EthereumNetworkNotSupported
 from .exceptions import InvalidERC20Info, InvalidERC721Info
 
 __all__ = [
     "EthereumClient",
-    "EthereumClientProvider",
+    "get_auto_ethereum_client",
     "EthereumTxSent",
     "FromAddressNotFound",
     "GasLimitExceeded",

gnosis/eth/clients/ens_client.py

@@ -1,13 +1,12 @@
 import os
 from dataclasses import dataclass
+from functools import cache
 from typing import Any, Dict, List, Optional, Union
 
 import requests
 from eth_typing import HexStr
 from hexbytes import HexBytes
 
-from gnosis.util import cache
-
 
 class EnsClient:
     """

gnosis/eth/clients/sourcify_client.py

@@ -1,9 +1,8 @@
 import os
+from functools import cache
 from typing import Any, Dict, List, Optional
 from urllib.parse import urljoin
 
-from gnosis.util import cache
-
 from ...util.http import prepare_http_session
 from .. import EthereumNetwork
 from ..utils import fast_is_checksum_address

gnosis/eth/contracts/__init__.py

@@ -30,15 +30,14 @@
 import json
 import os
 import sys
+from functools import cache
 from typing import Any, Callable, Dict, Optional
 
 from eth_typing import ChecksumAddress
 from hexbytes import HexBytes
 from web3 import Web3
 from web3.contract import Contract
 
-from gnosis.util import cache
-
 from .abis.multicall import multicall_v3_abi, multicall_v3_bytecode
 from .contract_base import ContractBase
 

gnosis/eth/ethereum_client.py

@@ -1,6 +1,6 @@
 import os
 from enum import Enum
-from functools import cached_property, wraps
+from functools import cache, cached_property, wraps
 from logging import getLogger
 from typing import (
     Any,
@@ -59,7 +59,7 @@
     mk_contract_address,
     mk_contract_address_2,
 )
-from gnosis.util import cache, chunks
+from gnosis.util import chunks
 
 from ..util.http import prepare_http_session
 from .constants import (
@@ -177,28 +177,33 @@ class TxSpeed(Enum):
     FASTEST = 6
 
 
-class EthereumClientProvider:
-    def __new__(cls):
-        if not hasattr(cls, "instance"):
-            try:
-                from django.conf import settings
-
-                ethereum_node_url = settings.ETHEREUM_NODE_URL
-            except ModuleNotFoundError:
-                ethereum_node_url = os.environ.get("ETHEREUM_NODE_URL")
-
-            cls.instance = EthereumClient(
-                ethereum_node_url,
-                provider_timeout=int(os.environ.get("ETHEREUM_RPC_TIMEOUT", 10)),
-                slow_provider_timeout=int(
-                    os.environ.get("ETHEREUM_RPC_SLOW_TIMEOUT", 60)
-                ),
-                retry_count=int(os.environ.get("ETHEREUM_RPC_RETRY_COUNT", 1)),
-                batch_request_max_size=int(
-                    os.environ.get("ETHEREUM_RPC_BATCH_REQUEST_MAX_SIZE", 500)
-                ),
-            )
-        return cls.instance
+@cache
+def get_auto_ethereum_client() -> "EthereumClient":
+    """
+    Use environment variables to configure `EthereumClient` and build a singleton:
+        - `ETHEREUM_NODE_URL`: No default.
+        - `ETHEREUM_RPC_TIMEOUT`: `10` by default.
+        - `ETHEREUM_RPC_SLOW_TIMEOUT`: `60` by default.
+        - `ETHEREUM_RPC_RETRY_COUNT`: `60` by default.
+        - `ETHEREUM_RPC_BATCH_REQUEST_MAX_SIZE`: `500` by default.
+
+    :return: A configured singleton of EthereumClient
+    """
+    try:
+        from django.conf import settings
+
+        ethereum_node_url = settings.ETHEREUM_NODE_URL
+    except ModuleNotFoundError:
+        ethereum_node_url = os.environ.get("ETHEREUM_NODE_URL")
+    return EthereumClient(
+        ethereum_node_url,
+        provider_timeout=int(os.environ.get("ETHEREUM_RPC_TIMEOUT", 10)),
+        slow_provider_timeout=int(os.environ.get("ETHEREUM_RPC_SLOW_TIMEOUT", 60)),
+        retry_count=int(os.environ.get("ETHEREUM_RPC_RETRY_COUNT", 1)),
+        batch_request_max_size=int(
+            os.environ.get("ETHEREUM_RPC_BATCH_REQUEST_MAX_SIZE", 500)
+        ),
+    )
 
 
 class EthereumClientManager:

gnosis/eth/tests/ethereum_test_case.py

@@ -7,7 +7,7 @@
 from web3.contract import Contract
 from web3.types import TxParams
 
-from ..ethereum_client import EthereumClient, EthereumClientProvider
+from ..ethereum_client import EthereumClient, get_auto_ethereum_client
 from ..multicall import Multicall
 from .utils import deploy_erc20, send_tx
 
@@ -35,7 +35,7 @@ def setUpClass(cls):
         cls.ethereum_client = _cached_data["ethereum_client"]
 
         if not cls.ethereum_client:
-            cls.ethereum_client = EthereumClientProvider()
+            cls.ethereum_client = get_auto_ethereum_client()
             Multicall.deploy_contract(cls.ethereum_client, cls.ethereum_test_account)
             _cached_data["ethereum_client"] = cls.ethereum_client
 

gnosis/eth/tests/test_ethereum_client.py

@@ -15,13 +15,13 @@
 from ..contracts import get_erc20_contract
 from ..ethereum_client import (
     EthereumClient,
-    EthereumClientProvider,
     EthereumNetwork,
     FromAddressNotFound,
     InsufficientFunds,
     InvalidNonce,
     SenderAccountNotFoundInNode,
     TracingManager,
+    get_auto_ethereum_client,
 )
 from ..exceptions import BatchCallException, ChainIdIsRequired, InvalidERC20Info
 from .ethereum_test_case import EthereumTestCaseMixin
@@ -922,8 +922,8 @@ def test_estimate_data_gas(self):
         )
 
     def test_provider_singleton(self):
-        ethereum_client1 = EthereumClientProvider()
-        ethereum_client2 = EthereumClientProvider()
+        ethereum_client1 = get_auto_ethereum_client()
+        ethereum_client2 = get_auto_ethereum_client()
         self.assertEqual(ethereum_client1, ethereum_client2)
 
     def test_send_eth_to(self):

gnosis/safe/proxy_factory.py

@@ -1,5 +1,6 @@
 import secrets
 from abc import ABCMeta
+from functools import cache
 from typing import Callable, Optional
 
 from eth_abi.packed import encode_packed
@@ -28,7 +29,6 @@
     get_empty_tx_params,
     mk_contract_address_2,
 )
-from gnosis.util import cache
 
 
 class ProxyFactory(ContractBase, metaclass=ABCMeta):

gnosis/util/__init__.py

@@ -1,4 +1,4 @@
 # flake8: noqa F401
-from .util import cache, chunks
+from .util import chunks
 
-__all__ = ["cache", "chunks"]
+__all__ = ["chunks"]

gnosis/util/util.py

@@ -1,12 +1,5 @@
 from typing import Any, Iterable, Sequence
 
-try:
-    from functools import cache
-except ImportError:
-    from functools import lru_cache
-
-    cache = lru_cache(maxsize=None)
-
 
 def chunks(elements: Sequence[Any], n: int) -> Iterable[Any]:
     """