This repository has been archived by the owner on May 11, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 332
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(prover): update APIs && integrate swagger docs (#386)
- Loading branch information
1 parent
91bba90
commit ebdb3da
Showing
21 changed files
with
1,400 additions
and
147 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| replace common.Address string |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| 8028a49ea2dfc123b1c818afb722a029d3743e5c | ||
| 098a350bac5d2f01f39c975d4c6f4d93efed943a |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,122 @@ | ||
| // Package docs 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}}", | ||
| "termsOfService": "http://swagger.io/terms/", | ||
| "contact": { | ||
| "name": "API Support", | ||
| "url": "https://community.taiko.xyz/", | ||
| "email": "[email protected]" | ||
| }, | ||
| "license": { | ||
| "name": "MIT", | ||
| "url": "hhttps://github.com/taikoxyz/taiko-client/blob/main/LICENSE.md" | ||
| }, | ||
| "version": "{{.Version}}" | ||
| }, | ||
| "host": "{{.Host}}", | ||
| "basePath": "{{.BasePath}}", | ||
| "paths": { | ||
| "/assignment": { | ||
| "post": { | ||
| "consumes": [ | ||
| "application/json" | ||
| ], | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "summary": "Try to accept a block proof assignment", | ||
| "operationId": "create-assignment", | ||
| "responses": { | ||
| "200": { | ||
| "description": "OK", | ||
| "schema": { | ||
| "$ref": "#/definitions/server.ProposeBlockResponse" | ||
| } | ||
| }, | ||
| "422": { | ||
| "description": "prover does not have capacity", | ||
| "schema": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/status": { | ||
| "get": { | ||
| "consumes": [ | ||
| "application/json" | ||
| ], | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "summary": "Get current prover server status", | ||
| "operationId": "get-status", | ||
| "responses": { | ||
| "200": { | ||
| "description": "OK", | ||
| "schema": { | ||
| "$ref": "#/definitions/server.Status" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "server.ProposeBlockResponse": { | ||
| "type": "object", | ||
| "properties": { | ||
| "prover": { | ||
| "type": "string" | ||
| }, | ||
| "signedPayload": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "integer" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "server.Status": { | ||
| "type": "object", | ||
| "properties": { | ||
| "currentCapacity": { | ||
| "type": "integer" | ||
| }, | ||
| "maxExpiry": { | ||
| "type": "integer" | ||
| }, | ||
| "minProofFee": { | ||
| "type": "integer" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }` | ||
|
|
||
| // SwaggerInfo holds exported Swagger Info so clients can modify it | ||
| var SwaggerInfo = &swag.Spec{ | ||
| Version: "1.0", | ||
| Host: "prover-api.test.taiko.xyz", | ||
| BasePath: "", | ||
| Schemes: []string{}, | ||
| Title: "Taiko Prover API", | ||
| Description: "", | ||
| InfoInstanceName: "swagger", | ||
| SwaggerTemplate: docTemplate, | ||
| LeftDelim: "{{", | ||
| RightDelim: "}}", | ||
| } | ||
|
|
||
| func init() { | ||
| swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| { | ||
| "swagger": "2.0", | ||
| "info": { | ||
| "title": "Taiko Prover API", | ||
| "termsOfService": "http://swagger.io/terms/", | ||
| "contact": { | ||
| "name": "API Support", | ||
| "url": "https://community.taiko.xyz/", | ||
| "email": "[email protected]" | ||
| }, | ||
| "license": { | ||
| "name": "MIT", | ||
| "url": "hhttps://github.com/taikoxyz/taiko-client/blob/main/LICENSE.md" | ||
| }, | ||
| "version": "1.0" | ||
| }, | ||
| "host": "prover-api.test.taiko.xyz", | ||
| "paths": { | ||
| "/assignment": { | ||
| "post": { | ||
| "consumes": [ | ||
| "application/json" | ||
| ], | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "summary": "Try to accept a block proof assignment", | ||
| "operationId": "create-assignment", | ||
| "responses": { | ||
| "200": { | ||
| "description": "OK", | ||
| "schema": { | ||
| "$ref": "#/definitions/server.ProposeBlockResponse" | ||
| } | ||
| }, | ||
| "422": { | ||
| "description": "prover does not have capacity", | ||
| "schema": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/status": { | ||
| "get": { | ||
| "consumes": [ | ||
| "application/json" | ||
| ], | ||
| "produces": [ | ||
| "application/json" | ||
| ], | ||
| "summary": "Get current prover server status", | ||
| "operationId": "get-status", | ||
| "responses": { | ||
| "200": { | ||
| "description": "OK", | ||
| "schema": { | ||
| "$ref": "#/definitions/server.Status" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "server.ProposeBlockResponse": { | ||
| "type": "object", | ||
| "properties": { | ||
| "prover": { | ||
| "type": "string" | ||
| }, | ||
| "signedPayload": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "integer" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "server.Status": { | ||
| "type": "object", | ||
| "properties": { | ||
| "currentCapacity": { | ||
| "type": "integer" | ||
| }, | ||
| "maxExpiry": { | ||
| "type": "integer" | ||
| }, | ||
| "minProofFee": { | ||
| "type": "integer" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| definitions: | ||
| server.ProposeBlockResponse: | ||
| properties: | ||
| prover: | ||
| type: string | ||
| signedPayload: | ||
| items: | ||
| type: integer | ||
| type: array | ||
| type: object | ||
| server.Status: | ||
| properties: | ||
| currentCapacity: | ||
| type: integer | ||
| maxExpiry: | ||
| type: integer | ||
| minProofFee: | ||
| type: integer | ||
| type: object | ||
| host: prover-api.test.taiko.xyz | ||
| info: | ||
| contact: | ||
| email: [email protected] | ||
| name: API Support | ||
| url: https://community.taiko.xyz/ | ||
| license: | ||
| name: MIT | ||
| url: hhttps://github.com/taikoxyz/taiko-client/blob/main/LICENSE.md | ||
| termsOfService: http://swagger.io/terms/ | ||
| title: Taiko Prover API | ||
| version: "1.0" | ||
| paths: | ||
| /assignment: | ||
| post: | ||
| consumes: | ||
| - application/json | ||
| operationId: create-assignment | ||
| produces: | ||
| - application/json | ||
| responses: | ||
| "200": | ||
| description: OK | ||
| schema: | ||
| $ref: '#/definitions/server.ProposeBlockResponse' | ||
| "422": | ||
| description: prover does not have capacity | ||
| schema: | ||
| type: string | ||
| summary: Try to accept a block proof assignment | ||
| /status: | ||
| get: | ||
| consumes: | ||
| - application/json | ||
| operationId: get-status | ||
| produces: | ||
| - application/json | ||
| responses: | ||
| "200": | ||
| description: OK | ||
| schema: | ||
| $ref: '#/definitions/server.Status' | ||
| summary: Get current prover server status | ||
| swagger: "2.0" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.