feat: support upstream providers (#258)

Author: antazoey

src/ape/api/__init__.py

@@ -11,6 +11,7 @@
     TransactionAPI,
     TransactionStatusEnum,
     TransactionType,
+    UpstreamProvider,
     Web3Provider,
 )
 
@@ -35,5 +36,6 @@
     "TransactionAPI",
     "TransactionStatusEnum",
     "TransactionType",
+    "UpstreamProvider",
     "Web3Provider",
 ]

src/ape/api/networks.py

@@ -78,6 +78,7 @@ def __getitem__(self, network_name: str) -> "NetworkAPI":
         return self._try_get_network(network_name)
 
     def __getattr__(self, network_name: str) -> "NetworkAPI":
+        network_name = network_name.replace("_", "-")
         return self._try_get_network(network_name)
 
     def add_network(self, network_name: str, network: "NetworkAPI"):
@@ -257,11 +258,7 @@ def providers(self):  # -> Dict[str, Partial[ProviderAPI]]
                     request_header=self.request_header,
                 )
 
-        if len(providers) > 0:
-            return providers
-
-        else:
-            raise NetworkError("No network providers found")
+        return providers
 
     def get_provider(
         self,

src/ape/api/providers.py

@@ -185,12 +185,10 @@ def gas_price(self) -> int:
         ...
 
     @property
-    @abstractmethod
     def priority_fee(self) -> int:
         raise NotImplementedError("priority_fee is not implemented by this provider")
 
     @property
-    @abstractmethod
     def base_fee(self) -> int:
         raise NotImplementedError("base_fee is not implemented by this provider")
 
@@ -320,3 +318,17 @@ def send_transaction(self, txn: TransactionAPI) -> ReceiptAPI:
         txn_hash = self._web3.eth.send_raw_transaction(txn.encode())
         receipt = self.get_transaction(txn_hash.hex())
         return receipt
+
+
+class UpstreamProvider(ProviderAPI):
+    """
+    A provider that can also be set as another provider's upstream.
+    """
+
+    @property
+    @abstractmethod
+    def connection_str(self) -> str:
+        """
+        The str used by downstream providers to connect to this one.
+        For example, the URL for HTTP-based providers.
+        """

src/ape_ethereum/__init__.py

@@ -20,5 +20,6 @@ def networks():
     for network_name, network_params in NETWORKS.items():
         yield "ethereum", network_name, create_network_type(*network_params)
 
-    # NOTE: This works for `geth --dev` as it gets chain_id from itself
+    # NOTE: This works for development providers, as they get chain_id from themselves
     yield "ethereum", "development", NetworkAPI
+    yield "ethereum", "mainnet-fork", NetworkAPI

src/ape_geth/providers.py

@@ -16,7 +16,7 @@
 from web3.middleware import geth_poa_middleware
 from web3.types import NodeInfo
 
-from ape.api import ReceiptAPI, TransactionAPI, Web3Provider
+from ape.api import ReceiptAPI, TransactionAPI, UpstreamProvider, Web3Provider
 from ape.api.config import ConfigItem
 from ape.exceptions import ContractLogicError, ProviderError, TransactionError, VirtualMachineError
 from ape.logging import logger
@@ -134,13 +134,17 @@ def __init__(self):
         )
 
 
-class GethProvider(Web3Provider):
+class GethProvider(Web3Provider, UpstreamProvider):
     _geth: Optional[EphemeralGeth] = None
 
     @property
     def uri(self) -> str:
         return getattr(self.config, self.network.ecosystem.name)[self.network.name]["uri"]
 
+    @property
+    def connection_str(self) -> str:
+        return self.uri
+
     def connect(self):
         self._web3 = Web3(HTTPProvider(self.uri))
 

src/ape_networks/_cli.py

@@ -37,11 +37,13 @@ def make_sub_tree(data: Dict, create_tree: Callable) -> Tree:
             ecosystem_tree = make_sub_tree(ecosystem, Tree)
             _networks = ecosystem["networks"]
             for network in _networks:
-                network_tree = make_sub_tree(network, ecosystem_tree.add)
                 providers = network["providers"]
-                for provider in providers:
-                    make_sub_tree(provider, network_tree.add)
+                if providers:
+                    network_tree = make_sub_tree(network, ecosystem_tree.add)
+                    for provider in providers:
+                        make_sub_tree(provider, network_tree.add)
 
-            echo_rich_text(ecosystem_tree)
+            if _networks:
+                echo_rich_text(ecosystem_tree)
     elif output_format == OutputFormat.YAML:
         click.echo(networks.networks_yaml.strip())

tests/integration/cli/test_networks.py

@@ -45,6 +45,7 @@
     - name: geth
       isDefault: true
     - name: test
+  - name: mainnet-fork
 """
 
 

tests/integration/cli/test_run.py

@@ -6,7 +6,7 @@
 @skip_projects(["script"])
 def test_run_no_scripts_dir(ape_cli, runner, project):
     result = runner.invoke_using_test_network(ape_cli, ["run", BAD_COMMAND])
-    assert result.exit_code == 1
+    assert result.exit_code == 1, result.output
     assert "No 'scripts/' directory detected to run script" in result.output