Merge branch 'main' into tt-2008-customisable-contract-deployment

Author: Tofel

book/src/SUMMARY.md

@@ -44,6 +44,7 @@
       - [Aptos](framework/components/blockchains/aptos.md)
       - [Sui](framework/components/blockchains/sui.md)
       - [TRON](framework/components/blockchains/tron.md)
+      - [ZKSync](framework/components/blockchains/zksync.md)
       - [Optimism Stack]()
       - [Arbitrum Stack]()
     - [Chainlink](framework/components/chainlink.md)

book/src/framework/components/blockchains/zksync.md

@@ -0,0 +1,22 @@
+# ZKSync clients
+
+We support [Anvil ZKSync](https://foundry-book.zksync.io/anvil-zksync/) memory blockchain in a Docker image.
+It is a fork of [Anvil](https://book.getfoundry.sh/anvil/) with support for ZK Sync transactions and ZK VM.
+
+Components are managed as [EVM](./evm) components.
+
+> The component will create a temporary Dockerfile that pulls the Anvil ZKSync executables from https://raw.githubusercontent.com/matter-labs/foundry-zksync/main/install-foundry-zksync
+> as per ZK Sync documentation.
+
+## Configuration
+
+Use `type: 'anvil-zksync'` to use Anvil ZKSync.
+
+The configurable arguments are two:
+
+- `chain_id`, defaults to `"260"`
+- `port`, defaults to `"8011"`
+
+## Test Private Keys
+
+Testing keys are exported in the `blockchain` go module under `AnvilZKSyncRichAccountPks`.

framework/.changeset/v0.6.2.md

@@ -0,0 +1 @@
+- Add `Anvil ZkSync` blockchain component

framework/components/blockchain/anvil.go

@@ -1,15 +1,7 @@
 package blockchain
 
 import (
-	"context"
-	"fmt"
 	"strings"
-	"time"
-
-	"github.com/docker/docker/api/types/container"
-	"github.com/docker/go-connections/nat"
-	"github.com/testcontainers/testcontainers-go"
-	"github.com/testcontainers/testcontainers-go/wait"
 
 	"github.com/smartcontractkit/chainlink-testing-framework/framework"
 )
@@ -33,60 +25,18 @@ func defaultAnvil(in *Input) {
 // newAnvil deploy foundry anvil node
 func newAnvil(in *Input) (*Output, error) {
 	defaultAnvil(in)
-	ctx := context.Background()
+	req := baseRequest(in, WithoutWsEndpoint)
+
+	req.Image = in.Image
+	req.AlwaysPullImage = in.PullImage
+
 	entryPoint := []string{"anvil"}
 	defaultCmd := []string{"--host", "0.0.0.0", "--port", in.Port, "--chain-id", in.ChainID}
 	entryPoint = append(entryPoint, defaultCmd...)
 	entryPoint = append(entryPoint, in.DockerCmdParamsOverrides...)
+	req.Entrypoint = entryPoint
+
 	framework.L.Info().Any("Cmd", strings.Join(entryPoint, " ")).Msg("Creating anvil with command")
-	bindPort := fmt.Sprintf("%s/tcp", in.Port)
-	containerName := framework.DefaultTCName("blockchain-node")
 
-	req := testcontainers.ContainerRequest{
-		AlwaysPullImage: in.PullImage,
-		Image:           in.Image,
-		Labels:          framework.DefaultTCLabels(),
-		Name:            containerName,
-		ExposedPorts:    []string{bindPort},
-		HostConfigModifier: func(h *container.HostConfig) {
-			h.PortBindings = framework.MapTheSamePort(bindPort)
-			framework.ResourceLimitsFunc(h, in.ContainerResources)
-		},
-		Networks: []string{framework.DefaultNetworkName},
-		NetworkAliases: map[string][]string{
-			framework.DefaultNetworkName: {containerName},
-		},
-		WaitingFor: wait.ForListeningPort(nat.Port(in.Port)).WithStartupTimeout(10 * time.Second).WithPollInterval(200 * time.Millisecond),
-		Entrypoint: entryPoint,
-	}
-	c, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
-		ContainerRequest: req,
-		Started:          true,
-	})
-	if err != nil {
-		return nil, err
-	}
-	host, err := framework.GetHost(c)
-	if err != nil {
-		return nil, err
-	}
-	mp, err := c.MappedPort(ctx, nat.Port(bindPort))
-	if err != nil {
-		return nil, err
-	}
-	return &Output{
-		UseCache:      true,
-		Family:        "evm",
-		ChainID:       in.ChainID,
-		ContainerName: containerName,
-		Container:     c,
-		Nodes: []*Node{
-			{
-				HostWSUrl:             fmt.Sprintf("ws://%s:%s", host, mp.Port()),
-				HostHTTPUrl:           fmt.Sprintf("http://%s:%s", host, mp.Port()),
-				DockerInternalWSUrl:   fmt.Sprintf("ws://%s:%s", containerName, in.Port),
-				DockerInternalHTTPUrl: fmt.Sprintf("http://%s:%s", containerName, in.Port),
-			},
-		},
-	}, nil
+	return createGenericEvmContainer(in, req, false)
 }

framework/components/blockchain/anvil_zksync.go

@@ -0,0 +1,85 @@
+package blockchain
+
+import (
+	"os"
+	"path/filepath"
+	"strings"
+
+	"github.com/testcontainers/testcontainers-go"
+
+	"github.com/smartcontractkit/chainlink-testing-framework/framework"
+)
+
+var AnvilZKSyncRichAccountPks = []string{
+	"ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80",
+	"59c6995e998f97a5a0044966f0945389dc9e86dae88c7a8412f4603b6b78690d",
+	"5de4111afa1a4b94908f83103eb1f1706367c2e68ca870fc3fb9a804cdab365a",
+	"7c852118294e51e653712a81e05800f419141751be58f605c371e15141b007a6",
+	"47e179ec197488593b187f80a00eb0da91f1b9d0b13f8733639f19c30a34926a",
+	"8b3a350cf5c34c9194ca85829a2df0ec3153be0318b5e2d3348e872092edffba",
+	"92db14e403b83dfe3df233f83dfa3a0d7096f21ca9b0d6d6b8d88b2b4ec1564e",
+	"4bbbf85ce3377467afe5d46f804f221813b2bb87f24d81f60f1fcdbf7cbf4356",
+	"dbda1821b80551c9d65939329250298aa3472ba22feea921c0cf5d620ea67b97",
+	"2a871d0798f97d79848a013d4936a73bf4cc922c825d33c1cf7073dff6d409c6",
+}
+
+func defaultAnvilZksync(in *Input) {
+	if in.ChainID == "" {
+		in.ChainID = "260"
+	}
+	if in.Port == "" {
+		in.Port = "8011"
+	}
+}
+
+const dockerFile = `FROM ubuntu:latest
+RUN apt update
+RUN apt install -y curl git
+RUN curl -L https://raw.githubusercontent.com/matter-labs/foundry-zksync/main/install-foundry-zksync | bash`
+
+// anvil-zskync has no public image builds. this method will build the image from source
+// creating a dockerfile in a temporary directory with the necessary commands to install
+// foundry-zksync.
+// see: https://foundry-book.zksync.io/getting-started/installation#using-foundry-with-docker
+func newAnvilZksync(in *Input) (*Output, error) {
+	defaultAnvilZksync(in)
+	req := baseRequest(in, WithoutWsEndpoint)
+
+	tempDir, err := os.MkdirTemp(".", "anvil-zksync-dockercontext")
+	if err != nil {
+		return nil, err
+	}
+
+	defer func() {
+		// delete the folder wether it was successful or not
+		_ = os.RemoveAll(tempDir)
+	}()
+
+	dockerfilePath := filepath.Join(tempDir, "anvilZksync.Dockerfile")
+
+	if err := os.WriteFile(dockerfilePath, []byte(dockerFile), 0600); err != nil {
+		return nil, err
+	}
+
+	req.FromDockerfile = testcontainers.FromDockerfile{
+		Context:    tempDir,
+		Dockerfile: "anvilZksync.Dockerfile",
+		KeepImage:  true,
+	}
+
+	req.Entrypoint = []string{
+		"/bin/sh",
+		"-c",
+		"/root/.foundry/bin/anvil-zksync" +
+			" --chain-id " + in.ChainID +
+			" --port " + in.Port}
+
+	framework.L.Info().Any("Cmd", strings.Join(req.Entrypoint, " ")).Msg("Creating anvil zkSync with command")
+
+	output, err := createGenericEvmContainer(in, req, false)
+	if err != nil {
+		return nil, err
+	}
+
+	return output, nil
+}

framework/components/blockchain/besu.go

@@ -1,19 +1,5 @@
 package blockchain
 
-import (
-	"context"
-	"fmt"
-	"time"
-
-	"github.com/docker/docker/api/types/container"
-
-	"github.com/smartcontractkit/chainlink-testing-framework/framework"
-
-	"github.com/docker/go-connections/nat"
-	"github.com/testcontainers/testcontainers-go"
-	"github.com/testcontainers/testcontainers-go/wait"
-)
-
 const (
 	DefaultBesuPrivateKey1 = "8f2a55949038a9610f50fb23b5883af3b4ecb3c3bb792cbcefbd1542c692be63"
 	DefaultBesuPrivateKey2 = "c87509a1c067bbde78beb793e6fa76530b6382a4c0241e5e4a9ec0a0f44dc0d3"
@@ -37,7 +23,11 @@ func defaultBesu(in *Input) {
 
 func newBesu(in *Input) (*Output, error) {
 	defaultBesu(in)
-	ctx := context.Background()
+	req := baseRequest(in, WithWsEndpoint)
+
+	req.Image = in.Image
+	req.AlwaysPullImage = in.PullImage
+
 	defaultCmd := []string{
 		"--network=dev",
 		"--miner-enabled",
@@ -53,64 +43,7 @@ func newBesu(in *Input) (*Output, error) {
 		"--data-path=/tmp/tmpDatdir",
 	}
 	entryPoint := append(defaultCmd, in.DockerCmdParamsOverrides...)
+	req.Cmd = entryPoint
 
-	containerName := framework.DefaultTCName("blockchain-node")
-	bindPort := fmt.Sprintf("%s/tcp", in.Port)
-	bindPortWs := fmt.Sprintf("%s/tcp", in.WSPort)
-
-	req := testcontainers.ContainerRequest{
-		AlwaysPullImage: in.PullImage,
-		Image:           in.Image,
-		Name:            containerName,
-		ExposedPorts:    []string{bindPort, bindPortWs},
-		Networks:        []string{framework.DefaultNetworkName},
-		NetworkAliases: map[string][]string{
-			framework.DefaultNetworkName: {containerName},
-		},
-		Labels: framework.DefaultTCLabels(),
-		HostConfigModifier: func(h *container.HostConfig) {
-			h.PortBindings = framework.MapTheSamePort(bindPortWs, bindPort)
-			framework.ResourceLimitsFunc(h, in.ContainerResources)
-		},
-		WaitingFor: wait.ForListeningPort(nat.Port(in.Port)).WithStartupTimeout(15 * time.Second).WithPollInterval(200 * time.Millisecond),
-		Cmd:        entryPoint,
-	}
-
-	c, err := testcontainers.GenericContainer(ctx, testcontainers.GenericContainerRequest{
-		ContainerRequest: req,
-		Started:          true,
-	})
-	if err != nil {
-		return nil, err
-	}
-
-	host, err := c.Host(ctx)
-	if err != nil {
-		return nil, err
-	}
-
-	mp, err := c.MappedPort(ctx, nat.Port(bindPort))
-	if err != nil {
-		return nil, err
-	}
-	mpWs, err := c.MappedPort(ctx, nat.Port(bindPortWs))
-	if err != nil {
-		return nil, err
-	}
-
-	return &Output{
-		UseCache:      true,
-		ChainID:       in.ChainID,
-		Family:        "evm",
-		ContainerName: containerName,
-		Container:     c,
-		Nodes: []*Node{
-			{
-				HostHTTPUrl:           fmt.Sprintf("http://%s:%s", host, mp.Port()),
-				HostWSUrl:             fmt.Sprintf("ws://%s:%s", host, mpWs.Port()),
-				DockerInternalHTTPUrl: fmt.Sprintf("http://%s:%s", containerName, in.Port),
-				DockerInternalWSUrl:   fmt.Sprintf("ws://%s:%s", containerName, in.WSPort),
-			},
-		},
-	}, nil
+	return createGenericEvmContainer(in, req, true)
 }

framework/components/blockchain/blockchain.go

@@ -77,6 +77,8 @@ func NewBlockchainNetwork(in *Input) (*Output, error) {
 		out, err = newSui(in)
 	case "tron":
 		out, err = newTron(in)
+	case "anvil-zksync":
+		out, err = newAnvilZksync(in)
 	default:
 		return nil, fmt.Errorf("blockchain type is not supported or empty, must be 'anvil' or 'geth'")
 	}