feat(coordinator): add prover rest api

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") {
 		fmt.Printf("%s:\n\t%v", c.name, out)
 	}
 	go c.checkFuncs.IterCb(func(_ string, value interface{}) {

common/types/message/message.go

@@ -58,7 +58,7 @@ type AuthMsg struct {
 
 // Identity contains all the fields to be signed by the prover.
 type Identity struct {
-	// Prover name
+	// ProverName the prover name
 	ProverName string `json:"prover_name"`
 	// Challenge unique challenge generated by manager
 	Challenge string `json:"challenge"`

common/types/message/message_test.go

@@ -15,9 +15,8 @@ func TestAuthMessageSignAndVerify(t *testing.T) {
 
 	authMsg := &AuthMsg{
 		Identity: &Identity{
-			Name:    "testName",
-			Version: "testVersion",
-			Token:   "testToken",
+			Challenge:  "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2OTEwMzgxNzUsIm9yaWdfaWF0IjoxNjkxMDM0NTc1fQ.HybBMsEJFhyZqtIa2iVcHUP7CEFttf708jmTMAImAWA",
+			ProverName: "test",
 		},
 	}
 	assert.NoError(t, authMsg.SignWithKey(privkey))
@@ -46,15 +45,14 @@ 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",
 	}
+
 	hash, err := identity.Hash()
 	assert.NoError(t, err)
 
-	expectedHash := "c0411a19531fb8c6133b2bae91f361c14e65f2d318aef72b83519e6061cad001"
+	expectedHash := "7373bb57ab7c01307d86fec55e088e00c526d82d9d1303fa4a189ff6ea95fbe2"
 	assert.Equal(t, expectedHash, hex.EncodeToString(hash))
 }
 

coordinator/cmd/app/app.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
@@ -55,9 +59,6 @@ func action(ctx *cli.Context) error {
 	}
 
 	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/mock_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.
@@ -83,7 +83,7 @@ func (c *CoordinatorApp) MockConfig(store bool) error {
 	cfg.ProverManagerConfig = &coordinatorConfig.ProverManagerConfig{
 		ProversPerSession: 1,
 		Verifier:          &coordinatorConfig.VerifierConfig{MockMode: true},
-		CollectionTime:    1,
+		CollectionTimeSec: 60,
 		TokenTimeToLive:   1,
 	}
 	cfg.DBConfig.DSN = base.DBImg.Endpoint()

coordinator/conf/config.json

@@ -3,7 +3,7 @@
     "compression_level": 9,
     "provers_per_session": 1,
     "session_attempts": 2,
-    "collection_time": 180,
+    "collection_time_sec": 180,
     "token_time_to_live": 60,
     "verifier": {
       "mock_mode": true,
@@ -21,5 +21,10 @@
   },
   "l2_config": {
     "chain_id": 111
+  },
+  "auth": {
+    "secret": "prover secret key",
+    "challenge_expire_duration_sec": 3600,
+    "login_expire_duration_sec": 3600
   }
 }

coordinator/go.mod

@@ -3,52 +3,67 @@ module scroll-tech/coordinator
 go 1.19
 
 require (
-	github.com/agiledragon/gomonkey/v2 v2.9.0
-	github.com/orcaman/concurrent-map v1.0.0
-	github.com/patrickmn/go-cache v2.1.0+incompatible
+	github.com/appleboy/gin-jwt/v2 v2.9.1
+	github.com/gin-gonic/gin v1.9.1
+	github.com/go-resty/resty/v2 v2.7.0
+	github.com/mitchellh/mapstructure v1.5.0
 	github.com/scroll-tech/go-ethereum v1.10.14-0.20230804022247-26eeb40ea3ca
 	github.com/shopspring/decimal v1.3.1
 	github.com/stretchr/testify v1.8.3
 	github.com/urfave/cli/v2 v2.25.7
-	golang.org/x/sync v0.3.0
 	gorm.io/gorm v1.25.2
 )
 
 require (
+	github.com/bytedance/sonic v1.9.2 // indirect
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
+	github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311 // indirect
+	github.com/gabriel-vasile/mimetype v1.4.2 // indirect
+	github.com/gin-contrib/sse v0.1.0 // indirect
+	github.com/go-playground/locales v0.14.1 // indirect
+	github.com/go-playground/universal-translator v0.18.1 // indirect
+	github.com/go-playground/validator/v10 v10.14.1 // indirect
+	github.com/goccy/go-json v0.10.2 // indirect
+	github.com/golang-jwt/jwt/v4 v4.5.0 // indirect
 	github.com/golang/snappy v0.0.5-0.20220116011046-fa5810519dcb // indirect
+	github.com/google/go-cmp v0.5.9 // indirect
 	github.com/jinzhu/inflection v1.0.0 // indirect
 	github.com/jinzhu/now v1.1.5 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/klauspost/cpuid/v2 v2.2.5 // indirect
 	github.com/kr/pretty v0.3.1 // indirect
+	github.com/leodido/go-urn v1.2.4 // indirect
+	github.com/mattn/go-isatty v0.0.19 // indirect
 	github.com/mattn/go-runewidth v0.0.14 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/pelletier/go-toml/v2 v2.0.8 // indirect
 	github.com/rivo/uniseg v0.4.4 // indirect
 	github.com/rogpeppe/go-internal v1.10.0 // indirect
-	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
+	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
+	github.com/ugorji/go/codec v1.2.11 // indirect
+	golang.org/x/arch v0.4.0 // indirect
+	golang.org/x/net v0.12.0 // indirect
+	golang.org/x/text v0.11.0 // indirect
+	google.golang.org/protobuf v1.31.0 // indirect
 )
 
 require (
 	github.com/btcsuite/btcd v0.20.1-beta // indirect
 	github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect
 	github.com/davecgh/go-spew v1.1.1 // indirect
-	github.com/deckarep/golang-set v1.8.0 // indirect
 	github.com/go-ole/go-ole v1.2.6 // indirect
 	github.com/go-stack/stack v1.8.1 // indirect
-	github.com/gopherjs/gopherjs v1.17.2 // indirect
-	github.com/gorilla/websocket v1.5.0 // indirect
 	github.com/iden3/go-iden3-crypto v0.0.15 // indirect
-	github.com/jtolds/gls v4.20.0+incompatible // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/scroll-tech/zktrie v0.6.0 // indirect
 	github.com/shirou/gopsutil v3.21.11+incompatible // indirect
-	github.com/smartystreets/assertions v1.13.1 // indirect
-	github.com/smartystreets/goconvey v1.8.0
 	github.com/tklauser/go-sysconf v0.3.11 // indirect
 	github.com/tklauser/numcpus v0.6.0 // indirect
 	github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 // indirect
 	github.com/yusufpapurcu/wmi v1.2.2 // indirect
 	golang.org/x/crypto v0.11.0 // indirect
 	golang.org/x/sys v0.10.0 // indirect
-	gopkg.in/natefinch/npipe.v2 v2.0.0-20160621034901-c1b8fa8bdcce // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )