[TT-950] Support for more eth1 clients

.github/workflows/docker-test.yaml

@@ -6,7 +6,7 @@ on:
     types: [labeled]
 
 jobs:
-  docker:
+  eth_env:
     if: ${{ github.event_name == 'pull_request_review' || github.event.label.name == 'docker_tests' }}
     runs-on: ubuntu-latest
     steps:
@@ -31,7 +31,83 @@ jobs:
           set -euo pipefail
           # disabled, because we want to use a multiline output of go list command
           # shellcheck disable=SC2046
-          go test -timeout 20m -json -cover -covermode=atomic -coverprofile=unit-test-coverage.out $(go list ./... | grep /docker/test_env) 2>&1 | tee /tmp/gotest.log | gotestfmt
+          go test -timeout 20m -json -parallel 2 -cover -covermode=atomic -coverprofile=unit-test-coverage.out $(go list ./... | grep /docker/test_env) -run 'TestEthEnv' 2>&1 | tee /tmp/gotest.log | gotestfmt
+      - name: Code Coverage
+        uses: codecov/codecov-action@v3
+        with:
+          files: ./unit-test-coverage.out
+          name: codecov-umbrella
+      - name: Publish Artifacts
+        if: failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: test-logs
+          path: ./logs
+
+  eth_clients:
+    if: ${{ github.event_name == 'pull_request_review' || github.event.label.name == 'docker_tests' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the Repo
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      - name: Install Go
+        uses: smartcontractkit/chainlink-github-actions/chainlink-testing-framework/setup-go@00c6214deb10a3f374c6d3430c32c5202015d463 # v2.2.12
+        with:
+          test_download_vendor_packages_command: go mod download
+          go_mod_path: ./go.mod
+          cache_key_id: ctf-go
+          cache_restore_only: 'false'
+      # gotestfmt gives us pretty test output
+      - name: Set Up gotestfmt
+        uses: GoTestTools/gotestfmt-action@v2
+        with:
+          token: ${{ github.token }} # Avoids rate-limiting
+      - name: Run Tests
+        run: |
+          PATH=$PATH:$(go env GOPATH)/bin
+          export PATH
+          set -euo pipefail
+          # disabled, because we want to use a multiline output of go list command
+          # shellcheck disable=SC2046
+          go test -timeout 20m -json -parallel 2 -cover -covermode=atomic -coverprofile=unit-test-coverage.out $(go list ./... | grep /docker/test_env) -run 'TestBesu|TestGeth|TestNethermind|TestErigon' 2>&1 | tee /tmp/gotest.log | gotestfmt
+      - name: Code Coverage
+        uses: codecov/codecov-action@v3
+        with:
+          files: ./unit-test-coverage.out
+          name: codecov-umbrella
+      - name: Publish Artifacts
+        if: failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: test-logs
+          path: ./logs
+
+  other:
+    if: ${{ github.event_name == 'pull_request_review' || github.event.label.name == 'docker_tests' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the Repo
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+      - name: Install Go
+        uses: smartcontractkit/chainlink-github-actions/chainlink-testing-framework/setup-go@00c6214deb10a3f374c6d3430c32c5202015d463 # v2.2.12
+        with:
+          test_download_vendor_packages_command: go mod download
+          go_mod_path: ./go.mod
+          cache_key_id: ctf-go
+          cache_restore_only: 'false'
+      # gotestfmt gives us pretty test output
+      - name: Set Up gotestfmt
+        uses: GoTestTools/gotestfmt-action@v2
+        with:
+          token: ${{ github.token }} # Avoids rate-limiting
+      - name: Run Tests
+        run: |
+          PATH=$PATH:$(go env GOPATH)/bin
+          export PATH
+          set -euo pipefail
+          # disabled, because we want to use a multiline output of go list command
+          # shellcheck disable=SC2046
+          go test -timeout 20m -json -parallel 2 -cover -covermode=atomic -coverprofile=unit-test-coverage.out $(go list ./... | grep /docker/test_env) -run 'TestPostgres|TestMockServer|TestKillgrave' 2>&1 | tee /tmp/gotest.log | gotestfmt
       - name: Code Coverage
         uses: codecov/codecov-action@v3
         with:

Makefile

@@ -77,7 +77,7 @@ test_unit: install_gotestfmt
 	go test -json -cover -covermode=count -coverprofile=unit-test-coverage.out ./client ./gauntlet ./testreporters ./k8s/config ./utils/osutil 2 2>&1 | tee /tmp/gotest.log | gotestfmt
 
 test_docker: install_gotestfmt
-	go test -json -cover -covermode=count -coverprofile=unit-test-coverage.out ./docker/test_env ./logstream 2>&1 | tee /tmp/gotest.log | gotestfmt	
+	go test -timeout 20m -json -failfast -parallel 3 -cover -covermode=atomic -coverprofile=unit-test-coverage.out ./docker/test_env 2>&1 | tee /tmp/gotest.log | gotestfmt
 
 
 #######################

README.md

@@ -133,19 +133,42 @@ We have extended support for execution layer clients in simulated networks. Foll
 
 When it comes to consensus layer we currently support only `Prysm`.
 
+The easiest way to start a simulated network is to use a builder. It allows to configure the network in a fluent way and then start it. For example:
+
+```go
+builder := NewEthereumNetworkBuilder()
+cfg, err: = builder.
+    WithEthereumVersion(EthereumVersion_Eth2).
+    WithExecutionLayer(ExecutionLayer_Geth).
+    Build()
+```
+
+Since we support both `eth1` (aka pre-Merge) and `eth2` (aka post-Merge) client versions, you need to specify which one you want to use. You can do that by calling `WithEthereumVersion` method. There's no default provided. The only execption is when you use custom docker images (instead of default ones), because then we can determine which version it is based on the image version.
+
+If you want your test to execute as fast as possible go for `eth1` since it's either using a fake PoW or PoA consensus and is much faster than `eth2` which uses PoS consensus (where there is a minimum viable length of slot/block, which is 4 seconds; for `eth1` it's 1 second). If you want to test the latest features, changes or forks in the Ethereum network and have your tests running on a network which is as close as possible to Ethereum Mainnet, go for `eth2`.
+
 Every component has some default Docker image it uses, but builder has a method that allows to pass custom one:
 
 ```go
 builder := NewEthereumNetworkBuilder()
 cfg, err: = builder.
-    WithConsensusType(ConsensusType_PoS).
+    WithEthereumVersion(EthereumVersion_Eth2).
     WithConsensusLayer(ConsensusLayer_Prysm).
     WithExecutionLayer(ExecutionLayer_Geth).
     WithCustomDockerImages(map[ContainerType]string{
-        ContainerType_Geth2: "my-custom-geth2-image:my-version"}).
+        ContainerType_Geth: "my-custom-geth-pos-image:my-version"}).
     Build()
+```
 
+When using a custom image you can even further simplify the builder by calling only `WithCustomDockerImages` method. Based on the image name and version we will determine which execution layer client it is and whether it's `eth1` or `eth2` client:
+```go
+builder := NewEthereumNetworkBuilder()
+cfg, err: = builder.
+    WithCustomDockerImages(map[ContainerType]string{
+        ContainerType_Geth: "ethereum/client-go:v1.13.10"}).
+    Build()
 ```
+In the case above we would launch a `Geth` client with `eth2` network and `Prysm` consensus layer.
 
 You can also configure epochs at which hardforks will happen. Currently only `Deneb` is supported. Epoch must be >= 1. Example:
 

blockchain/blockchain.go

@@ -13,6 +13,7 @@ import (
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/common/hexutil"
 	"github.com/ethereum/go-ethereum/core/types"
+	"github.com/ethereum/go-ethereum/ethclient"
 )
 
 // EVMClient is the interface that wraps a given client implementation for a blockchain, to allow for switching
@@ -112,6 +113,8 @@ type EVMClient interface {
 	FilterLogs(ctx context.Context, filterQuery ethereum.FilterQuery) ([]types.Log, error)
 
 	RawJsonRPCCall(ctx context.Context, result interface{}, method string, params ...interface{}) error
+
+	GetEthClient() *ethclient.Client
 }
 
 // NodeHeader header with the ID of the node that received it

blockchain/ethereum.go

@@ -587,6 +587,10 @@ func (e *EthereumClient) ProcessTransaction(tx *types.Transaction) error {
 	return nil
 }
 
+func (e *EthereumClient) GetEthClient() *ethclient.Client {
+	return e.Client
+}
+
 // ProcessEvent will queue or wait on an event depending on whether parallel transactions are enabled
 func (e *EthereumClient) ProcessEvent(name string, event *types.Log, confirmedChan chan bool, errorChan chan error) error {
 	var eventConfirmer HeaderEventSubscription
@@ -1171,6 +1175,10 @@ type EthereumMultinodeClient struct {
 	Clients       []EVMClient
 }
 
+func (e *EthereumMultinodeClient) GetEthClient() *ethclient.Client {
+	return e.DefaultClient.GetEthClient()
+}
+
 func (e *EthereumMultinodeClient) Backend() bind.ContractBackend {
 	return e.DefaultClient.Backend()
 }
@@ -1296,10 +1304,24 @@ func ConnectEVMClient(networkSettings EVMNetwork, logger zerolog.Logger) (EVMCli
 			continue
 		}
 		// a call to BalanceAt to ensure the client is connected
-		_, err = ec.BalanceAt(context.Background(), ec.GetDefaultWallet().address)
+		b, err := ec.BalanceAt(context.Background(), ec.GetDefaultWallet().address)
 		if err == nil {
 			ec.SetID(idx)
 			ecl.Clients = append(ecl.Clients, ec)
+
+			logger.Info().
+				Uint64("Balance", b.Uint64()).
+				Str("Address", ec.GetDefaultWallet().address.Hex()).
+				Msg("Default address balance")
+
+			if networkSettings.Simulated && b.Cmp(big.NewInt(0)) == 0 {
+				noBalanceErr := fmt.Errorf("Default wallet %s has no balance", ec.GetDefaultWallet().address.Hex())
+				logger.Err(noBalanceErr).
+					Msg("Ending test before it fails anyway")
+
+				return nil, noBalanceErr
+			}
+
 			break
 		}
 	}

client/github.go

@@ -15,6 +15,8 @@ type GithubClient struct {
 	client *github.Client
 }
 
+const WITHOUT_TOKEN = ""
+
 func NewGithubClient(token string) *GithubClient {
 	// Optional: Authenticate with a personal access token if necessary
 	// This is recommended to avoid rate limits for unauthenticated requests
@@ -34,12 +36,21 @@ func NewGithubClient(token string) *GithubClient {
 	}
 }
 
+// ListLatestReleases lists the latest releases for a given repository
+func (g *GithubClient) ListLatestReleases(org, repository string, count int) ([]*github.RepositoryRelease, error) {
+	ctx := context.Background()
+	releases, _, err := g.client.Repositories.ListReleases(ctx, org, repository, &github.ListOptions{PerPage: count})
+	return releases, err
+}
+
+// ListLatestCLCoreReleases lists the latest releases for the Chainlink core repository
 func (g *GithubClient) ListLatestCLCoreReleases(count int) ([]*github.RepositoryRelease, error) {
 	ctx := context.Background()
 	releases, _, err := g.client.Repositories.ListReleases(ctx, "smartcontractkit", "chainlink", &github.ListOptions{PerPage: count})
 	return releases, err
 }
 
+// ListLatestCLCoreTags lists the latest tags for the Chainlink core repository
 func (g *GithubClient) ListLatestCLCoreTags(count int) ([]*github.RepositoryTag, error) {
 	ctx := context.Background()
 	tags, _, err := g.client.Repositories.ListTags(ctx, "smartcontractkit", "chainlink", &github.ListOptions{PerPage: count})

config/examples/example.toml

@@ -43,8 +43,8 @@ polygon_mumbai = ["wss://polygon-endpoint.io"]
 polygon_mumbai = ["change-me-to-your-PK"]
 
 [PrivateEthereumNetwork]
-# pos or pow
-consensus_type="pos"
+# eth1 or eth2
+ethereum_version="eth2"
 # only prysm supported currently
 consensus_layer="prysm"
 # geth, besu, nethermind or erigon
@@ -63,4 +63,13 @@ genesis_delay=15
 validator_count=8
 chain_id=1337
 # list of addresses to be prefunded in genesis
-addresses_to_fund=["0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"]
+addresses_to_fund=["0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266"]
+
+[PrivateEthereumNetwork.EthereumChainConfig.HardForkEpochs]
+Deneb=500
+
+[PrivateEthereumNetwork.CustomDockerImages]
+# this will override our default image
+# also when set and no explicit ethereum_version or execution_layer is provided
+# we will deduct it from this custom image
+besu="hyperledger/besu:24.2.0-RC2"

config/wasp_autobuild.go

@@ -0,0 +1,39 @@
+package config
+
+import (
+	"errors"
+)
+
+type WaspAutoBuildConfig struct {
+	Namespace           *string `toml:"namespace"`
+	RepoImageVersionURI *string `toml:"repo_image_version_uri"`
+	TestBinaryName      *string `toml:"test_binary_name"`
+	TestName            *string `toml:"test_name"`
+	TestTimeout         *string `toml:"test_timeout"`
+	KeepJobs            bool    `toml:"keep_jobs"`
+	WaspLogLevel        *string `toml:"wasp_log_level"`
+	WaspJobs            *string `toml:"wasp_jobs"`
+	UpdateImage         bool    `toml:"update_image"`
+}
+
+func (c *WaspAutoBuildConfig) Validate() error {
+	if c.Namespace == nil || *c.Namespace == "" {
+		return errors.New("WASP namespace name should not be empty, see WASP docs to setup it")
+	}
+	if c.RepoImageVersionURI == nil || *c.RepoImageVersionURI == "" {
+		return errors.New("WASP image URI is empty, must be ${registry}/${repo}:${tag}")
+	}
+	if c.TestBinaryName == nil || *c.TestBinaryName == "" {
+		return errors.New("WASP test binary is empty, should be 'ocr.test', run 'go test -c ./...' in load test dir to figure out the name")
+	}
+	if c.TestName == nil || *c.TestName == "" {
+		return errors.New("WASP test name is empty, should be a name of go test you want to run")
+	}
+	if c.TestTimeout == nil || *c.TestTimeout == "" {
+		return errors.New("WASP test timeout should be in Go time format: '1w2d3h4m5s'")
+	}
+	if c.WaspJobs == nil || *c.WaspJobs == "" {
+		return errors.New("WASP jobs are empty, amount of pods to spin up in k8s")
+	}
+	return nil
+}

docker/docker.go

@@ -55,6 +55,9 @@ var NaiveRetrier = func(l zerolog.Logger, startErr error, req tc.GenericContaine
 		Str("Retrier", "NaiveRetrier").
 		Msgf("Attempting to start %s container", req.Name)
 
+	oldName := req.Name
+	req.Name = req.Name + "-naive-retry"
+
 	ct, err := tc.GenericContainer(testcontext.Get(nil), req)
 	if err == nil {
 		l.Debug().
@@ -72,6 +75,8 @@ var NaiveRetrier = func(l zerolog.Logger, startErr error, req tc.GenericContaine
 		}
 	}
 
+	req.Name = oldName
+
 	l.Debug().
 		Str("Original start error", startErr.Error()).
 		Str("Current start error", err.Error()).
@@ -81,12 +86,14 @@ var NaiveRetrier = func(l zerolog.Logger, startErr error, req tc.GenericContaine
 	return nil, startErr
 }
 
-var LinuxPlatoformImageRetrier = func(l zerolog.Logger, startErr error, req tc.GenericContainerRequest) (tc.Container, error) {
+var LinuxPlatformImageRetrier = func(l zerolog.Logger, startErr error, req tc.GenericContainerRequest) (tc.Container, error) {
 	// if it's nil we don't know if we can handle it so we won't try
 	if startErr == nil {
 		return nil, startErr
 	}
 	req.Reuse = false // We need to force a new container to be created
+	oldName := req.Name
+	req.Name = req.Name + "-linux-retry"
 
 	// a bit lame, but that's the lame error we get in case there's no specific image for our platform :facepalm:
 	if !strings.Contains(startErr.Error(), "No such image") {
@@ -114,6 +121,7 @@ var LinuxPlatoformImageRetrier = func(l zerolog.Logger, startErr error, req tc.G
 	}
 
 	req.ImagePlatform = originalPlatform
+	req.Name = oldName
 
 	if ct != nil {
 		err := ct.Terminate(testcontext.Get(nil))
@@ -145,18 +153,16 @@ func StartContainerWithRetry(l zerolog.Logger, req tc.GenericContainerRequest, r
 	}
 
 	if len(retriers) == 0 {
-		retriers = append(retriers, LinuxPlatoformImageRetrier, NaiveRetrier)
+		retriers = append(retriers, LinuxPlatformImageRetrier, NaiveRetrier)
 	}
 
-	for i := 0; i < RetryAttempts; i++ {
-		l.Info().Err(err).Msgf("Cannot start %s container, retrying %d/%d", req.Name, i+1, RetryAttempts)
+	l.Info().Err(err).Msgf("Cannot start %s container, retrying", req.Name)
 
-		req.Reuse = true // Try and see if we can reuse the container for a retry
-		for _, retrier := range retriers {
-			ct, err = retrier(l, err, req)
-			if err == nil {
-				return ct, nil
-			}
+	req.Reuse = true // Try and see if we can reuse the container for a retry
+	for _, retrier := range retriers {
+		ct, err = retrier(l, err, req)
+		if err == nil {
+			return ct, nil
 		}
 	}