From 56399ad0540135cd9bdbfde4d647c6e7f6fb5025 Mon Sep 17 00:00:00 2001 From: georgehao Date: Tue, 18 Jul 2023 16:56:21 +0800 Subject: [PATCH] feat: update prover stats api some files --- go.work.sum | 11 +- prover-stats-api/Makefile | 3 + prover-stats-api/README | 23 ++ prover-stats-api/cmd/app/app.go | 23 +- prover-stats-api/cmd/docs/docs.go | 49 ---- prover-stats-api/cmd/docs/swagger.json | 24 -- prover-stats-api/cmd/docs/swagger.yaml | 17 -- prover-stats-api/cmd/main.go | 5 +- prover-stats-api/conf/config.json | 7 +- prover-stats-api/docs/docs.go | 263 ++++++++++++++++++ prover-stats-api/docs/swagger.json | 238 ++++++++++++++++ prover-stats-api/docs/swagger.yaml | 157 +++++++++++ prover-stats-api/go.mod | 3 +- prover-stats-api/go.sum | 54 +++- prover-stats-api/internal/config/config.go | 9 +- prover-stats-api/internal/controller/auth.go | 54 ++++ .../internal/controller/controller.go | 120 +------- .../internal/controller/prover_task.go | 127 +++++++++ prover-stats-api/internal/controller/route.go | 29 -- prover-stats-api/internal/controller/types.go | 26 -- prover-stats-api/internal/logic/logic.go | 45 --- .../internal/logic/prover_task.go | 42 +++ .../{logic_test.go => prover_task_test.go} | 0 prover-stats-api/internal/middleware/jwt.go | 93 +++---- prover-stats-api/internal/orm/prover_task.go | 69 ++--- prover-stats-api/internal/route/route.go | 34 +++ prover-stats-api/internal/types/auth.go | 12 + prover-stats-api/internal/types/errno.go | 7 + .../internal/types/prover_task.go | 31 +++ prover-stats-api/internal/types/response.go | 27 ++ 30 files changed, 1180 insertions(+), 422 deletions(-) create mode 100644 prover-stats-api/README delete mode 100644 prover-stats-api/cmd/docs/docs.go delete mode 100644 prover-stats-api/cmd/docs/swagger.json delete mode 100644 prover-stats-api/cmd/docs/swagger.yaml create mode 100644 prover-stats-api/docs/docs.go create mode 100644 prover-stats-api/docs/swagger.json create mode 100644 prover-stats-api/docs/swagger.yaml create mode 100644 prover-stats-api/internal/controller/auth.go create mode 100644 prover-stats-api/internal/controller/prover_task.go delete mode 100644 prover-stats-api/internal/controller/route.go delete mode 100644 prover-stats-api/internal/controller/types.go delete mode 100644 prover-stats-api/internal/logic/logic.go create mode 100644 prover-stats-api/internal/logic/prover_task.go rename prover-stats-api/internal/logic/{logic_test.go => prover_task_test.go} (100%) create mode 100644 prover-stats-api/internal/route/route.go create mode 100644 prover-stats-api/internal/types/auth.go create mode 100644 prover-stats-api/internal/types/errno.go create mode 100644 prover-stats-api/internal/types/prover_task.go create mode 100644 prover-stats-api/internal/types/response.go diff --git a/go.work.sum b/go.work.sum index e809d37e4..b58146e17 100644 --- a/go.work.sum +++ b/go.work.sum @@ -155,7 +155,6 @@ github.com/dgraph-io/badger/v2 v2.2007.4 h1:TRWBQg8UrlUhaFdco01nO2uXwzKS7zd+HVdw github.com/dgraph-io/badger/v2 v2.2007.4/go.mod h1:vSw/ax2qojzbN6eXHIx6KPKtCSHJN/Uz0X0VPruTIhk= github.com/dgraph-io/ristretto v0.0.3-0.20200630154024-f66de99634de h1:t0UHb5vdojIDUqktM6+xJAfScFBsVpXZmqC9dsgJmeA= github.com/dgraph-io/ristretto v0.0.3-0.20200630154024-f66de99634de/go.mod h1:KPxhHT9ZxKefz+PCeOGsrHpl1qZ7i70dGTu2u+Ahh6E= -github.com/dgrijalva/jwt-go v3.2.0+incompatible h1:7qlOGliEKZXTDg6OTjfoBKDXWrumCAMpl/TFQ4/5kLM= github.com/dgryski/go-bitstream v0.0.0-20180413035011-3522498ce2c8 h1:akOQj8IVgoeFfBTzGOEQakCYshWD6RNo1M5pivFXt70= github.com/dgryski/go-farm v0.0.0-20190423205320-6a90982ecee2 h1:tdlZCpZ/P9DhczCTSixgIKmwPv6+wP5DGjqLYw5SUiA= github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78= @@ -211,7 +210,6 @@ github.com/ghemawat/stream v0.0.0-20171120220530-696b145b53b9 h1:r5GgOLGbza2wVHR github.com/ghemawat/stream v0.0.0-20171120220530-696b145b53b9/go.mod h1:106OIgooyS7OzLDOpUGgm9fA3bQENb/cFSyyBmMoJDs= github.com/ghodss/yaml v1.0.0 h1:wQHKEahhL6wmXdzwWG11gIVCkOv05bNOh+Rxn0yngAk= github.com/gin-gonic/gin v1.8.1 h1:4+fr/el88TOO3ewCmQr8cx/CtZ/umlIRIs5M4NTNjf8= -github.com/gin-gonic/gin v1.8.1/go.mod h1:ji8BvRH1azfM+SYow9zQ6SZMvR8qOMZHmsCuWR9tTTk= github.com/glycerine/go-unsnap-stream v0.0.0-20180323001048-9f0cb55181dd h1:r04MMPyLHj/QwZuMJ5+7tJcBr1AQjpiAK/rZWRrQT7o= github.com/glycerine/goconvey v0.0.0-20190410193231-58a59202ab31 h1:gclg6gY70GLy3PbkQ1AERPfmLMMagS60DKF78eWwLn8= github.com/go-check/check v0.0.0-20180628173108-788fd7840127 h1:0gkP6mzaMqkmpcJYCFOLkIBwI7xFExG03bbkOkCvUPI= @@ -229,11 +227,8 @@ github.com/go-ole/go-ole v1.2.1/go.mod h1:7FAglXiTm7HKlQRDeOQ6ZNUHidzCWXuZWq/1dT github.com/go-openapi/jsonpointer v0.19.5 h1:gZr+CIYByUqjcgeLXnQu2gHYQC9o73G2XUeOFYEICuY= github.com/go-openapi/swag v0.19.5 h1:lTz6Ys4CmqqCQmZPBlbQENR1/GucA2bzYTE12Pw4tFY= github.com/go-playground/locales v0.14.0 h1:u50s323jtVGugKlcYeyzC0etD1HifMjqmJqb8WugfUU= -github.com/go-playground/locales v0.14.0/go.mod h1:sawfccIbzZTqEDETgFXqTho0QybSa7l++s0DH+LDiLs= github.com/go-playground/universal-translator v0.18.0 h1:82dyy6p4OuJq4/CByFNOn/jYrnRPArHwAcmLoJZxyho= -github.com/go-playground/universal-translator v0.18.0/go.mod h1:UvRDBj+xPUEGrFYl+lu/H90nyDXpg0fqeB/AQUGNTVA= github.com/go-playground/validator/v10 v10.11.1 h1:prmOlTVv+YjZjmRmNSF3VmspqJIxJWXmqUsHwfTRRkQ= -github.com/go-playground/validator/v10 v10.11.1/go.mod h1:i+3WkQ1FvaUjjxh1kSvIA4dMGDBiPU55YFDl0WbKdWU= github.com/go-redis/redis/v8 v8.11.5 h1:AcZZR7igkdvfVmQTPnu9WE37LRrO/YrBH5zWyjDC0oI= github.com/go-redis/redis/v8 v8.11.5/go.mod h1:gREzHqY1hg6oD9ngVRbLStwAWKhA0FEgq8Jd4h5lpwo= github.com/go-sourcemap/sourcemap v2.1.3+incompatible h1:W1iEw64niKVGogNgBN3ePyLFfuisuzeidWPMPWmECqU= @@ -368,7 +363,6 @@ github.com/labstack/gommon v0.3.1 h1:OomWaJXm7xR6L1HmEtGyQf26TEn7V6X88mktX9kee9o github.com/labstack/gommon v0.3.1/go.mod h1:uW6kP17uPlLJsD3ijUYn3/M5bAxtlZhMI6m3MFxTMTM= github.com/leanovate/gopter v0.2.9/go.mod h1:U2L/78B+KVFIx2VmW6onHJQzXtFb+p5y3y2Sh+Jxxv8= github.com/leodido/go-urn v1.2.1 h1:BqpAaACuzVSgi/VLzGZIobT2z4v53pjosyNd9Yv6n/w= -github.com/leodido/go-urn v1.2.1/go.mod h1:zt4jvISO2HfUBqxjfIshjdMTYS56ZS/qv49ictyFfxY= github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0 h1:6E+4a0GO5zZEnZ81pIr0yLvtUWk2if982qA3F3QD6H4= github.com/lufia/plan9stats v0.0.0-20211012122336-39d0f177ccd0/go.mod h1:zJYVVT2jmtg6P3p1VtQj7WsuWi/y4VnjVBn7F8KPB3I= github.com/magiconair/properties v1.8.0 h1:LLgXmsheXeRoUOBOjtwPQCWIYqM/LU1ayDtDePerRcY= @@ -479,8 +473,8 @@ github.com/tklauser/numcpus v0.2.2/go.mod h1:x3qojaO3uyYt0i56EW/VUYs7uBvdl2fkfZF github.com/tklauser/numcpus v0.4.0/go.mod h1:1+UI3pD8NW14VMwdgJNJ1ESk2UnwhAnz5hMwiKKqXCQ= github.com/tyler-smith/go-bip39 v1.0.1-0.20181017060643-dbb3b84ba2ef/go.mod h1:sJ5fKU0s6JVwZjjcUEX2zFOnvq0ASQ2K9Zr6cf67kNs= github.com/ugorji/go v1.1.7 h1:/68gy2h+1mWMrwZFeD1kQialdSzAb432dtpeJ42ovdo= +github.com/ugorji/go v1.2.7 h1:qYhyWUUd6WbiM+C6JZAUkIJt/1WrjzNHY9+KCIjVqTo= github.com/ugorji/go/codec v1.2.7 h1:YPXUKf7fYbp/y8xloBqZOw2qaVggbfwMlI8WM3wZUJ0= -github.com/ugorji/go/codec v1.2.7/go.mod h1:WGN1fab3R1fzQlVQTkfxVtIBhWDRqOviHU95kRgeqEY= github.com/urfave/cli/v2 v2.3.0/go.mod h1:LJmUH05zAU44vOAcrfzZQKsZbVcdbOG8rtL3/XcUArI= github.com/urfave/negroni v1.0.0 h1:kIimOitoypq34K7TG7DUaJ9kq/N4Ofuwi1sjz0KipXc= github.com/valyala/fasthttp v1.40.0 h1:CRq/00MfruPGFLTQKY8b+8SfdK60TxNztjRMnH0t1Yc= @@ -526,7 +520,6 @@ golang.org/x/net v0.0.0-20201010224723-4f7140c49acb/go.mod h1:sp8m0HH+o8qH0wwXwY golang.org/x/net v0.0.0-20210220033124-5f55cee0dc0d/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20210610132358-84b48f89b13b/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= -golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/net v0.8.0/go.mod h1:QVkue5JL9kW//ek3r6jTKnTFis1tRmNAW2P1shuFdJc= golang.org/x/net v0.9.0/go.mod h1:d48xBJpPfHeWQsugry2m+kC02ZBRGRgulfHnEXEuWns= golang.org/x/oauth2 v0.0.0-20200107190931-bf48bf16ab8d h1:TzXSXBo42m9gQenoE3b9BGiEpg5IG2JkU5FkPIawgtw= @@ -568,9 +561,7 @@ google.golang.org/genproto v0.0.0-20210624195500-8bfb893ecb84 h1:R1r5J0u6Cx+RNl/ google.golang.org/grpc v1.26.0 h1:2dTRdpdFEEhJYQD8EMLB61nnrzSCTbG38PhqdhvOltg= google.golang.org/grpc v1.38.0 h1:/9BgsAsa5nWe26HqOlvlgJnqBuktYOLCgjCPqsa56W0= google.golang.org/protobuf v1.26.0 h1:bxAC2xTBsZGibn2RTntX0oH50xLsqy1OxA9tTL3p/lk= -google.golang.org/protobuf v1.28.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I= google.golang.org/protobuf v1.28.1 h1:d0NfwRgPtno5B1Wa6L2DAG+KivqkdutMf1UhdNx175w= -google.golang.org/protobuf v1.28.1/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I= gopkg.in/alecthomas/kingpin.v2 v2.2.6 h1:jMFz6MfLP0/4fUyZle81rXUoxOBFi19VUFKVDOQfozc= gopkg.in/errgo.v2 v2.1.0 h1:0vLT13EuvQ0hNvakwLuFZ/jYrLp5F3kcWHXdRggjCE8= gopkg.in/fsnotify.v1 v1.4.7 h1:xOHLXZwVvI9hhs+cLKq5+I5onOuwQLhQwiu63xxlHs4= diff --git a/prover-stats-api/Makefile b/prover-stats-api/Makefile index 81307cf20..856427ebf 100644 --- a/prover-stats-api/Makefile +++ b/prover-stats-api/Makefile @@ -6,5 +6,8 @@ build: clean: ## Empty out the bin folder @rm -rf build/bin +swag: + swag init -g ./cmd/main.go + test: go test -v $(PWD)/... \ No newline at end of file diff --git a/prover-stats-api/README b/prover-stats-api/README new file mode 100644 index 000000000..47ef34b0b --- /dev/null +++ b/prover-stats-api/README @@ -0,0 +1,23 @@ +# prover-stats-api + +## how to get the prover-stats-api docs + +### 1. start the prover-stats-api server + +``` +cd ./prover-stats-api +go build -o prover-stats ./cmd/ +./prover-stats --config=./conf/config.json +``` + +you will get server run log +``` +Listening and serving HTTP on :8990 +``` + +### 2. browse the documents + +open this documents in your browser +``` +http://localhost:8990/swagger/index.html +``` \ No newline at end of file diff --git a/prover-stats-api/cmd/app/app.go b/prover-stats-api/cmd/app/app.go index 0c001f39f..e31849abf 100644 --- a/prover-stats-api/cmd/app/app.go +++ b/prover-stats-api/cmd/app/app.go @@ -5,18 +5,19 @@ import ( "fmt" "os" "os/signal" - "scroll-tech/common/metrics" + "github.com/gin-gonic/gin" "github.com/scroll-tech/go-ethereum/log" "github.com/urfave/cli/v2" "scroll-tech/common/database" + "scroll-tech/common/metrics" "scroll-tech/common/utils" "scroll-tech/common/version" - _ "scroll-tech/prover-stats-api/cmd/docs" "scroll-tech/prover-stats-api/internal/config" "scroll-tech/prover-stats-api/internal/controller" + "scroll-tech/prover-stats-api/internal/route" ) var app *cli.App @@ -55,11 +56,6 @@ func action(ctx *cli.Context) error { }() subCtx, cancel := context.WithCancel(ctx.Context) - - // init Prover Stats API - port := ctx.String(httpPortFlag.Name) - controller.Route(db, port, cfg) - defer func() { cancel() }() @@ -67,6 +63,19 @@ func action(ctx *cli.Context) error { // Start metrics server. metrics.Serve(subCtx, ctx) + // init Prover Stats API + port := ctx.String(httpPortFlag.Name) + + router := gin.Default() + controller.InitController(db) + route.Route(router, cfg) + + go func() { + if runServerErr := router.Run(fmt.Sprintf(":%s", port)); runServerErr != nil { + log.Crit("run http server failure", "error", runServerErr) + } + }() + // Catch CTRL-C to ensure a graceful shutdown. interrupt := make(chan os.Signal, 1) signal.Notify(interrupt, os.Interrupt) diff --git a/prover-stats-api/cmd/docs/docs.go b/prover-stats-api/cmd/docs/docs.go deleted file mode 100644 index dcc32a055..000000000 --- a/prover-stats-api/cmd/docs/docs.go +++ /dev/null @@ -1,49 +0,0 @@ -// Code generated by swaggo/swag. DO NOT EDIT. - -package docs - -import "github.com/swaggo/swag" - -const docTemplate = `{ - "schemes": {{ marshal .Schemes }}, - "swagger": "2.0", - "info": { - "description": "{{escape .Description}}", - "title": "{{.Title}}", - "contact": { - "name": "Prover Stats API Support", - "email": "Be Pending" - }, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0.html" - }, - "version": "{{.Version}}" - }, - "host": "{{.Host}}", - "basePath": "{{.BasePath}}", - "paths": {}, - "securityDefinitions": { - "BasicAuth": { - "type": "basic" - } - } -}` - -// SwaggerInfo holds exported Swagger Info so clients can modify it -var SwaggerInfo = &swag.Spec{ - Version: "1.0", - Host: "localhost:8990", - BasePath: "/api/v1", - Schemes: []string{}, - Title: "Zero-knowledge Prover Stats API", - Description: "This is an API server for Provers.", - InfoInstanceName: "swagger", - SwaggerTemplate: docTemplate, - LeftDelim: "{{", - RightDelim: "}}", -} - -func init() { - swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) -} diff --git a/prover-stats-api/cmd/docs/swagger.json b/prover-stats-api/cmd/docs/swagger.json deleted file mode 100644 index 960c08822..000000000 --- a/prover-stats-api/cmd/docs/swagger.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "description": "This is an API server for Provers.", - "title": "Zero-knowledge Prover Stats API", - "contact": { - "name": "Prover Stats API Support", - "email": "Be Pending" - }, - "license": { - "name": "Apache 2.0", - "url": "http://www.apache.org/licenses/LICENSE-2.0.html" - }, - "version": "1.0" - }, - "host": "localhost:8990", - "basePath": "/api/v1", - "paths": {}, - "securityDefinitions": { - "BasicAuth": { - "type": "basic" - } - } -} \ No newline at end of file diff --git a/prover-stats-api/cmd/docs/swagger.yaml b/prover-stats-api/cmd/docs/swagger.yaml deleted file mode 100644 index 36129305d..000000000 --- a/prover-stats-api/cmd/docs/swagger.yaml +++ /dev/null @@ -1,17 +0,0 @@ -basePath: /api/v1 -host: localhost:8990 -info: - contact: - email: Be Pending - name: Prover Stats API Support - description: This is an API server for Provers. - license: - name: Apache 2.0 - url: http://www.apache.org/licenses/LICENSE-2.0.html - title: Zero-knowledge Prover Stats API - version: "1.0" -paths: {} -securityDefinitions: - BasicAuth: - type: basic -swagger: "2.0" diff --git a/prover-stats-api/cmd/main.go b/prover-stats-api/cmd/main.go index 5e309f3c3..fe7f50d9f 100644 --- a/prover-stats-api/cmd/main.go +++ b/prover-stats-api/cmd/main.go @@ -1,6 +1,9 @@ package main -import "scroll-tech/prover-stats-api/cmd/app" +import ( + "scroll-tech/prover-stats-api/cmd/app" + _ "scroll-tech/prover-stats-api/docs" +) // @title Zero-knowledge Prover Stats API // @version 1.0 diff --git a/prover-stats-api/conf/config.json b/prover-stats-api/conf/config.json index 3b4bef80f..d4c7dd0e9 100644 --- a/prover-stats-api/conf/config.json +++ b/prover-stats-api/conf/config.json @@ -1,9 +1,12 @@ { "db_config": { "driver_name": "postgres", - "dsn": "postgres://admin:123456@localhost/test?sslmode=disable", + "dsn": "postgres://localhost/scroll?sslmode=disable", "maxOpenNum": 200, "maxIdleNum": 20 }, - "api_secret": "test-api" + "auth": { + "secret": "prover secret key", + "token_expire_duration": 3600 + } } \ No newline at end of file diff --git a/prover-stats-api/docs/docs.go b/prover-stats-api/docs/docs.go new file mode 100644 index 000000000..bfe946930 --- /dev/null +++ b/prover-stats-api/docs/docs.go @@ -0,0 +1,263 @@ +// Code generated by swaggo/swag. DO NOT EDIT. + +package docs + +import "github.com/swaggo/swag" + +const docTemplate = `{ + "schemes": {{ marshal .Schemes }}, + "swagger": "2.0", + "info": { + "description": "{{escape .Description}}", + "title": "{{.Title}}", + "contact": { + "name": "Prover Stats API Support", + "email": "Be Pending" + }, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "{{.Version}}" + }, + "host": "{{.Host}}", + "basePath": "{{.BasePath}}", + "paths": { + "/api/prover_task/v1/request_token": { + "get": { + "description": "login with prover public key", + "consumes": [ + "text/plain" + ], + "produces": [ + "text/plain" + ], + "tags": [ + "prover_task" + ], + "summary": "login with prover public key", + "parameters": [ + { + "type": "string", + "description": "prover public key", + "name": "pubkey", + "in": "query", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/types.LoginSchema" + } + } + } + } + } + }, + "/api/prover_task/v1/task": { + "get": { + "description": "get prover task by task id", + "consumes": [ + "text/plain" + ], + "produces": [ + "text/plain" + ], + "tags": [ + "prover_task" + ], + "summary": "give the specific prover task", + "parameters": [ + { + "type": "string", + "description": "prover task hash", + "name": "task_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Bearer license", + "name": "Authorization", + "in": "header" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/types.ProverTaskSchema" + } + } + } + } + }, + "/api/prover_task/v1/tasks": { + "get": { + "description": "get all the prover task by prover public key", + "consumes": [ + "text/plain" + ], + "produces": [ + "text/plain" + ], + "tags": [ + "prover_task" + ], + "summary": "get all the prover task by prover public key", + "parameters": [ + { + "type": "string", + "description": "prover public key", + "name": "pubkey", + "in": "query", + "required": true + }, + { + "type": "integer", + "description": "page", + "name": "page", + "in": "query", + "required": true + }, + { + "type": "integer", + "description": "page_size", + "name": "page_size", + "in": "query", + "required": true + }, + { + "type": "string", + "description": "Bearer license", + "name": "Authorization", + "in": "header" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/types.ProverTaskSchema" + } + } + } + } + } + }, + "/api/prover_task/v1/total_rewards": { + "get": { + "description": "get uint64 by prover public key", + "consumes": [ + "text/plain" + ], + "produces": [ + "text/plain" + ], + "tags": [ + "prover_task" + ], + "summary": "give the total rewards of a prover", + "parameters": [ + { + "type": "string", + "description": "prover public key", + "name": "pubkey", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Bearer license", + "name": "Authorization", + "in": "header" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/types.ProverTotalRewardsSchema" + } + } + } + } + } + }, + "definitions": { + "types.LoginSchema": { + "type": "object", + "properties": { + "time": { + "type": "string" + }, + "token": { + "type": "string" + } + } + }, + "types.ProverTaskSchema": { + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "failure_type": { + "type": "string" + }, + "prover_name": { + "type": "string" + }, + "proving_status": { + "type": "string" + }, + "reward": { + "type": "string" + }, + "task_id": { + "type": "string" + }, + "task_type": { + "type": "string" + } + } + }, + "types.ProverTotalRewardsSchema": { + "type": "object", + "properties": { + "rewards": { + "type": "string" + } + } + } + }, + "securityDefinitions": { + "BasicAuth": { + "type": "basic" + } + } +}` + +// SwaggerInfo holds exported Swagger Info so clients can modify it +var SwaggerInfo = &swag.Spec{ + Version: "1.0", + Host: "localhost:8990", + BasePath: "/api/v1", + Schemes: []string{}, + Title: "Zero-knowledge Prover Stats API", + Description: "This is an API server for Provers.", + InfoInstanceName: "swagger", + SwaggerTemplate: docTemplate, + LeftDelim: "{{", + RightDelim: "}}", +} + +func init() { + swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) +} diff --git a/prover-stats-api/docs/swagger.json b/prover-stats-api/docs/swagger.json new file mode 100644 index 000000000..fbfa1a83d --- /dev/null +++ b/prover-stats-api/docs/swagger.json @@ -0,0 +1,238 @@ +{ + "swagger": "2.0", + "info": { + "description": "This is an API server for Provers.", + "title": "Zero-knowledge Prover Stats API", + "contact": { + "name": "Prover Stats API Support", + "email": "Be Pending" + }, + "license": { + "name": "Apache 2.0", + "url": "http://www.apache.org/licenses/LICENSE-2.0.html" + }, + "version": "1.0" + }, + "host": "localhost:8990", + "basePath": "/api/v1", + "paths": { + "/api/prover_task/v1/request_token": { + "get": { + "description": "login with prover public key", + "consumes": [ + "text/plain" + ], + "produces": [ + "text/plain" + ], + "tags": [ + "prover_task" + ], + "summary": "login with prover public key", + "parameters": [ + { + "type": "string", + "description": "prover public key", + "name": "pubkey", + "in": "query", + "required": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/types.LoginSchema" + } + } + } + } + } + }, + "/api/prover_task/v1/task": { + "get": { + "description": "get prover task by task id", + "consumes": [ + "text/plain" + ], + "produces": [ + "text/plain" + ], + "tags": [ + "prover_task" + ], + "summary": "give the specific prover task", + "parameters": [ + { + "type": "string", + "description": "prover task hash", + "name": "task_id", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Bearer license", + "name": "Authorization", + "in": "header" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/types.ProverTaskSchema" + } + } + } + } + }, + "/api/prover_task/v1/tasks": { + "get": { + "description": "get all the prover task by prover public key", + "consumes": [ + "text/plain" + ], + "produces": [ + "text/plain" + ], + "tags": [ + "prover_task" + ], + "summary": "get all the prover task by prover public key", + "parameters": [ + { + "type": "string", + "description": "prover public key", + "name": "pubkey", + "in": "query", + "required": true + }, + { + "type": "integer", + "description": "page", + "name": "page", + "in": "query", + "required": true + }, + { + "type": "integer", + "description": "page_size", + "name": "page_size", + "in": "query", + "required": true + }, + { + "type": "string", + "description": "Bearer license", + "name": "Authorization", + "in": "header" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/types.ProverTaskSchema" + } + } + } + } + } + }, + "/api/prover_task/v1/total_rewards": { + "get": { + "description": "get uint64 by prover public key", + "consumes": [ + "text/plain" + ], + "produces": [ + "text/plain" + ], + "tags": [ + "prover_task" + ], + "summary": "give the total rewards of a prover", + "parameters": [ + { + "type": "string", + "description": "prover public key", + "name": "pubkey", + "in": "path", + "required": true + }, + { + "type": "string", + "description": "Bearer license", + "name": "Authorization", + "in": "header" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/types.ProverTotalRewardsSchema" + } + } + } + } + } + }, + "definitions": { + "types.LoginSchema": { + "type": "object", + "properties": { + "time": { + "type": "string" + }, + "token": { + "type": "string" + } + } + }, + "types.ProverTaskSchema": { + "type": "object", + "properties": { + "created_at": { + "type": "string" + }, + "failure_type": { + "type": "string" + }, + "prover_name": { + "type": "string" + }, + "proving_status": { + "type": "string" + }, + "reward": { + "type": "string" + }, + "task_id": { + "type": "string" + }, + "task_type": { + "type": "string" + } + } + }, + "types.ProverTotalRewardsSchema": { + "type": "object", + "properties": { + "rewards": { + "type": "string" + } + } + } + }, + "securityDefinitions": { + "BasicAuth": { + "type": "basic" + } + } +} \ No newline at end of file diff --git a/prover-stats-api/docs/swagger.yaml b/prover-stats-api/docs/swagger.yaml new file mode 100644 index 000000000..0d083f5e3 --- /dev/null +++ b/prover-stats-api/docs/swagger.yaml @@ -0,0 +1,157 @@ +basePath: /api/v1 +definitions: + types.LoginSchema: + properties: + time: + type: string + token: + type: string + type: object + types.ProverTaskSchema: + properties: + created_at: + type: string + failure_type: + type: string + prover_name: + type: string + proving_status: + type: string + reward: + type: string + task_id: + type: string + task_type: + type: string + type: object + types.ProverTotalRewardsSchema: + properties: + rewards: + type: string + type: object +host: localhost:8990 +info: + contact: + email: Be Pending + name: Prover Stats API Support + description: This is an API server for Provers. + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0.html + title: Zero-knowledge Prover Stats API + version: "1.0" +paths: + /api/prover_task/v1/request_token: + get: + consumes: + - text/plain + description: login with prover public key + parameters: + - description: prover public key + in: query + name: pubkey + required: true + type: string + produces: + - text/plain + responses: + "200": + description: OK + schema: + items: + $ref: '#/definitions/types.LoginSchema' + type: array + summary: login with prover public key + tags: + - prover_task + /api/prover_task/v1/task: + get: + consumes: + - text/plain + description: get prover task by task id + parameters: + - description: prover task hash + in: path + name: task_id + required: true + type: string + - description: Bearer license + in: header + name: Authorization + type: string + produces: + - text/plain + responses: + "200": + description: OK + schema: + $ref: '#/definitions/types.ProverTaskSchema' + summary: give the specific prover task + tags: + - prover_task + /api/prover_task/v1/tasks: + get: + consumes: + - text/plain + description: get all the prover task by prover public key + parameters: + - description: prover public key + in: query + name: pubkey + required: true + type: string + - description: page + in: query + name: page + required: true + type: integer + - description: page_size + in: query + name: page_size + required: true + type: integer + - description: Bearer license + in: header + name: Authorization + type: string + produces: + - text/plain + responses: + "200": + description: OK + schema: + items: + $ref: '#/definitions/types.ProverTaskSchema' + type: array + summary: get all the prover task by prover public key + tags: + - prover_task + /api/prover_task/v1/total_rewards: + get: + consumes: + - text/plain + description: get uint64 by prover public key + parameters: + - description: prover public key + in: path + name: pubkey + required: true + type: string + - description: Bearer license + in: header + name: Authorization + type: string + produces: + - text/plain + responses: + "200": + description: OK + schema: + $ref: '#/definitions/types.ProverTotalRewardsSchema' + summary: give the total rewards of a prover + tags: + - prover_task +securityDefinitions: + BasicAuth: + type: basic +swagger: "2.0" diff --git a/prover-stats-api/go.mod b/prover-stats-api/go.mod index a90fddd2d..ad36b003d 100644 --- a/prover-stats-api/go.mod +++ b/prover-stats-api/go.mod @@ -3,6 +3,7 @@ module scroll-tech/prover-stats-api go 1.19 require ( + github.com/appleboy/gin-jwt/v2 v2.9.1 github.com/gin-gonic/gin v1.9.1 github.com/stretchr/testify v1.8.3 gorm.io/gorm v1.25.2 @@ -11,6 +12,7 @@ require ( require ( github.com/davecgh/go-spew v1.1.1 // indirect github.com/go-stack/stack v1.8.0 // indirect + github.com/golang-jwt/jwt/v4 v4.4.3 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect ) @@ -19,7 +21,6 @@ require ( github.com/bytedance/sonic v1.9.2 // indirect github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311 // indirect github.com/cpuguy83/go-md2man/v2 v2.0.2 // indirect - github.com/dgrijalva/jwt-go v3.2.0+incompatible github.com/gabriel-vasile/mimetype v1.4.2 // indirect github.com/gin-contrib/sse v0.1.0 // indirect github.com/go-openapi/jsonpointer v0.19.6 // indirect diff --git a/prover-stats-api/go.sum b/prover-stats-api/go.sum index f1f50c2d4..544a0b9c2 100644 --- a/prover-stats-api/go.sum +++ b/prover-stats-api/go.sum @@ -1,5 +1,9 @@ github.com/KyleBanks/depth v1.2.1 h1:5h8fQADFrWtarTdtDudMmGsC7GPbOAu6RVB3ffsVFHc= github.com/KyleBanks/depth v1.2.1/go.mod h1:jzSb9d0L43HxTQfT+oSA1EEp2q+ne2uh6XgeJcm8brE= +github.com/appleboy/gin-jwt/v2 v2.9.1 h1:l29et8iLW6omcHltsOP6LLk4s3v4g2FbFs0koxGWVZs= +github.com/appleboy/gin-jwt/v2 v2.9.1/go.mod h1:jwcPZJ92uoC9nOUTOKWoN/f6JZOgMSKlFSHw5/FrRUk= +github.com/appleboy/gofight/v2 v2.1.2 h1:VOy3jow4vIK8BRQJoC/I9muxyYlJ2yb9ht2hZoS3rf4= +github.com/appleboy/gofight/v2 v2.1.2/go.mod h1:frW+U1QZEdDgixycTj4CygQ48yLTUhplt43+Wczp3rw= github.com/bytedance/sonic v1.5.0/go.mod h1:ED5hyg4y6t3/9Ku1R6dU/4KyJ48DZ4jPhfY1O2AihPM= github.com/bytedance/sonic v1.9.2 h1:GDaNjuWSGu09guE9Oql0MSTNhNCLlWwO8y/xM5BzcbM= github.com/bytedance/sonic v1.9.2/go.mod h1:i736AoUSYt75HyZLoJW9ERYxcy6eaN6h4BZXU064P/U= @@ -12,13 +16,12 @@ github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ3 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= -github.com/dgrijalva/jwt-go v3.2.0+incompatible h1:7qlOGliEKZXTDg6OTjfoBKDXWrumCAMpl/TFQ4/5kLM= -github.com/dgrijalva/jwt-go v3.2.0+incompatible/go.mod h1:E3ru+11k8xSBh+hMPgOLZmtrrCbhqsmaPHjLKYnJCaQ= github.com/gabriel-vasile/mimetype v1.4.2 h1:w5qFW6JKBz9Y393Y4q372O9A7cUSequkh1Q7OhCmWKU= github.com/gabriel-vasile/mimetype v1.4.2/go.mod h1:zApsH/mKG4w07erKIaJPFiX0Tsq9BFQgN3qGY5GnNgA= github.com/gin-contrib/gzip v0.0.6 h1:NjcunTcGAj5CO1gn4N8jHOSIeRFHIbn51z6K+xaN4d4= github.com/gin-contrib/sse v0.1.0 h1:Y/yl/+YNO8GZSjAhjMsSuLt29uWRFHdHYUb5lYOV9qE= github.com/gin-contrib/sse v0.1.0/go.mod h1:RHrZQHXnP2xjPF+u1gW/2HnVO7nvIa9PG3Gm+fLHvGI= +github.com/gin-gonic/gin v1.8.1/go.mod h1:ji8BvRH1azfM+SYow9zQ6SZMvR8qOMZHmsCuWR9tTTk= github.com/gin-gonic/gin v1.9.1 h1:4idEAncQnU5cB7BeOkPtxjfCSye0AAm1R0RVIqJ+Jmg= github.com/gin-gonic/gin v1.9.1/go.mod h1:hPrL7YrpYKXt5YId3A/Tnip5kqbEAP+KLuI3SUcPTeU= github.com/go-openapi/jsonpointer v0.19.3/go.mod h1:Pl9vOtqEWErmShwVjC8pYs9cog34VGT37dQOVbmoatg= @@ -35,17 +38,26 @@ github.com/go-openapi/swag v0.19.15/go.mod h1:QYRuS/SOXUCsnplDa677K7+DxSOj6IPNl/ github.com/go-openapi/swag v0.22.3/go.mod h1:UzaqsxGiab7freDnrUUra0MwWfN/q7tE4j+VcZ0yl14= github.com/go-openapi/swag v0.22.4 h1:QLMzNJnMGPRNDCbySlcj1x01tzU8/9LTTL9hZZZogBU= github.com/go-openapi/swag v0.22.4/go.mod h1:UzaqsxGiab7freDnrUUra0MwWfN/q7tE4j+VcZ0yl14= +github.com/go-playground/assert/v2 v2.0.1/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4= github.com/go-playground/assert/v2 v2.2.0 h1:JvknZsQTYeFEAhQwI4qEt9cyV5ONwRHC+lYKSsYSR8s= +github.com/go-playground/locales v0.14.0/go.mod h1:sawfccIbzZTqEDETgFXqTho0QybSa7l++s0DH+LDiLs= github.com/go-playground/locales v0.14.1 h1:EWaQ/wswjilfKLTECiXz7Rh+3BjFhfDFKv/oXslEjJA= github.com/go-playground/locales v0.14.1/go.mod h1:hxrqLVvrK65+Rwrd5Fc6F2O76J/NuW9t0sjnWqG1slY= +github.com/go-playground/universal-translator v0.18.0/go.mod h1:UvRDBj+xPUEGrFYl+lu/H90nyDXpg0fqeB/AQUGNTVA= github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJnYK9S473LQFuzCbDbfSFY= github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY= +github.com/go-playground/validator/v10 v10.10.0/go.mod h1:74x4gJWsvQexRdW8Pn3dXSGrTK4nAUsbPlLADvpJkos= +github.com/go-playground/validator/v10 v10.11.1/go.mod h1:i+3WkQ1FvaUjjxh1kSvIA4dMGDBiPU55YFDl0WbKdWU= github.com/go-playground/validator/v10 v10.14.1 h1:9c50NUPC30zyuKprjL3vNZ0m5oG+jU0zvx4AqHGnv4k= github.com/go-playground/validator/v10 v10.14.1/go.mod h1:9iXMNT7sEkjXb0I+enO7QXmzG6QCsPWY4zveKFVRSyU= github.com/go-stack/stack v1.8.0 h1:5SgMzNM5HxrEjV0ww2lTmX6E2Izsfxas4+YHWRs3Lsk= github.com/go-stack/stack v1.8.0/go.mod h1:v0f6uXyyMGvRgIKkXu+yp6POWl0qKG85gN/melR3HDY= +github.com/goccy/go-json v0.9.7/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I= +github.com/goccy/go-json v0.10.0/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I= github.com/goccy/go-json v0.10.2 h1:CrxCmQqYDkv1z7lO7Wbh2HN93uovUHgrECaO5ZrCXAU= github.com/goccy/go-json v0.10.2/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I= +github.com/golang-jwt/jwt/v4 v4.4.3 h1:Hxl6lhQFj4AnOX6MLrsCb/+7tCj7DxP7VA+2rDIq5AU= +github.com/golang-jwt/jwt/v4 v4.4.3/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0= github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU= github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= @@ -62,12 +74,14 @@ github.com/klauspost/cpuid/v2 v2.0.9/go.mod h1:FInQzS24/EEf25PyTYn52gqo7WaD8xa02 github.com/klauspost/cpuid/v2 v2.2.5 h1:0E5MSMDEoAulmXNFquVs//DdoomxaoTY1kUhbc/qbZg= github.com/klauspost/cpuid/v2 v2.2.5/go.mod h1:Lcz8mBdAVJIBVzewtcLocK12l3Y+JytZYpaMropDUws= github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= -github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI= github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= +github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0= +github.com/kr/pretty v0.3.0/go.mod h1:640gp4NfQd8pI5XOwp5fnNeVWj67G7CFk/SaSQn7NBk= github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= +github.com/leodido/go-urn v1.2.1/go.mod h1:zt4jvISO2HfUBqxjfIshjdMTYS56ZS/qv49ictyFfxY= github.com/leodido/go-urn v1.2.4 h1:XlAE/cm/ms7TE/VMVoduSpNBoyc2dOxHs5MZSwAN63Q= github.com/leodido/go-urn v1.2.4/go.mod h1:7ZrI8mTSeBSHl/UaRyKQW1qZeMgak41ANeCNaVckg+4= github.com/mailru/easyjson v0.0.0-20190614124828-94de47d64c63/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc= @@ -75,6 +89,8 @@ github.com/mailru/easyjson v0.0.0-20190626092158-b2ccc519800e/go.mod h1:C1wdFJiN github.com/mailru/easyjson v0.7.6/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc= github.com/mailru/easyjson v0.7.7 h1:UGYAvKxe3sBsEDzO8ZeWOSlIQfWFlxbzLZe7hwFURr0= github.com/mailru/easyjson v0.7.7/go.mod h1:xzfreul335JAWq5oZzymOObrkdz5UnU4kGfJJLY9Nlc= +github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= +github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA= github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q= @@ -83,10 +99,16 @@ github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJ github.com/modern-go/reflect2 v1.0.2 h1:xBagoLtFs94CBntxluKeaWgTMpvLxC4ur3nMaC9Gz0M= github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk= github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno= +github.com/pelletier/go-toml/v2 v2.0.1/go.mod h1:r9LEWfGN8R5k0VXJ+0BkIe7MYkRdwZOjgMj2KwnJFUo= +github.com/pelletier/go-toml/v2 v2.0.6/go.mod h1:eumQOmlWiOPt5WriQQqoM5y18pDHwha2N+QD+EUNTek= github.com/pelletier/go-toml/v2 v2.0.8 h1:0ctb6s9mE31h0/lhu+J6OPmVeDxJn+kYnJc2jZR9tGQ= github.com/pelletier/go-toml/v2 v2.0.8/go.mod h1:vuYfssBdrU2XDZ9bYydBu6t+6a6PYNcZljzZR9VXg+4= +github.com/pkg/diff v0.0.0-20210226163009-20ebb0f2a09e/go.mod h1:pJLUxLENpZxwdsKMEsNbx1VGcRFpLqf3715MtcvvzbA= github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/rogpeppe/go-internal v1.6.1/go.mod h1:xXDCJY+GAPziupqXw64V24skbSoqbTEfhy4qGm1nDQc= +github.com/rogpeppe/go-internal v1.8.0 h1:FCbCCtXNOY3UtUuHUYaghJg4y7Fd14rXifAYUAtL9R8= +github.com/rogpeppe/go-internal v1.8.0/go.mod h1:WmiCO8CzOY8rg0OYDC4/i/2WRWAB6poM+XZ2dLUbcbE= github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/scroll-tech/go-ethereum v1.10.14-0.20230613025759-f055f50f9d56 h1:Cqj7haxwvzI2O4n9ZZ25helShzFGCy7Z/B+FFSBFHNI= @@ -111,8 +133,16 @@ github.com/swaggo/gin-swagger v1.6.0 h1:y8sxvQ3E20/RCyrXeFfg60r6H0Z+SwpTjMYsMm+z github.com/swaggo/gin-swagger v1.6.0/go.mod h1:BG00cCEy294xtVpyIAHG6+e2Qzj/xKlRdOqDkvq0uzo= github.com/swaggo/swag v1.16.1 h1:fTNRhKstPKxcnoKsytm4sahr8FaYzUcT7i1/3nd/fBg= github.com/swaggo/swag v1.16.1/go.mod h1:9/LMvHycG3NFHfR6LwvikHv5iFvmPADQ359cKikGxto= +github.com/tidwall/gjson v1.14.3 h1:9jvXn7olKEHU1S9vwoMGliaT8jq1vJ7IH/n9zD9Dnlw= +github.com/tidwall/gjson v1.14.3/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk= +github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA= +github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM= +github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs= +github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU= github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS4MhqMhdFk5YI= github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08= +github.com/ugorji/go v1.2.7/go.mod h1:nF9osbDWLy6bDVv/Rtoh6QgnvNDpmCalQV5urGCCS6M= +github.com/ugorji/go/codec v1.2.7/go.mod h1:WGN1fab3R1fzQlVQTkfxVtIBhWDRqOviHU95kRgeqEY= github.com/ugorji/go/codec v1.2.11 h1:BMaWp1Bb6fHwEtbplGBGJ498wD+LKlNSl25MjdZY4dU= github.com/ugorji/go/codec v1.2.11/go.mod h1:UNopzCgEMSXjBc6AOMqYvWC1ktqTAfzJZUZgYf6w6lg= github.com/urfave/cli/v2 v2.25.7 h1:VAzn5oq403l5pHjc4OhD54+XGO9cdKVL/7lDjF+iKUs= @@ -124,14 +154,20 @@ golang.org/x/arch v0.0.0-20210923205945-b76863e36670/go.mod h1:5om86z9Hs0C8fWVUu golang.org/x/arch v0.4.0 h1:A8WCeEWhLwPBKNbFi5Wv5UTCBx5zzubnXDlMOFAzFMc= golang.org/x/arch v0.4.0/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20210711020723-a769d52b0f97/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.0.0-20211215153901-e495a2d5b3d3/go.mod h1:IxCIyHEi3zRg3s0A5j5BB6A9Jmi73HwBIUl50j+osU4= +golang.org/x/crypto v0.4.0/go.mod h1:3quD/ATkf6oY+rnes5c3ExXTbLc8mueNue5/DoinL80= golang.org/x/crypto v0.11.0 h1:6Ewdq3tDic1mg5xRO4milcWCfMVQhI4NkqWWvqejpuA= golang.org/x/crypto v0.11.0/go.mod h1:xgJhtzW8F9jGdVFWZESrid1U1bjeNy4zgy5cRr/CIio= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= golang.org/x/mod v0.12.0 h1:rmsUpXtvNzj340zd98LZ4KntptpfRHwpFOHG188oHXc= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= +golang.org/x/net v0.3.0/go.mod h1:MBQ8lrhLObU/6UmLb4fmbmk5OcyYmqtbGd/9yIeKjEE= +golang.org/x/net v0.4.0/go.mod h1:MBQ8lrhLObU/6UmLb4fmbmk5OcyYmqtbGd/9yIeKjEE= golang.org/x/net v0.7.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= golang.org/x/net v0.12.0 h1:cfawfvKITfUsFCeJIHJrbSxpeu/E81khclypR0GVT50= golang.org/x/net v0.12.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA= @@ -139,19 +175,27 @@ golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJ golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210806184541-e5e7981a1069/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.3.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.10.0 h1:SqMFp9UcQJZa+pmYuAKjd9xq1f0j5rLcDIk0mj4qAsA= golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.3.0/go.mod h1:q750SLmJuPmVoN1blW3UFBPREJfb1KmY3vwxfr+nFDA= golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.5.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= golang.org/x/text v0.11.0 h1:LAntKIrcmeSKERyiOh0XMV39LXS8IE9UL2yP7+f5ij4= golang.org/x/text v0.11.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= @@ -164,6 +208,8 @@ golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8T golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= +google.golang.org/protobuf v1.28.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I= +google.golang.org/protobuf v1.28.1/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I= google.golang.org/protobuf v1.31.0 h1:g0LDEJHgrBl9N9r17Ru3sqWhkIx2NB67okBHPwC7hs8= google.golang.org/protobuf v1.31.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= @@ -171,11 +217,13 @@ gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8 gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= +gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.0-20200615113413-eeeca48fe776/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= +gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gorm.io/gorm v1.25.2 h1:gs1o6Vsa+oVKG/a9ElL3XgyGfghFfkKA2SInQaCyMho= diff --git a/prover-stats-api/internal/config/config.go b/prover-stats-api/internal/config/config.go index 00bf45390..3bae47c3c 100644 --- a/prover-stats-api/internal/config/config.go +++ b/prover-stats-api/internal/config/config.go @@ -8,8 +8,13 @@ import ( ) type Config struct { - DBConfig *database.Config `json:"db_config"` - ApiSecret string `json:"api_secret"` + DBConfig *database.Config `json:"db_config"` + Auth Auth `json:"auth"` +} + +type Auth struct { + Secret string `json:"secret"` + TokenExpireDuration int `json:"token_expire_duration"` // unit: seconds } // NewConfig returns a new instance of Config. diff --git a/prover-stats-api/internal/controller/auth.go b/prover-stats-api/internal/controller/auth.go new file mode 100644 index 000000000..994894aa6 --- /dev/null +++ b/prover-stats-api/internal/controller/auth.go @@ -0,0 +1,54 @@ +package controller + +import ( + "errors" + "fmt" + "time" + + "github.com/gin-gonic/gin" + + "scroll-tech/prover-stats-api/internal/types" +) + +type AuthController struct { +} + +func NewAuthController() *AuthController { + return &AuthController{} +} + +// Login godoc +// @Summary login with prover public key +// @Description login with prover public key +// @Tags prover_task +// @Accept plain +// @Produce plain +// @Param pubkey query string true "prover public key" +// @Success 200 {array} types.LoginSchema +// @Router /api/prover_task/v1/request_token [get] +func (a *AuthController) Login(c *gin.Context) (interface{}, error) { + var login types.LoginParameter + if err := c.ShouldBindQuery(&login); err != nil { + return "", fmt.Errorf("missing the public_key, err:%w", err) + } + + // TODO check public key is exist + + if a.checkValidPublicKey() { + return types.LoginParameter{PublicKey: login.PublicKey}, nil + } + + return nil, errors.New("incorrect public_key") +} + +func (a *AuthController) checkValidPublicKey() bool { + return true +} + +func (a *AuthController) LoginResponse(c *gin.Context, code int, message string, time time.Time) { + resp := types.LoginSchema{ + Time: time, + Token: message, + } + types.RenderJson(c, code, nil, resp) +} diff --git a/prover-stats-api/internal/controller/controller.go b/prover-stats-api/internal/controller/controller.go index 61f5d699a..f74b25458 100644 --- a/prover-stats-api/internal/controller/controller.go +++ b/prover-stats-api/internal/controller/controller.go @@ -1,121 +1,11 @@ package controller -import ( - "encoding/json" - "net/http" +import "gorm.io/gorm" - "scroll-tech/prover-stats-api/internal/middleware" - - "scroll-tech/prover-stats-api/internal/logic" - - "github.com/gin-gonic/gin" +var ( + ProverTask *ProverTaskController ) -type ProverTaskController struct { - router *gin.RouterGroup - logic *logic.ProverTaskLogic -} - -func NewProverTaskController(r *gin.RouterGroup, taskLogic *logic.ProverTaskLogic) *ProverTaskController { - router := r.Group("/prover_task") - return &ProverTaskController{ - router: router, - logic: taskLogic, - } -} - -func (c *ProverTaskController) Route() { - c.router.GET("/request_token", c.RequestToken) - c.router.GET("/tasks", c.GetTasksByProver) - c.router.GET("/total_rewards", c.GetTotalRewards) - c.router.GET("/task", c.GetTask) -} - -// RequestToken godoc -// @Summary request token -// @Description generate token for the client -// @Tags prover_task -// @Produce json -// @Success 200 {object} string -// @Failure 401 {object} string -// @Router /prover_task/request_token [get] -func (c *ProverTaskController) RequestToken(ctx *gin.Context) { - token, err := middleware.GenToken() - if err != nil { - ctx.JSON(http.StatusOK, Err(err)) - return - } - ctx.JSON(http.StatusOK, Ok([]byte(token))) -} - -// GetTasksByProver godoc -// @Summary give the proverTasks -// @Description get []*ProverTask by prover public key -// @Tags prover_task -// @Accept string -// @Produce json -// @Param pubkey path string true "prover public key" -// @Success 200 {object} []*orm.ProverTask -// @Failure 404 {object} string -// @Failure 500 {object} string -// @Router /prover_task/tasks/{pubkey} [get] -func (c *ProverTaskController) GetTasksByProver(ctx *gin.Context) { - pubkey := ctx.Query("pubkey") - tasks, err := c.logic.GetTasksByProver(pubkey) - if err != nil { - ctx.JSON(http.StatusOK, Err(err)) - return - } - byt, err := json.Marshal(tasks) - if err != nil { - ctx.JSON(http.StatusOK, Err(err)) - return - } - ctx.JSON(http.StatusOK, Ok(byt)) -} - -// GetTotalRewards godoc -// @Summary give the total rewards of a prover -// @Description get uint64 by prover public key -// @Tags prover_task -// @Accept string -// @Produce json -// @Param pubkey path string true "prover public key" -// @Success 200 {object} map[string]*big.Int -// @Failure 404 {object} string -// @Failure 500 {object} string -// @Router /prover_task/total_rewards/{pubkey} [get] -func (c *ProverTaskController) GetTotalRewards(ctx *gin.Context) { - pubkey := ctx.Query("pubkey") - rewards, err := c.logic.GetTotalRewards(pubkey) - if err != nil { - ctx.JSON(http.StatusOK, Err(err)) - return - } - ctx.JSON(http.StatusOK, Ok(rewards.Bytes())) -} - -// GetTask godoc -// @Summary give the specific prover task -// @Description get prover task by task id -// @Tags prover_task -// @Accept string -// @Produce json -// @Param task_id path string true "prover task hash" -// @Success 200 {object} *orm.ProverTask -// @Failure 500 {object} string -// @Router /prover_task/task/{task_id} [get] -func (c *ProverTaskController) GetTask(ctx *gin.Context) { - taskID := ctx.Query("task_id") - task, err := c.logic.GetTask(taskID) - if err != nil { - ctx.JSON(http.StatusOK, Err(err)) - return - } - byt, err := json.Marshal(task) - if err != nil { - ctx.JSON(http.StatusOK, Err(err)) - return - } - ctx.JSON(http.StatusOK, Ok(byt)) +func InitController(db *gorm.DB) { + ProverTask = NewProverTaskController(db) } diff --git a/prover-stats-api/internal/controller/prover_task.go b/prover-stats-api/internal/controller/prover_task.go new file mode 100644 index 000000000..95b623ef1 --- /dev/null +++ b/prover-stats-api/internal/controller/prover_task.go @@ -0,0 +1,127 @@ +package controller + +import ( + "fmt" + + "github.com/gin-gonic/gin" + "gorm.io/gorm" + + ctype "scroll-tech/common/types" + "scroll-tech/common/types/message" + + "scroll-tech/prover-stats-api/internal/logic" + "scroll-tech/prover-stats-api/internal/types" +) + +type ProverTaskController struct { + logic *logic.ProverTaskLogic +} + +func NewProverTaskController(db *gorm.DB) *ProverTaskController { + return &ProverTaskController{ + logic: logic.NewProverTaskLogic(db), + } +} + +// ProverTasks godoc +// @Summary get all the prover task by prover public key +// @Description get all the prover task by prover public key +// @Tags prover_task +// @Accept plain +// @Produce plain +// @Param pubkey query string true "prover public key" +// @Param page query int true "page" +// @Param page_size query int true "page_size" +// @Param Authorization header string false "Bearer license" +// @Success 200 {array} types.ProverTaskSchema +// @Router /api/prover_task/v1/tasks [get] +func (c *ProverTaskController) ProverTasks(ctx *gin.Context) { + var pp types.ProverTasksPaginationParameter + if err := ctx.ShouldBind(&pp); err != nil { + nerr := fmt.Errorf("parameter invalid, err:%w", err) + types.RenderJson(ctx, types.ErrParameterInvalidNo, nerr, nil) + return + } + + tasks, err := c.logic.GetTasksByProver(ctx, pp.PublicKey, pp.Page, pp.PageSize) + if err != nil { + nerr := fmt.Errorf("controller.ProverTasks err:%w", err) + types.RenderJson(ctx, types.ErrProverTaskFailure, nerr, nil) + return + } + + var proverTaskSchemas []types.ProverTaskSchema + for _, task := range tasks { + proverTaskSchema := types.ProverTaskSchema{ + TaskID: task.TaskID, + ProverName: task.ProverName, + TaskType: message.ProofType(task.TaskType).String(), + ProvingStatus: ctype.ProvingStatus(task.ProvingStatus).String(), + Reward: task.Reward.String(), + CreatedAt: task.CreatedAt, + } + proverTaskSchemas = append(proverTaskSchemas, proverTaskSchema) + } + + types.RenderJson(ctx, 0, nil, proverTaskSchemas) +} + +// GetTotalRewards godoc +// @Summary give the total rewards of a prover +// @Description get uint64 by prover public key +// @Tags prover_task +// @Accept plain +// @Produce plain +// @Param pubkey path string true "prover public key" +// @Param Authorization header string false "Bearer license" +// @Success 200 {object} types.ProverTotalRewardsSchema +// @Router /api/prover_task/v1/total_rewards [get] +func (c *ProverTaskController) GetTotalRewards(ctx *gin.Context) { + var pp types.ProverTotalRewardsParameter + if err := ctx.ShouldBind(&pp); err != nil { + nerr := fmt.Errorf("parameter invalid, err:%w", err) + types.RenderJson(ctx, types.ErrParameterInvalidNo, nerr, nil) + return + } + + rewards, err := c.logic.GetTotalRewards(ctx, pp.PublicKey) + if err != nil { + nerr := fmt.Errorf("controller.GetTotalRewards, err:%w", err) + types.RenderJson(ctx, types.ErrProverTotalRewardFailure, nerr, nil) + return + } + + resp := types.ProverTotalRewardsSchema{ + Rewards: rewards.String(), + } + + types.RenderJson(ctx, 0, nil, resp) +} + +// GetTask godoc +// @Summary give the specific prover task +// @Description get prover task by task id +// @Tags prover_task +// @Accept plain +// @Produce plain +// @Param task_id path string true "prover task hash" +// @Param Authorization header string false "Bearer license" +// @Success 200 {object} types.ProverTaskSchema +// @Router /api/prover_task/v1/task [get] +func (c *ProverTaskController) GetTask(ctx *gin.Context) { + var pp types.ProverTaskParameter + if err := ctx.ShouldBind(&pp); err != nil { + nerr := fmt.Errorf("parameter invalid, err:%w", err) + types.RenderJson(ctx, types.ErrParameterInvalidNo, nerr, nil) + return + } + + task, err := c.logic.GetTask(ctx, pp.TaskID) + if err != nil { + nerr := fmt.Errorf("controller.GetTask, err:%w", err) + types.RenderJson(ctx, types.ErrProverTotalRewardFailure, nerr, nil) + return + } + + types.RenderJson(ctx, 0, nil, task) +} diff --git a/prover-stats-api/internal/controller/route.go b/prover-stats-api/internal/controller/route.go deleted file mode 100644 index 2bb8d65bc..000000000 --- a/prover-stats-api/internal/controller/route.go +++ /dev/null @@ -1,29 +0,0 @@ -package controller - -import ( - "github.com/gin-gonic/gin" - swaggerfiles "github.com/swaggo/files" - ginSwagger "github.com/swaggo/gin-swagger" - "gorm.io/gorm" - - "scroll-tech/prover-stats-api/internal/config" - "scroll-tech/prover-stats-api/internal/logic" - "scroll-tech/prover-stats-api/internal/middleware" -) - -func Route(db *gorm.DB, port string, cfg *config.Config) { - taskService := logic.NewProverTaskLogic(db) - - r := gin.Default() - middleware.Secret = cfg.ApiSecret - r.Use(middleware.JWTAuthMiddleware()) - r.GET("swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler)) - router := r.Group("/api/v1") - - c := NewProverTaskController(router, taskService) - c.Route() - - go func() { - r.Run(port) - }() -} diff --git a/prover-stats-api/internal/controller/types.go b/prover-stats-api/internal/controller/types.go deleted file mode 100644 index 297546c64..000000000 --- a/prover-stats-api/internal/controller/types.go +++ /dev/null @@ -1,26 +0,0 @@ -package controller - -type Resp struct { - Code int `json:"code"` - Object []byte `json:"object"` - Error error `json:"error"` -} - -const ( - OK = 1000 - ERR = 1001 -) - -func Ok(obj []byte) *Resp { - return &Resp{ - Code: OK, - Object: obj, - } -} - -func Err(err error) *Resp { - return &Resp{ - Code: ERR, - Error: err, - } -} diff --git a/prover-stats-api/internal/logic/logic.go b/prover-stats-api/internal/logic/logic.go deleted file mode 100644 index d09807ded..000000000 --- a/prover-stats-api/internal/logic/logic.go +++ /dev/null @@ -1,45 +0,0 @@ -package logic - -import ( - "context" - "math/big" - - "gorm.io/gorm" - - "scroll-tech/prover-stats-api/internal/orm" -) - -type ProverTaskLogic struct { - db *orm.ProverTask -} - -func NewProverTaskLogic(db *gorm.DB) *ProverTaskLogic { - return &ProverTaskLogic{db: orm.NewProverTask(db)} -} - -func (p *ProverTaskLogic) GetTasksByProver(pubkey string) ([]*orm.ProverTask, error) { - return p.db.GetProverTasksByProver(context.Background(), pubkey) -} - -func (p *ProverTaskLogic) GetTotalRewards(pubkey string) (*big.Int, error) { - tasks, err := p.db.GetProverTasksByProver(context.Background(), pubkey) - if err != nil { - return nil, err - } - rewards := new(big.Int) - for _, task := range tasks { - rewards.Add(rewards, task.Reward.BigInt()) - } - return rewards, nil -} - -func (p *ProverTaskLogic) GetTask(taskID string) (*orm.ProverTask, error) { - tasks, err := p.db.GetProverTasksByHashes(context.Background(), []string{taskID}) - if err != nil { - return nil, err - } - if len(tasks) > 0 { - return tasks[0], nil - } - return nil, nil -} diff --git a/prover-stats-api/internal/logic/prover_task.go b/prover-stats-api/internal/logic/prover_task.go new file mode 100644 index 000000000..53a8b7c56 --- /dev/null +++ b/prover-stats-api/internal/logic/prover_task.go @@ -0,0 +1,42 @@ +package logic + +import ( + "context" + "math/big" + + "gorm.io/gorm" + + "scroll-tech/prover-stats-api/internal/orm" +) + +type ProverTaskLogic struct { + proverTaskOrm *orm.ProverTask +} + +func NewProverTaskLogic(db *gorm.DB) *ProverTaskLogic { + return &ProverTaskLogic{ + proverTaskOrm: orm.NewProverTask(db), + } +} + +func (p *ProverTaskLogic) GetTasksByProver(ctx context.Context, pubkey string, page, pageSize int) ([]*orm.ProverTask, error) { + offset := (page - 1) * pageSize + limit := pageSize + return p.proverTaskOrm.GetProverTasksByProver(ctx, pubkey, offset, limit) +} + +func (p *ProverTaskLogic) GetTotalRewards(ctx context.Context, pubkey string) (*big.Int, error) { + totalReward, err := p.proverTaskOrm.GetProverTotalReward(ctx, pubkey) + if err != nil { + return nil, err + } + return totalReward, nil +} + +func (p *ProverTaskLogic) GetTask(ctx context.Context, taskID string) (*orm.ProverTask, error) { + task, err := p.proverTaskOrm.GetProverTasksByHash(ctx, taskID) + if err != nil { + return nil, err + } + return task, nil +} diff --git a/prover-stats-api/internal/logic/logic_test.go b/prover-stats-api/internal/logic/prover_task_test.go similarity index 100% rename from prover-stats-api/internal/logic/logic_test.go rename to prover-stats-api/internal/logic/prover_task_test.go diff --git a/prover-stats-api/internal/middleware/jwt.go b/prover-stats-api/internal/middleware/jwt.go index aa13f2653..39a7b3fa0 100644 --- a/prover-stats-api/internal/middleware/jwt.go +++ b/prover-stats-api/internal/middleware/jwt.go @@ -2,67 +2,64 @@ package middleware import ( "errors" - "fmt" - "net/http" "time" - "github.com/dgrijalva/jwt-go" + jwt "github.com/appleboy/gin-jwt/v2" "github.com/gin-gonic/gin" + + "github.com/scroll-tech/go-ethereum/log" + "scroll-tech/prover-stats-api/internal/config" + "scroll-tech/prover-stats-api/internal/controller" + "scroll-tech/prover-stats-api/internal/types" ) -const TokenExpireDuration = time.Minute * 10 +const IdentityKey = "public_key" -var ( - Secret string - skipPaths = []string{"/api/v1/prover_task/request_token"} -) - -type ApiClaims struct { - jwt.StandardClaims -} - -func GenToken() (string, error) { - c := ApiClaims{ - jwt.StandardClaims{ - ExpiresAt: time.Now().Add(TokenExpireDuration).Unix(), - }, - } - token := jwt.NewWithClaims(jwt.SigningMethodHS256, c) - return token.SignedString([]byte(Secret)) -} - -func ParseToken(tokenStr string) (*ApiClaims, error) { - token, err := jwt.ParseWithClaims(tokenStr, &ApiClaims{}, func(token *jwt.Token) (interface{}, error) { - return []byte(Secret), nil +// AuthMiddleware jwt auth middleware +func AuthMiddleware(conf *config.Config) *jwt.GinJWTMiddleware { + authLogic := controller.NewAuthController() + jwtMiddleware, err := jwt.New(&jwt.GinJWTMiddleware{ + PayloadFunc: PayloadFunc, + IdentityHandler: IdentityHandler, + IdentityKey: IdentityKey, + Key: []byte(conf.Auth.Secret), + Timeout: time.Second * time.Duration(conf.Auth.TokenExpireDuration), + Authenticator: authLogic.Login, + Unauthorized: Unauthorized, + TokenLookup: "header: Authorization, query: token, cookie: jwt", + TokenHeadName: "Bearer", + TimeFunc: time.Now, + LoginResponse: authLogic.LoginResponse, }) + if err != nil { - return nil, err + log.Crit("new jwt middleware panic", "error", err) } - if claims, ok := token.Claims.(*ApiClaims); ok && token.Valid { - return claims, nil + + if errInit := jwtMiddleware.MiddlewareInit(); errInit != nil { + log.Crit("init jwt middleware panic", "error", errInit) } - return nil, errors.New("invalid token") + + return jwtMiddleware } -func JWTAuthMiddleware() gin.HandlerFunc { - return func(c *gin.Context) { - for _, path := range skipPaths { - if path == c.FullPath() { - c.Next() - return - } - } - tokenString := c.Request.Header.Get("Authorization") - if tokenString == "" { - c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "Null token"}) - return - } +func Unauthorized(c *gin.Context, code int, message string) { + err := errors.New(message) + types.RenderJson(c, code, err, nil) +} - _, err := ParseToken(tokenString) - if err != nil { - c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": fmt.Sprintf("Unauthorized: %v", err)}) - return +func PayloadFunc(data interface{}) jwt.MapClaims { + if v, ok := data.(types.LoginParameter); ok { + return jwt.MapClaims{ + IdentityKey: v.PublicKey, } - c.Next() + } + return jwt.MapClaims{} +} + +func IdentityHandler(c *gin.Context) interface{} { + claims := jwt.ExtractClaims(c) + return &types.LoginParameter{ + PublicKey: claims[IdentityKey].(string), } } diff --git a/prover-stats-api/internal/orm/prover_task.go b/prover-stats-api/internal/orm/prover_task.go index 18204472a..9df262d34 100644 --- a/prover-stats-api/internal/orm/prover_task.go +++ b/prover-stats-api/internal/orm/prover_task.go @@ -3,15 +3,11 @@ package orm import ( "context" "fmt" + "math/big" "time" - "gorm.io/gorm" - "gorm.io/gorm/clause" - "github.com/shopspring/decimal" - - "scroll-tech/common/types" - "scroll-tech/common/types/message" + "gorm.io/gorm" ) // ProverTask is assigned rollers info of chunk/batch proof prover task @@ -42,58 +38,45 @@ func (*ProverTask) TableName() string { return "prover_task" } -// GetProverTasksByHashes retrieves the ProverTask records associated with the specified hashes. -// The returned prover task objects are sorted in ascending order by their ids. -func (o *ProverTask) GetProverTasksByHashes(ctx context.Context, hashes []string) ([]*ProverTask, error) { - if len(hashes) == 0 { - return nil, nil - } - +// GetProverTasksByProver get all prover tasks by the given prover's public key. +func (o *ProverTask) GetProverTasksByProver(ctx context.Context, pubkey string, offset, limit int) ([]*ProverTask, error) { + var proverTasks []*ProverTask db := o.db.WithContext(ctx) db = db.Model(&ProverTask{}) - db = db.Where("task_id IN ?", hashes) - db = db.Order("id asc") - - var proverTasks []*ProverTask + db = db.Where("prover_public_key", pubkey) + db = db.Order("id desc") + db = db.Offset(offset) + db = db.Limit(limit) if err := db.Find(&proverTasks).Error; err != nil { - return nil, fmt.Errorf("ProverTask.GetProverTasksByHashes error: %w, hashes: %v", err, hashes) - } - return proverTasks, nil -} - -// GetProverTasksByProver returns prover-tasks by the given prover's public key. -func (o *ProverTask) GetProverTasksByProver(ctx context.Context, pubkey string) ([]*ProverTask, error) { - var proverTasks []*ProverTask - err := o.db.WithContext(ctx).Model(&ProverTask{}).Where(&ProverTask{ProverPublicKey: pubkey}).Order("id desc").Find(&proverTasks).Error - if err != nil { return nil, fmt.Errorf("ProverTask.GetProverTasksByProver error: %w, prover %s", err, pubkey) } return proverTasks, nil } -// SetProverTask updates or inserts a ProverTask record. -func (o *ProverTask) SetProverTask(ctx context.Context, proverTask *ProverTask) error { +// GetProverTotalReward get prover all reward by the given prover's public key. +func (o *ProverTask) GetProverTotalReward(ctx context.Context, pubkey string) (*big.Int, error) { + var totalReward decimal.Decimal db := o.db.WithContext(ctx) db = db.Model(&ProverTask{}) - db = db.Clauses(clause.OnConflict{ - Columns: []clause.Column{{Name: "task_type"}, {Name: "task_id"}, {Name: "prover_public_key"}}, - DoUpdates: clause.AssignmentColumns([]string{"proving_status"}), - }) - - if err := db.Create(&proverTask).Error; err != nil { - return fmt.Errorf("ProverTask.SetProverTask error: %w, prover task: %v", err, proverTask) + db = db.Select("sum(reward)") + db = db.Where("prover_public_key", pubkey) + if err := db.Scan(&totalReward).Error; err != nil { + return nil, fmt.Errorf("ProverTask.GetProverTotalReward error:%w, prover:%s", err, pubkey) } - return nil + return totalReward.BigInt(), nil } -// UpdateProverTaskProvingStatus updates the proving_status of a specific ProverTask record. -func (o *ProverTask) UpdateProverTaskProvingStatus(ctx context.Context, proofType message.ProofType, taskID string, pk string, status types.RollerProveStatus) error { +// GetProverTasksByHash retrieves the ProverTask records associated with the specified hashes. +// The returned prover task objects are sorted in ascending order by their ids. +func (o *ProverTask) GetProverTasksByHash(ctx context.Context, hash string) (*ProverTask, error) { db := o.db.WithContext(ctx) db = db.Model(&ProverTask{}) - db = db.Where("task_type = ? AND task_id = ? AND prover_public_key = ?", proofType, taskID, pk) + db = db.Where("task_id", hash) + db = db.Order("id asc") - if err := db.Update("proving_status", status).Error; err != nil { - return fmt.Errorf("ProverTask.UpdateProverTaskProvingStatus error: %w, proof type: %v, taskID: %v, prover public key: %v, status: %v", err, proofType.String(), taskID, pk, status.String()) + var proverTask *ProverTask + if err := db.Find(&proverTask).Error; err != nil { + return nil, fmt.Errorf("ProverTask.GetProverTasksByHash error: %w, hash: %v", err, hash) } - return nil + return proverTask, nil } diff --git a/prover-stats-api/internal/route/route.go b/prover-stats-api/internal/route/route.go new file mode 100644 index 000000000..ad93c94f5 --- /dev/null +++ b/prover-stats-api/internal/route/route.go @@ -0,0 +1,34 @@ +package route + +import ( + "github.com/gin-gonic/gin" + swaggerFiles "github.com/swaggo/files" + ginSwagger "github.com/swaggo/gin-swagger" + "scroll-tech/prover-stats-api/internal/controller" + + "scroll-tech/prover-stats-api/internal/config" + "scroll-tech/prover-stats-api/internal/middleware" +) + +func Route(router *gin.Engine, conf *config.Config) { + router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler)) + + r := router.Group("api/prover_task") + + v1(r, conf) +} + +func v1(router *gin.RouterGroup, conf *config.Config) { + r := router.Group("/v1") + + authMiddleware := middleware.AuthMiddleware(conf) + r.GET("/request_token", authMiddleware.LoginHandler) + + // need jwt token api + r.Use(authMiddleware.MiddlewareFunc()) + { + r.GET("/tasks", controller.ProverTask.ProverTasks) + r.GET("/total_rewards", controller.ProverTask.GetTotalRewards) + r.GET("/task", controller.ProverTask.GetTask) + } +} diff --git a/prover-stats-api/internal/types/auth.go b/prover-stats-api/internal/types/auth.go new file mode 100644 index 000000000..c89c5bc44 --- /dev/null +++ b/prover-stats-api/internal/types/auth.go @@ -0,0 +1,12 @@ +package types + +import "time" + +type LoginParameter struct { + PublicKey string `form:"public_key" json:"public_key" binding:"required"` +} + +type LoginSchema struct { + Time time.Time `json:"time"` + Token string `json:"token"` +} diff --git a/prover-stats-api/internal/types/errno.go b/prover-stats-api/internal/types/errno.go new file mode 100644 index 000000000..0e3fbbdac --- /dev/null +++ b/prover-stats-api/internal/types/errno.go @@ -0,0 +1,7 @@ +package types + +const ( + ErrParameterInvalidNo = 10001 + ErrProverTaskFailure = 10002 + ErrProverTotalRewardFailure = 10003 +) diff --git a/prover-stats-api/internal/types/prover_task.go b/prover-stats-api/internal/types/prover_task.go new file mode 100644 index 000000000..8529bdc6e --- /dev/null +++ b/prover-stats-api/internal/types/prover_task.go @@ -0,0 +1,31 @@ +package types + +import "time" + +type ProverTasksPaginationParameter struct { + PublicKey string `form:"public_key" json:"public_key" binding:"required"` + Page int `form:"page" json:"page" binding:"required"` + PageSize int `form:"page_size" json:"limit" binding:"required"` +} + +type ProverTaskSchema struct { + TaskID string `json:"task_id"` + ProverName string `json:"prover_name"` + TaskType string `json:"task_type"` + ProvingStatus string `json:"proving_status"` + FailureType string `json:"failure_type"` + Reward string `json:"reward"` + CreatedAt time.Time `json:"created_at"` +} + +type ProverTotalRewardsParameter struct { + PublicKey string `form:"public_key" json:"public_key" binding:"required"` +} + +type ProverTotalRewardsSchema struct { + Rewards string `json:"rewards"` +} + +type ProverTaskParameter struct { + TaskID string `form:"task_id" json:"task_id" binding:"required"` +} diff --git a/prover-stats-api/internal/types/response.go b/prover-stats-api/internal/types/response.go new file mode 100644 index 000000000..3b0c74ad5 --- /dev/null +++ b/prover-stats-api/internal/types/response.go @@ -0,0 +1,27 @@ +package types + +import ( + "net/http" + + "github.com/gin-gonic/gin" +) + +// Response the response schema +type Response struct { + ErrCode int `json:"errcode"` + ErrMsg string `json:"errmsg"` + Data interface{} `json:"data"` +} + +func RenderJson(ctx *gin.Context, errCode int, err error, data interface{}) { + var errMsg string + if err != nil { + errMsg = err.Error() + } + renderData := Response{ + ErrCode: errCode, + ErrMsg: errMsg, + Data: data, + } + ctx.JSON(http.StatusOK, renderData) +}