feat: status endpoint

Author: rafaelcr

api/src/api/init.ts

@@ -7,12 +7,14 @@ import { EtchingRoutes } from './routes/etchings';
 import { AddressRoutes } from './routes/addresses';
 import { TransactionRoutes } from './routes/transactions';
 import { BlockRoutes } from './routes/blocks';
+import { StatusRoutes } from './routes/status';
 
 export const Api: FastifyPluginAsync<
   Record<never, never>,
   Server,
   TypeBoxTypeProvider
 > = async fastify => {
+  await fastify.register(StatusRoutes);
   await fastify.register(EtchingRoutes);
   await fastify.register(AddressRoutes);
   await fastify.register(TransactionRoutes);

api/src/api/routes/status.ts

@@ -0,0 +1,42 @@
+import { TypeBoxTypeProvider } from '@fastify/type-provider-typebox';
+import { FastifyPluginCallback } from 'fastify';
+import { Server } from 'http';
+import { ApiStatusResponse } from '../schemas';
+import { SERVER_VERSION } from '@hirosystems/api-toolkit';
+import { handleCache } from '../util/cache';
+
+export const StatusRoutes: FastifyPluginCallback<
+  Record<never, never>,
+  Server,
+  TypeBoxTypeProvider
+> = (fastify, options, done) => {
+  fastify.addHook('preHandler', handleCache);
+
+  fastify.get(
+    '/',
+    {
+      schema: {
+        operationId: 'getApiStatus',
+        summary: 'API Status',
+        description: 'Displays the status of the API',
+        tags: ['Status'],
+        response: {
+          200: ApiStatusResponse,
+        },
+      },
+    },
+    async (request, reply) => {
+      const result = await fastify.db.sqlTransaction(async sql => {
+        const block_height = await fastify.db.getChainTipBlockHeight();
+        return {
+          server_version: `runes-api ${SERVER_VERSION.tag} (${SERVER_VERSION.branch}:${SERVER_VERSION.commit})`,
+          status: 'ready',
+          block_height: block_height ? parseInt(block_height) : undefined,
+        };
+      });
+      await reply.send(result);
+    }
+  );
+
+  done();
+};

api/src/api/schemas.ts

@@ -107,6 +107,15 @@ export type Block = Static<typeof BlockSchema>;
 // Responses
 // ==========================
 
+export const ApiStatusResponse = Type.Object(
+  {
+    server_version: Type.String({ examples: [''] }),
+    status: Type.String(),
+    block_height: Optional(Type.Integer()),
+  },
+  { title: 'Api Status Response' }
+);
+
 export const EtchingResponseSchema = Type.Object({
   id: Type.String({ examples: ['840000:1'] }),
   name: Type.String({ examples: ['ZZZZZFEHUZZZZZ'] }),

api/src/pg/pg-store.ts

@@ -82,6 +82,13 @@ export class PgStore extends BasePgStore {
     return result[0]?.etag;
   }
 
+  async getChainTipBlockHeight(): Promise<string | undefined> {
+    const result = await this.sql<{ block_height: string }[]>`
+      SELECT block_height FROM ledger ORDER BY block_height DESC LIMIT 1
+    `;
+    return result[0]?.block_height;
+  }
+
   async getEtching(id: Rune): Promise<DbRuneWithChainTip | undefined> {
     const result = await this.sql<DbRuneWithChainTip[]>`
       SELECT *, (SELECT MAX(block_height) FROM ledger) AS chain_tip
@@ -95,7 +102,7 @@ export class PgStore extends BasePgStore {
     const results = await this.sql<DbCountedQueryResult<DbRuneWithChainTip>[]>`
       WITH
         rune_count AS (SELECT COALESCE(MAX(number), 0) + 1 AS total FROM runes),
-        max AS (SELECT MAX(block_height) AS max FROM ledger)
+        max AS (SELECT MAX(block_height) AS chain_tip FROM ledger)
       SELECT *, (SELECT total FROM rune_count), (SELECT chain_tip FROM max)
       FROM runes
       ORDER BY block_height DESC, tx_index DESC