Merge branch 'develop' into multi_verifier

Co-authored-by: georgehao <haohongfan@gmail.com>

.github/scripts/bump_version_dot_go.mjs

@@ -1,37 +0,0 @@
-import { URL } from "url";
-import { readFileSync, writeFileSync } from "fs";
-
-const versionFilePath = new URL(
-  "../../common/version/version.go",
-  import.meta.url
-).pathname;
-
-const versionFileContent = readFileSync(versionFilePath, { encoding: "utf-8" });
-
-const currentVersion = versionFileContent.match(
-  /var tag = "(?<version>v(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+))"/
-);
-
-try {
-  parseInt(currentVersion.groups.major);
-  parseInt(currentVersion.groups.minor);
-  parseInt(currentVersion.groups.patch);
-} catch (err) {
-  console.error(new Error("Failed to parse version in version.go file"));
-  throw err;
-}
-
-// prettier-ignore
-const newVersion = `v${currentVersion.groups.major}.${currentVersion.groups.minor}.${parseInt(currentVersion.groups.patch) + 1}`;
-
-console.log(
-  `Bump version from ${currentVersion.groups.version} to ${newVersion}`
-);
-
-writeFileSync(
-  versionFilePath,
-  versionFileContent.replace(
-    `var tag = "${currentVersion.groups.version}"`,
-    `var tag = "${newVersion}"`
-  )
-);

.github/workflows/bump_version.yml

@@ -1,61 +0,0 @@
-name: Bump Version
-
-on:
-  pull_request:
-    branches: [develop]
-    types:
-      - opened
-      - reopened
-      - synchronize
-      - ready_for_review
-
-jobs:
-  check:
-    runs-on: ubuntu-latest
-    outputs:
-      check-result: ${{ steps.check-diff.outputs.result }}
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-      - name: check diff
-        id: check-diff
-        run: |
-          set -euo pipefail
-
-          # fetch develop branch so that we can diff against later
-          git fetch origin develop
-
-          echo 'checking verion changes in diff...'
-
-          # check if version changed in version.go
-          # note: the grep will fail if use \d instead of [0-9]
-          git diff HEAD..origin/develop --text --no-ext-diff --unified=0 --no-prefix common/version/version.go | grep -E '^\+var tag = "v[0-9]+\.[0-9]+\.[0-9]+"$' && true
-
-          exit_code=$?
-
-          # auto bump if version is not bumped manually
-          echo '> require auto version bump?'
-
-          if [ $exit_code -eq 0 ]; then
-            echo '> no, already bumped'
-            echo "result=no-bump" >> "$GITHUB_OUTPUT"
-          else
-            echo '> yes'
-            echo "result=bump" >> "$GITHUB_OUTPUT"
-          fi
-  bump:
-    runs-on: ubuntu-latest
-    needs: check
-    if: needs.check.outputs.check-result == 'bump'
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v3
-      - name: Install Node.js 16
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16
-      - name: bump version in common/version/version.go
-        run: node .github/scripts/bump_version_dot_go.mjs
-      - uses: stefanzweifel/git-auto-commit-action@3ea6ae190baf489ba007f7c92608f33ce20ef04a
-        with:
-          commit_message: "chore: auto version bump [bot]"

bridge/internal/controller/sender/sender.go

@@ -488,7 +488,7 @@ func (s *Sender) loop(ctx context.Context) {
 		case <-checkBalanceTicker.C:
 			// Check and set balance.
 			if err := s.checkBalance(ctx); err != nil {
-				log.Error("check balance error", "err", err)
+				log.Error("check balance, err: %w", err)
 			}
 		case <-ctx.Done():
 			return

common/version/version.go

@@ -6,7 +6,7 @@ import (
 	"strings"
 )
 
-var tag = "v4.1.49"
+var tag = "v4.1.46"
 
 var commit = func() string {
 	if info, ok := debug.ReadBuildInfo(); ok {
@@ -28,8 +28,15 @@ var commit = func() string {
 // The default `000000-000000` is set for integration test, and will be overwritten by coordinator's & prover's actual compilations (see their Makefiles).
 var ZkVersion = "000000-000000"
 
-// Version denote the version of scroll protocol, including the l2geth, relayer, coordinator, prover, contracts and etc.
-var Version = fmt.Sprintf("%s-%s-%s", tag, commit, ZkVersion)
+// OldZkVersion is the last version of ZkVersion.
+var OldZkVersion = "000000-000000"
+
+var (
+	// Version denote the version of scroll protocol, including the l2geth, relayer, coordinator, prover, contracts and etc.
+	Version = fmt.Sprintf("%s-%s-%s", tag, commit, ZkVersion)
+	// OldVersion is the last version of Version.
+	OldVersion = fmt.Sprintf("%s-%s-%s", tag, commit, OldZkVersion)
+)
 
 // CheckScrollProverVersion check the "scroll-prover" version, if it's different from the local one, return false
 func CheckScrollProverVersion(proverVersion string) bool {

coordinator/Makefile

@@ -5,28 +5,38 @@ IMAGE_VERSION=latest
 REPO_ROOT_DIR=./..
 
 ifeq (4.3,$(firstword $(sort $(MAKE_VERSION) 4.3)))
-	ZKEVM_VERSION=$(shell grep -m 1 "scroll-prover" ../common/libzkp/impl/Cargo.lock | cut -d "#" -f2 | cut -c-7)
-	HALO2_VERSION=$(shell grep -m 1 "halo2.git" ../common/libzkp/impl/Cargo.lock | cut -d "#" -f2 | cut -c-7)
+	ZKEVM_VERSION=$(shell grep -m 1 "scroll-prover" ../common/libzkp/impl/Cargo.lock.new | cut -d "#" -f2 | cut -c-7)
+	HALO2_VERSION=$(shell grep -m 1 "halo2.git" ../common/libzkp/impl/Cargo.lock.new | cut -d "#" -f2 | cut -c-7)
+	OLD_ZKEVM_VERSION=$(shell grep -m 1 "scroll-prover" ../common/libzkp/impl/Cargo.lock.old | cut -d "#" -f2 | cut -c-7)
+	OLD_HALO2_VERSION=$(shell grep -m 1 "halo2.git" ../common/libzkp/impl/Cargo.lock.old | cut -d "#" -f2 | cut -c-7)
 else
-	ZKEVM_VERSION=$(shell grep -m 1 "scroll-prover" ../common/libzkp/impl/Cargo.lock | cut -d "\#" -f2 | cut -c-7)
-	HALO2_VERSION=$(shell grep -m 1 "halo2.git" ../common/libzkp/impl/Cargo.lock | cut -d "\#" -f2 | cut -c-7)
+	ZKEVM_VERSION=$(shell grep -m 1 "scroll-prover" ../common/libzkp/impl/Cargo.lock.new | cut -d "\#" -f2 | cut -c-7)
+	HALO2_VERSION=$(shell grep -m 1 "halo2.git" ../common/libzkp/impl/Cargo.lock.new | cut -d "\#" -f2 | cut -c-7)
+	OLD_ZKEVM_VERSION=$(shell grep -m 1 "scroll-prover" ../common/libzkp/impl/Cargo.lock.old | cut -d "\#" -f2 | cut -c-7)
+	OLD_HALO2_VERSION=$(shell grep -m 1 "halo2.git" ../common/libzkp/impl/Cargo.lock.old | cut -d "\#" -f2 | cut -c-7)
 endif
 
 ZK_VERSION=${ZKEVM_VERSION}-${HALO2_VERSION}
+OLD_ZK_VERSION=${OLD_ZKEVM_VERSION}-${OLD_HALO2_VERSION}
+
+pre-upgrade-zk:
+	cd ../common/libzkp/impl && cp Cargo.lock.old Cargo.lock && cargo clean && cargo build --release && cp ./target/release/libzkp.so ../interface/liboldzkp.so
+	cp -r ../common/libzkp/interface ./internal/logic/old_verifier/lib && rm ../common/libzkp/interface/liboldzkp.so
+	find ../common | grep libzktrie.so | xargs -I{} cp {} ./internal/logic/old_verifier/lib/liboldzktrie.so
 
 test:
 	go test -v -race -coverprofile=coverage.txt -covermode=atomic -p 1 $(PWD)/...
 
-libzkp:
-	cd ../common/libzkp/impl && cargo clean && cargo build --release && cp ./target/release/libzkp.so ../interface/
-	rm -rf ./internal/logic/verifier/lib && cp -r ../common/libzkp/interface ./internal/logic/verifier/lib
+libzkp: pre-upgrade-zk
+	cd ../common/libzkp/impl && cp Cargo.lock.new Cargo.lock && cargo clean && cargo build --release && cp ./target/release/libzkp.so ../interface/
+	cp -r ../common/libzkp/interface ./internal/logic/verifier/lib
 	find ../common | grep libzktrie.so | xargs -I{} cp {} ./internal/logic/verifier/lib
 
 coordinator: libzkp ## Builds the Coordinator instance.
-	go build -ldflags "-X scroll-tech/common/version.ZkVersion=${ZK_VERSION}" -o $(PWD)/build/bin/coordinator ./cmd
+	go build -ldflags "-X scroll-tech/common/version.ZkVersion=${ZK_VERSION} -X scroll-tech/common/version.OldZkVersion=${OLD_ZK_VERSION}" -o $(PWD)/build/bin/coordinator ./cmd
 
 coordinator_skip_libzkp:
-	go build -ldflags "-X scroll-tech/common/version.ZkVersion=${ZK_VERSION}" -o $(PWD)/build/bin/coordinator ./cmd
+	go build -ldflags "-X scroll-tech/common/version.ZkVersion=${ZK_VERSION} -X scroll-tech/common/version.OldZkVersion=${OLD_ZK_VERSION}" -o $(PWD)/build/bin/coordinator ./cmd
 
 mock_coordinator: ## Builds the mocked Coordinator instance.
 	go build -tags="mock_prover mock_verifier" -o $(PWD)/build/bin/coordinator ./cmd

coordinator/cmd/app/app.go

@@ -71,11 +71,6 @@ func action(ctx *cli.Context) error {
 
 	apiSrv := apiServer(ctx, cfg, db, registry)
 
-	log.Info(
-		"coordinator start successfully",
-		"version", version.Version,
-	)
-
 	// Catch CTRL-C to ensure a graceful shutdown.
 	interrupt := make(chan os.Signal, 1)
 	signal.Notify(interrupt, os.Interrupt)

coordinator/conf/config.json

@@ -8,6 +8,11 @@
       "params_path": "",
       "assets_path": ""
     },
+    "old_verifier": {
+      "mock_mode": true,
+      "params_path": "",
+      "assets_path": ""
+    },
     "max_verifier_workers": 4
   },
   "db": {

coordinator/internal/config/config.go

@@ -17,6 +17,8 @@ type ProverManager struct {
 	SessionAttempts uint8 `json:"session_attempts"`
 	// Zk verifier config.
 	Verifier *VerifierConfig `json:"verifier"`
+	// Old Zk version config
+	OldVerifier *VerifierConfig `json:"old_verifier"`
 	// Proof collection time (in seconds).
 	CollectionTimeSec int `json:"collection_time_sec"`
 	// Max number of workers in verifier worker pool

coordinator/internal/logic/old_verifier/mock.go

@@ -0,0 +1,35 @@
+//go:build mock_verifier
+
+package old_verifier
+
+import (
+	"scroll-tech/common/types/message"
+
+	"scroll-tech/coordinator/internal/config"
+)
+
+const InvalidTestProof = "this is a invalid proof"
+
+// OldVerifier represents a mock halo2 verifier.
+type OldVerifier struct{}
+
+// NewVerifier Sets up a mock verifier.
+func NewOldVerifier(_ *config.VerifierConfig) (*OldVerifier, error) {
+	return &OldVerifier{}, nil
+}
+
+// VerifyChunkProof return a mock verification result for a ChunkProof.
+func (v *OldVerifier) VerifyChunkProof(proof *message.ChunkProof) (bool, error) {
+	if string(proof.Proof) == InvalidTestProof {
+		return false, nil
+	}
+	return true, nil
+}
+
+// VerifyBatchProof return a mock verification result for a BatchProof.
+func (v *OldVerifier) VerifyBatchProof(proof *message.BatchProof) (bool, error) {
+	if string(proof.Proof) == InvalidTestProof {
+		return false, nil
+	}
+	return true, nil
+}

coordinator/internal/logic/old_verifier/old_verifier.go

@@ -0,0 +1,98 @@
+//go:build !mock_verifier
+
+package old_verifier
+
+/*
+#cgo LDFLAGS: -loldzkp -lm -ldl -loldzktrie -L${SRCDIR}/lib/ -Wl,-rpath=${SRCDIR}/lib
+#cgo gpu LDFLAGS: -loldzkp -lm -ldl -lgmp -lstdc++ -lprocps -loldzktrie -L/usr/local/cuda/lib64/ -lcudart -L${SRCDIR}/lib/ -Wl,-rpath=${SRCDIR}/lib
+#include <stdlib.h>
+#include "./lib/libzkp.h"
+*/
+import "C" //nolint:typecheck
+
+import (
+	"encoding/json"
+	"scroll-tech/common/types/message"
+	"unsafe"
+
+	"scroll-tech/coordinator/internal/logic/verifier"
+
+	"github.com/scroll-tech/go-ethereum/log"
+
+	"scroll-tech/coordinator/internal/config"
+)
+
+// OldVerifier represents a rust ffi to a halo2 verifier.
+type OldVerifier struct {
+	cfg *config.VerifierConfig
+}
+
+// NewOldVerifier Sets up a rust ffi to call verify.
+func NewOldVerifier(cfg *config.VerifierConfig) (*OldVerifier, error) {
+	if cfg.MockMode {
+		return &OldVerifier{cfg: cfg}, nil
+	}
+	paramsPathStr := C.CString(cfg.ParamsPath)
+	assetsPathStr := C.CString(cfg.AssetsPath)
+	defer func() {
+		C.free(unsafe.Pointer(paramsPathStr))
+		C.free(unsafe.Pointer(assetsPathStr))
+	}()
+
+	log.Info("Init old verifier!")
+
+	C.init_batch_verifier(paramsPathStr, assetsPathStr)
+	C.init_chunk_verifier(paramsPathStr, assetsPathStr)
+
+	return &OldVerifier{cfg: cfg}, nil
+}
+
+// VerifyBatchProof Verify a ZkProof by marshaling it and sending it to the Halo2 OldVerifier.
+func (v *OldVerifier) VerifyBatchProof(proof *message.BatchProof) (bool, error) {
+	if v.cfg.MockMode {
+		log.Info("Mock mode, batch verifier disabled")
+		if string(proof.Proof) == verifier.InvalidTestProof {
+			return false, nil
+		}
+		return true, nil
+
+	}
+	buf, err := json.Marshal(proof)
+	if err != nil {
+		return false, err
+	}
+
+	proofStr := C.CString(string(buf))
+	defer func() {
+		C.free(unsafe.Pointer(proofStr))
+	}()
+
+	log.Info("Start to verify batch proof ...")
+	verified := C.verify_batch_proof(proofStr)
+	return verified != 0, nil
+}
+
+// VerifyChunkProof Verify a ZkProof by marshaling it and sending it to the Halo2 OldVerifier.
+func (v *OldVerifier) VerifyChunkProof(proof *message.ChunkProof) (bool, error) {
+	if v.cfg.MockMode {
+		log.Info("Mock mode, verifier disabled")
+		if string(proof.Proof) == verifier.InvalidTestProof {
+			return false, nil
+		}
+		return true, nil
+
+	}
+	buf, err := json.Marshal(proof)
+	if err != nil {
+		return false, err
+	}
+
+	proofStr := C.CString(string(buf))
+	defer func() {
+		C.free(unsafe.Pointer(proofStr))
+	}()
+
+	log.Info("Start to verify chunk proof ...")
+	verified := C.verify_chunk_proof(proofStr)
+	return verified != 0, nil
+}

coordinator/internal/logic/submitproof/proof_receiver.go

@@ -5,8 +5,13 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	"scroll-tech/common/version"
 	"time"
 
+	"scroll-tech/coordinator/internal/logic/old_verifier"
+
+	jwt "github.com/appleboy/gin-jwt/v2"
+
 	"github.com/gin-gonic/gin"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promauto"
@@ -27,6 +32,8 @@ var (
 	ErrValidatorFailureProofMsgStatusNotOk = errors.New("validator failure proof msg status not ok")
 	// ErrValidatorFailureProverTaskEmpty get none prover task
 	ErrValidatorFailureProverTaskEmpty = errors.New("validator failure get none prover task for the proof")
+	// ErrInvalidProverVersion means prover version is invalid.
+	ErrInvalidProverVersion = errors.New("prover version invalid")
 	// ErrValidatorFailureProverTaskCannotSubmitTwice prove task can not submit proof twice
 	ErrValidatorFailureProverTaskCannotSubmitTwice = errors.New("validator failure prove task cannot submit proof twice")
 	// ErrValidatorFailureProofTimeout the submit proof is timeout
@@ -44,7 +51,8 @@ type ProofReceiverLogic struct {
 	db  *gorm.DB
 	cfg *config.ProverManager
 
-	verifier *verifier.Verifier
+	verifier    *verifier.Verifier
+	oldVerifier *old_verifier.OldVerifier
 
 	proofReceivedTotal                    prometheus.Counter
 	proofSubmitFailure                    prometheus.Counter
@@ -64,6 +72,10 @@ func NewSubmitProofReceiverLogic(cfg *config.ProverManager, db *gorm.DB, reg pro
 	if err != nil {
 		panic("proof receiver new verifier failure")
 	}
+	oldVf, err := old_verifier.NewOldVerifier(cfg.OldVerifier)
+	if err != nil {
+		panic("proof receiver new OldVerifier failure")
+	}
 	return &ProofReceiverLogic{
 		chunkOrm:      orm.NewChunk(db),
 		batchOrm:      orm.NewBatch(db),
@@ -72,7 +84,8 @@ func NewSubmitProofReceiverLogic(cfg *config.ProverManager, db *gorm.DB, reg pro
 		cfg: cfg,
 		db:  db,
 
-		verifier: vf,
+		verifier:    vf,
+		oldVerifier: oldVf,
 
 		proofReceivedTotal: promauto.With(reg).NewCounter(prometheus.CounterOpts{
 			Name: "coordinator_submit_proof_total",
@@ -150,9 +163,9 @@ func (m *ProofReceiverLogic) HandleZkProof(ctx *gin.Context, proofMsg *message.P
 	var success bool
 	var verifyErr error
 	if proofMsg.Type == message.ProofTypeChunk {
-		success, verifyErr = m.verifier.VerifyChunkProof(proofMsg.ChunkProof)
+		success, verifyErr = m.verifyChunkProof(ctx, proofMsg.ChunkProof)
 	} else if proofMsg.Type == message.ProofTypeBatch {
-		success, verifyErr = m.verifier.VerifyBatchProof(proofMsg.BatchProof)
+		success, verifyErr = m.verifyBatchProof(ctx, proofMsg.BatchProof)
 	}
 
 	if verifyErr != nil || !success {
@@ -383,3 +396,27 @@ func (m *ProofReceiverLogic) updateProverTaskProof(ctx context.Context, pk strin
 	}
 	return m.proverTaskOrm.UpdateProverTaskProof(ctx, proofMsg.Type, proofMsg.ID, pk, proofBytes)
 }
+
+func (m *ProofReceiverLogic) verifyChunkProof(c *gin.Context, proof *message.ChunkProof) (bool, error) {
+	claims := jwt.ExtractClaims(c)
+	proverVersion := claims[coordinatorType.ProverVersion]
+	switch proverVersion.(string) {
+	case version.Version:
+		return m.verifier.VerifyChunkProof(proof)
+	case version.OldVersion:
+		return m.oldVerifier.VerifyChunkProof(proof)
+	}
+	return false, ErrInvalidProverVersion
+}
+
+func (m *ProofReceiverLogic) verifyBatchProof(c *gin.Context, proof *message.BatchProof) (bool, error) {
+	claims := jwt.ExtractClaims(c)
+	proverVersion := claims[coordinatorType.ProverVersion]
+	switch proverVersion.(string) {
+	case version.Version:
+		return m.verifier.VerifyBatchProof(proof)
+	case version.OldVersion:
+		return m.oldVerifier.VerifyBatchProof(proof)
+	}
+	return false, ErrInvalidProverVersion
+}

coordinator/internal/logic/verifier/verifier.go

@@ -41,6 +41,8 @@ func NewVerifier(cfg *config.VerifierConfig) (*Verifier, error) {
 		C.free(unsafe.Pointer(assetsPathStr))
 	}()
 
+	log.Info("Init verifier!")
+
 	C.init_batch_verifier(paramsPathStr, assetsPathStr)
 	C.init_chunk_verifier(paramsPathStr, assetsPathStr)
 

coordinator/test/api_test.go

@@ -109,7 +109,8 @@ func setupCoordinator(t *testing.T, proversPerSession uint8, coordinatorURL stri
 }
 
 func setEnv(t *testing.T) {
-	version.Version = "v1.2.3-aaa-bbb-ccc"
+	version.Version = "v1.2.3-commit-prover-halo2"
+	version.OldZkVersion = "prover_old"
 
 	base = docker.NewDockerApp()
 	base.RunDBImage(t)

prover/cmd/app/app.go

@@ -52,11 +52,9 @@ func action(ctx *cli.Context) error {
 	r.Start()
 
 	defer r.Stop()
-	log.Info(
-		"prover start successfully",
+	log.Info("prover start successfully",
 		"name", cfg.ProverName, "type", cfg.Core.ProofType,
-		"publickey", r.PublicKey(), "version", version.Version,
-	)
+		"publickey", r.PublicKey(), "version", version.Version)
 
 	// Catch CTRL-C to ensure a graceful shutdown.
 	interrupt := make(chan os.Signal, 1)

scripts/download_params.sh

@@ -5,6 +5,7 @@ DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" > /dev/null 2>&1 && pwd)"
 PROJ_DIR=$DIR"/.."
 
 mkdir -p $PROJ_DIR/assets/params
-wget https://circuit-release.s3.us-west-2.amazonaws.com/circuit-release/release-1220/test_seed -O $PROJ_DIR/assets/seed
-wget https://circuit-release.s3.us-west-2.amazonaws.com/circuit-release/params-0320/params20 -O $PROJ_DIR/assets/params/params20
-wget https://circuit-release.s3.us-west-2.amazonaws.com/circuit-release/params-0320/params26 -O $PROJ_DIR/assets/params/params26
+wget https://circuit-release.s3.us-west-2.amazonaws.com/setup/params19 -O $PROJ_DIR/assets/params/params19
+wget https://circuit-release.s3.us-west-2.amazonaws.com/setup/params20 -O $PROJ_DIR/assets/params/params20
+wget https://circuit-release.s3.us-west-2.amazonaws.com/setup/params24 -O $PROJ_DIR/assets/params/params24
+wget https://circuit-release.s3.us-west-2.amazonaws.com/setup/params25 -O $PROJ_DIR/assets/params/params25