fix(client): add rate limiter to Safe Transaction Gateway session (#100)

Author: fubuloubu

ape_safe/client/__init__.py

@@ -11,7 +11,7 @@
 from eth_utils import to_hex
 from pydantic import TypeAdapter
 
-from ape_safe.client.base import BaseSafeClient
+from ape_safe.client.base import BaseSafeClient, RequestsClient
 from ape_safe.client.mock import MockSafeClient
 from ape_safe.client.types import (
     DelegateInfo,
@@ -71,7 +71,9 @@
 }
 
 
-class SafeClient(BaseSafeClient):
+class SafeClient(RequestsClient):
+    """Client to use to communicate with Safe Client Gateway Service"""
+
     def __init__(
         self,
         address: AddressType,
@@ -158,8 +160,14 @@ def post_transaction(
         tx_data = UnexecutedTxData.from_safe_tx(safe_tx, self.safe_details.threshold)
         signature = HexBytes(
             reduce(
-                lambda raw_sig, next_sig: raw_sig
-                + (next_sig.encode_rsv() if isinstance(next_sig, MessageSignature) else next_sig),
+                lambda raw_sig, next_sig: (
+                    raw_sig
+                    + (
+                        next_sig.encode_rsv()
+                        if isinstance(next_sig, MessageSignature)
+                        else next_sig
+                    )
+                ),
                 order_by_signer(signatures),
                 b"",
             )
@@ -278,6 +286,7 @@ def remove_delegate(self, delegate: "AddressType", delegator: "AccountAPI"):
 
 __all__ = [
     "ExecutedTxData",
+    "BaseSafeClient",
     "MockSafeClient",
     "OperationType",
     "SafeApiTxData",

ape_safe/client/base.py

@@ -5,11 +5,11 @@
 from typing import TYPE_CHECKING, Optional, Union
 
 import certifi
-import requests
 import urllib3
 from ape.types import AddressType, HexBytes, MessageSignature
 from eth_utils import keccak
 from requests.adapters import HTTPAdapter
+from requests_ratelimiter import LimiterSession
 
 from ape_safe.client.types import (
     ExecutedTxData,
@@ -24,7 +24,7 @@
 
 if TYPE_CHECKING:
     from ape.api import AccountAPI
-    from requests import Response
+    from requests import Response, Session
 
 DEFAULT_HEADERS = {
     "Accept": "application/json",
@@ -33,10 +33,7 @@
 
 
 class BaseSafeClient(ABC):
-    def __init__(self, base_url: str):
-        self.base_url = base_url
-
-    """Abstract methods"""
+    """All custom SafeClient instances should implement this"""
 
     @property
     @abstractmethod
@@ -135,11 +132,14 @@ def add_delegate(self, delegate: AddressType, label: str, delegator: "AccountAPI
     @abstractmethod
     def remove_delegate(self, delegate: AddressType, delegator: "AccountAPI"): ...
 
-    """Request methods"""
+
+class RequestsClient(BaseSafeClient):
+    def __init__(self, base_url: str):
+        self.base_url = base_url
 
     @cached_property
-    def session(self) -> requests.Session:
-        session = requests.Session()
+    def session(self) -> "Session":
+        session = LimiterSession(per_second=5)
         adapter = HTTPAdapter(
             pool_connections=10,  # Doing all the connections to the same url
             pool_maxsize=100,  # Number of concurrent connections

setup.py

@@ -68,6 +68,7 @@
         "eth-utils>=2.1.0,<6",
         "pydantic>=2.10.2,<3",
         "requests>=2.31.0,<3",
+        "requests-ratelimiter>=0.7,<1",
     ],
     entry_points={
         "ape_cli_subcommands": [