feat: allow to sequence_sender to work as Banana or Elderberry

.github/workflows/test-e2e.yml

@@ -0,0 +1,67 @@
+name: Test e2e
+on: 
+  push:
+    branches:
+      - '**'
+  workflow_dispatch: {}
+
+
+jobs:
+  test-e2e:
+    strategy:
+      fail-fast: false
+      matrix:
+        go-version: [ 1.21.x ]
+        goarch: [ "amd64" ]
+        e2e-group: [ "elderberry-validium", "elderberry-rollup" ]
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Install Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: ${{ matrix.go-version }}
+      env:
+        GOARCH: ${{ matrix.goarch }}
+
+    - name: Build Docker
+      run: make build-docker
+
+      # this is better to get the action in
+    - name: Install kurtosis
+      shell: bash
+      run: |
+        echo "deb [trusted=yes] https://apt.fury.io/kurtosis-tech/ /" | sudo tee /etc/apt/sources.list.d/kurtosis.list
+        sudo apt update
+        sudo apt install kurtosis-cli=0.90.1
+        kurtosis version
+
+    - name: Disable kurtosis analytics
+      shell: bash
+      run: kurtosis analytics disable
+
+    - name: Install yq
+      shell: bash
+      run: |
+        pip3 install yq
+        yq --version
+
+    - name: Install foundry
+      uses: foundry-rs/foundry-toolchain@v1
+
+    - name: checkout kurtosis-cdk
+      uses: actions/checkout@v4
+      with:
+        repository: 0xPolygon/kurtosis-cdk
+        ref: jesteban/cdk-seq_sender
+        path: "ext/kurtosis-cdk"
+
+    - name: Link kurtosis-cdk folder
+      shell: bash
+      run: mkdir -p  /tmp/cdk/ && ln -s $GITHUB_WORKSPACE/ext/kurtosis-cdk /tmp/cdk/kurtosis-cdk-jesteban_cdk-seq_sender_
+
+    - name: Test
+      run: make test-e2e-${{ matrix.e2e-group }}
+      working-directory: test

.github/workflows/test-unittest.yml

@@ -0,0 +1,20 @@
+name: Test Unittest
+on: 
+  push:
+     branches:
+      - '**'
+  workflow_dispatch: {}
+
+
+jobs:
+  test-unittest:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+    - name: Install Go
+      uses: actions/setup-go@v3
+
+    - name: Launch unittest
+      run: make test

Dockerfile

@@ -14,6 +14,6 @@ RUN cd /src && make build
 # CONTAINER FOR RUNNING BINARY
 FROM alpine:3.18.4
 COPY --from=build /src/dist/cdk /app/cdk
-RUN apk update && apk add postgresql15-client
+RUN mkdir /app/data &&  apk update && apk add postgresql15-client
 EXPOSE 8123
 CMD ["/bin/sh", "-c", "/app/cdk run"]

Makefile

@@ -82,7 +82,7 @@ stop: ## Stops all services
 
 .PHONY: test
 test:
-	go test -count=1 -short -race -p 1 -timeout 60s ./...
+	trap '$(STOP)' EXIT; MallocNanoZone=0 go test -count=1 -short -race -p 1 -covermode=atomic -coverprofile=../coverage.out  -coverpkg ./... -timeout 200s ./...
 
 .PHONY: install-linter
 install-linter: ## Installs the linter

cmd/run.go

@@ -16,10 +16,14 @@ import (
 	"github.com/0xPolygon/cdk/dataavailability"
 	"github.com/0xPolygon/cdk/dataavailability/datacommittee"
 	"github.com/0xPolygon/cdk/etherman"
+	ethermanconfig "github.com/0xPolygon/cdk/etherman/config"
+	"github.com/0xPolygon/cdk/etherman/contracts"
 	"github.com/0xPolygon/cdk/log"
 	"github.com/0xPolygon/cdk/sequencesender"
+	"github.com/0xPolygon/cdk/sequencesender/txbuilder"
 	"github.com/0xPolygon/cdk/state"
 	"github.com/0xPolygon/cdk/state/pgstatestorage"
+	"github.com/0xPolygon/cdk/translator"
 	ethtxman "github.com/0xPolygonHermez/zkevm-ethtx-manager/etherman"
 	"github.com/0xPolygonHermez/zkevm-ethtx-manager/etherman/etherscan"
 	"github.com/jackc/pgx/v4/pgxpool"
@@ -111,7 +115,7 @@ func createAggregator(ctx context.Context, c config.Config, runMigrations bool)
 }
 
 func createSequenceSender(cfg config.Config) *sequencesender.SequenceSender {
-	ethman, err := etherman.NewClient(etherman.Config{
+	ethman, err := etherman.NewClient(ethermanconfig.Config{
 		EthermanConfig: ethtxman.Config{
 			URL:              cfg.SequenceSender.EthTxManager.Etherman.URL,
 			MultiGasProvider: cfg.SequenceSender.EthTxManager.Etherman.MultiGasProvider,
@@ -122,10 +126,9 @@ func createSequenceSender(cfg config.Config) *sequencesender.SequenceSender {
 			},
 			HTTPHeaders: cfg.SequenceSender.EthTxManager.Etherman.HTTPHeaders,
 		},
-		IsValidiumMode: cfg.SequenceSender.IsValidiumMode,
-	}, cfg.NetworkConfig.L1Config)
+	}, cfg.NetworkConfig.L1Config, cfg.Common)
 	if err != nil {
-		log.Fatal(err)
+		log.Fatalf("Failed to create etherman. Err: %w, ", err)
 	}
 
 	auth, _, err := ethman.LoadAuthFromKeyStore(cfg.SequenceSender.PrivateKey.Path, cfg.SequenceSender.PrivateKey.Password)
@@ -134,23 +137,56 @@ func createSequenceSender(cfg config.Config) *sequencesender.SequenceSender {
 	}
 	cfg.SequenceSender.SenderAddress = auth.From
 
-	da, err := newDataAvailability(cfg, ethman)
+	txBuilder, err := newTxBuilder(cfg, ethman)
 	if err != nil {
 		log.Fatal(err)
 	}
-
-	seqSender, err := sequencesender.New(cfg.SequenceSender, ethman, da)
+	seqSender, err := sequencesender.New(cfg.SequenceSender, ethman, txBuilder)
 	if err != nil {
 		log.Fatal(err)
 	}
 
 	return seqSender
 }
 
+func newTxBuilder(cfg config.Config, ethman *etherman.Client) (txbuilder.TxBuilder, error) {
+	auth, _, err := ethman.LoadAuthFromKeyStore(cfg.SequenceSender.PrivateKey.Path, cfg.SequenceSender.PrivateKey.Password)
+	if err != nil {
+		log.Fatal(err)
+	}
+	da, err := newDataAvailability(cfg, ethman)
+	if err != nil {
+		log.Fatal(err)
+	}
+	var txBuilder txbuilder.TxBuilder
+
+	switch contracts.VersionType(cfg.Common.ContractVersions) {
+	case contracts.VersionBanana:
+		if cfg.Common.IsValidiumMode {
+			txBuilder = txbuilder.NewTxBuilderBananaValidium(ethman.Contracts.Banana.Rollup, ethman.Contracts.Banana.GlobalExitRoot, da, *auth, auth.From, cfg.SequenceSender.MaxBatchesForL1)
+		} else {
+			txBuilder = txbuilder.NewTxBuilderBananaZKEVM(ethman.Contracts.Banana.Rollup, ethman.Contracts.Banana.GlobalExitRoot, *auth, auth.From, cfg.SequenceSender.MaxTxSizeForL1)
+		}
+	case contracts.VersionElderberry:
+		if cfg.Common.IsValidiumMode {
+			txBuilder = txbuilder.NewTxBuilderElderberryValidium(ethman.Contracts.Elderberry.Rollup, da, *auth, auth.From, cfg.SequenceSender.MaxBatchesForL1)
+		} else {
+			txBuilder = txbuilder.NewTxBuilderElderberryZKEVM(ethman.Contracts.Elderberry.Rollup, *auth, auth.From, cfg.SequenceSender.MaxTxSizeForL1)
+		}
+	default:
+		err = fmt.Errorf("unknown contract version: %s", cfg.Common.ContractVersions)
+	}
+
+	return txBuilder, err
+}
+
 func newDataAvailability(c config.Config, etherman *etherman.Client) (*dataavailability.DataAvailability, error) {
-	if !c.SequenceSender.IsValidiumMode {
+	if !c.Common.IsValidiumMode {
 		return nil, nil
 	}
+	translator := translator.NewTranslatorImpl()
+	log.Infof("Translator rules: %v", c.Common.Translator)
+	translator.AddConfigRules(c.Common.Translator)
 
 	// Backend specific config
 	daProtocolName, err := etherman.GetDAProtocolName()
@@ -178,6 +214,7 @@ func newDataAvailability(c config.Config, etherman *etherman.Client) (*dataavail
 			dacAddr,
 			pk,
 			dataCommitteeClient.NewFactory(),
+			translator,
 		)
 		if err != nil {
 			return nil, err
@@ -209,10 +246,10 @@ func runMigrations(c db.Config, name string) {
 }
 
 func newEtherman(c config.Config) (*etherman.Client, error) {
-	config := etherman.Config{
+	config := ethermanconfig.Config{
 		URL: c.Aggregator.EthTxManager.Etherman.URL,
 	}
-	return etherman.NewClient(config, c.NetworkConfig.L1Config)
+	return etherman.NewClient(config, c.NetworkConfig.L1Config, c.Common)
 }
 
 func logVersion() {

common/config.go

@@ -0,0 +1,11 @@
+package common
+
+import "github.com/0xPolygon/cdk/translator"
+
+type Config struct {
+	// IsValidiumMode has the value true if the sequence sender is running in validium mode.
+	IsValidiumMode bool `mapstructure:"IsValidiumMode"`
+	// Contract Versions: elderberry, banana
+	ContractVersions string            `mapstructure:"ContractVersions"`
+	Translator       translator.Config `mapstructure:"Translator"`
+}

config/config.go

@@ -6,7 +6,8 @@ import (
 	"strings"
 
 	"github.com/0xPolygon/cdk/aggregator"
-	"github.com/0xPolygon/cdk/etherman"
+	"github.com/0xPolygon/cdk/common"
+	ethermanconfig "github.com/0xPolygon/cdk/etherman/config"
 	"github.com/0xPolygon/cdk/log"
 	"github.com/0xPolygon/cdk/sequencesender"
 	"github.com/0xPolygonHermez/zkevm-ethtx-manager/ethtxmanager"
@@ -55,7 +56,7 @@ You could find some examples:
 */
 type Config struct {
 	// Configuration of the etherman (client for access L1)
-	Etherman etherman.Config
+	Etherman ethermanconfig.Config
 	// Configuration for ethereum transaction manager
 	EthTxManager ethtxmanager.Config
 	// Configuration of the aggregator
@@ -66,6 +67,9 @@ type Config struct {
 	NetworkConfig NetworkConfig
 	// Configuration of the sequence sender service
 	SequenceSender sequencesender.Config
+
+	// Common Config that affects all the services
+	Common common.Config
 }
 
 // Default parses the default configuration values.

config/default.go

@@ -5,13 +5,16 @@ const DefaultValues = `
 ForkUpgradeBatchNumber = 0
 ForkUpgradeNewForkId = 0
 
+[Common]
+IsValidiumMode = false
+ContractVersions = "banana"
+
 [Log]
 Environment = "development" # "production" or "development"
 Level = "info"
 Outputs = ["stderr"]
 
 [SequenceSender]
-IsValidiumMode = false
 WaitPeriodSendSequence = "15s"
 LastBatchVirtualizationTimeMaxWaitPeriod = "10s"
 L1BlockTimestampMargin = "30s"

config/network.go

@@ -7,7 +7,7 @@ import (
 	"io"
 	"os"
 
-	"github.com/0xPolygon/cdk/etherman"
+	ethermanconfig "github.com/0xPolygon/cdk/etherman/config"
 	"github.com/0xPolygon/cdk/log"
 	"github.com/0xPolygon/cdk/state"
 	"github.com/ethereum/go-ethereum/common"
@@ -17,7 +17,7 @@ import (
 // NetworkConfig is the configuration struct for the different environments
 type NetworkConfig struct {
 	// L1: Configuration related to L1
-	L1Config etherman.L1Config `json:"l1Config"`
+	L1Config ethermanconfig.L1Config `json:"l1Config"`
 	// L1: Genesis of the rollup, first block number and root
 	Genesis state.Genesis
 }
@@ -48,7 +48,7 @@ type GenesisFromJSON struct {
 	// L2:  List of states contracts used to populate merkle tree at initial state
 	Genesis []genesisAccountFromJSON `json:"genesis"`
 	// L1: configuration of the network
-	L1Config etherman.L1Config
+	L1Config ethermanconfig.L1Config
 }
 
 type genesisAccountFromJSON struct {

dataavailability/dataavailability.go

@@ -23,3 +23,7 @@ func New(backend DABackender) (*DataAvailability, error) {
 func (d *DataAvailability) PostSequence(ctx context.Context, sequenceBanana etherman.SequenceBanana) ([]byte, error) {
 	return d.backend.PostSequence(ctx, sequenceBanana)
 }
+
+func (d *DataAvailability) PostSequenceElderberry(ctx context.Context, batchesData [][]byte) ([]byte, error) {
+	return d.backend.PostSequenceElderberry(ctx, batchesData)
+}