feat: consume inscription reveals from chainhook node (#13)

* feat: draft

* fix: cache and server progress

* feat: more progress

* fix: env var

* fix: default port

* fix: add missing properties

* feat: add ping before server

* fix: final schema

* feat: rollback

src/api/routes/inscriptions.ts

@@ -21,13 +21,13 @@ import {
   BlockHashParamCType,
   BlockHeightParamCType,
   InscriptionIdParamCType,
-  BlockParam,
   BlockHeightParam,
-  TimestampParam,
+  BlockParam,
   OrdinalParam,
   InscriptionNumberParam,
+  TimestampParam,
 } from '../schemas';
-import { handleChainTipCache, handleInscriptionCache } from '../util/cache';
+import { handleInscriptionCache, handleInscriptionTransfersCache } from '../util/cache';
 import {
   DEFAULT_API_LIMIT,
   hexToBuffer,
@@ -58,7 +58,7 @@ const IndexRoutes: FastifyPluginCallback<Record<never, never>, Server, TypeBoxTy
   options,
   done
 ) => {
-  fastify.addHook('preHandler', handleChainTipCache);
+  fastify.addHook('preHandler', handleInscriptionTransfersCache);
   fastify.get(
     '/inscriptions',
     {

src/api/util/cache.ts

@@ -3,7 +3,7 @@ import { logger } from '../../logger';
 import { InscriptionIdParamCType, InscriptionNumberParamCType } from '../schemas';
 
 export enum ETagType {
-  chainTip,
+  inscriptionTransfers,
   inscription,
 }
 
@@ -19,8 +19,11 @@ export async function handleInscriptionCache(request: FastifyRequest, reply: Fas
   return handleCache(ETagType.inscription, request, reply);
 }
 
-export async function handleChainTipCache(request: FastifyRequest, reply: FastifyReply) {
-  return handleCache(ETagType.chainTip, request, reply);
+export async function handleInscriptionTransfersCache(
+  request: FastifyRequest,
+  reply: FastifyReply
+) {
+  return handleCache(ETagType.inscriptionTransfers, request, reply);
 }
 
 async function handleCache(type: ETagType, request: FastifyRequest, reply: FastifyReply) {
@@ -30,8 +33,8 @@ async function handleCache(type: ETagType, request: FastifyRequest, reply: Fasti
     case ETagType.inscription:
       etag = await getInscriptionLocationEtag(request);
       break;
-    case ETagType.chainTip:
-      etag = await getChainTipEtag(request);
+    case ETagType.inscriptionTransfers:
+      etag = await getInscriptionTransfersEtag(request);
       break;
   }
   if (etag) {
@@ -73,16 +76,13 @@ async function getInscriptionLocationEtag(request: FastifyRequest): Promise<stri
 }
 
 /**
- * Get an ETag based on the last observed chain tip.
+ * Get an ETag based on the last state of inscription transfers.
  * @param request - Fastify request
  * @returns ETag string
  */
-async function getChainTipEtag(request: FastifyRequest): Promise<string | undefined> {
+async function getInscriptionTransfersEtag(request: FastifyRequest): Promise<string | undefined> {
   try {
-    const blockHeight = await request.server.db.getChainTipBlockHeight();
-    if (blockHeight) {
-      return blockHeight.toString();
-    }
+    return await request.server.db.getInscriptionTransfersETag();
   } catch (error) {
     return;
   }

src/api/util/helpers.ts

@@ -15,7 +15,7 @@ export function parseDbInscriptions(
     genesis_block_hash: i.genesis_block_hash,
     genesis_tx_id: i.genesis_tx_id,
     genesis_fee: i.genesis_fee.toString(),
-    genesis_timestamp: i.genesis_timestamp,
+    genesis_timestamp: i.genesis_timestamp.valueOf(),
     location: `${i.output}:${i.offset}`,
     output: i.output,
     value: i.value.toString(),
@@ -26,7 +26,7 @@ export function parseDbInscriptions(
     mime_type: i.mime_type,
     content_type: i.content_type,
     content_length: i.content_length,
-    timestamp: i.timestamp,
+    timestamp: i.timestamp.valueOf(),
   }));
 }
 export function parseDbInscription(item: DbFullyLocatedInscriptionResult): InscriptionResponseType {