feat: add metadata and parent columns to inscriptions table (#305)

* chore: update client

* feat: add columns

* fix: tests

migrations/1707770109739_metadata-parent.ts

@@ -0,0 +1,15 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+import { MigrationBuilder, ColumnDefinitions } from 'node-pg-migrate';
+
+export const shorthands: ColumnDefinitions | undefined = undefined;
+
+export function up(pgm: MigrationBuilder): void {
+  pgm.addColumns('inscriptions', {
+    metadata: {
+      type: 'text',
+    },
+    parent: {
+      type: 'text',
+    },
+  });
+}

package.json

@@ -54,7 +54,7 @@
     "@fastify/swagger": "^8.3.1",
     "@fastify/type-provider-typebox": "^3.2.0",
     "@hirosystems/api-toolkit": "^1.3.1",
-    "@hirosystems/chainhook-client": "^1.6.0",
+    "@hirosystems/chainhook-client": "^1.7.0",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/commit-analyzer": "^10.0.4",
     "@semantic-release/git": "^10.0.1",

src/pg/helpers.ts

@@ -114,6 +114,8 @@ function updateFromOrdhookInscriptionRevealed(args: {
       sat_rarity: satoshi.rarity,
       sat_coinbase_height: satoshi.blockHeight,
       recursive: recursive_refs.length > 0,
+      metadata: args.reveal.metadata ? JSON.stringify(args.reveal.metadata) : null,
+      parent: args.reveal.parent,
     },
     location: {
       block_hash: args.block_hash,

src/pg/pg-store.ts

@@ -26,10 +26,8 @@ import {
   DbInscriptionIndexFilters,
   DbInscriptionIndexOrder,
   DbInscriptionIndexPaging,
-  InscriptionData,
   DbInscriptionLocationChange,
   DbLocation,
-  RevealLocationData,
   DbLocationPointer,
   DbLocationPointerInsert,
   DbPaginatedResult,

src/pg/types.ts

@@ -20,6 +20,8 @@ export type InscriptionData = {
   sat_rarity: string;
   sat_coinbase_height: number;
   recursive: boolean;
+  metadata: string | null;
+  parent: string | null;
 };
 
 export type InscriptionInsert = InscriptionData;

tests/api/cache.test.ts

@@ -45,6 +45,11 @@ describe('ETag cache', () => {
         transfers_pre_inscription: 0,
         tx_index: 0,
         curse_type: null,
+        inscription_pointer: null,
+        delegate: null,
+        metaprotocol: null,
+        metadata: null,
+        parent: null,
       })
       .build();
     await db.updateInscriptions(block);
@@ -180,6 +185,11 @@ describe('ETag cache', () => {
         transfers_pre_inscription: 0,
         tx_index: 0,
         curse_type: null,
+        inscription_pointer: null,
+        delegate: null,
+        metaprotocol: null,
+        metadata: null,
+        parent: null,
       })
       .build();
     await db.updateInscriptions(block1);
@@ -208,6 +218,11 @@ describe('ETag cache', () => {
         transfers_pre_inscription: 0,
         tx_index: 0,
         curse_type: null,
+        inscription_pointer: null,
+        delegate: null,
+        metaprotocol: null,
+        metadata: null,
+        parent: null,
       })
       .build();
     await db.updateInscriptions(block2);
@@ -283,6 +298,11 @@ describe('ETag cache', () => {
         transfers_pre_inscription: 0,
         tx_index: 0,
         curse_type: null,
+        inscription_pointer: null,
+        delegate: null,
+        metaprotocol: null,
+        metadata: null,
+        parent: null,
       })
       .build();
     await db.updateInscriptions(block1);
@@ -330,6 +350,11 @@ describe('ETag cache', () => {
         transfers_pre_inscription: 0,
         tx_index: 0,
         curse_type: null,
+        inscription_pointer: null,
+        delegate: null,
+        metaprotocol: null,
+        metadata: null,
+        parent: null,
       })
       .build();
     await db.updateInscriptions(block2);
@@ -369,6 +394,11 @@ describe('ETag cache', () => {
         transfers_pre_inscription: 0,
         tx_index: 0,
         curse_type: null,
+        inscription_pointer: null,
+        delegate: null,
+        metaprotocol: null,
+        metadata: null,
+        parent: null,
       })
       .build();
     await db.updateInscriptions(block1);
@@ -416,6 +446,11 @@ describe('ETag cache', () => {
         transfers_pre_inscription: 0,
         tx_index: 0,
         curse_type: null,
+        inscription_pointer: null,
+        delegate: null,
+        metaprotocol: null,
+        metadata: null,
+        parent: null,
       })
       .build();
     await db.updateInscriptions(block2);