feat: Blockscout contract verification

boa/contracts/vyper/vyper_contract.py

@@ -26,7 +26,7 @@
 from vyper.codegen.module import generate_ir_for_module
 from vyper.compiler import CompilerData
 from vyper.compiler import output as compiler_output
-from vyper.compiler.output import build_abi_output
+from vyper.compiler.output import build_abi_output, build_solc_json
 from vyper.compiler.settings import OptimizationLevel, anchor_settings
 from vyper.exceptions import VyperException
 from vyper.ir.optimizer import optimize
@@ -126,6 +126,20 @@ def at(self, address: Any) -> "VyperContract":
 
         return ret
 
+    def verify(self, address: Address, explorer, license_type: str = None) -> None:
+        """
+        Verifies the Vyper contract on a block explorer.
+        :param address: The address of the contract.
+        :param explorer: The block explorer to use for verification.
+        :param license_type: Optional license to use for the contract.
+        """
+        explorer.verify(
+            address=address,
+            standard_json=build_solc_json(self.compiler_data),
+            contract_name=self.compiler_data.contract_path.name,
+            license_type=license_type,
+        )
+
     @cached_property
     def _constants(self):
         # Make constants available at compile time. Useful for testing. See #196
@@ -155,6 +169,10 @@ def __init__(
                 msg += f"{capabilities.describe_capabilities()}"
                 raise Exception(msg)
 
+    @cached_property
+    def deployer(self):
+        return VyperDeployer(self.compiler_data, filename=self.filename)
+
     @cached_property
     def abi(self):
         return build_abi_output(self.compiler_data)
@@ -163,6 +181,14 @@ def abi(self):
     def _constants(self):
         return ConstantsModel(self.compiler_data)
 
+    def verify(self, explorer, license_type: str = None) -> None:
+        """
+        Verifies the Vyper contract on a block explorer.
+        :param explorer: The block explorer to use for verification.
+        :param license_type: Optional license to use for the contract.
+        """
+        self.deployer.verify(self.address, explorer, license_type)
+
 
 # create a blueprint for use with `create_from_blueprint`.
 # uses a ERC5202 preamble, when calling `create_from_blueprint` will
@@ -204,10 +230,6 @@ def __init__(
 
         self.env.register_blueprint(compiler_data.bytecode, self)
 
-    @cached_property
-    def deployer(self):
-        return VyperDeployer(self.compiler_data, filename=self.filename)
-
 
 class FrameDetail(dict):
     def __init__(self, fn_name, *args, **kwargs):
@@ -631,11 +653,6 @@ def __repr__(self):
     def _immutables(self):
         return ImmutablesModel(self)
 
-    @cached_property
-    def deployer(self):
-        # TODO add test
-        return VyperDeployer(self.compiler_data, filename=self.filename)
-
     # is this actually useful?
     def at(self, address):
         return self.deployer.at(address)

boa/interpret.py

@@ -131,15 +131,15 @@ def compiler_data(
 ) -> CompilerData:
     global _disk_cache, _search_path
 
-    file_input = FileInput(
-        contents=source_code,
-        source_id=-1,
-        path=Path(contract_name),
-        resolved_path=Path(filename),
-    )
     search_paths = get_search_paths(_search_path)
     input_bundle = FilesystemInputBundle(search_paths)
 
+    path = Path(contract_name)
+    resolved_path = Path(filename).resolve(strict=False)
+
+    file_input = FileInput(
+        contents=source_code, source_id=-1, path=path, resolved_path=resolved_path
+    )
     settings = Settings(**kwargs)
     ret = CompilerData(file_input, input_bundle, settings)
     if _disk_cache is None:
@@ -208,14 +208,16 @@ def loads_partial(
     dedent: bool = True,
     compiler_args: dict = None,
 ) -> VyperDeployer:
-    name = name or "VyperContract"  # TODO handle this upstream in CompilerData
+    name = name or "VyperContract"
     filename = filename or "<unknown>"
+
     if dedent:
         source_code = textwrap.dedent(source_code)
 
     version = _detect_version(source_code)
     if version is not None and version != vyper.__version__:
         filename = str(filename)  # help mypy
+        # TODO: pass name to loads_partial_vvm, not filename
         return _loads_partial_vvm(source_code, version, filename)
 
     compiler_args = compiler_args or {}

boa/verifiers.py

@@ -0,0 +1,89 @@
+import json
+import time
+from datetime import datetime, timedelta
+from http import HTTPStatus
+from typing import Optional
+
+import requests
+from attr import dataclass
+
+from boa.util.abi import Address
+
+DEFAULT_BLOCKSCOUT_URI = "https://eth.blockscout.com"
+
+
+@dataclass
+class Blockscout:
+    """
+    Allows users to verify contracts on Blockscout.
+    This is independent of Vyper contracts, and can be used to verify any smart contract.
+    """
+
+    uri: str = DEFAULT_BLOCKSCOUT_URI
+    api_key: Optional[str] = None
+    timeout: timedelta = timedelta(minutes=2)
+    backoff: timedelta = timedelta(milliseconds=500)
+    backoff_factor: float = 1.1
+    retry_http_codes: tuple[int, ...] = (
+        HTTPStatus.NOT_FOUND,
+        HTTPStatus.INTERNAL_SERVER_ERROR,
+        HTTPStatus.SERVICE_UNAVAILABLE,
+        HTTPStatus.GATEWAY_TIMEOUT,
+    )
+
+    def verify(
+        self,
+        address: Address,
+        contract_name: str,
+        standard_json: dict,
+        license_type: str = None,
+    ) -> None:
+        """
+        Verifies the Vyper contract on Blockscout.
+        :param address: The address of the contract.
+        :param contract_name: The name of the contract.
+        :param standard_json: The standard JSON output of the Vyper compiler.
+        :param license_type: The license to use for the contract. Defaults to "none".
+        """
+        if license_type is None:
+            license_type = "none"
+        response = requests.post(
+            url=f"{self.uri}/api/v2/smart-contracts/{address.lower()}/"
+            f"verification/via/vyper-standard-input?apikey={self.api_key or ''}",
+            data={
+                "compiler_version": standard_json["compiler_version"],
+                "license_type": license_type,
+            },
+            files={
+                "files[0]": (
+                    contract_name,
+                    json.dumps(standard_json).encode("utf-8"),
+                    "application/json",
+                )
+            },
+        )
+        response.raise_for_status()
+        print(response.json().get("message"))  # usually verification started
+
+        timeout = datetime.now() + timedelta(minutes=2)
+        wait_time = self.backoff
+        while datetime.now() < timeout:
+            time.sleep(wait_time.total_seconds())
+            if self.is_verified(address):
+                print(
+                    f"Contract verified! {self.uri}/address/{address.lower()}?tab=contract_code"
+                )
+                return
+            wait_time *= self.backoff_factor
+
+        raise TimeoutError("Timeout waiting for verification to complete")
+
+    def is_verified(self, address: Address) -> bool:
+        url = (
+            f"{self.uri}/api/v2/smart-contracts/{address.lower()}?apikey={self.api_key}"
+        )
+        response = requests.get(url)
+        if response.status_code in self.retry_http_codes:
+            return False
+        response.raise_for_status()
+        return True

tests/integration/network/sepolia/test_sepolia_env.py

@@ -1,7 +1,10 @@
+import os
+
 import pytest
 
 import boa
 from boa.network import NetworkEnv
+from boa.verifiers import Blockscout
 
 # boa.env.anchor() does not work in prod environment
 pytestmark = pytest.mark.ignore_isolation
@@ -32,6 +35,13 @@ def simple_contract():
     return boa.loads(code, STARTING_SUPPLY)
 
 
+def test_verify(simple_contract):
+    api_key = os.getenv("BLOCKSCOUT_API_KEY", "")
+    blockscout = Blockscout("https://eth-sepolia.blockscout.com", api_key)
+    simple_contract.verify(blockscout)
+    assert blockscout.is_verified(simple_contract.address) is True
+
+
 def test_env_type():
     # sanity check
     assert isinstance(boa.env, NetworkEnv)