evmchains 0.0.9__tar.gz → 0.0.11__tar.gz

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

@@ -60,7 +60,7 @@ jobs:
 
         strategy:
             matrix:
-                os: [ubuntu-latest, macos-latest]   # eventually add `windows-latest`
+                os: [ubuntu-latest, macos-latest, windows-latest]
                 python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
         steps:

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: evmchains
-Version: 0.0.9
+Version: 0.0.11
 Summary: Packaged metadata on Ethereum Virtual Machine (EVM) chains
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -213,6 +213,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: MacOS
 Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
@@ -238,13 +239,13 @@ Requires-Dist: types-requests>=2.31.0.20240106; extra == "dev"
 
 Provides general metadata on EVM-compatible chains organized by Ape-style ecosystem and network.
 
-Original soure data: https://github.com/ethereum-lists/chains
+Original source data: https://github.com/ethereum-lists/chains
 
 ## Quick Start
 
 ## Dependencies
 
-- [python3](https://www.python.org/downloads) version 3.8 up to 3.11.
+- [python3](https://www.python.org/downloads) version 3.8 up to 3.12.
 
 ## Installation
 

{evmchains-0.0.9 → evmchains-0.0.11}/README.md

@@ -2,13 +2,13 @@
 
 Provides general metadata on EVM-compatible chains organized by Ape-style ecosystem and network.
 
-Original soure data: https://github.com/ethereum-lists/chains
+Original source data: https://github.com/ethereum-lists/chains
 
 ## Quick Start
 
 ## Dependencies
 
-- [python3](https://www.python.org/downloads) version 3.8 up to 3.11.
+- [python3](https://www.python.org/downloads) version 3.8 up to 3.12.
 
 ## Installation
 

evmchains-0.0.11/evmchains/__init__.py

@@ -0,0 +1,50 @@
+import os
+import random
+import re
+from typing import List
+
+from evmchains.chains import PUBLIC_CHAIN_META
+from evmchains.types import Chain
+
+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"""
+    if (
+        ecosystem not in PUBLIC_CHAIN_META
+        or network not in PUBLIC_CHAIN_META[ecosystem]
+    ):
+        raise KeyError(f"Unknown ecosystem:network: {ecosystem}:{network}")
+
+    return Chain(**PUBLIC_CHAIN_META[ecosystem][network])
+
+
+def get_rpcs(ecosystem: str, network: str) -> List[str]:
+    """Get a list of valid RPC endpoints for an ecosystem:network pair"""
+    rpcs = []
+
+    chain = get_chain_meta(ecosystem, network)
+
+    for rpc in chain.rpc:
+        # Look for env var replacements in the endpoint URL
+        match = ENV_VAR_REGEX.search(rpc)
+        if match:
+            to_replace = match.group(0)
+            env_var = match.group(1)
+            # Include them only if the env var is available
+            if env_var in os.environ:
+                rpcs.append(rpc.replace(to_replace, os.environ[env_var]))
+        else:
+            rpcs.append(rpc)
+
+    return rpcs
+
+
+def get_random_rpc(ecosystem: str, network: str) -> str:
+    """Return a random RPC endpoint for an ecosystem:network pair"""
+    rpcs = get_rpcs(ecosystem, network)
+    return random.choice(rpcs)
+
+
+__all__ = ["PUBLIC_CHAIN_META", "Chain", "get_chain_meta", "get_random_rpc", "get_rpcs"]

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

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

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

@@ -1,5 +1,5 @@
 # This file is auto-generated by scripts/update.py
-# 2024-05-30 20:30:00.884580
+# 2024-07-03 20:26:21.491217
 # Do not edit this file directly.
 from typing import Any, Dict
 
@@ -253,6 +253,7 @@ PUBLIC_CHAIN_META: Dict[str, Dict[str, Dict[str, Any]]] = {
                 "https://blast.din.dev/rpc",
                 "https://blastl2-mainnet.public.blastapi.io",
                 "https://blast.blockpi.network/v1/rpc/public",
+                "https://blast-rpc.publicnode.com",
             ],
             "shortName": "blastmainnet",
             "slip44": None,
@@ -652,6 +653,78 @@ PUBLIC_CHAIN_META: Dict[str, Dict[str, Dict[str, Any]]] = {
             "slip44": 700,
         },
     },
+    "linea": {
+        "mainnet": {
+            "chain": "ETH",
+            "chainId": 59144,
+            "ens": None,
+            "explorers": [
+                {
+                    "icon": "linea",
+                    "name": "Etherscan",
+                    "standard": "EIP3091",
+                    "url": "https://lineascan.build",
+                },
+                {
+                    "icon": "linea",
+                    "name": "Blockscout",
+                    "standard": "EIP3091",
+                    "url": "https://explorer.linea.build",
+                },
+                {
+                    "icon": "linea",
+                    "name": "L2scan",
+                    "standard": "EIP3091",
+                    "url": "https://linea.l2scan.co",
+                },
+            ],
+            "faucets": [],
+            "features": None,
+            "icon": "linea",
+            "infoURL": "https://linea.build",
+            "name": "Linea",
+            "nativeCurrency": {"decimals": 18, "name": "Linea Ether", "symbol": "ETH"},
+            "networkId": 59144,
+            "rpc": [
+                "https://rpc.linea.build",
+                "https://linea-mainnet.infura.io/v3/${INFURA_API_KEY}",
+            ],
+            "shortName": "linea",
+            "slip44": None,
+        },
+        "sepolia": {
+            "chain": "ETH",
+            "chainId": 59141,
+            "ens": None,
+            "explorers": [
+                {
+                    "icon": "linea",
+                    "name": "Etherscan",
+                    "standard": "EIP3091",
+                    "url": "https://sepolia.lineascan.build",
+                },
+                {
+                    "icon": "linea",
+                    "name": "Blockscout",
+                    "standard": "EIP3091",
+                    "url": "https://explorer.sepolia.linea.build",
+                },
+            ],
+            "faucets": [],
+            "features": None,
+            "icon": "linea",
+            "infoURL": "https://linea.build",
+            "name": "Linea Sepolia",
+            "nativeCurrency": {"decimals": 18, "name": "Linea Ether", "symbol": "ETH"},
+            "networkId": 59141,
+            "rpc": [
+                "https://rpc.sepolia.linea.build",
+                "https://linea-sepolia.infura.io/v3/${INFURA_API_KEY}",
+            ],
+            "shortName": "linea-sepolia",
+            "slip44": 1,
+        },
+    },
     "optimism": {
         "mainnet": {
             "chain": "ETH",
@@ -861,6 +934,31 @@ PUBLIC_CHAIN_META: Dict[str, Dict[str, Dict[str, Any]]] = {
             "shortName": "maticmum",
             "slip44": 1,
         },
+        "amoy": {
+            "chain": "Polygon",
+            "chainId": 80002,
+            "ens": None,
+            "explorers": [
+                {
+                    "name": "polygonamoy",
+                    "standard": "EIP3091",
+                    "url": "https://www.oklink.com/amoy",
+                }
+            ],
+            "faucets": ["https://faucet.polygon.technology/"],
+            "features": None,
+            "icon": "polygon",
+            "infoURL": "https://polygon.technology/",
+            "name": "Amoy",
+            "nativeCurrency": {"decimals": 18, "name": "MATIC", "symbol": "MATIC"},
+            "networkId": 80002,
+            "rpc": [
+                "https://rpc-amoy.polygon.technology",
+                "https://polygon-amoy-bor-rpc.publicnode.com",
+            ],
+            "shortName": "polygonamoy",
+            "slip44": 1,
+        },
     },
     "polygon-zkevm": {
         "mainnet": {
@@ -911,78 +1009,28 @@ PUBLIC_CHAIN_META: Dict[str, Dict[str, Dict[str, Any]]] = {
             "shortName": "testnet-zkEVM-mango",
             "slip44": 1,
         },
-    },
-    "linea": {
-        "mainnet": {
-            "chain": "ETH",
-            "chainId": 59144,
+        "cardona": {
+            "chain": "Polygon",
+            "chainId": 2442,
             "ens": None,
             "explorers": [
                 {
-                    "icon": "linea",
-                    "name": "Etherscan",
-                    "standard": "EIP3091",
-                    "url": "https://lineascan.build",
-                },
-                {
-                    "icon": "linea",
-                    "name": "Blockscout",
-                    "standard": "EIP3091",
-                    "url": "https://explorer.linea.build",
-                },
-                {
-                    "icon": "linea",
-                    "name": "L2scan",
+                    "name": "polygonscan",
                     "standard": "EIP3091",
-                    "url": "https://linea.l2scan.co",
-                },
+                    "url": "https://cardona-zkevm.polygonscan.com",
+                }
             ],
             "faucets": [],
             "features": None,
-            "icon": "linea",
-            "infoURL": "https://linea.build",
-            "name": "Linea",
-            "nativeCurrency": {"decimals": 18, "name": "Linea Ether", "symbol": "ETH"},
-            "networkId": 59144,
-            "rpc": [
-                "https://rpc.linea.build",
-                "https://linea-mainnet.infura.io/v3/${INFURA_API_KEY}",
-            ],
-            "shortName": "linea",
+            "icon": "zkevm",
+            "infoURL": "https://polygon.technology/polygon-zkevm",
+            "name": "Polygon zkEVM Cardona Testnet",
+            "nativeCurrency": {"decimals": 18, "name": "Ether", "symbol": "ETH"},
+            "networkId": 2442,
+            "rpc": ["https://rpc.cardona.zkevm-rpc.com"],
+            "shortName": "zkevm-testnet-cardona",
             "slip44": None,
         },
-        "sepolia": {
-            "chain": "ETH",
-            "chainId": 59141,
-            "ens": None,
-            "explorers": [
-                {
-                    "icon": "linea",
-                    "name": "Etherscan",
-                    "standard": "EIP3091",
-                    "url": "https://sepolia.lineascan.build",
-                },
-                {
-                    "icon": "linea",
-                    "name": "Blockscout",
-                    "standard": "EIP3091",
-                    "url": "https://explorer.sepolia.linea.build",
-                },
-            ],
-            "faucets": [],
-            "features": None,
-            "icon": "linea",
-            "infoURL": "https://linea.build",
-            "name": "Linea Sepolia",
-            "nativeCurrency": {"decimals": 18, "name": "Linea Ether", "symbol": "ETH"},
-            "networkId": 59141,
-            "rpc": [
-                "https://rpc.sepolia.linea.build",
-                "https://linea-sepolia.infura.io/v3/${INFURA_API_KEY}",
-            ],
-            "shortName": "linea-sepolia",
-            "slip44": 1,
-        },
     },
     "rootstock": {
         "mainnet": {
@@ -1047,4 +1095,54 @@ PUBLIC_CHAIN_META: Dict[str, Dict[str, Dict[str, Any]]] = {
             "slip44": 1,
         },
     },
+    "shibarium": {
+        "mainnet": {
+            "chain": "Shibarium",
+            "chainId": 109,
+            "ens": None,
+            "explorers": [
+                {
+                    "name": "shibariumscan",
+                    "standard": "none",
+                    "url": "https://www.shibariumscan.io",
+                }
+            ],
+            "faucets": [],
+            "features": None,
+            "icon": "shibarium",
+            "infoURL": "https://shibariumecosystem.com",
+            "name": "Shibarium",
+            "nativeCurrency": {
+                "decimals": 18,
+                "name": "BONE Shibarium",
+                "symbol": "BONE",
+            },
+            "networkId": 109,
+            "rpc": ["https://www.shibrpc.com"],
+            "shortName": "shibariumecosystem",
+            "slip44": None,
+        },
+        "puppynet": {
+            "chain": "Puppynet Shibarium",
+            "chainId": 157,
+            "ens": None,
+            "explorers": [
+                {
+                    "name": "puppyscan",
+                    "standard": "none",
+                    "url": "https://puppyscan.shib.io",
+                }
+            ],
+            "faucets": ["https://beta.shibariumtech.com/faucet"],
+            "features": None,
+            "icon": "shibarium",
+            "infoURL": "https://shibariumecosystem.com",
+            "name": "Puppynet Shibarium",
+            "nativeCurrency": {"decimals": 18, "name": "BONE", "symbol": "BONE"},
+            "networkId": 157,
+            "rpc": ["https://puppynet.shibrpc.com"],
+            "shortName": "puppynet",
+            "slip44": None,
+        },
+    },
 }

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: evmchains
-Version: 0.0.9
+Version: 0.0.11
 Summary: Packaged metadata on Ethereum Virtual Machine (EVM) chains
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -213,6 +213,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
 Classifier: Operating System :: MacOS
 Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
@@ -238,13 +239,13 @@ Requires-Dist: types-requests>=2.31.0.20240106; extra == "dev"
 
 Provides general metadata on EVM-compatible chains organized by Ape-style ecosystem and network.
 
-Original soure data: https://github.com/ethereum-lists/chains
+Original source data: https://github.com/ethereum-lists/chains
 
 ## Quick Start
 
 ## Dependencies
 
-- [python3](https://www.python.org/downloads) version 3.8 up to 3.11.
+- [python3](https://www.python.org/downloads) version 3.8 up to 3.12.
 
 ## Installation
 

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

@@ -18,6 +18,7 @@ classifiers = [
     "Natural Language :: English",
     "Operating System :: MacOS",
     "Operating System :: POSIX",
+    "Operating System :: Microsoft :: Windows",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",

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

@@ -56,6 +56,10 @@ CHAIN_IDS = {
     "gnosis": {
         "mainnet": 100,
     },
+    "linea": {
+        "mainnet": 59144,
+        "sepolia": 59141,
+    },
     "optimism": {
         "mainnet": 10,
         "goerli": 420,
@@ -68,19 +72,21 @@ CHAIN_IDS = {
     "polygon": {
         "mainnet": 137,
         "mumbai": 80001,
+        "amoy": 80002,
     },
     "polygon-zkevm": {
         "mainnet": 1101,
         "testnet": 1442,
-    },
-    "linea": {
-        "mainnet": 59144,
-        "sepolia": 59141,
+        "cardona": 2442,
     },
     "rootstock": {
         "mainnet": 30,
         "testnet": 31,
     },
+    "shibarium": {
+        "mainnet": 109,
+        "puppynet": 157,
+    }
 }
 
 pp = PrettyPrinter(indent=4)

evmchains-0.0.11/tests/test_func.py

@@ -0,0 +1,88 @@
+import os
+from contextlib import contextmanager
+
+import pytest
+
+from evmchains import PUBLIC_CHAIN_META, Chain, get_chain_meta, get_rpcs
+
+
+@pytest.fixture()
+def env():
+    @contextmanager
+    def inner(environ=dict(), unset=list()):
+        old_environ = os.environ.copy()
+        os.environ.update(environ)
+        for key in unset:
+            try:
+                del os.environ[key]
+            except KeyError:
+                pass
+        yield
+        os.environ = old_environ
+
+    return inner
+
+
+def test_chain_structure():
+    assert "ethereum" in PUBLIC_CHAIN_META
+    assert "mainnet" in PUBLIC_CHAIN_META["ethereum"]
+
+    chain = PUBLIC_CHAIN_META["ethereum"]["mainnet"]
+    assert isinstance(chain, dict)
+    assert len(chain["rpc"]) > 0
+    assert chain["chainId"] == 1
+    assert chain["networkId"] == 1
+    assert chain["shortName"] == "eth"
+    assert chain["name"] == "Ethereum Mainnet"
+    assert chain["nativeCurrency"]["symbol"] == "ETH"
+    assert len(chain["explorers"]) > 0
+
+
+def test_get_chain_meta():
+    chain = get_chain_meta("arbitrum", "mainnet")
+    assert isinstance(chain, Chain)
+    assert len(chain.rpc) > 0
+    assert chain.chainId == 42161
+    assert chain.networkId == 42161
+    assert chain.shortName == "arb1"
+    assert chain.name == "Arbitrum One"
+    assert chain.nativeCurrency["symbol"] == "ETH"
+    assert len(chain.explorers) > 0
+
+
+def test_get_rpcs_alchemy(env):
+    alchemy_key = "alchemistsayswhat"
+    expected_rpc = f"https://arb-mainnet.g.alchemy.com/v2/{alchemy_key}"
+
+    def find_rpc(rpcs, expected):
+        for rpc in rpcs:
+            if rpc == expected:
+                return True
+        return False
+
+    with env({"ALCHEMY_API_KEY": alchemy_key}, unset=["INFURA_API_KEY"]):
+        rpcs = get_rpcs("arbitrum", "mainnet")
+        assert isinstance(rpcs, list)
+        assert len(rpcs) > 0
+        assert find_rpc(rpcs, expected_rpc)
+        # Ensure the infura endpoint was also filtered out
+        assert len([rpc for rpc in rpcs if "infura" in rpc]) == 0
+
+
+def test_get_rpcs_infura(env):
+    infura_key = "infuraaaaaa"
+    expected_rpc = f"https://arbitrum-mainnet.infura.io/v3/{infura_key}"
+
+    def find_rpc(rpcs, expected):
+        for rpc in rpcs:
+            if rpc == expected:
+                return True
+        return False
+
+    with env({"INFURA_API_KEY": infura_key}, unset=["ALCHEMY_API_KEY"]):
+        rpcs = get_rpcs("arbitrum", "mainnet")
+        assert isinstance(rpcs, list)
+        assert len(rpcs) > 0
+        assert find_rpc(rpcs, expected_rpc)
+        # Ensure the alchemy endpoint was also filtered out
+        assert len([rpc for rpc in rpcs if "alchemy" in rpc]) == 0

evmchains-0.0.9/evmchains/__init__.py

@@ -1,24 +0,0 @@
-import random
-
-from evmchains.chains import PUBLIC_CHAIN_META
-from evmchains.types import Chain
-
-
-def get_chain_meta(ecosystem: str, network: str) -> 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]
-    ):
-        raise KeyError(f"Unknown ecosystem:network: {ecosystem}:{network}")
-
-    return Chain(**PUBLIC_CHAIN_META[ecosystem][network])
-
-
-def get_random_rpc(ecosystem: str, network: str) -> str:
-    """Return a random RPC endpoint for an ecosystem:network pair"""
-    chain = get_chain_meta(ecosystem, network)
-    return random.choice(chain.rpc)
-
-
-__all__ = ["PUBLIC_CHAIN_META", "Chain", "get_chain_meta"]

evmchains-0.0.9/tests/test_func.py

@@ -1,28 +0,0 @@
-from evmchains import PUBLIC_CHAIN_META, Chain, get_chain_meta
-
-
-def test_chain_structure():
-    assert "ethereum" in PUBLIC_CHAIN_META
-    assert "mainnet" in PUBLIC_CHAIN_META["ethereum"]
-
-    chain = PUBLIC_CHAIN_META["ethereum"]["mainnet"]
-    assert isinstance(chain, dict)
-    assert len(chain["rpc"]) > 0
-    assert chain["chainId"] == 1
-    assert chain["networkId"] == 1
-    assert chain["shortName"] == "eth"
-    assert chain["name"] == "Ethereum Mainnet"
-    assert chain["nativeCurrency"]["symbol"] == "ETH"
-    assert len(chain["explorers"]) > 0
-
-
-def test_get_chain_meta():
-    chain = get_chain_meta("arbitrum", "mainnet")
-    assert isinstance(chain, Chain)
-    assert len(chain.rpc) > 0
-    assert chain.chainId == 42161
-    assert chain.networkId == 42161
-    assert chain.shortName == "arb1"
-    assert chain.name == "Arbitrum One"
-    assert chain.nativeCurrency["symbol"] == "ETH"
-    assert len(chain.explorers) > 0