@rosen-bridge/abstract-extractor 1.0.2 → 2.0.0-8792333e

package/lib/ergo/AbstractErgoExtractor.ts

@@ -2,19 +2,22 @@ import { AbstractLogger, DummyLogger } from '@rosen-bridge/abstract-logger';
 import JsonBigInt from '@rosen-bridge/json-bigint';
 import { Mutex } from 'await-semaphore';
 import { v4 as uuidv4 } from 'uuid';
-
-import { AbstractExtractor } from '../AbstractExtractor';
-import { AbstractErgoExtractorAction } from './AbstractErgoExtractorAction';
-import { BlockInfo } from '../interfaces';
 import {
   Transaction,
   OutputBox,
+  InputExtension,
+  AbstractExtractor,
+  BlockInfo,
+} from '@rosen-bridge/scanner-interfaces';
+
+import { AbstractErgoExtractorAction } from './AbstractErgoExtractorAction';
+import {
   AbstractBoxData,
   SpendInfo,
   CallbackType,
   CallbackMap,
   CallbackDataMap,
-  InputExtension,
+  TxExtra,
 } from './interfaces';
 import { AbstractErgoExtractorEntity } from './AbstractErgoExtractorEntity';
 
@@ -105,7 +108,8 @@ export abstract class AbstractErgoExtractor<
    */
   abstract extractBoxData: (
     box: OutputBox,
-    inputExtensions: InputExtension[]
+    inputExtensions: InputExtension[],
+    txExtra?: TxExtra
   ) => ExtractedData | undefined;
 
   /**
@@ -115,6 +119,31 @@ export abstract class AbstractErgoExtractor<
    */
   abstract hasData: (box: OutputBox) => boolean;
 
+  /**
+   * create spend info array for the transaction
+   * @param tx
+   * @returns spend info array of the transaction
+   */
+  getTransactionSpendInfo = (tx: Transaction) => {
+    let boxIndex = 1;
+    const spendInfoArray = [];
+    for (const input of tx.inputs) {
+      spendInfoArray.push({ txId: tx.id, boxId: input.boxId, index: boxIndex });
+      boxIndex += 1;
+    }
+    return spendInfoArray;
+  };
+
+  /**
+   * extract transaction extra information
+   * override this function if there is extra needed information
+   * @param tx
+   * @returns
+   */
+  getTransactionExtraData = (tx: Transaction): TxExtra | undefined => {
+    return undefined;
+  };
+
   /**
    * process a list of transactions in a block and store required information
    * @param txs list of transactions in the block
@@ -135,7 +164,11 @@ export abstract class AbstractErgoExtractor<
             continue;
           }
           this.logger.debug(`Trying to extract data from box ${output.boxId}`);
-          const extractedData = this.extractBoxData(output, inputExtensions);
+          const extractedData = this.extractBoxData(
+            output,
+            inputExtensions,
+            this.getTransactionExtraData(tx)
+          );
           if (extractedData) {
             this.logger.debug(
               `Extracted data ${JsonBigInt.stringify(extractedData)} from box ${
@@ -145,11 +178,7 @@ export abstract class AbstractErgoExtractor<
             boxes.push(extractedData);
           }
         }
-        let boxIndex = 1;
-        for (const input of tx.inputs) {
-          spentInfos.push({ txId: tx.id, boxId: input.boxId, index: boxIndex });
-          boxIndex += 1;
-        }
+        spentInfos.push(...this.getTransactionSpendInfo(tx));
       }
 
       if (boxes.length > 0) {

package/lib/ergo/AbstractErgoExtractorAction.ts

@@ -10,8 +10,8 @@ import {
 import { chunk, difference, pick } from 'lodash-es';
 import { AbstractLogger, DummyLogger } from '@rosen-bridge/abstract-logger';
 import JsonBigInt from '@rosen-bridge/json-bigint';
+import { BlockInfo } from '@rosen-bridge/scanner-interfaces';
 
-import { BlockInfo } from '../interfaces';
 import { AbstractBoxData, BoxInfo, SpendInfo } from './interfaces';
 import { DB_CHUNK_SIZE } from '../constants';
 import { AbstractErgoExtractorEntity } from './AbstractErgoExtractorEntity';

package/lib/ergo/initializable/AbstractInitializable.ts

@@ -1,15 +1,11 @@
 import { AbstractLogger } from '@rosen-bridge/abstract-logger';
 import { groupBy, sortBy } from 'lodash-es';
+import { BlockInfo, ErgoNetworkType } from '@rosen-bridge/scanner-interfaces';
 
-import {
-  AbstractBoxData,
-  ErgoNetworkType,
-  ExtendedTransaction,
-} from '../interfaces';
+import { AbstractBoxData, ExtendedTransaction } from '../interfaces';
 import { API_LIMIT, RETRIAL_COUNT } from '../../constants';
 import { AbstractErgoExtractor } from '../AbstractErgoExtractor';
 import { AbstractInitializableErgoExtractorAction } from './AbstractInitializableAction';
-import { BlockInfo } from '../../interfaces';
 import { ExplorerNetwork } from '../network/ExplorerNetwork';
 import { NodeNetwork } from '../network/NodeNetwork';
 import { AbstractErgoExtractorEntity } from '../AbstractErgoExtractorEntity';

package/lib/ergo/interfaces.ts

@@ -1,45 +1,4 @@
-export enum ErgoNetworkType {
-  Explorer = 'explorer',
-  Node = 'node',
-}
-
-export type InputExtension = {
-  [key: string]: string;
-};
-
-export type InputBox = {
-  boxId: string;
-  extension?: InputExtension;
-};
-
-export type DataInput = {
-  boxId: string;
-};
-
-export type Asset = {
-  tokenId: string;
-  amount: bigint;
-};
-
-export type AdditionalRegisters = {
-  R4?: string;
-  R5?: string;
-  R6?: string;
-  R7?: string;
-  R8?: string;
-  R9?: string;
-};
-
-export type OutputBox = {
-  boxId: string;
-  value: bigint;
-  ergoTree: string;
-  creationHeight: number;
-  assets: Array<Asset>;
-  additionalRegisters: AdditionalRegisters;
-  transactionId: string;
-  index: number;
-};
+import { OutputBox, Transaction } from '@rosen-bridge/scanner-interfaces';
 
 export interface ErgoBox extends OutputBox {
   blockId: string;
@@ -50,14 +9,6 @@ export interface ErgoBox extends OutputBox {
   spentIndex?: number;
 }
 
-export type Transaction = {
-  id: string;
-  inputs: Array<InputBox>;
-  dataInputs: Array<DataInput>;
-  outputs: Array<OutputBox>;
-  size?: bigint;
-};
-
 export interface ExtendedTransaction extends Transaction {
   inclusionHeight: number;
   blockId: string;
@@ -67,7 +18,7 @@ export interface SpendInfo {
   boxId: string;
   txId: string;
   index: number;
-  extras?: string[];
+  extras?: { [key: string]: string };
 }
 
 export interface AbstractBoxData {
@@ -96,3 +47,5 @@ export type CallbackDataMap<ExtractedData extends AbstractBoxData> = {
 export type CallbackMap<ExtractedData extends AbstractBoxData> = {
   [K in CallbackType]: (data: CallbackDataMap<ExtractedData>[K]) => void;
 };
+
+export type TxExtra = { [key: string]: string };

package/lib/ergo/network/ExplorerNetwork.ts

@@ -1,9 +1,9 @@
 import ergoExplorerClientFactory from '@rosen-clients/ergo-explorer';
 import { AbstractNetwork } from './AbstractNetwork';
 import { V1 } from '@rosen-clients/ergo-explorer';
+import { BlockInfo, Transaction } from '@rosen-bridge/scanner-interfaces';
 
-import { BlockInfo } from '../../interfaces';
-import { ErgoBox, ExtendedTransaction, Transaction } from '../interfaces';
+import { ErgoBox, ExtendedTransaction } from '../interfaces';
 import { mapValues, pick } from 'lodash-es';
 import { API_LIMIT } from '../../constants';
 

package/lib/ergo/network/NodeNetwork.ts

@@ -2,8 +2,8 @@ import ergoNodeClientFactory, {
   IndexedErgoBox,
   IndexedErgoTransaction,
 } from '@rosen-clients/ergo-node';
+import { BlockInfo } from '@rosen-bridge/scanner-interfaces';
 
-import { BlockInfo } from '../../interfaces';
 import { ErgoBox, ExtendedTransaction } from '../interfaces';
 import { AbstractNetwork } from './AbstractNetwork';
 

package/lib/ergo/utils.ts

@@ -1,5 +1,5 @@
 import { intersection } from 'lodash-es';
-import { OutputBox } from './interfaces';
+import { OutputBox } from '@rosen-bridge/scanner-interfaces';
 
 /**
  * Check box to have specified tokens

package/lib/index.ts

@@ -1,4 +1,2 @@
-export * from './interfaces';
 export * from './ergo';
-export * from './AbstractExtractor';
 export * from './constants';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rosen-bridge/abstract-extractor",
-  "version": "1.0.2",
+  "version": "2.0.0-8792333e",
   "description": "Rosen Bridge extractor interfaces to work with scanner",
   "repository": "",
   "license": "GPL-3.0",
@@ -38,6 +38,7 @@
   "dependencies": {
     "@rosen-bridge/abstract-logger": "^2.0.1",
     "@rosen-bridge/json-bigint": "^0.1.0",
+    "@rosen-bridge/scanner-interfaces": "^0.1.0-8792333e",
     "@rosen-clients/ergo-explorer": "^1.1.2",
     "@rosen-clients/ergo-node": "^1.2.0",
     "lodash-es": "^4.17.21",

package/tests/AbstractErgoExtractor.mock.ts

@@ -1,8 +1,8 @@
 import { V1 } from '@rosen-clients/ergo-explorer';
+import { BlockInfo, OutputBox } from '@rosen-bridge/scanner-interfaces';
+
 import {
   AbstractErgoExtractor,
-  BlockInfo,
-  OutputBox,
   AbstractBoxData,
   AbstractErgoExtractorAction,
   AbstractErgoExtractorEntity,

package/tests/AbstractErgoExtractor.spec.ts

@@ -1,8 +1,8 @@
 import { V1 } from '@rosen-clients/ergo-explorer';
 import { describe, it, expect, vitest } from 'vitest';
+import { OutputBox } from '@rosen-bridge/scanner-interfaces';
 
 import {
-  OutputBox,
   AbstractBoxData,
   AbstractErgoExtractorAction,
   CallbackType,
@@ -49,10 +49,11 @@ describe('AbstractErgoExtractor', () => {
       const result = await extractor.processTransactions([tx], block);
 
       expect(extractSpy).toBeCalledTimes(1);
-      expect(extractSpy).toBeCalledWith(tx.outputs[0], [
-        tx.inputs[0].extension,
-        {},
-      ]);
+      expect(extractSpy).toBeCalledWith(
+        tx.outputs[0],
+        [tx.inputs[0].extension, {}],
+        undefined
+      );
       expect(storeSpy).toBeCalledWith([extractedData], block, 'Test');
       expect(result).toEqual(true);
       expect(triggerCallbacks).toBeCalledWith(CallbackType.Insert, [

package/tests/AbstractErgoExtractorAction.mock.ts

@@ -1,10 +1,10 @@
 import { DataSource } from 'typeorm';
 import { pick } from 'lodash-es';
+import { BlockInfo } from '@rosen-bridge/scanner-interfaces';
 
 import {
   AbstractErgoExtractorAction,
   AbstractErgoExtractorEntity,
-  BlockInfo,
   AbstractBoxData,
 } from '../lib';
 import { TestEntity } from './testUtils';

package/tests/initializable/AbstractInitializable.mock.ts

@@ -1,14 +1,11 @@
 import { V1 } from '@rosen-clients/ergo-explorer';
+import { BlockInfo, OutputBox } from '@rosen-bridge/scanner-interfaces';
+
 import {
   AbstractInitializableErgoExtractor,
   AbstractInitializableErgoExtractorAction,
 } from '../../lib/ergo/initializable';
-import {
-  OutputBox,
-  AbstractBoxData,
-  BlockInfo,
-  AbstractErgoExtractorEntity,
-} from '../../lib';
+import { AbstractBoxData, AbstractErgoExtractorEntity } from '../../lib';
 import { ergoBoxes } from './testData';
 
 export class MockedInitializableErgoExtractor extends AbstractInitializableErgoExtractor<

package/tests/initializable/AbstractInitializable.spec.ts

@@ -1,7 +1,7 @@
 import { describe, expect, it, vi, vitest } from 'vitest';
+import { ErgoNetworkType } from '@rosen-bridge/scanner-interfaces';
 
 import {
-  ErgoNetworkType,
   NodeNetwork,
   AbstractBoxData,
   ExplorerNetwork,

package/tests/initializable/AbstractInitializableAction.mock.ts

@@ -1,9 +1,9 @@
 import { DataSource } from 'typeorm';
 import { pick } from 'lodash-es';
+import { BlockInfo } from '@rosen-bridge/scanner-interfaces';
 
 import {
   AbstractErgoExtractorEntity,
-  BlockInfo,
   AbstractBoxData,
   AbstractInitializableErgoExtractorAction,
 } from '../../lib';

package/tests/testData.ts

@@ -1,4 +1,5 @@
-import { Block, InputExtension } from '../lib';
+import { Block, InputExtension } from '@rosen-bridge/scanner-interfaces';
+
 import { TestEntity } from './testUtils';
 
 export const tx = {

package/tsconfig.build.json

@@ -3,5 +3,6 @@
   "compilerOptions": {
     "rootDir": "./lib"
   },
-  "exclude": ["tests", "vitest.config.ts"]
+  "exclude": ["tests", "vitest.config.ts"],
+  "references": [{ "path": "../scanner-interfaces/tsconfig.build.json" }]
 }