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.
- Loading branch information
1 parent
0ffb59d
commit 2024139
Showing
4 changed files
with
44 additions
and
23 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 |
|---|---|---|
|
|
@@ -16,8 +16,7 @@ const docTemplate = `{ | |
| "email": "[email protected]" | ||
| }, | ||
| "license": { | ||
| "name": "MIT", | ||
| "url": "hhttps://github.com/taikoxyz/taiko-client/blob/main/LICENSE.md" | ||
| "name": "MIT" | ||
| }, | ||
| "version": "{{.Version}}" | ||
| }, | ||
|
|
@@ -38,7 +37,7 @@ const docTemplate = `{ | |
| "200": { | ||
| "description": "OK", | ||
| "schema": { | ||
| "$ref": "#/definitions/server.ProposeBlockResponse" | ||
| "$ref": "#/definitions/prover_server.ProposeBlockResponse" | ||
| } | ||
| }, | ||
| "422": { | ||
|
|
@@ -64,15 +63,15 @@ const docTemplate = `{ | |
| "200": { | ||
| "description": "OK", | ||
| "schema": { | ||
| "$ref": "#/definitions/server.Status" | ||
| "$ref": "#/definitions/prover_server.Status" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "server.ProposeBlockResponse": { | ||
| "prover_server.ProposeBlockResponse": { | ||
| "type": "object", | ||
| "properties": { | ||
| "prover": { | ||
|
|
@@ -86,7 +85,7 @@ const docTemplate = `{ | |
| } | ||
| } | ||
| }, | ||
| "server.Status": { | ||
| "prover_server.Status": { | ||
| "type": "object", | ||
| "properties": { | ||
| "currentCapacity": { | ||
|
|
@@ -95,7 +94,13 @@ const docTemplate = `{ | |
| "maxExpiry": { | ||
| "type": "integer" | ||
| }, | ||
| "minProofFee": { | ||
| "minOptimisticTierFee": { | ||
| "type": "integer" | ||
| }, | ||
| "minPseZkevmTierFee": { | ||
| "type": "integer" | ||
| }, | ||
| "minSgxTierFee": { | ||
| "type": "integer" | ||
| } | ||
| } | ||
|
|
@@ -106,7 +111,7 @@ const docTemplate = `{ | |
| // SwaggerInfo holds exported Swagger Info so clients can modify it | ||
| var SwaggerInfo = &swag.Spec{ | ||
| Version: "1.0", | ||
| Host: "prover-api.test.taiko.xyz", | ||
| Host: "", | ||
| BasePath: "", | ||
| Schemes: []string{}, | ||
| Title: "Taiko Prover API", | ||
|
|
||
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 |
|---|---|---|
|
|
@@ -9,12 +9,10 @@ | |
| "email": "[email protected]" | ||
| }, | ||
| "license": { | ||
| "name": "MIT", | ||
| "url": "hhttps://github.com/taikoxyz/taiko-client/blob/main/LICENSE.md" | ||
| "name": "MIT" | ||
| }, | ||
| "version": "1.0" | ||
| }, | ||
| "host": "prover-api.test.taiko.xyz", | ||
| "paths": { | ||
| "/assignment": { | ||
| "post": { | ||
|
|
@@ -30,7 +28,7 @@ | |
| "200": { | ||
| "description": "OK", | ||
| "schema": { | ||
| "$ref": "#/definitions/server.ProposeBlockResponse" | ||
| "$ref": "#/definitions/prover_server.ProposeBlockResponse" | ||
| } | ||
| }, | ||
| "422": { | ||
|
|
@@ -56,15 +54,15 @@ | |
| "200": { | ||
| "description": "OK", | ||
| "schema": { | ||
| "$ref": "#/definitions/server.Status" | ||
| "$ref": "#/definitions/prover_server.Status" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "definitions": { | ||
| "server.ProposeBlockResponse": { | ||
| "prover_server.ProposeBlockResponse": { | ||
| "type": "object", | ||
| "properties": { | ||
| "prover": { | ||
|
|
@@ -78,7 +76,7 @@ | |
| } | ||
| } | ||
| }, | ||
| "server.Status": { | ||
| "prover_server.Status": { | ||
| "type": "object", | ||
| "properties": { | ||
| "currentCapacity": { | ||
|
|
@@ -87,7 +85,13 @@ | |
| "maxExpiry": { | ||
| "type": "integer" | ||
| }, | ||
| "minProofFee": { | ||
| "minOptimisticTierFee": { | ||
| "type": "integer" | ||
| }, | ||
| "minPseZkevmTierFee": { | ||
| "type": "integer" | ||
| }, | ||
| "minSgxTierFee": { | ||
| "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 |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| definitions: | ||
| server.ProposeBlockResponse: | ||
| prover_server.ProposeBlockResponse: | ||
| properties: | ||
| prover: | ||
| type: string | ||
|
|
@@ -8,24 +8,26 @@ definitions: | |
| type: integer | ||
| type: array | ||
| type: object | ||
| server.Status: | ||
| prover_server.Status: | ||
| properties: | ||
| currentCapacity: | ||
| type: integer | ||
| maxExpiry: | ||
| type: integer | ||
| minProofFee: | ||
| minOptimisticTierFee: | ||
| type: integer | ||
| minPseZkevmTierFee: | ||
| type: integer | ||
| minSgxTierFee: | ||
| 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" | ||
|
|
@@ -41,7 +43,7 @@ paths: | |
| "200": | ||
| description: OK | ||
| schema: | ||
| $ref: '#/definitions/server.ProposeBlockResponse' | ||
| $ref: '#/definitions/prover_server.ProposeBlockResponse' | ||
| "422": | ||
| description: prover does not have capacity | ||
| schema: | ||
|
|
@@ -58,6 +60,6 @@ paths: | |
| "200": | ||
| description: OK | ||
| schema: | ||
| $ref: '#/definitions/server.Status' | ||
| $ref: '#/definitions/prover_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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,6 +13,16 @@ import ( | |
| "github.com/taikoxyz/taiko-client/pkg/rpc" | ||
| ) | ||
|
|
||
| // @title Taiko Prover API | ||
| // @version 1.0 | ||
| // @termsOfService http://swagger.io/terms/ | ||
|
|
||
| // @contact.name API Support | ||
| // @contact.url https://community.taiko.xyz/ | ||
| // @contact.email [email protected] | ||
|
|
||
| // @license.name MIT | ||
|
|
||
| // CreateAssignmentRequestBody represents a request body when handling assignment creation request. | ||
| type CreateAssignmentRequestBody struct { | ||
| FeeToken common.Address | ||
|
|
||