Merge pull request #52 from me-rob/rwei/utxo-based-spent-outputs

expand spent outputs to utxos

Author: Michael Yu

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magiceden-oss/runestone-lib",
-  "version": "0.9.6-alpha",
+  "version": "0.9.7-alpha",
   "description": "",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

src/indexer/types.ts

@@ -104,10 +104,7 @@ export namespace RuneLocation {
   }
 }
 
-export type RuneOutput = {
-  txid: string;
-  vout: number;
-};
+export type SpentRuneUtxoBalance = RuneUtxoBalance & { mempoolTxid: string };
 
 export type RuneUtxoBalance = {
   txid: string;
@@ -156,6 +153,6 @@ export type RuneBlockIndex = {
   etchings: RuneEtching[];
   mintCounts: RuneMintCount[];
   utxoBalances: RuneUtxoBalance[];
-  spentOutputs: RuneOutput[];
+  spentBalances: SpentRuneUtxoBalance[];
   burnedBalances: RuneBalance[];
 };

src/indexer/updater.ts

@@ -12,18 +12,18 @@ import { BitcoinRpcClient } from '../rpcclient';
 import { Rune } from '../rune';
 import { Runestone } from '../runestone';
 import { script } from '../script';
+import { SpacedRune } from '../spacedrune';
 import {
   BlockInfo,
-  RuneBlockIndex,
   RuneBalance,
+  RuneBlockIndex,
   RuneEtching,
   RuneLocation,
   RuneMintCount,
-  RuneOutput,
   RuneUtxoBalance,
   RunestoneStorage,
+  SpentRuneUtxoBalance,
 } from './types';
-import { SpacedRune } from '../spacedrune';
 
 function isScriptPubKeyHexOpReturn(scriptPubKeyHex: string) {
   return scriptPubKeyHex && Buffer.from(scriptPubKeyHex, 'hex')[0] === OP_RETURN;
@@ -39,7 +39,7 @@ export class RuneUpdater implements RuneBlockIndex {
   block: BlockInfo;
   etchings: RuneEtching[] = [];
   utxoBalances: RuneUtxoBalance[] = [];
-  spentOutputs: RuneOutput[] = [];
+  spentBalances: SpentRuneUtxoBalance[] = [];
 
   private _minimum: Rune;
   private _mintCountsByRuneLocation: Map<string, RuneMintCount> = new Map();
@@ -446,13 +446,22 @@ export class RuneUpdater implements RuneBlockIndex {
       const utxoBalance =
         utxoBalancesByOutputLocation.get(`${input.txid}:${input.vout}`) ??
         (await this._storage.getUtxoBalance(input.txid, input.vout));
-      this.spentOutputs.push({ txid: input.txid, vout: input.vout });
       for (const additionalBalance of utxoBalance) {
         const runeId = additionalBalance.runeId;
         const runeLocation = RuneLocation.toString(runeId);
         const balance = unallocated.get(runeLocation) ?? { runeId, amount: 0n };
         unallocated.set(runeLocation, balance);
         balance.amount = u128.checkedAddThrow(u128(balance.amount), u128(additionalBalance.amount));
+        this.spentBalances.push({
+          txid: input.txid,
+          vout: input.vout,
+          address: additionalBalance.address,
+          scriptPubKey: additionalBalance.scriptPubKey,
+          runeId: additionalBalance.runeId,
+          runeTicker: additionalBalance.runeTicker,
+          amount: additionalBalance.amount,
+          mempoolTxid: tx.txid,
+        });
       }
     }
 

test/updater.test.ts

@@ -882,6 +882,7 @@ describe('edict', () => {
     await runeUpdater.indexRunes(tx2, 89);
     expect(runeUpdater.etchings.length).toBe(0);
     expect(runeUpdater.utxoBalances.length).toBe(2);
+    expect(runeUpdater.spentBalances.length).toBe(2);
     expect(runeUpdater.utxoBalances[0]).toMatchObject({
       txid: 'txid',
       vout: 1,
@@ -902,10 +903,31 @@ describe('edict', () => {
       },
       amount: 400n,
     });
-    expect(runeUpdater.spentOutputs).toEqual([
-      { txid: 'parenttxid', vout: 0 },
-      { txid: 'txid', vout: 1 },
-    ]);
+    expect(runeUpdater.spentBalances[0]).toMatchObject({
+      txid: 'parenttxid',
+      vout: 0,
+      address: '3P4WqXDbSLRhzo2H6MT6YFbvBKBDPLbVtQ',
+      scriptPubKey: Buffer.from('a914ea6b832a05c6ca578baa3836f3f25553d41068a587', 'hex'),
+      runeId: {
+        block: 888,
+        tx: 8,
+      },
+      runeTicker: 'TESTRUNE',
+      amount: 400n,
+      mempoolTxid: 'txid',
+    });
+    expect(runeUpdater.spentBalances[1]).toMatchObject({
+      txid: 'txid',
+      vout: 1,
+      address: '3P4WqXDbSLRhzo2H6MT6YFbvBKBDPLbVtQ',
+      runeId: {
+        block: 888,
+        tx: 8,
+      },
+      runeTicker: 'TESTRUNE',
+      amount: 400n,
+      mempoolTxid: 'childtxid',
+    });
   });
 
   test('edict with invalid output is cenotaph', async () => {