feat: number field in rune response (#35)

* add number field to Rune response * add number fetch to the sql * add test which actually exercises the rune response with number --------- Co-authored-by: brady.ouren <[email protected]>
hirosystems · Jul 29, 2024 · 4485057 · 4485057
1 parent ada15c7
commit 4485057
Show file tree

Hide file tree

Showing 5 changed files with 110 additions and 65 deletions.
diff --git a/api/src/api/schemas.ts b/api/src/api/schemas.ts
@@ -308,6 +308,7 @@ const RuneDetailResponseSchema = Type.Object({
   rune: Type.Object(
     {
       id: RuneIdResponseSchema,
+      number: RuneNumberResponseSchema,
       name: RuneNameResponseSchema,
       spaced_name: RuneSpacedNameResponseSchema,
     },

diff --git a/api/src/api/util/helpers.ts b/api/src/api/util/helpers.ts
@@ -68,6 +68,7 @@ export function parseActivityResponse(entry: DbItemWithRune<DbLedgerEntry>): Act
   return {
     rune: {
       id: entry.rune_id,
+      number: entry.number,
       name: entry.name,
       spaced_name: entry.spaced_name,
     },
@@ -91,6 +92,7 @@ export function parseBalanceResponse(item: DbItemWithRune<DbBalance>): BalanceRe
   return {
     rune: {
       id: item.rune_id,
+      number: item.number,
       name: item.name,
       spaced_name: item.spaced_name,
     },

diff --git a/api/src/pg/pg-store.ts b/api/src/pg/pg-store.ts
@@ -146,7 +146,7 @@ export class PgStore extends BasePgStore {
     const results = await this.sql<DbCountedQueryResult<DbItemWithRune<DbLedgerEntry>>[]>`
       WITH ${cte ? cte : this.sql`none AS (SELECT NULL)`},
       results AS (
-        SELECT l.*, r.name, r.spaced_name, r.divisibility, ${count} AS total
+        SELECT l.*, r.name, r.number, r.spaced_name, r.divisibility, ${count} AS total
         FROM ledger AS l
         INNER JOIN runes AS r ON r.id = l.rune_id
         WHERE ${filter}
@@ -222,7 +222,7 @@ export class PgStore extends BasePgStore {
   ): Promise<DbPaginatedResult<DbItemWithRune<DbBalance>>> {
     const results = await this.sql<DbCountedQueryResult<DbItemWithRune<DbBalance>>[]>`
       WITH grouped AS (
-        SELECT DISTINCT ON (b.address) b.address, b.balance, b.total_operations, b.rune_id, r.name,
+        SELECT DISTINCT ON (b.address) b.address, b.balance, b.total_operations, b.rune_id, r.name, r.number
           r.spaced_name, r.divisibility, COUNT(*) OVER() AS total
         FROM balance_changes AS b
         INNER JOIN runes AS r ON r.id = b.rune_id
@@ -245,7 +245,7 @@ export class PgStore extends BasePgStore {
   ): Promise<DbItemWithRune<DbBalance> | undefined> {
     const results = await this.sql<DbItemWithRune<DbBalance>[]>`
       SELECT b.rune_id, b.address, b.balance, b.total_operations, r.name,
-        r.spaced_name, r.divisibility, COUNT(*) OVER() AS total
+        r.number, r.spaced_name, r.divisibility, COUNT(*) OVER() AS total
       FROM balance_changes AS b
       INNER JOIN runes AS r ON r.id = b.rune_id
       WHERE ${runeFilter(this.sql, id, 'r')} AND address = ${address}
@@ -263,7 +263,7 @@ export class PgStore extends BasePgStore {
     const results = await this.sql<DbCountedQueryResult<DbItemWithRune<DbBalance>>[]>`
       WITH grouped AS (
         SELECT DISTINCT ON (b.rune_id) b.address, b.balance, b.total_operations, b.rune_id, r.name,
-          r.spaced_name, r.divisibility, COUNT(*) OVER() AS total
+          r.number, r.spaced_name, r.divisibility, COUNT(*) OVER() AS total
         FROM balance_changes AS b
         INNER JOIN runes AS r ON r.id = b.rune_id
         WHERE address = ${address}

diff --git a/api/src/pg/types.ts b/api/src/pg/types.ts
@@ -53,6 +53,7 @@ export type DbLedgerEntry = {
 
 export type DbItemWithRune<T> = T & {
   name: string;
+  number: number;
   spaced_name: string;
   divisibility: number;
   total_operations: number;

diff --git a/api/tests/api/api.test.ts b/api/tests/api/api.test.ts
@@ -12,7 +12,7 @@ import {
   sampleLedgerEntry,
 } from '../helpers';
 
-describe('Etchings', () => {
+describe('Endpoints', () => {
   let db: PgStore;
   let fastify: TestFastifyServer;
 
@@ -39,72 +39,113 @@ describe('Etchings', () => {
     await db.close();
   });
 
-  test('lists runes', async () => {
-    const expected = {
-      divisibility: 0,
-      id: '1:1',
-      location: {
-        block_hash: '0000000000000000000320283a032748cef8227873ff4872689bf23f1cda83a5',
-        block_height: 840000,
-        timestamp: 0,
-        tx_id: '2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e',
-        tx_index: 1,
-      },
-      mint_terms: {
-        amount: '100',
-        cap: '5000000',
-        height_end: null,
-        height_start: null,
-        offset_end: null,
-        offset_start: null,
-      },
-      name: 'Sample Rune',
-      number: 1,
-      spaced_name: 'Sample•Rune',
-      supply: {
-        burned: '0',
-        current: '0',
-        mint_percentage: '0.0000',
-        mintable: false,
-        minted: '0',
-        premine: '0',
-        total_burns: '0',
-        total_mints: '0',
-      },
-      symbol: 'ᚠ',
-      turbo: false,
-    };
-    const runesResponse = await fastify.inject({
-      method: 'GET',
-      url: '/runes/v1/etchings',
+  describe('Etchings', () => {
+    test('lists runes', async () => {
+      const expected = {
+        divisibility: 0,
+        id: '1:1',
+        location: {
+          block_hash: '0000000000000000000320283a032748cef8227873ff4872689bf23f1cda83a5',
+          block_height: 840000,
+          timestamp: 0,
+          tx_id: '2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e',
+          tx_index: 1,
+        },
+        mint_terms: {
+          amount: '100',
+          cap: '5000000',
+          height_end: null,
+          height_start: null,
+          offset_end: null,
+          offset_start: null,
+        },
+        name: 'Sample Rune',
+        number: 1,
+        spaced_name: 'Sample•Rune',
+        supply: {
+          burned: '0',
+          current: '0',
+          mint_percentage: '0.0000',
+          mintable: false,
+          minted: '0',
+          premine: '0',
+          total_burns: '0',
+          total_mints: '0',
+        },
+        symbol: 'ᚠ',
+        turbo: false,
+      };
+      const runesResponse = await fastify.inject({
+        method: 'GET',
+        url: '/runes/v1/etchings',
+      });
+      expect(runesResponse.statusCode).toBe(200);
+      expect(runesResponse.json().results).not.toHaveLength(0);
+
+      const response = await fastify.inject({
+        method: 'GET',
+        url: '/runes/v1/etchings/' + ledgerEntry.rune_id,
+      });
+      expect(response.statusCode).toBe(200);
+      expect(response.json()).toStrictEqual(expected);
     });
-    expect(runesResponse.statusCode).toBe(200);
-    expect(runesResponse.json().results).not.toHaveLength(0);
 
-    const response = await fastify.inject({
-      method: 'GET',
-      url: '/runes/v1/etchings/' + ledgerEntry.rune_id,
+    test('can fetch by spaced name', async () => {
+      const url = '/runes/v1/etchings/' + rune.spaced_name;
+      const response = await fastify.inject({
+        method: 'GET',
+        url: url,
+      });
+      expect(response.statusCode).toBe(200);
+      expect(response.json().spaced_name).toEqual(rune.spaced_name);
     });
-    expect(response.statusCode).toBe(200);
-    expect(response.json()).toStrictEqual(expected);
-  });
 
-  test('can fetch by spaced name', async () => {
-    const url = '/runes/v1/etchings/' + rune.spaced_name;
-    const response = await fastify.inject({
-      method: 'GET',
-      url: url,
+    test('can not fetch by spaced name if lacking bullets', async () => {
+      const url = '/runes/v1/etchings/' + rune.spaced_name.replaceAll('•', '-');
+      const response = await fastify.inject({
+        method: 'GET',
+        url: url,
+      });
+      expect(response.statusCode).toBe(400);
     });
-    expect(response.statusCode).toBe(200);
-    expect(response.json().spaced_name).toEqual(rune.spaced_name);
   });
-
-  test('can not fetch by spaced name if lacking bullets', async () => {
-    const url = '/runes/v1/etchings/' + rune.spaced_name.replaceAll('•', '-');
-    const response = await fastify.inject({
-      method: 'GET',
-      url: url,
+  describe('Transactions', () => {
+    test('shows details', async () => {
+      const expected = {
+        limit: 20,
+        offset: 0,
+        results: [
+          {
+            address: '0',
+            amount: '0',
+            location: {
+              block_hash: '0000000000000000000320283a032748cef8227873ff4872689bf23f1cda83a5',
+              block_height: 840000,
+              output: '2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e:0',
+              timestamp: 0,
+              tx_id: '2bb85f4b004be6da54f766c17c1e855187327112c231ef2ff35ebad0ea67c69e',
+              tx_index: 0,
+              vout: 0,
+            },
+            operation: 'etching',
+            receiver_address: '0',
+            rune: {
+              id: '1:1',
+              name: 'Sample Rune',
+              number: 1,
+              spaced_name: 'Sample•Rune',
+            },
+          },
+        ],
+        total: 1,
+      };
+      const txid = ledgerEntry.tx_id;
+      const response = await fastify.inject({
+        method: 'GET',
+        url: '/runes/v1/transactions/' + txid + '/activity',
+      });
+      expect(response.statusCode).toBe(200);
+      expect(response.json()).toStrictEqual(expected);
     });
-    expect(response.statusCode).toBe(400);
   });
 });