fixup

taikoxyz · May 14, 2024 · 76ba72e · 76ba72e
1 parent 2d3405d
commit 76ba72e
Show file tree

Hide file tree

Showing 17 changed files with 44 additions and 178 deletions.
diff --git a/.github/workflows/blobstorage-preview.yml b/.github/workflows/blobstorage-preview.yml
diff --git a/.github/workflows/blobstorage-production.yml b/.github/workflows/blobstorage-production.yml
diff --git a/.github/workflows/taiko-client-proverapi-preview.yml b/.github/workflows/taiko-client-proverapi-preview.yml
diff --git a/.github/workflows/taiko-client-proverapi-production.yml b/.github/workflows/taiko-client-proverapi-production.yml
diff --git a/packages/blobstorage/docs/docs.go b/packages/blobstorage/docs/docs.go
@@ -57,6 +57,9 @@ const docTemplate = `{
         "http.blobData": {
             "type": "object",
             "properties": {
+                "blob": {
+                    "type": "string"
+                },
                 "blob_hash": {
                     "type": "string"
                 },

diff --git a/packages/blobstorage/docs/swagger.json b/packages/blobstorage/docs/swagger.json
@@ -45,6 +45,9 @@
     "http.blobData": {
       "type": "object",
       "properties": {
+        "blob": {
+          "type": "string"
+        },
         "blob_hash": {
           "type": "string"
         },

diff --git a/packages/blobstorage/docs/swagger.yaml b/packages/blobstorage/docs/swagger.yaml
@@ -1,6 +1,8 @@
 definitions:
   http.blobData:
     properties:
+      blob:
+        type: string
       blob_hash:
         type: string
       kzg_commitment:

diff --git a/packages/docs-site/astro.config.ts b/packages/docs-site/astro.config.ts
@@ -17,11 +17,18 @@ export default defineConfig({
       plugins: [
         starlightLinksValidator({
           exclude: [
+            // "/api-reference/blob-storage",
             "/api-reference/bridge-relayer",
             "/api-reference/event-indexer",
+            "/api-reference/prover-server",
           ],
         }),
         starlightOpenAPI([
+          // {
+          //   base: "api-reference/blob-storage",
+          //   label: "Blob Storage API",
+          //   schema: "../blobstorage/docs/swagger.yaml",
+          // },
           {
             base: "api-reference/bridge-relayer",
             label: "Bridge Relayer API",

diff --git a/packages/eventindexer/docs/docs.go b/packages/eventindexer/docs/docs.go
@@ -16,7 +16,8 @@ const docTemplate = `{
             "email": "[email protected]"
         },
         "license": {
-            "name": "MIT"
+            "name": "MIT",
+            "url": "https://github.com/taikoxyz/taiko-mono/blob/main/LICENSE.md"
         },
         "version": "{{.Version}}"
     },
@@ -323,10 +324,10 @@ 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,

diff --git a/packages/eventindexer/docs/swagger.json b/packages/eventindexer/docs/swagger.json
@@ -1,19 +1,20 @@
 {
   "swagger": "2.0",
   "info": {
-    "title": "Taiko Eventindexer API",
+    "title": "Taiko Event Indexer API",
     "termsOfService": "http://swagger.io/terms/",
     "contact": {
       "name": "API Support",
       "url": "https://community.taiko.xyz/",
       "email": "[email protected]"
     },
     "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": {

diff --git a/packages/eventindexer/docs/swagger.yaml b/packages/eventindexer/docs/swagger.yaml
@@ -69,16 +69,17 @@ definitions:
       visible:
         type: integer
     type: object
-host: eventindexer.katla.taiko.xyz
+host: eventindexer.hekla.taiko.xyz
 info:
   contact:
     email: [email protected]
     name: API Support
     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:

diff --git 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 [email protected]
 
 // @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
@@ -16,7 +16,8 @@ const docTemplate = `{
             "email": "[email protected]"
         },
         "license": {
-            "name": "MIT"
+            "name": "MIT",
+            "url": "https://github.com/taikoxyz/taiko-mono/blob/main/LICENSE.md"
         },
         "version": "{{.Version}}"
     },
@@ -165,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
@@ -1,19 +1,20 @@
 {
   "swagger": "2.0",
   "info": {
-    "title": "Taiko Relayer API",
+    "title": "Taiko Bridge Relayer API",
     "termsOfService": "http://swagger.io/terms/",
     "contact": {
       "name": "API Support",
       "url": "https://community.taiko.xyz/",
       "email": "[email protected]"
     },
     "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": {

diff --git a/packages/relayer/docs/swagger.yaml b/packages/relayer/docs/swagger.yaml
@@ -39,16 +39,17 @@ definitions:
       visible:
         type: integer
     type: object
-host: relayer.katla.taiko.xyz
+host: relayer.hekla.taiko.xyz
 info:
   contact:
     email: [email protected]
     name: API Support
     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
@@ -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 [email protected]
 
 // @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
@@ -27,8 +27,7 @@ import (
 // @contact.email [email protected]
 
 // @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