refactor(coordinator & prover): RESTful API (scroll-tech#696)

Co-authored-by: georgehao <[email protected]>
Co-authored-by: HAOYUatHZ <[email protected]>

Author: 3 people

common/cmd/cmd.go

@@ -83,7 +83,7 @@ func (c *Cmd) Write(data []byte) (int, error) {
 	out := string(data)
 	if verbose || c.openLog {
 		fmt.Printf("%s:\n\t%v", c.name, out)
-	} else if strings.Contains(out, "error") || strings.Contains(out, "warning") {
+	} else if strings.Contains(strings.ToLower(out), "error") || strings.Contains(strings.ToLower(out), "warning") || strings.Contains(strings.ToLower(out), "info") {
 		fmt.Printf("%s:\n\t%v", c.name, out)
 	}
 	go c.checkFuncs.IterCb(func(_ string, value interface{}) {

common/types/errno.go

@@ -0,0 +1,20 @@
+package types
+
+const (
+	// Success shows OK.
+	Success = 0
+
+	// ErrJWTCommonErr jwt common error
+	ErrJWTCommonErr = 50000
+	// ErrJWTTokenExpired jwt token expired
+	ErrJWTTokenExpired = 50001
+
+	// ErrCoordinatorParameterInvalidNo is invalid params
+	ErrCoordinatorParameterInvalidNo = 20001
+	// ErrCoordinatorGetTaskFailure is getting prover task error
+	ErrCoordinatorGetTaskFailure = 20002
+	// ErrCoordinatorHandleZkProofFailure is handle submit proof error
+	ErrCoordinatorHandleZkProofFailure = 20003
+	// ErrCoordinatorEmptyProofData get empty proof data
+	ErrCoordinatorEmptyProofData = 20004
+)

common/types/message/message.go

@@ -58,15 +58,12 @@ type AuthMsg struct {
 
 // Identity contains all the fields to be signed by the prover.
 type Identity struct {
-	// Prover name
-	Name string `json:"name"`
-	// Prover ProverType
-	ProverType ProofType `json:"prover_type,omitempty"`
-	// Version is common.Version+ZkVersion. Use the following to check the latest ZkVersion version.
-	// curl -sL https://api.github.com/repos/scroll-tech/scroll-prover/commits | jq -r ".[0].sha"
-	Version string `json:"version"`
-	// Random unique token generated by manager
-	Token string `json:"token"`
+	// ProverName the prover name
+	ProverName string `json:"prover_name"`
+	// ProverVersion the prover version
+	ProverVersion string `json:"prover_version"`
+	// Challenge unique challenge generated by manager
+	Challenge string `json:"challenge"`
 }
 
 // GenerateToken generates token

common/types/message/message_test.go

@@ -15,9 +15,9 @@ func TestAuthMessageSignAndVerify(t *testing.T) {
 
 	authMsg := &AuthMsg{
 		Identity: &Identity{
-			Name:    "testName",
-			Version: "testVersion",
-			Token:   "testToken",
+			Challenge:     "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2OTEwMzgxNzUsIm9yaWdfaWF0IjoxNjkxMDM0NTc1fQ.HybBMsEJFhyZqtIa2iVcHUP7CEFttf708jmTMAImAWA",
+			ProverName:    "test",
+			ProverVersion: "v1.0.0",
 		},
 	}
 	assert.NoError(t, authMsg.SignWithKey(privkey))
@@ -46,15 +46,15 @@ func TestGenerateToken(t *testing.T) {
 
 func TestIdentityHash(t *testing.T) {
 	identity := &Identity{
-		Name:       "testName",
-		ProverType: ProofTypeChunk,
-		Version:    "testVersion",
-		Token:      "testToken",
+		Challenge:     "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2OTEwMzM0MTksIm9yaWdfaWF0IjoxNjkxMDI5ODE5fQ.EhkLZsj__rNPVC3ZDYBtvdh0nB8mmM_Hl82hObaIWOs",
+		ProverName:    "test",
+		ProverVersion: "v1.0.0",
 	}
+
 	hash, err := identity.Hash()
 	assert.NoError(t, err)
 
-	expectedHash := "c0411a19531fb8c6133b2bae91f361c14e65f2d318aef72b83519e6061cad001"
+	expectedHash := "83f5e0ad023e9c1de639ab07b9b4cb972ec9dbbd2524794c533a420a5b137721"
 	assert.Equal(t, expectedHash, hex.EncodeToString(hash))
 }
 

common/version/version.go

@@ -5,7 +5,7 @@ import (
 	"runtime/debug"
 )
 
-var tag = "v4.0.43"
+var tag = "v4.1.0"
 
 var commit = func() string {
 	if info, ok := debug.ReadBuildInfo(); ok {

coordinator/README.md

@@ -37,7 +37,7 @@ make lint
 
 ## Configure
 
-The coordinator behavior can be configured using [`config.json`](config.json). Check the code comments under `ProverManagerConfig` in [`config/config.go`](config/config.go) for more details.
+The coordinator behavior can be configured using [`config.json`](config.json). Check the code comments under `ProverManager` in [`config/config.go`](config/config.go) for more details.
 
 
 ## Start

coordinator/client/client.go

@@ -2,13 +2,17 @@ package app
 
 import (
 	"context"
+	"errors"
 	"fmt"
+	"net/http"
 	"os"
 	"os/signal"
+	"time"
 
 	// enable the pprof
 	_ "net/http/pprof"
 
+	"github.com/gin-gonic/gin"
 	"github.com/scroll-tech/go-ethereum/log"
 	"github.com/urfave/cli/v2"
 
@@ -20,7 +24,7 @@ import (
 	"scroll-tech/coordinator/internal/config"
 	"scroll-tech/coordinator/internal/controller/api"
 	"scroll-tech/coordinator/internal/controller/cron"
-	"scroll-tech/coordinator/internal/logic/provermanager"
+	"scroll-tech/coordinator/internal/route"
 )
 
 var app *cli.App
@@ -49,15 +53,12 @@ func action(ctx *cli.Context) error {
 	}
 
 	subCtx, cancel := context.WithCancel(ctx.Context)
-	db, err := database.InitDB(cfg.DBConfig)
+	db, err := database.InitDB(cfg.DB)
 	if err != nil {
 		log.Crit("failed to init db connection", "err", err)
 	}
 
 	proofCollector := cron.NewCollector(subCtx, db, cfg)
-
-	provermanager.InitProverManager(db)
-
 	defer func() {
 		proofCollector.Stop()
 		cancel()
@@ -66,42 +67,42 @@ func action(ctx *cli.Context) error {
 		}
 	}()
 
+	router := gin.Default()
+	api.InitController(cfg, db)
+	route.Route(router, cfg)
+	port := ctx.String(httpPortFlag.Name)
+	srv := &http.Server{
+		Addr:              fmt.Sprintf(":%s", port),
+		Handler:           router,
+		ReadHeaderTimeout: time.Minute,
+	}
+
 	// Start metrics server.
 	metrics.Serve(subCtx, ctx)
 
-	apis := api.RegisterAPIs(cfg, db)
-	// Register api and start rpc service.
-	if ctx.Bool(httpEnabledFlag.Name) {
-		handler, addr, err := utils.StartHTTPEndpoint(fmt.Sprintf("%s:%d", ctx.String(httpListenAddrFlag.Name), ctx.Int(httpPortFlag.Name)), apis)
-		if err != nil {
-			log.Crit("Could not start RPC api", "error", err)
-		}
-		defer func() {
-			_ = handler.Shutdown(ctx.Context)
-			log.Info("HTTP endpoint closed", "url", fmt.Sprintf("http://%v/", addr))
-		}()
-		log.Info("HTTP endpoint opened", "url", fmt.Sprintf("http://%v/", addr))
-	}
-	// Register api and start ws service.
-	if ctx.Bool(wsEnabledFlag.Name) {
-		handler, addr, err := utils.StartWSEndpoint(fmt.Sprintf("%s:%d", ctx.String(wsListenAddrFlag.Name), ctx.Int(wsPortFlag.Name)), apis, cfg.ProverManagerConfig.CompressionLevel)
-		if err != nil {
-			log.Crit("Could not start WS api", "error", err)
+	go func() {
+		if runServerErr := srv.ListenAndServe(); err != nil && !errors.Is(runServerErr, http.ErrServerClosed) {
+			log.Crit("run coordinator http server failure", "error", runServerErr)
 		}
-		defer func() {
-			_ = handler.Shutdown(ctx.Context)
-			log.Info("WS endpoint closed", "url", fmt.Sprintf("ws://%v/", addr))
-		}()
-		log.Info("WS endpoint opened", "url", fmt.Sprintf("ws://%v/", addr))
-	}
+	}()
 
 	// Catch CTRL-C to ensure a graceful shutdown.
 	interrupt := make(chan os.Signal, 1)
 	signal.Notify(interrupt, os.Interrupt)
 
 	// Wait until the interrupt signal is received from an OS signal.
 	<-interrupt
+	log.Info("start shutdown coordinator server ...")
+
+	closeCtx, cancelExit := context.WithTimeout(context.Background(), 5*time.Second)
+	defer cancelExit()
+	if err = srv.Shutdown(closeCtx); err != nil {
+		log.Warn("shutdown coordinator server failure", "error", err)
+		return nil
+	}
 
+	<-closeCtx.Done()
+	log.Info("coordinator server exiting success")
 	return nil
 }
 

coordinator/cmd/app/app.go

@@ -18,7 +18,7 @@ import (
 )
 
 var (
-	wsStartPort int64 = 40000
+	httpStartPort int64 = 40000
 )
 
 // CoordinatorApp coordinator-test client manager.
@@ -29,7 +29,7 @@ type CoordinatorApp struct {
 
 	originFile      string
 	coordinatorFile string
-	WSPort          int64
+	HTTPPort        int64
 
 	args []string
 	docker.AppAPI
@@ -39,13 +39,13 @@ type CoordinatorApp struct {
 func NewCoordinatorApp(base *docker.App, file string) *CoordinatorApp {
 	coordinatorFile := fmt.Sprintf("/tmp/%d_coordinator-config.json", base.Timestamp)
 	port, _ := rand.Int(rand.Reader, big.NewInt(2000))
-	wsPort := port.Int64() + wsStartPort
+	httpPort := port.Int64() + httpStartPort
 	coordinatorApp := &CoordinatorApp{
 		base:            base,
 		originFile:      file,
 		coordinatorFile: coordinatorFile,
-		WSPort:          wsPort,
-		args:            []string{"--log.debug", "--config", coordinatorFile, "--ws", "--ws.port", strconv.Itoa(int(wsPort))},
+		HTTPPort:        httpPort,
+		args:            []string{"--log.debug", "--config", coordinatorFile, "--http", "--http.port", strconv.Itoa(int(httpPort))},
 	}
 	if err := coordinatorApp.MockConfig(true); err != nil {
 		panic(err)
@@ -67,9 +67,9 @@ func (c *CoordinatorApp) Free() {
 	_ = os.Remove(c.coordinatorFile)
 }
 
-// WSEndpoint returns ws endpoint.
-func (c *CoordinatorApp) WSEndpoint() string {
-	return fmt.Sprintf("ws://localhost:%d", c.WSPort)
+// HTTPEndpoint returns ws endpoint.
+func (c *CoordinatorApp) HTTPEndpoint() string {
+	return fmt.Sprintf("http://localhost:%d", c.HTTPPort)
 }
 
 // MockConfig creates a new coordinator config.
@@ -80,14 +80,13 @@ func (c *CoordinatorApp) MockConfig(store bool) error {
 		return err
 	}
 	// Reset prover manager config for manager test cases.
-	cfg.ProverManagerConfig = &coordinatorConfig.ProverManagerConfig{
+	cfg.ProverManager = &coordinatorConfig.ProverManager{
 		ProversPerSession: 1,
 		Verifier:          &coordinatorConfig.VerifierConfig{MockMode: true},
-		CollectionTime:    1,
-		TokenTimeToLive:   1,
+		CollectionTimeSec: 60,
 	}
-	cfg.DBConfig.DSN = base.DBImg.Endpoint()
-	cfg.L2Config.ChainID = 111
+	cfg.DB.DSN = base.DBImg.Endpoint()
+	cfg.L2.ChainID = 111
 	c.Config = cfg
 
 	if !store {

coordinator/cmd/app/mock_app.go

@@ -1,25 +1,27 @@
 {
-  "prover_manager_config": {
-    "compression_level": 9,
+  "prover_manager": {
     "provers_per_session": 1,
     "session_attempts": 2,
-    "collection_time": 180,
-    "token_time_to_live": 60,
+    "collection_time_sec": 180,
     "verifier": {
       "mock_mode": true,
       "params_path": "",
       "assets_path": ""
     },
-    "max_verifier_workers": 10,
-    "order_session": "ASC"
+    "max_verifier_workers": 10
   },
-  "db_config": {
+  "db": {
     "driver_name": "postgres",
     "dsn": "postgres://admin:123456@localhost/test?sslmode=disable",
     "maxOpenNum": 200,
     "maxIdleNum": 20
   },
-  "l2_config": {
+  "l2": {
     "chain_id": 111
+  },
+  "auth": {
+    "secret": "prover secret key",
+    "challenge_expire_duration_sec": 3600,
+    "login_expire_duration_sec": 3600
   }
 }