Added time to BlockInfo and new seedEtchings method for storage (#29)

Author: summraznboi

index.ts

@@ -9,6 +9,7 @@ import { Terms } from './src/terms';
 import { MAX_DIVISIBILITY } from './src/constants';
 
 export {
+  BlockIdentifier,
   BlockInfo,
   RuneBalance,
   RuneBlockIndex,

package.json

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

src/indexer/index.ts

@@ -2,6 +2,7 @@ import { RunestoneStorage, RunestoneIndexerOptions } from './types';
 import { Network } from '../network';
 import { BitcoinRpcClient } from '../rpcclient';
 import { RuneUpdater } from './updater';
+import { u128 } from '../integer';
 
 export * from './types';
 
@@ -35,6 +36,20 @@ export class RunestoneIndexer {
     if (this._pollIntervalMs !== null) {
       this._intervalId = setInterval(() => this.updateRuneUtxoBalances(), this._pollIntervalMs);
     }
+
+    if (this._network === Network.MAINNET) {
+      this._storage.seedEtchings([
+        {
+          rune: 'UNCOMMONGOODS',
+          runeId: { block: 1, tx: 0 },
+          txid: '0000000000000000000000000000000000000000000000000000000000000000',
+          valid: true,
+          spacers: [7],
+          symbol: '⧉',
+          terms: { amount: 1n, cap: u128.MAX, height: { start: 840000n, end: 1050000n } },
+        },
+      ]);
+    }
   }
 
   async stop(): Promise<void> {

src/indexer/types.ts

@@ -21,14 +21,20 @@ export interface RunestoneStorage {
   /**
    * Get the most recently indexed block's index and hash stored in IRunestoneStorage.
    */
-  getCurrentBlock(): Promise<BlockInfo | null>;
+  getCurrentBlock(): Promise<BlockIdentifier | null>;
 
   /**
    * Reset the most recent index block to a previous block height/hash by unindexing all blocks
    * following the specified block (this is used to handle reorgs).
    * @param block the block height and hash to reset current block to
    */
-  resetCurrentBlock(block: BlockInfo): Promise<void>;
+  resetCurrentBlock(block: BlockIdentifier): Promise<void>;
+
+  /**
+   * Seeds the database with any predefined etchings.
+   * @param etchings etchings to seed the database with
+   */
+  seedEtchings(etchings: RuneEtching[]): Promise<void>;
 
   /**
    * Save new utxo balances for the given block.
@@ -73,10 +79,14 @@ export type RunestoneIndexerOptions = {
   pollIntervalMs?: number;
 };
 
-export type BlockInfo = {
+export type BlockIdentifier = {
   height: number;
   hash: string;
+};
+
+export type BlockInfo = BlockIdentifier & {
   previousblockhash: string;
+  time: number;
 };
 
 export type RuneLocation = {

src/indexer/updater.ts

@@ -56,6 +56,7 @@ export class RuneUpdater implements RuneBlockIndex {
       height: block.height,
       hash: block.hash,
       previousblockhash: block.previousblockhash,
+      time: block.time,
     };
     this._minimum = Rune.getMinimumAtHeight(network, u128(block.height));
   }

test/updater.test.ts

@@ -8,7 +8,12 @@ import { OP_RETURN, TAPROOT_SCRIPT_PUBKEY_TYPE } from '../src/constants';
 import _ from 'lodash';
 
 function getDefaultRuneUpdaterContext() {
-  const block = { hash: 'hash', height: 100_000, previousblockhash: 'previousblockhash' };
+  const block = {
+    hash: 'hash',
+    height: 100_000,
+    previousblockhash: 'previousblockhash',
+    time: 123,
+  };
 
   const storage = mock<RunestoneStorage>();
   storage.getEtching.mockResolvedValue(null);