evmchains 0.0.11__tar.gz → 0.0.13__tar.gz

{evmchains-0.0.11 → evmchains-0.0.13}/.github/workflows/test.yaml

@@ -26,15 +26,11 @@ jobs:
             python -m pip install --upgrade pip
             pip install .[dev]
 
-        - name: Run Black
-          #run: black --check .
-          run: black --diff .
+        - name: Run linter
+          run: ruff check
 
-        - name: Run isort
-          run: isort --check-only .
-
-        - name: Run flake8
-          run: flake8 .
+        - name: Run format check
+          run: ruff format --check --diff
 
     type-check:
         runs-on: ubuntu-latest

{evmchains-0.0.11 → evmchains-0.0.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: evmchains
-Version: 0.0.11
+Version: 0.0.13
 Summary: Packaged metadata on Ethereum Virtual Machine (EVM) chains
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -227,11 +227,10 @@ Requires-Dist: pydantic<3,>=2.5.3
 Provides-Extra: dev
 Requires-Dist: black~=23.12.1; extra == "dev"
 Requires-Dist: build~=1.0.3; extra == "dev"
-Requires-Dist: flake8~=7.0.0; extra == "dev"
-Requires-Dist: isort~=5.13.2; extra == "dev"
 Requires-Dist: mypy~=1.8.0; extra == "dev"
 Requires-Dist: pytest~=7.4.4; extra == "dev"
 Requires-Dist: requests~=2.31.0; extra == "dev"
+Requires-Dist: ruff~=0.6.8; extra == "dev"
 Requires-Dist: setuptools-scm~=8.0.4; extra == "dev"
 Requires-Dist: types-requests>=2.31.0.20240106; extra == "dev"
 

{evmchains-0.0.11 → evmchains-0.0.13}/evmchains/__init__.py

@@ -1,3 +1,9 @@
+"""EVM-compatible chains metadata.
+
+Chain data is organized by Ape-style ecosystem and network and provided by the
+below utility functions.
+"""
+
 import os
 import random
 import re
@@ -10,7 +16,7 @@ ENV_VAR_REGEX = re.compile(r"\$\{([A-Za-z0-9_]+)\}")
 
 
 def get_chain_meta(ecosystem: str, network: str) -> Chain:
-    """Return a Chain instance with metadata for an EVM chain"""
+    """Return a Chain instance with metadata for an EVM chain."""
     if (
         ecosystem not in PUBLIC_CHAIN_META
         or network not in PUBLIC_CHAIN_META[ecosystem]
@@ -21,7 +27,7 @@ def get_chain_meta(ecosystem: str, network: str) -> Chain:
 
 
 def get_rpcs(ecosystem: str, network: str) -> List[str]:
-    """Get a list of valid RPC endpoints for an ecosystem:network pair"""
+    """Get a list of valid RPC endpoints for an ecosystem:network pair."""
     rpcs = []
 
     chain = get_chain_meta(ecosystem, network)
@@ -42,7 +48,7 @@ def get_rpcs(ecosystem: str, network: str) -> List[str]:
 
 
 def get_random_rpc(ecosystem: str, network: str) -> str:
-    """Return a random RPC endpoint for an ecosystem:network pair"""
+    """Return a random RPC endpoint for an ecosystem:network pair."""
     rpcs = get_rpcs(ecosystem, network)
     return random.choice(rpcs)
 

{evmchains-0.0.11 → evmchains-0.0.13}/evmchains/_meta.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.0.11'
-__version_tuple__ = version_tuple = (0, 0, 11)
+__version__ = version = '0.0.13'
+__version_tuple__ = version_tuple = (0, 0, 13)

{evmchains-0.0.11 → evmchains-0.0.13}/evmchains/chains.py

@@ -1,6 +1,12 @@
-# This file is auto-generated by scripts/update.py
-# 2024-07-03 20:26:21.491217
-# Do not edit this file directly.
+"""Constants containing metadata for EVM-comaptitble chains.
+
+!!!!!!!!!!!!!!!!!!!!!!!!! WARNING !!!!!!!!!!!!!!!!!!!!!!!!!
+!!!! DO NOT EDIT THIS FILE DIRECTLY!                   !!!!
+!!!! This file is auto-generated by scripts/update.py  !!!!
+!!!! 2024-10-15 20:35:49.075377+00:00                  !!!!
+!!!!!!!!!!!!!!!!!!!!!!!!! WARNING !!!!!!!!!!!!!!!!!!!!!!!!!
+"""
+
 from typing import Any, Dict
 
 PUBLIC_CHAIN_META: Dict[str, Dict[str, Dict[str, Any]]] = {
@@ -367,6 +373,38 @@ PUBLIC_CHAIN_META: Dict[str, Dict[str, Dict[str, Any]]] = {
             "shortName": "bnbt",
             "slip44": 1,
         },
+        "opBNB": {
+            "chain": "opBNB",
+            "chainId": 204,
+            "ens": None,
+            "explorers": [
+                {
+                    "name": "opbnbscan",
+                    "standard": "EIP3091",
+                    "url": "https://mainnet.opbnbscan.com",
+                }
+            ],
+            "faucets": [],
+            "features": None,
+            "icon": "bnbchain",
+            "infoURL": "https://opbnb.bnbchain.org/en",
+            "name": "opBNB Mainnet",
+            "nativeCurrency": {
+                "decimals": 18,
+                "name": "BNB Chain Native Token",
+                "symbol": "BNB",
+            },
+            "networkId": 204,
+            "rpc": [
+                "https://opbnb-mainnet-rpc.bnbchain.org",
+                "https://opbnb-mainnet.nodereal.io/v1/64a9df0874fb4a93b9d0a3849de012d3",
+                "https://opbnb-mainnet.nodereal.io/v1/e9a36765eb8a40b9bd12e680a1fd2bc5",
+                "https://opbnb-rpc.publicnode.com",
+                "https://opbnb.drpc.org",
+            ],
+            "shortName": "obnb",
+            "slip44": 714,
+        },
     },
     "ethereum": {
         "mainnet": {
@@ -528,13 +566,11 @@ PUBLIC_CHAIN_META: Dict[str, Dict[str, Dict[str, Any]]] = {
             "rpc": [
                 "https://rpc.sepolia.org",
                 "https://rpc2.sepolia.org",
-                "https://rpc-sepolia.rockx.com",
                 "https://rpc.sepolia.ethpandaops.io",
                 "https://sepolia.infura.io/v3/${INFURA_API_KEY}",
                 "https://sepolia.gateway.tenderly.co",
                 "https://ethereum-sepolia-rpc.publicnode.com",
                 "https://sepolia.drpc.org",
-                "https://rpc-sepolia.rockx.com",
             ],
             "shortName": "sep",
             "slip44": 1,
@@ -688,6 +724,7 @@ PUBLIC_CHAIN_META: Dict[str, Dict[str, Dict[str, Any]]] = {
             "rpc": [
                 "https://rpc.linea.build",
                 "https://linea-mainnet.infura.io/v3/${INFURA_API_KEY}",
+                "https://linea-rpc.publicnode.com",
             ],
             "shortName": "linea",
             "slip44": None,
@@ -720,6 +757,7 @@ PUBLIC_CHAIN_META: Dict[str, Dict[str, Dict[str, Any]]] = {
             "rpc": [
                 "https://rpc.sepolia.linea.build",
                 "https://linea-sepolia.infura.io/v3/${INFURA_API_KEY}",
+                "https://linea-sepolia-rpc.publicnode.com",
             ],
             "shortName": "linea-sepolia",
             "slip44": 1,
@@ -892,7 +930,7 @@ PUBLIC_CHAIN_META: Dict[str, Dict[str, Dict[str, Any]]] = {
             "icon": "polygon",
             "infoURL": "https://polygon.technology/",
             "name": "Polygon Mainnet",
-            "nativeCurrency": {"decimals": 18, "name": "MATIC", "symbol": "MATIC"},
+            "nativeCurrency": {"decimals": 18, "name": "POL", "symbol": "POL"},
             "networkId": 137,
             "rpc": [
                 "https://polygon-rpc.com/",
@@ -905,7 +943,7 @@ PUBLIC_CHAIN_META: Dict[str, Dict[str, Dict[str, Any]]] = {
                 "https://polygon.gateway.tenderly.co",
                 "https://polygon.drpc.org",
             ],
-            "shortName": "matic",
+            "shortName": "pol",
             "slip44": 966,
         },
         "mumbai": {
@@ -950,7 +988,7 @@ PUBLIC_CHAIN_META: Dict[str, Dict[str, Dict[str, Any]]] = {
             "icon": "polygon",
             "infoURL": "https://polygon.technology/",
             "name": "Amoy",
-            "nativeCurrency": {"decimals": 18, "name": "MATIC", "symbol": "MATIC"},
+            "nativeCurrency": {"decimals": 18, "name": "POL", "symbol": "POL"},
             "networkId": 80002,
             "rpc": [
                 "https://rpc-amoy.polygon.technology",

{evmchains-0.0.11 → evmchains-0.0.13}/evmchains/types.py

@@ -1,9 +1,14 @@
+"""Types used in the evmchains package."""
+
+# ruff: noqa: N815
 from typing import Any, Dict, List, Optional
 
 from pydantic import BaseModel
 
 
 class Chain(BaseModel):
+    """Chain object format for chain data from ethereum-lists/chains."""
+
     chainId: int
     networkId: int
     name: str

{evmchains-0.0.11 → evmchains-0.0.13}/evmchains.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: evmchains
-Version: 0.0.11
+Version: 0.0.13
 Summary: Packaged metadata on Ethereum Virtual Machine (EVM) chains
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -227,11 +227,10 @@ Requires-Dist: pydantic<3,>=2.5.3
 Provides-Extra: dev
 Requires-Dist: black~=23.12.1; extra == "dev"
 Requires-Dist: build~=1.0.3; extra == "dev"
-Requires-Dist: flake8~=7.0.0; extra == "dev"
-Requires-Dist: isort~=5.13.2; extra == "dev"
 Requires-Dist: mypy~=1.8.0; extra == "dev"
 Requires-Dist: pytest~=7.4.4; extra == "dev"
 Requires-Dist: requests~=2.31.0; extra == "dev"
+Requires-Dist: ruff~=0.6.8; extra == "dev"
 Requires-Dist: setuptools-scm~=8.0.4; extra == "dev"
 Requires-Dist: types-requests>=2.31.0.20240106; extra == "dev"
 

{evmchains-0.0.11 → evmchains-0.0.13}/evmchains.egg-info/requires.txt

@@ -3,10 +3,9 @@ pydantic<3,>=2.5.3
 [dev]
 black~=23.12.1
 build~=1.0.3
-flake8~=7.0.0
-isort~=5.13.2
 mypy~=1.8.0
 pytest~=7.4.4
 requests~=2.31.0
+ruff~=0.6.8
 setuptools-scm~=8.0.4
 types-requests>=2.31.0.20240106

{evmchains-0.0.11 → evmchains-0.0.13}/pyproject.toml

@@ -33,13 +33,13 @@ dynamic = ["version"]
 
 [project.optional-dependencies]
 dev = [
+    # NOTE: black still used as a library in update.py
     "black~=23.12.1",
     "build~=1.0.3",
-    "flake8~=7.0.0",
-    "isort~=5.13.2",
     "mypy~=1.8.0",
     "pytest~=7.4.4",
     "requests~=2.31.0",
+    "ruff~=0.6.8",
     "setuptools-scm~=8.0.4",
     "types-requests>=2.31.0.20240106",
 ]
@@ -47,25 +47,31 @@ dev = [
 [tool.mypy]
 exclude = "build/"
 
-[tool.setuptools_scm]
-write_to = "evmchains/_meta.py"
+[tool.ruff]
+# Mimic's black's default line length
+line-length = 88
 
-# NOTE: you have to use single-quoted strings in TOML for regular expressions.
-# It's the equivalent of r-strings in Python.  Multiline strings are treated as
-# verbose regular expressions by Black.  Use [ ] to denote a significant space
-# character.
+[tool.ruff.lint]
+# Ref: https://docs.astral.sh/ruff/rules
+extend-select = [
+    "D",    # pydocstyle
+    "E501", # Line length
+    "I",    # isort
+    "N",    # PEP8 naming
+    "UP",   # pyupgrade
+    "RUF",  # ruf-specific rules
+    "W",    # warnings
+]
 
-[tool.black]
-target-version = ['py38', 'py39', 'py310', 'py311', 'py312']
-include = '\.pyi?$'
+[tool.ruff.lint.per-file-ignores]
+"tests/test_*.py" = ["D"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.setuptools_scm]
+write_to = "evmchains/_meta.py"
 
 [tool.pytest.ini_options]
 python_files = "test_*.py"
 testpaths = "tests"
-
-
-[tool.isort]
-force_grid_wrap = 0
-include_trailing_comma = true
-multi_line_output = 3
-use_parentheses = true

{evmchains-0.0.11 → evmchains-0.0.13}/scripts/update.py

@@ -1,5 +1,11 @@
+"""Script updates chains.py constants file with up to date data.
+
+To add new chains to this module, update CHAIN_IDS below and re-run the script. See
+README.md for more details.
+"""
+
 import logging
-from datetime import datetime
+from datetime import datetime, timezone
 from pathlib import Path
 from pprint import PrettyPrinter
 from typing import Any, Dict
@@ -17,10 +23,13 @@ SOURCE_URL = (
 CHAIN_CONST_FILE = Path(__file__).parent.parent / "evmchains" / "chains.py"
 BLACKLIST_STRINGS = [
     # 2024-01-19: Node appears to be broken.  Returning errors on simple requests.
-    "rpc.blocknative.com"
+    "rpc.blocknative.com",
+    # 2024-09-05: Node returning 504s for days.
+    "rpc-sepolia.rockx.com",
 ]
 
-# Mapping of Ape ecosystem:network to chain IDs. These are the chains that we will be fetching.
+# Mapping of Ape ecosystem:network to chain IDs. These are the chains that we will be
+# fetching.
 CHAIN_IDS = {
     "arbitrum": {
         "mainnet": 42161,
@@ -42,6 +51,7 @@ CHAIN_IDS = {
     "bsc": {
         "mainnet": 56,
         "testnet": 97,
+        "opBNB": 204,
     },
     "ethereum": {
         "mainnet": 1,
@@ -86,7 +96,7 @@ CHAIN_IDS = {
     "shibarium": {
         "mainnet": 109,
         "puppynet": 157,
-    }
+    },
 }
 
 pp = PrettyPrinter(indent=4)
@@ -95,11 +105,12 @@ logger.setLevel(logging.DEBUG)
 
 
 def stamp() -> str:
-    """UTC timestamp for file header"""
-    return str(datetime.utcnow())
+    """UTC timestamp for file header."""
+    return str(datetime.now(tz=timezone.utc))
 
 
 def ensure_dict(d: Dict[str, Any], key: str):
+    """Ensures a dict value at key."""
     if key in d and isinstance(d[key], dict):
         return
     d[key] = dict()
@@ -146,10 +157,15 @@ def fetch_chains() -> Dict[str, Dict[str, Chain]]:
 
 
 def write_chain_const(chains: Dict[str, Dict[str, Chain]]):
-    """Write the file with Python constant"""
-    file_str = "# This file is auto-generated by scripts/update.py\n"
-    file_str += f"# {stamp()}\n"
-    file_str += "# Do not edit this file directly.\n"
+    """Write the file with Python constant."""
+    stamp_str = stamp()
+    file_str = '"""Constants containing metadata for EVM-comaptitble chains.\n\n'
+    file_str += "!!!!!!!!!!!!!!!!!!!!!!!!! WARNING !!!!!!!!!!!!!!!!!!!!!!!!!\n"
+    file_str += "!!!! DO NOT EDIT THIS FILE DIRECTLY!                   !!!!\n"
+    file_str += "!!!! This file is auto-generated by scripts/update.py  !!!!\n"
+    file_str += f"!!!! {stamp_str}{' ' * (50 - len(stamp_str))}!!!!\n"
+    file_str += "!!!!!!!!!!!!!!!!!!!!!!!!! WARNING !!!!!!!!!!!!!!!!!!!!!!!!!\n"
+    file_str += '"""\n\n'
     file_str += "from typing import Any, Dict\n\n"
     file_str += "PUBLIC_CHAIN_META: Dict[str, Dict[str, Dict[str, Any]]] = {\n"
 
@@ -169,6 +185,7 @@ def write_chain_const(chains: Dict[str, Dict[str, Chain]]):
 
 
 def main():
+    """Fetch data and update the constants file."""
     logger.info("Fetching chain data...")
     logger.info(f"    Source: {SOURCE_URL}")
     logger.info(f"    Dest: {CHAIN_CONST_FILE}")

{evmchains-0.0.11 → evmchains-0.0.13}/setup.py

@@ -1,3 +1,5 @@
+"""Setup file for the package."""
+
 from setuptools import setup  # type: ignore
 
 setup()