Improve docs for Sourcify and Etherscan clients

safe-global · Dec 16, 2024 · 2535f9d · 2535f9d
1 parent 27f89be
commit 2535f9d
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 3 deletions.
diff --git a/safe_eth/eth/clients/etherscan_client_v2.py b/safe_eth/eth/clients/etherscan_client_v2.py
@@ -9,6 +9,12 @@
 
 
 class EtherscanClientV2(EtherscanClient):
+    """
+    Etherscan API V2 supports multiple chains in the same url.
+
+    Reference: https://docs.etherscan.io/etherscan-v2
+    """
+
     BASE_API_V2_URL = "https://api.etherscan.io"
 
     def __init__(
@@ -35,6 +41,24 @@ def get_supported_networks(cls) -> List[Dict[str, Any]]:
         Fetches a list of supported networks by the Etherscan API v2.
 
         :return: List of supported networks, or empty list if request fails.
+
+        Example response
+        ```
+        {
+            "chainname":"Ethereum Mainnet",
+            "chainid":"1",
+            "blockexplorer":"https://etherscan.io",
+            "apiurl":"https://api.etherscan.io/v2/api?chainid=1",
+            "status":1
+        },
+        {
+            "chainname":"Sepolia Testnet",
+            "chainid":"11155111",
+            "blockexplorer":"https://sepolia.etherscan.io",
+            "apiurl":"https://api.etherscan.io/v2/api?chainid=11155111",
+            "status":1
+        }
+        ```
         """
         url = urljoin(cls.BASE_API_V2_URL, "v2/chainlist")
         response = requests.get(url)
@@ -48,7 +72,7 @@ def is_supported_network(cls, network: EthereumNetwork) -> bool:
         Checks if a given Ethereum network is supported by the Etherscan API v2.
 
         :param network: The Ethereum network to check.
-        :return: True if the network is supported; False otherwise.
+        :return: `True` if the network is supported; `False` otherwise.
         """
         supported_networks = cls.get_supported_networks()
         return any(

diff --git a/safe_eth/eth/clients/sourcify_client.py b/safe_eth/eth/clients/sourcify_client.py
@@ -21,12 +21,13 @@ class SourcifyClient:
     """
     Get contract metadata from Sourcify. Matches can be full or partial:
 
-      - Full: Both the source files as well as the meta data files were an exact match between the deployed bytecode
+      - Full: Both the source files and the metadata files were an exact match between the deployed bytecode
         and the published files.
       - Partial: Source code compiles to the same bytecode and thus the contract behaves in the same way,
-        but the source code can be different: Variables can have misleading names,
+        but the source code can be different: variables can have misleading names,
         comments can be different and especially the NatSpec comments could have been modified.
 
+    Reference: https://docs.sourcify.dev/docs/api/
     """
 
     def __init__(