Verify with Blockscout (#1413)

* example foundry contract

* programmatic verification

* docs

* update regex in reload

Author: skudasov

book/src/SUMMARY.md

@@ -13,6 +13,7 @@
     - [Creating your own components](./developing/developing_components.md)
     - [Fork Testing](./framework/fork.md)
     - [Quick Contracts Deployment](./framework/quick_deployment.md)
+    - [Verifying Contracts](./framework/verify.md)
     - [NodeSet with External Blockchain]()
     - [CLI](./framework/cli.md)
     - [Configuration](./framework/configuration.md)

book/src/framework/observability/blockscout.md

@@ -25,9 +25,4 @@ ctf bs -r http://host.docker.internal:8555 d
 Blockscout isn’t ideal for local, ephemeral environments, as it won’t re-index blocks and transactions on test reruns. The easiest approach is to set up Blockscout first, initialize the test environment, switch to the [cache](../components/caching.md) config, and run tests without restarting RPC nodes. 
 
 Otherwise, use `ctf bs r` each time you restart your test with a fresh docker environment.
-</div>
-
-<div class="warning">
-
-Blockscout integration is still WIP, for now Blockscout reads only one node that is on `:8545`, all our blockchain implementation expose this port by default.
-</div>
+</div>

book/src/framework/verify.md

@@ -0,0 +1,16 @@
+# Verifying Contracts
+
+Check out our [example](https://github.com/smartcontractkit/chainlink-testing-framework/blob/main/framework/examples/myproject/verify_test.go) of programmatically verifying contracts using `Blockscout` and `Foundry`. You'll need to provide:
+
+- The path to your Foundry directory
+- The path to the contract
+- The contract name
+
+```golang
+		err := blockchain.VerifyContract(blockchainComponentOutput, c.Addresses[0].String(),
+			"example_components/onchain",
+			"src/Counter.sol",
+			"Counter",
+		)
+		require.NoError(t, err)
+```

framework/.changeset/v0.3.1.md

@@ -1,2 +1,3 @@
-- Use docker cmd instead of testcontainers
+- Use docker cmd for building instead of testcontainers-go
 - Add "CHAINLINK_IMAGE" flag to override NodeSet image
+- Add Go wrapper for Blockscout verification (foundry)

framework/cmd/observability/blockscout/docker-compose.yml

@@ -30,6 +30,7 @@ services:
         ETHEREUM_JSONRPC_VARIANT: 'geth'
         ETHEREUM_JSONRPC_HTTP_URL: ${BLOCKSCOUT_RPC_URL}
         ETHEREUM_JSONRPC_TRACE_URL: ${BLOCKSCOUT_RPC_URL}
+        CHAIN_ID: ${BLOCKSCOUT_CHAIN_ID:-1337}
 
   visualizer:
     extends:

framework/components/blockchain/verify.go

@@ -0,0 +1,22 @@
+package blockchain
+
+import (
+	"fmt"
+	"github.com/smartcontractkit/chainlink-testing-framework/framework"
+)
+
+// VerifyContract wraps the forge verify-contract command.
+func VerifyContract(out *Output, address, foundryDir, contractFile, contractName string) error {
+	args := []string{
+		"verify-contract",
+		"--rpc-url", out.Nodes[0].HostHTTPUrl,
+		"--chain-id",
+		out.ChainID,
+		"--compiler-version=0.8.24",
+		address,
+		fmt.Sprintf("%s:%s", contractFile, contractName),
+		"--verifier", "blockscout",
+		"--verifier-url", "http://localhost/api/",
+	}
+	return framework.RunCommandDir(foundryDir, "forge", args...)
+}

framework/components/simple_node_set/reload.go

@@ -9,7 +9,7 @@ import (
 // UpgradeNodeSet updates nodes configuration TOML files
 // this API is discouraged, however, you can use it if nodes require restart or configuration updates, temporarily!
 func UpgradeNodeSet(in *Input, bc *blockchain.Output, wait time.Duration) (*Output, error) {
-	_, err := chaos.ExecPumba("rm --volumes=false re2:node.*|ns-postgresql.*", wait)
+	_, err := chaos.ExecPumba("rm --volumes=false re2:^node.*|ns-postgresql.*", wait)
 	if err != nil {
 		return nil, err
 	}

framework/docker.go

@@ -77,6 +77,17 @@ func runCommand(name string, args ...string) error {
 	return cmd.Run()
 }
 
+// RunCommandDir executes a command in some directory and prints the output
+func RunCommandDir(dir, name string, args ...string) error {
+	cmd := exec.Command(name, args...)
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
+	if dir != "" {
+		cmd.Dir = dir
+	}
+	return cmd.Run()
+}
+
 // DockerClient wraps a Docker API client and provides convenience methods
 type DockerClient struct {
 	cli *client.Client

framework/examples/myproject/example_components/onchain/.github/workflows/test.yml

@@ -0,0 +1,34 @@
+name: test
+
+on: workflow_dispatch
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    strategy:
+      fail-fast: true
+
+    name: Foundry project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Run Forge build
+        run: |
+          forge --version
+          forge build --sizes
+        id: build
+
+      - name: Run Forge tests
+        run: |
+          forge test -vvv
+        id: test

framework/examples/myproject/example_components/onchain/.gitignore

@@ -0,0 +1,14 @@
+# Compiler files
+cache/
+out/
+
+# Ignores development broadcast logs
+!/broadcast
+/broadcast/*/31337/
+/broadcast/**/dry-run/
+
+# Docs
+docs/
+
+# Dotenv file
+.env