Add new script to retrieve chains info from Viem

scripts/generators/generate_chains_info_from_viem.py

@@ -0,0 +1,261 @@
+import json
+import re
+import shutil
+from glob import glob
+from typing import Optional
+
+import requests
+from git import Repo
+
+GIT_URL = "https://github.com/wevm/viem.git"
+REPO_DIR = "sources"
+RESULT_MULTICALL_ADDRESSES_FILE_PATH = "multicall_addresses.json"
+
+ATTR_ID = "id"
+ATTR_URL = "url"
+ATTR_API_URL = "api_url"
+ATTR_MULTICALL_ADDRESS = "multicall_address"
+ATTR_MULTICALL_BLOCK_CREATED = "multicall_block_created"
+
+SEARCH_PATTERNS = {
+    ATTR_ID: r"id\s*:\s*([\d_]+)",
+    ATTR_URL: r"url\s*:\s*[\'\"]([^\'\"]+)[\'\"]",
+    ATTR_API_URL: r"apiUrl\s*:\s*[\'\"]([^\'\"]+)[\'\"]",
+    ATTR_MULTICALL_ADDRESS: r"multicall3\s*:\s*{\s*address\s*:\s*[\'\"]([^\'\"]+)[\'\"]",
+    ATTR_MULTICALL_BLOCK_CREATED: r"multicall3\s*:\s*{\s*[^}]*blockCreated\s*:\s*(\d+)",
+}
+
+
+def clean_resources() -> None:
+    """Removes the intermediate resources used (source repository)"""
+    try:
+        shutil.rmtree(REPO_DIR)
+    except OSError:
+        pass
+
+
+def convert_chain_name(name: str) -> str:
+    """
+    Converts a chain name into a valid constant name by replacing non-word characters
+    with underscores and ensuring it does not start with a digit.
+
+    :param name: The original chain name.
+    :return: The converted chain name suitable for use as a constant.
+    """
+    # Change every symbol that is not a word or digit for underscore
+    name_converted = re.sub(r"[^\w\d]+", r"_", name.upper().replace(")", ""))
+    # Add underscore at the beggining if start by digit
+    if name_converted[0].isdigit():
+        name_converted = "_" + name_converted
+    return name_converted
+
+
+def get_chain_enum_name(chain_id: int) -> Optional[str]:
+    """
+    Retrieves the chain name for a given chain ID from the Ethereum Chains GitHub repository.
+    Converts the name to a constant format using `convert_chain_name`.
+
+    :param chain_id: The ID of the chain.
+    :return: The converted chain name as a string, or None if the request fails.
+    """
+    try:
+        url = f"https://raw.githubusercontent.com/ethereum-lists/chains/master/_data/chains/eip155-{chain_id}.json"
+        response = requests.get(url)
+        if response.status_code == 200:
+            return convert_chain_name(response.json().get("name"))
+        return None
+    except IOError as e:
+        print(f"Error getting chain name: {e}")
+        return None
+
+
+def validate_api_url(api_url: str) -> bool:
+    """
+    Validates the API URL by making a request to the `ethsupply` endpoint
+    and checking if the response status is '1'.
+
+    :param api_url: The URL to validate.
+    :return: True if the URL is valid, otherwise False.
+    """
+    try:
+        url = f"{api_url}?module=stats&action=ethsupply"
+        response = requests.get(url, verify=False)
+        if response.status_code == 200:
+            tx_status = response.json().get("status", "")
+            if tx_status == "1":
+                return True
+    except (IOError, ConnectionError) as e:
+        print(f"Error validating Etherscan Client API URL: {e}")
+    return False
+
+
+def upsert_chain_id(chain_id: int, chain_enum_name: str) -> str:
+    """
+    Inserts or updates an entry in the `EthereumNetwork` enum for the given chain ID and name.
+    If an entry with the same chain ID exists, it returns the existing constant name.
+    Otherwise, it adds a new entry and returns the new constant name.
+
+    :param chain_id: The ID of the chain.
+    :param chain_enum_name: The name of the chain in constant format.
+    :return: The name of the constant in the `EthereumNetwork` enum.
+    """
+    file_path = "safe_eth/eth/ethereum_network.py"
+    with open(file_path, "r") as file:
+        content = file.read()
+    match = re.search(
+        r'class EthereumNetwork\(Enum\):(\s*\n\s*"""[^"]*"""\s*\n\s*)?(.+?)(\n\s*@.*)',
+        content,
+        re.MULTILINE | re.DOTALL,
+    )
+    if match:
+        enum_lines = str(match.group(2).strip()).split("\n")
+        existing_entry = next(
+            (line for line in enum_lines if re.search(rf"\b{chain_id}\b", line)), None
+        )
+        if existing_entry:
+            match = re.match(r"^\s*(\w+)\s*=", existing_entry)
+            if match:
+                current_constant_name = match.group(1)
+                print(
+                    f"Entry with ID '{chain_id}' already exists with the name '{current_constant_name}'."
+                )
+                return current_constant_name
+        else:
+            new_entry = f"    {chain_enum_name} = {chain_id}"
+            enum_lines.append(new_entry)
+            enum_lines.sort(key=lambda x: int(x.split("=")[1].strip().replace("_", "")))
+            updated_content = (
+                content[: match.start()]
+                + "class EthereumNetwork(Enum):"
+                + match.group(1)
+                + "\n".join(enum_lines)
+                + match.group(3)
+            )
+            with open(file_path, "w") as file:
+                file.write(updated_content)
+            print(f"Entry '{chain_enum_name} = {chain_id}' added successfully.")
+    else:
+        print("Error: EthereumNetwork class definition not found in the file.")
+    return chain_enum_name
+
+
+def upsert_explorer_client_url(
+    chain_enum_name: str,
+    client_url: str,
+    config_enum_name: str,
+) -> None:
+    """
+    Updates or adds the URL for a given chain in the specified config enum.
+    If the URL already exists, it updates the entry. If not, it adds a new entry.
+
+    :param chain_enum_name: The name of the chain constant in the enum.
+    :param client_url: The URL to add or update.
+    :param config_enum_name: The name of the configuration enum to update.
+    :return: None
+    """
+    file_path = "safe_eth/eth/clients/etherscan_client.py"
+    with open(file_path, "r") as file:
+        content = file.read()
+    match = re.search(
+        config_enum_name + r" = \{\n(.+?)(\n\s*}.*)", content, re.MULTILINE | re.DOTALL
+    )
+    if match:
+        url_lines = str(match.group(1).strip()).split("\n")
+        existing_entry_index = next(
+            (
+                i
+                for i, line in enumerate(url_lines)
+                if re.search(f"EthereumNetwork.{chain_enum_name}:", line)
+            ),
+            None,
+        )
+        if existing_entry_index is not None:
+            url_lines[
+                existing_entry_index
+            ] = f'        EthereumNetwork.{chain_enum_name}: "{client_url}",'
+            print(
+                f"Updated entry EthereumNetwork.{chain_enum_name} with URL '{client_url}'."
+            )
+        else:
+            new_entry = f'        EthereumNetwork.{chain_enum_name}: "{client_url}",'
+            url_lines.append(new_entry)
+            print(
+                f"Added new entry EthereumNetwork.{chain_enum_name} with URL '{client_url}'."
+            )
+        updated_content = (
+            content[: match.start()]
+            + config_enum_name
+            + " = {\n        "
+            + "\n".join(url_lines)
+            + match.group(2)
+        )
+        with open(file_path, "w") as file:
+            file.write(updated_content)
+    else:
+        print("Error: Class definition not found in the file.")
+
+
+def process_chains() -> None:
+    """
+    Processes the chain definitions from TypeScript files in the Viem GitHub repository.
+    It clones the repository, extracts chain information, updates or adds chain IDs and etherscan client URLs,
+    and writes multicall contract addresses to a JSON file.
+    """
+    clean_resources()
+    Repo.clone_from(GIT_URL, REPO_DIR)
+
+    chains_info = []
+    multicall_contract_addresses = {}
+
+    for f_name in glob(REPO_DIR + "/src/chains/definitions/**/*.ts", recursive=True):
+        with open(f_name, "r") as file:
+            content = file.read()
+        chain_info = {}
+        for key, pattern in SEARCH_PATTERNS.items():
+            match = re.search(pattern, content)
+            if match:
+                chain_info[key] = match.group(1)
+        if chain_info:
+            chains_info.append(chain_info)
+
+    for chain_info in chains_info:
+        chain_id = int(chain_info[ATTR_ID].replace("_", ""))
+        chain_name = get_chain_enum_name(chain_id)
+        if chain_name:
+            chain_enum_name = upsert_chain_id(chain_id, chain_name)
+
+            if chain_info.get(ATTR_URL) and chain_info.get(ATTR_API_URL):
+                chain_explorer_url = chain_info[ATTR_URL]
+                chain_explorer_api_url = chain_info[ATTR_API_URL]
+                valid_api_url = validate_api_url(chain_explorer_api_url)
+                if valid_api_url:
+                    upsert_explorer_client_url(
+                        chain_enum_name, chain_explorer_url, "NETWORK_WITH_URL"
+                    )
+                    base_api_url = (
+                        chain_explorer_url[: -len("/api")]
+                        if chain_explorer_url.endswith("/api")
+                        else chain_explorer_url
+                    )
+                    upsert_explorer_client_url(
+                        chain_enum_name,
+                        base_api_url,
+                        "NETWORK_WITH_API_URL",
+                    )
+
+            if chain_info.get(ATTR_MULTICALL_ADDRESS) and chain_info.get(
+                ATTR_MULTICALL_BLOCK_CREATED
+            ):
+                multicall_contract_addresses[chain_enum_name] = (
+                    chain_info[ATTR_MULTICALL_ADDRESS],
+                    int(chain_info[ATTR_MULTICALL_BLOCK_CREATED]),
+                )
+
+    with open(RESULT_MULTICALL_ADDRESSES_FILE_PATH, "w") as file:
+        json.dump(multicall_contract_addresses, file, indent=4)
+
+    clean_resources()
+
+
+if __name__ == "__main__":
+    process_chains()