feat(api): return inscription charms in responses (#435)

* add to schema

* test: values

Author: rafaelcr

api/ordinals/src/api/schemas.ts

@@ -342,6 +342,7 @@ export const InscriptionResponse = Type.Object(
         examples: ['brc20'],
       })
     ),
+    charms: Type.Array(Type.String({ examples: ['coin', 'palindrome', 'vindicated'] })),
   },
   { title: 'Inscription Response' }
 );

api/ordinals/src/api/util/helpers.ts

@@ -31,6 +31,37 @@ function parseTimestamp(timestamp: number): number {
   return timestamp * 1000;
 }
 
+enum Charm {
+  coin = 0,
+  cursed = 1,
+  epic = 2,
+  legendary = 3,
+  lost = 4,
+  nineball = 5,
+  rare = 6,
+  reinscription = 7,
+  unbound = 8,
+  uncommon = 9,
+  vindicated = 10,
+  mythic = 11,
+  burned = 12,
+  palindrome = 13,
+}
+
+function parseCharms(charms: string): string[] {
+  const charmsVal = parseInt(charms);
+  const result: Charm[] = [];
+  for (const charm in Charm) {
+    if (!isNaN(Number(charm))) {
+      const charmValue = Number(charm);
+      if (charmsVal & (1 << charmValue)) {
+        result.push(charmValue as Charm);
+      }
+    }
+  }
+  return result.map(charm => Charm[charm]);
+}
+
 export function parseDbInscriptions(
   items: DbFullyLocatedInscriptionResult[]
 ): InscriptionResponseType[] {
@@ -63,6 +94,7 @@ export function parseDbInscriptions(
     metadata: i.metadata ? JSON.parse(i.metadata) : null,
     delegate: i.delegate ?? null,
     meta_protocol: i.metaprotocol ?? null,
+    charms: parseCharms(i.charms),
   }));
 }
 export function parseDbInscription(item: DbFullyLocatedInscriptionResult): InscriptionResponseType {

api/ordinals/src/pg/pg-store.ts

@@ -190,6 +190,7 @@ export class PgStore extends BasePgStore {
             i.tx_index AS genesis_tx_index,
             i.timestamp AS genesis_timestamp,
             i.address AS genesis_address,
+            i.charms,
             cur.address,
             cur.tx_index,
             cur.block_height,

api/ordinals/src/pg/types.ts

@@ -37,6 +37,7 @@ export type DbFullyLocatedInscriptionResult = {
   pointer: number | null;
   metaprotocol: string | null;
   delegate: string | null;
+  charms: string;
 };
 
 export type DbLocation = {

api/ordinals/tests/api/cache.test.ts

@@ -65,6 +65,7 @@ describe('ETag cache', () => {
       transfer_type: 'transferred',
       rarity: 'common',
       coinbase_height: '9000',
+      charms: 0,
     });
     const response = await fastify.inject({
       method: 'GET',
@@ -165,6 +166,7 @@ describe('ETag cache', () => {
       prev_offset: null,
       transfer_type: 'transferred',
       rarity: 'common',
+      charms: 0,
     });
     await inscriptionReveal(db.sql, {
       content: '0x48656C6C6F',
@@ -197,6 +199,7 @@ describe('ETag cache', () => {
       prev_offset: null,
       transfer_type: 'transferred',
       rarity: 'common',
+      charms: 0,
     });
 
     // ETag response
@@ -277,6 +280,7 @@ describe('ETag cache', () => {
       prev_offset: null,
       transfer_type: 'transferred',
       rarity: 'common',
+      charms: 0,
     });
 
     // ETag response
@@ -328,6 +332,7 @@ describe('ETag cache', () => {
       prev_offset: null,
       transfer_type: 'transferred',
       rarity: 'common',
+      charms: 0,
     });
 
     // Cache busted
@@ -371,6 +376,7 @@ describe('ETag cache', () => {
       prev_offset: null,
       transfer_type: 'transferred',
       rarity: 'common',
+      charms: 0,
     });
 
     // ETag response
@@ -422,6 +428,7 @@ describe('ETag cache', () => {
       prev_offset: null,
       transfer_type: 'transferred',
       rarity: 'common',
+      charms: 0,
     });
 
     // Cache busted