From af00627e59a1c389fc7a6dded006916ad7edc268 Mon Sep 17 00:00:00 2001 From: d1onys1us <13951458+d1onys1us@users.noreply.github.com> Date: Mon, 13 May 2024 20:37:58 -0400 Subject: [PATCH 1/2] chore(eventindexer,relayer,taiko-client): clean up swagger apis for migration --- packages/eventindexer/docs/docs.go | 57 +++---------------- packages/eventindexer/docs/swagger.json | 49 ++-------------- packages/eventindexer/docs/swagger.yaml | 35 +----------- packages/eventindexer/pkg/http/server.go | 5 +- packages/relayer/docs/docs.go | 13 ++++- packages/relayer/docs/swagger.json | 13 ++++- packages/relayer/docs/swagger.yaml | 9 ++- packages/relayer/pkg/http/server.go | 5 +- packages/taiko-client/prover/server/server.go | 3 +- 9 files changed, 48 insertions(+), 141 deletions(-) diff --git a/packages/eventindexer/docs/docs.go b/packages/eventindexer/docs/docs.go index 65a6411b2c..950eaea61e 100644 --- a/packages/eventindexer/docs/docs.go +++ b/packages/eventindexer/docs/docs.go @@ -1,4 +1,4 @@ -// Code generated by swaggo/swag. DO NOT EDIT +// Package docs Code generated by swaggo/swag. DO NOT EDIT package docs import "github.com/swaggo/swag" @@ -16,7 +16,8 @@ const docTemplate = `{ "email": "info@taiko.xyz" }, "license": { - "name": "MIT" + "name": "MIT", + "url": "https://github.com/taikoxyz/taiko-mono/blob/main/LICENSE.md" }, "version": "{{.Version}}" }, @@ -167,26 +168,6 @@ const docTemplate = `{ } } }, - "/stats": { - "get": { - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "summary": "Get stats", - "operationId": "get-stats", - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/eventindexer.Stat" - } - } - } - } - }, "/uniqueProposers": { "get": { "consumes": [ @@ -251,32 +232,6 @@ const docTemplate = `{ } } }, - "eventindexer.Stat": { - "type": "object", - "properties": { - "averageProofReward": { - "type": "string" - }, - "averageProofTime": { - "type": "string" - }, - "feeTokenAddress": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "numBlocksAssigned": { - "type": "integer" - }, - "numProofs": { - "type": "integer" - }, - "statType": { - "type": "string" - } - } - }, "eventindexer.UniqueProposersResponse": { "type": "object", "properties": { @@ -369,13 +324,15 @@ const docTemplate = `{ // SwaggerInfo holds exported Swagger Info so clients can modify it var SwaggerInfo = &swag.Spec{ Version: "1.0", - Host: "eventindexer.katla.taiko.xyz", + Host: "eventindexer.hekla.taiko.xyz", BasePath: "", Schemes: []string{}, - Title: "Taiko Eventindexer API", + Title: "Taiko Event Indexer API", Description: "", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, + LeftDelim: "{{", + RightDelim: "}}", } func init() { diff --git a/packages/eventindexer/docs/swagger.json b/packages/eventindexer/docs/swagger.json index c693053f63..8927b8f636 100644 --- a/packages/eventindexer/docs/swagger.json +++ b/packages/eventindexer/docs/swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Taiko Eventindexer API", + "title": "Taiko Event Indexer API", "termsOfService": "http://swagger.io/terms/", "contact": { "name": "API Support", @@ -9,11 +9,12 @@ "email": "info@taiko.xyz" }, "license": { - "name": "MIT" + "name": "MIT", + "url": "https://github.com/taikoxyz/taiko-mono/blob/main/LICENSE.md" }, "version": "1.0" }, - "host": "eventindexer.katla.taiko.xyz", + "host": "eventindexer.hekla.taiko.xyz", "paths": { "/assignedBlocks": { "get": { @@ -143,22 +144,6 @@ } } }, - "/stats": { - "get": { - "consumes": ["application/json"], - "produces": ["application/json"], - "summary": "Get stats", - "operationId": "get-stats", - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/eventindexer.Stat" - } - } - } - } - }, "/uniqueProposers": { "get": { "consumes": ["application/json"], @@ -215,32 +200,6 @@ } } }, - "eventindexer.Stat": { - "type": "object", - "properties": { - "averageProofReward": { - "type": "string" - }, - "averageProofTime": { - "type": "string" - }, - "feeTokenAddress": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "numBlocksAssigned": { - "type": "integer" - }, - "numProofs": { - "type": "integer" - }, - "statType": { - "type": "string" - } - } - }, "eventindexer.UniqueProposersResponse": { "type": "object", "properties": { diff --git a/packages/eventindexer/docs/swagger.yaml b/packages/eventindexer/docs/swagger.yaml index 877a55c026..a595892b8b 100644 --- a/packages/eventindexer/docs/swagger.yaml +++ b/packages/eventindexer/docs/swagger.yaml @@ -13,23 +13,6 @@ definitions: $ref: "#/definitions/eventindexer.ChartItem" type: array type: object - eventindexer.Stat: - properties: - averageProofReward: - type: string - averageProofTime: - type: string - feeTokenAddress: - type: string - id: - type: integer - numBlocksAssigned: - type: integer - numProofs: - type: integer - statType: - type: string - type: object eventindexer.UniqueProposersResponse: properties: address: @@ -86,7 +69,7 @@ definitions: visible: type: integer type: object -host: eventindexer.katla.taiko.xyz +host: eventindexer.hekla.taiko.xyz info: contact: email: info@taiko.xyz @@ -94,8 +77,9 @@ info: url: https://community.taiko.xyz/ license: name: MIT + url: https://github.com/taikoxyz/taiko-mono/blob/main/LICENSE.md termsOfService: http://swagger.io/terms/ - title: Taiko Eventindexer API + title: Taiko Event Indexer API version: "1.0" paths: /assignedBlocks: @@ -194,19 +178,6 @@ paths: schema: $ref: "#/definitions/paginate.Page" summary: Get nft balances by address and chain ID - /stats: - get: - consumes: - - application/json - operationId: get-stats - produces: - - application/json - responses: - "200": - description: OK - schema: - $ref: "#/definitions/eventindexer.Stat" - summary: Get stats /uniqueProposers: get: consumes: diff --git a/packages/eventindexer/pkg/http/server.go b/packages/eventindexer/pkg/http/server.go index e5bfdf6b06..7a49cc20a7 100644 --- a/packages/eventindexer/pkg/http/server.go +++ b/packages/eventindexer/pkg/http/server.go @@ -14,7 +14,7 @@ import ( echo "github.com/labstack/echo/v4" ) -// @title Taiko Eventindexer API +// @title Taiko Event Indexer API // @version 1.0 // @termsOfService http://swagger.io/terms/ @@ -23,8 +23,9 @@ import ( // @contact.email info@taiko.xyz // @license.name MIT +// @license.url https://github.com/taikoxyz/taiko-mono/blob/main/LICENSE.md -// @host eventindexer.katla.taiko.xyz +// @host eventindexer.hekla.taiko.xyz // Server represents an eventindexer http server instance. type Server struct { echo *echo.Echo diff --git a/packages/relayer/docs/docs.go b/packages/relayer/docs/docs.go index 21b73bbfed..622106df9d 100644 --- a/packages/relayer/docs/docs.go +++ b/packages/relayer/docs/docs.go @@ -16,7 +16,8 @@ const docTemplate = `{ "email": "info@taiko.xyz" }, "license": { - "name": "MIT" + "name": "MIT", + "url": "https://github.com/taikoxyz/taiko-mono/blob/main/LICENSE.md" }, "version": "{{.Version}}" }, @@ -126,6 +127,12 @@ const docTemplate = `{ "paginate.Page": { "type": "object", "properties": { + "error": { + "type": "boolean" + }, + "error_message": { + "type": "string" + }, "first": { "type": "boolean" }, @@ -159,10 +166,10 @@ const docTemplate = `{ // SwaggerInfo holds exported Swagger Info so clients can modify it var SwaggerInfo = &swag.Spec{ Version: "1.0", - Host: "relayer.katla.taiko.xyz", + Host: "relayer.hekla.taiko.xyz", BasePath: "", Schemes: []string{}, - Title: "Taiko Relayer API", + Title: "Taiko Bridge Relayer API", Description: "", InfoInstanceName: "swagger", SwaggerTemplate: docTemplate, diff --git a/packages/relayer/docs/swagger.json b/packages/relayer/docs/swagger.json index 88960a8024..028b3a5e08 100644 --- a/packages/relayer/docs/swagger.json +++ b/packages/relayer/docs/swagger.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Taiko Relayer API", + "title": "Taiko Bridge Relayer API", "termsOfService": "http://swagger.io/terms/", "contact": { "name": "API Support", @@ -9,11 +9,12 @@ "email": "info@taiko.xyz" }, "license": { - "name": "MIT" + "name": "MIT", + "url": "https://github.com/taikoxyz/taiko-mono/blob/main/LICENSE.md" }, "version": "1.0" }, - "host": "relayer.katla.taiko.xyz", + "host": "relayer.hekla.taiko.xyz", "paths": { "/blockInfo": { "get": { @@ -110,6 +111,12 @@ "paginate.Page": { "type": "object", "properties": { + "error": { + "type": "boolean" + }, + "error_message": { + "type": "string" + }, "first": { "type": "boolean" }, diff --git a/packages/relayer/docs/swagger.yaml b/packages/relayer/docs/swagger.yaml index 18099106cc..8e35602519 100644 --- a/packages/relayer/docs/swagger.yaml +++ b/packages/relayer/docs/swagger.yaml @@ -17,6 +17,10 @@ definitions: type: object paginate.Page: properties: + error: + type: boolean + error_message: + type: string first: type: boolean items: {} @@ -35,7 +39,7 @@ definitions: visible: type: integer type: object -host: relayer.katla.taiko.xyz +host: relayer.hekla.taiko.xyz info: contact: email: info@taiko.xyz @@ -43,8 +47,9 @@ info: url: https://community.taiko.xyz/ license: name: MIT + url: https://github.com/taikoxyz/taiko-mono/blob/main/LICENSE.md termsOfService: http://swagger.io/terms/ - title: Taiko Relayer API + title: Taiko Bridge Relayer API version: "1.0" paths: /blockInfo: diff --git a/packages/relayer/pkg/http/server.go b/packages/relayer/pkg/http/server.go index 514f3aa5d2..e6f5ee0dfb 100644 --- a/packages/relayer/pkg/http/server.go +++ b/packages/relayer/pkg/http/server.go @@ -21,7 +21,7 @@ type ethClient interface { BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error) } -// @title Taiko Relayer API +// @title Taiko Bridge Relayer API // @version 1.0 // @termsOfService http://swagger.io/terms/ @@ -30,8 +30,9 @@ type ethClient interface { // @contact.email info@taiko.xyz // @license.name MIT +// @license.url https://github.com/taikoxyz/taiko-mono/blob/main/LICENSE.md -// @host relayer.katla.taiko.xyz +// @host relayer.hekla.taiko.xyz // Server represents an relayer http server instance. type Server struct { echo *echo.Echo diff --git a/packages/taiko-client/prover/server/server.go b/packages/taiko-client/prover/server/server.go index 88b33ea527..814a1c98a2 100644 --- a/packages/taiko-client/prover/server/server.go +++ b/packages/taiko-client/prover/server/server.go @@ -27,8 +27,7 @@ import ( // @contact.email info@taiko.xyz // @license.name MIT -// @license.url https://github.com/taikoxyz/taiko-mono/packages/taiko-client/blob/main/LICENSE.md - +// @license.url https://github.com/taikoxyz/taiko-mono/blob/main/LICENSE.md // ProverServer represents a prover server instance. type ProverServer struct { echo *echo.Echo From 0d7884e99278751c77f1f9c9b6f04d034a6d8bc2 Mon Sep 17 00:00:00 2001 From: d1onys1us <13951458+d1onys1us@users.noreply.github.com> Date: Mon, 13 May 2024 20:42:29 -0400 Subject: [PATCH 2/2] chore(eventindexer,relayer,taiko-client): clean up swagger apis for migration --- .../taiko-client-proverapi-preview.yml | 46 ------------------- .../taiko-client-proverapi-production.yml | 43 ----------------- 2 files changed, 89 deletions(-) delete mode 100644 .github/workflows/taiko-client-proverapi-preview.yml delete mode 100644 .github/workflows/taiko-client-proverapi-production.yml diff --git a/.github/workflows/taiko-client-proverapi-preview.yml b/.github/workflows/taiko-client-proverapi-preview.yml deleted file mode 100644 index faa4440f9e..0000000000 --- a/.github/workflows/taiko-client-proverapi-preview.yml +++ /dev/null @@ -1,46 +0,0 @@ -name: Prover Server API Preview - -env: - VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }} - VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID_PROVER_SERVER }} - -on: - workflow_dispatch: - push: - branches-ignore: - - main - - release-please-* - paths: - - "packages/taiko-client/**" - -jobs: - deploy-proverserver-api-preview: - runs-on: [taiko-runner] - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - - name: Install pnpm dependencies - uses: ./.github/actions/install-pnpm-dependencies - - - name: Set up Go - uses: actions/setup-go@v5 - with: - go-version: 1.22.0 - - - name: Install swag cli - run: go install github.com/swaggo/swag/cmd/swag@latest - - - name: Install Vercel CLI - run: pnpm add --global vercel@latest - - - name: Swag autogen - working-directory: packages/taiko-client - run: ./scripts/gen_swagger_json.sh - - - name: Pull Vercel Environment Information - run: vercel pull --yes --environment=preview --token=${{ secrets.VERCEL_TOKEN }} - - - name: Deploy Project Artifacts to Vercel - working-directory: packages/taiko-client - run: vercel --token=${{ secrets.VERCEL_TOKEN }} diff --git a/.github/workflows/taiko-client-proverapi-production.yml b/.github/workflows/taiko-client-proverapi-production.yml deleted file mode 100644 index d6f768ef6a..0000000000 --- a/.github/workflows/taiko-client-proverapi-production.yml +++ /dev/null @@ -1,43 +0,0 @@ -name: Prover Server API Production - -env: - VERCEL_ORG_ID: ${{ secrets.VERCEL_ORG_ID }} - VERCEL_PROJECT_ID: ${{ secrets.VERCEL_PROJECT_ID_PROVER_SERVER }} - -on: - workflow_dispatch: - push: - tags: - - "taiko-client-*" - -jobs: - deploy-proverserver-api-production: - runs-on: [taiko-runner] - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - - name: Install pnpm dependencies - uses: ./.github/actions/install-pnpm-dependencies - - - name: Set up Go - uses: actions/setup-go@v5 - with: - go-version: 1.22.0 - - - name: Install swag cli - run: go install github.com/swaggo/swag/cmd/swag@latest - - - name: Install Vercel CLI - run: pnpm add --global vercel@latest - - - name: Swag autogen - working-directory: packages/taiko-client - run: ./scripts/gen_swagger_json.sh - - - name: Pull Vercel Environment Information - run: vercel pull --yes --environment=preview --token=${{ secrets.VERCEL_TOKEN }} - - - name: Deploy Project Artifacts to Vercel - working-directory: packages/taiko-client - run: vercel --token=${{ secrets.VERCEL_TOKEN }}