feat: adds support for $WEB3_PROVIDER_URI (#2687)

Author: antazoey

src/ape/managers/config.py

@@ -7,6 +7,7 @@
 from typing import TYPE_CHECKING, Any, Optional, Union
 
 from ape.api.config import ApeConfig
+from ape.logging import logger
 from ape.managers.base import BaseManager
 from ape.utils.basemodel import (
     ExtraAttributesMixin,
@@ -150,7 +151,13 @@ def isolate_data_folder(
                             continue
 
                         dest_path = temp_data_folder / item
-                        shutil.copytree(path_to_keep, dest_path)
+                        try:
+                            shutil.copytree(path_to_keep, dest_path)
+                        except Exception as err:
+                            logger.warning(
+                                f"Problem copying '{dest_path.name}' when making isolated project: {err}"
+                            )
+                            continue
 
                     self.DATA_FOLDER = temp_data_folder
                     yield temp_data_folder

src/ape_ethereum/provider.py

@@ -73,6 +73,8 @@
 from ape_ethereum.trace import CallTrace, TraceApproach, TransactionTrace
 from ape_ethereum.transactions import AccessList, AccessListTransaction, TransactionStatusEnum
 
+WEB3_PROVIDER_URI_ENV_VAR_NAME = "WEB3_PROVIDER_URI"
+
 if TYPE_CHECKING:
     from ethpm_types import EventABI
 
@@ -105,34 +107,6 @@ def _sanitize_web3_url(msg: str) -> str:
     return f"{prefix} URI: {sanitized_url} {' '.join(rest[1:])}"
 
 
-WEB3_PROVIDER_URI_ENV_VAR_NAME = "WEB3_PROVIDER_URI"
-
-
-def assert_web3_provider_uri_env_var_not_set():
-    """
-    Environment variable $WEB3_PROVIDER_URI causes problems
-    when used with Ape (ignores Ape's networks). Use
-    this validator to eliminate the concern.
-
-    Raises:
-          :class:`~ape.exceptions.ProviderError`: If environment variable
-            WEB3_PROVIDER_URI exists in ``os.environ``.
-    """
-    if WEB3_PROVIDER_URI_ENV_VAR_NAME not in os.environ:
-        return
-
-    # NOTE: This was the source of confusion for user when they noticed
-    #  Ape would only connect to RPC URL set by an environment variable
-    #  named $WEB3_PROVIDER_URI instead of whatever network they were telling Ape.
-    raise ProviderError(
-        "Ape does not support Web3.py's environment variable "
-        f"${WEB3_PROVIDER_URI_ENV_VAR_NAME}. If you are using this environment "
-        "variable name incidentally, please use a different name. If you are "
-        "trying to set the network in Web3.py, please use Ape's `ape-config.yaml` "
-        "or `--network` option instead."
-    )
-
-
 def _post_send_transaction(tx: TransactionAPI, receipt: ReceiptAPI):
     """Execute post-transaction ops"""
 
@@ -171,8 +145,6 @@ class Web3Provider(ProviderAPI, ABC):
     _transaction_trace_cache: dict[str, TransactionTrace] = {}
 
     def __new__(cls, *args, **kwargs):
-        assert_web3_provider_uri_env_var_not_set()
-
         # Post-connection ops
         def post_connect_hook(connect):
             @wraps(connect)
@@ -384,7 +356,20 @@ def _default_http_uri(self) -> Optional[str]:
             # Use a default localhost value.
             return DEFAULT_HTTP_URI
 
-        elif rpc := self._get_random_rpc():
+        elif env_var := os.getenv(WEB3_PROVIDER_URI_ENV_VAR_NAME):
+            # Default Web3 environment variable support that works with web3 out-the-box.
+            # Eliminates need for random RPCs and allows usage of this feature. **MUST BE**
+            # for the same chain the user is trying to connect to, which requires a bit of a hack.
+            # NOTE: We should be able to assume NOT dev here which means chain IDs are hardcoded.
+            tmp_w3 = Web3(HTTPProvider(endpoint_uri=env_var))
+            if self.network.chain_id == tmp_w3.eth.chain_id:
+                return env_var
+
+            # NOTE: We **must** remove the environment variable here or else Ape won't work.
+            os.environ.pop(WEB3_PROVIDER_URI_ENV_VAR_NAME, None)
+            # Next, drop down and try to use a random RPc from evmchains.
+
+        if rpc := self._get_random_rpc():
             # This works when the network is in `evmchains`.
             return rpc
 

tests/functional/test_project.py

@@ -737,7 +737,7 @@ def test_init(self, with_dependencies_project_path):
             project.manifest_path.unlink(missing_ok=True)
 
             #  Re-init to show it doesn't create the manifest file.
-            project = Project(temp_project.path)
+            _ = Project(temp_project.path)
 
     def test_init_invalid_config(self):
         here = os.curdir

tests/functional/test_provider.py

@@ -1,4 +1,3 @@
-import os
 from pathlib import Path
 from unittest import mock
 
@@ -25,7 +24,6 @@
 from ape.types.events import LogFilter
 from ape.utils.testing import DEFAULT_TEST_CHAIN_ID
 from ape_ethereum.provider import (
-    WEB3_PROVIDER_URI_ENV_VAR_NAME,
     EthereumNodeProvider,
     Web3Provider,
     _sanitize_web3_url,
@@ -671,39 +669,6 @@ def test_auto_mine(eth_tester_provider, owner):
     assert eth_tester_provider.auto_mine
 
 
-def test_new_when_web3_provider_uri_set():
-    """
-    Tests against a confusing case where having an env var
-    $WEB3_PROVIDER_URI caused web3.py to only ever use that RPC
-    URL regardless of what was said in Ape's --network or config.
-    Now, we raise an error to avoid having users think Ape's
-    network system is broken.
-    """
-    os.environ[WEB3_PROVIDER_URI_ENV_VAR_NAME] = "TEST"
-    expected = (
-        rf"Ape does not support Web3\.py's environment variable "
-        rf"\${WEB3_PROVIDER_URI_ENV_VAR_NAME}\. If you are using this environment "
-        r"variable name incidentally, please use a different name\. If you are "
-        r"trying to set the network in Web3\.py, please use Ape's `ape-config\.yaml` "
-        r"or `--network` option instead\."
-    )
-
-    class MyProvider(Web3Provider):
-        def connect(self):
-            raise NotImplementedError()
-
-        def disconnect(self):
-            raise NotImplementedError()
-
-    try:
-        with pytest.raises(ProviderError, match=expected):
-            _ = MyProvider(data_folder=None, name=None, network=None)
-
-    finally:
-        if WEB3_PROVIDER_URI_ENV_VAR_NAME in os.environ:
-            del os.environ[WEB3_PROVIDER_URI_ENV_VAR_NAME]
-
-
 def test_account_balance_state(project, eth_tester_provider, owner):
     amount = convert("100_000 ETH", int)