example foundry contract

Author: skudasov

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

framework/examples/myproject/example_components/onchain/README.md

@@ -0,0 +1,66 @@
+## Foundry
+
+**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
+
+Foundry consists of:
+
+- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
+- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
+- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
+- **Chisel**: Fast, utilitarian, and verbose solidity REPL.
+
+## Documentation
+
+https://book.getfoundry.sh/
+
+## Usage
+
+### Build
+
+```shell
+$ forge build
+```
+
+### Test
+
+```shell
+$ forge test
+```
+
+### Format
+
+```shell
+$ forge fmt
+```
+
+### Gas Snapshots
+
+```shell
+$ forge snapshot
+```
+
+### Anvil
+
+```shell
+$ anvil
+```
+
+### Deploy
+
+```shell
+$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
+```
+
+### Cast
+
+```shell
+$ cast <subcommand>
+```
+
+### Help
+
+```shell
+$ forge --help
+$ anvil --help
+$ cast --help
+```

framework/examples/myproject/example_components/onchain/foundry.toml

@@ -0,0 +1,6 @@
+[profile.default]
+src = "src"
+out = "out"
+libs = ["lib"]
+
+# See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

framework/examples/myproject/example_components/onchain/script/Counter.s.sol

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+import {Script, console} from "forge-std/Script.sol";
+
+contract CounterScript is Script {
+    function setUp() public {}
+
+    function run() public {
+        vm.broadcast();
+    }
+}

framework/examples/myproject/example_components/onchain/src/Counter.sol

@@ -0,0 +1,14 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+contract Counter {
+    uint256 public number;
+
+    function setNumber(uint256 newNumber) public {
+        number = newNumber;
+    }
+
+    function increment() public {
+        number++;
+    }
+}

framework/examples/myproject/example_components/onchain/test/Counter.t.sol

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+import {Test, console} from "forge-std/Test.sol";
+import {Counter} from "../src/Counter.sol";
+
+contract CounterTest is Test {
+    Counter public counter;
+
+    function setUp() public {
+        counter = new Counter();
+        counter.setNumber(0);
+    }
+
+    function test_Increment() public {
+        counter.increment();
+        assertEq(counter.number(), 1);
+    }
+
+    function testFuzz_SetNumber(uint256 x) public {
+        counter.setNumber(x);
+        assertEq(counter.number(), x);
+    }
+}

framework/examples/myproject/verify.toml

@@ -0,0 +1,4 @@
+[contracts_src]
+[blockchain_a]
+  type = "anvil"
+  docker_cmd_params = ["-b", "3"]

framework/examples/myproject/verify_test.go

@@ -0,0 +1,46 @@
+package examples
+
+import (
+	"github.com/smartcontractkit/chainlink-testing-framework/framework"
+	"github.com/smartcontractkit/chainlink-testing-framework/framework/components/blockchain"
+	"github.com/smartcontractkit/chainlink-testing-framework/framework/examples/example_components/onchain"
+	"github.com/smartcontractkit/chainlink-testing-framework/seth"
+	"github.com/stretchr/testify/require"
+	"testing"
+)
+
+type VerifyCfg struct {
+	ContractsSrc *onchain.Input    `toml:"contracts_src" validate:"required"`
+	BlockchainA  *blockchain.Input `toml:"blockchain_a" validate:"required"`
+}
+
+func TestVerify(t *testing.T) {
+	in, err := framework.Load[VerifyCfg](t)
+	require.NoError(t, err)
+
+	bc, err := blockchain.NewBlockchainNetwork(in.BlockchainA)
+	require.NoError(t, err)
+
+	// connect 2 clients
+	scSrc, err := seth.NewClientBuilder().
+		WithRpcUrl(bc.Nodes[0].HostWSUrl).
+		WithGasPriceEstimations(true, 0, seth.Priority_Fast).
+		WithTracing(seth.TracingLevel_All, []string{seth.TraceOutput_Console}).
+		WithPrivateKeys([]string{blockchain.DefaultAnvilPrivateKey}).
+		Build()
+	require.NoError(t, err)
+	in.ContractsSrc.URL = bc.Nodes[0].HostWSUrl
+	c, err := onchain.NewProductOnChainDeployment(scSrc, in.ContractsSrc)
+	require.NoError(t, err)
+
+	t.Run("test something", func(t *testing.T) {
+		err := framework.VerifyContract(
+			bc.Nodes[0].HostHTTPUrl,
+			c.Addresses[0].String(),
+			"/Users/fahrenheit/GolandProjects/chainlink-testing-framework/framework/examples/myproject/example_components/onchain/src/Counter.sol",
+			"Counter",
+			"http://localhost",
+		)
+		require.NoError(t, err)
+	})
+}

framework/verify.go

@@ -0,0 +1,18 @@
+package framework
+
+import "fmt"
+
+// VerifyContract wraps the forge verify-contract command.
+func VerifyContract(rpcURL, address, contractFile, contractName, blockscoutURL string) error {
+	verifierURL := fmt.Sprintf("%s/api/", blockscoutURL)
+	args := []string{
+		"verify-contract",
+		"--rpc-url", rpcURL,
+		"--compiler-version=0.8.17",
+		address,
+		fmt.Sprintf("%s:%s", contractFile, contractName),
+		"--verifier", "blockscout",
+		"--verifier-url", verifierURL,
+	}
+	return runCommand("forge", args...)
+}