feat: localstatequery rest endpoints (part 1) (#134)

Signed-off-by: Chris Gianelloni <[email protected]>
blinklabs-io · Mar 24, 2024 · 0286c60 · 0286c60
1 parent 136036e
commit 0286c60
Show file tree

Hide file tree

Showing 5 changed files with 531 additions and 2 deletions.
diff --git a/docs/docs.go b/docs/docs.go
diff --git a/docs/swagger.json b/docs/swagger.json
@@ -20,6 +20,81 @@
     "host": "localhost",
     "basePath": "/api",
     "paths": {
+        "/localstatequery/current-era": {
+            "get": {
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "localstatequery"
+                ],
+                "summary": "Query Current Era",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/api.responseLocalStateQueryCurrentEra"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/api.responseApiError"
+                        }
+                    }
+                }
+            }
+        },
+        "/localstatequery/system-start": {
+            "get": {
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "localstatequery"
+                ],
+                "summary": "Query System Start",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/api.responseLocalStateQuerySystemStart"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/api.responseApiError"
+                        }
+                    }
+                }
+            }
+        },
+        "/localstatequery/tip": {
+            "get": {
+                "produces": [
+                    "application/json"
+                ],
+                "tags": [
+                    "localstatequery"
+                ],
+                "summary": "Query Chain Tip",
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "schema": {
+                            "$ref": "#/definitions/api.responseLocalStateQueryTip"
+                        }
+                    },
+                    "500": {
+                        "description": "Internal Server Error",
+                        "schema": {
+                            "$ref": "#/definitions/api.responseApiError"
+                        }
+                    }
+                }
+            }
+        },
         "/localtxmonitor/has_tx/{tx_hash}": {
             "get": {
                 "consumes": [
@@ -165,6 +240,51 @@
                 }
             }
         },
+        "api.responseLocalStateQueryCurrentEra": {
+            "type": "object",
+            "properties": {
+                "id": {
+                    "type": "integer"
+                },
+                "name": {
+                    "type": "string"
+                }
+            }
+        },
+        "api.responseLocalStateQuerySystemStart": {
+            "type": "object",
+            "properties": {
+                "day": {
+                    "type": "integer"
+                },
+                "picoseconds": {
+                    "type": "integer"
+                },
+                "year": {
+                    "type": "integer"
+                }
+            }
+        },
+        "api.responseLocalStateQueryTip": {
+            "type": "object",
+            "properties": {
+                "block_no": {
+                    "type": "integer"
+                },
+                "epoch_no": {
+                    "type": "integer"
+                },
+                "era": {
+                    "type": "string"
+                },
+                "hash": {
+                    "type": "string"
+                },
+                "slot_no": {
+                    "type": "integer"
+                }
+            }
+        },
         "api.responseLocalTxMonitorHasTx": {
             "type": "object",
             "properties": {

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -6,6 +6,35 @@ definitions:
         example: error message
         type: string
     type: object
+  api.responseLocalStateQueryCurrentEra:
+    properties:
+      id:
+        type: integer
+      name:
+        type: string
+    type: object
+  api.responseLocalStateQuerySystemStart:
+    properties:
+      day:
+        type: integer
+      picoseconds:
+        type: integer
+      year:
+        type: integer
+    type: object
+  api.responseLocalStateQueryTip:
+    properties:
+      block_no:
+        type: integer
+      epoch_no:
+        type: integer
+      era:
+        type: string
+      hash:
+        type: string
+      slot_no:
+        type: integer
+    type: object
   api.responseLocalTxMonitorHasTx:
     properties:
       has_tx:
@@ -44,6 +73,54 @@ info:
   title: cardano-node-api
   version: "1.0"
 paths:
+  /localstatequery/current-era:
+    get:
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/api.responseLocalStateQueryCurrentEra'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/api.responseApiError'
+      summary: Query Current Era
+      tags:
+      - localstatequery
+  /localstatequery/system-start:
+    get:
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/api.responseLocalStateQuerySystemStart'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/api.responseApiError'
+      summary: Query System Start
+      tags:
+      - localstatequery
+  /localstatequery/tip:
+    get:
+      produces:
+      - application/json
+      responses:
+        "200":
+          description: OK
+          schema:
+            $ref: '#/definitions/api.responseLocalStateQueryTip'
+        "500":
+          description: Internal Server Error
+          schema:
+            $ref: '#/definitions/api.responseApiError'
+      summary: Query Chain Tip
+      tags:
+      - localstatequery
   /localtxmonitor/has_tx/{tx_hash}:
     get:
       consumes:

diff --git a/internal/api/api.go b/internal/api/api.go
@@ -36,11 +36,10 @@ import (
 //	@host			localhost
 //	@Schemes		http
 //	@BasePath		/api
-
 //	@contact.name	Blink Labs
 //	@contact.url	https://blinklabs.io
 //	@contact.email	[email protected]
-
+//
 //	@license.name	Apache 2.0
 //	@license.url	http://www.apache.org/licenses/LICENSE-2.0.html
 func Start(cfg *config.Config) error {
@@ -75,6 +74,7 @@ func Start(cfg *config.Config) error {
 
 	// Configure API routes
 	apiGroup := router.Group("/api")
+	configureLocalStateQueryRoutes(apiGroup)
 	configureLocalTxMonitorRoutes(apiGroup)
 	configureLocalTxSubmissionRoutes(apiGroup)