@my-packages-changeit/abstract-extractor 3.2.3

package/CHANGELOG.md

@@ -0,0 +1,225 @@
+# @rosen-bridge/abstract-extractor
+
+## 3.2.3
+
+### Patch Changes
+
+- Replace `await-semaphore` with `@rosen-bridge/semaphore` package
+
+## 3.2.2
+
+### Patch Changes
+
+- Update dependencies
+  - @rosen-clients/ergo-explorer@2.1.3
+  - @rosen-clients/ergo-node@3.1.3
+
+## 3.2.1
+
+### Patch Changes
+
+- Make `fromHeight` and `toHeight` required in `hasEventInHeightRange`.
+
+## 3.2.0
+
+### Minor Changes
+
+- Add `hasEventInHeightRange` function to `AbstractExtractor` which is utilized by the fast-forward feature in scanners
+
+### Patch Changes
+
+- Update dependencies
+  - @rosen-bridge/scanner-interfaces@1.0.0
+  - uuid@11.1.1
+
+## 3.1.2
+
+### Patch Changes
+
+- Update dependencies
+  - @rosen-bridge/extended-typeorm@1.1.0
+
+## 3.1.1
+
+### Patch Changes
+
+- Update dependencies
+  - @rosen-clients/ergo-explorer@2.1.2
+  - @rosen-clients/ergo-node@3.1.2
+
+## 3.1.0
+
+### Minor Changes
+
+- Add block parameter to the AbstractErgoTxExtractor.extractTxData method
+
+## 3.0.1
+
+### Patch Changes
+
+- Add `spendingProof` to input box interface
+- Update dependencies
+  - @rosen-bridge/scanner-interfaces@0.2.2
+
+## 3.0.0
+
+### Major Changes
+
+- Update AbstractExtractor interface; use `BlockInfo` in `processTransactions` and rename `initializeBoxes` to `initializeData`
+- Update abstract entities and actions to have a new abstraction level, seperating box-based logic from general extraction
+- Update `AbstractErgoExtractor` to use a tx-based data extraction method and add `AbstractErgoBoxExtractor` for box-based data extraction
+- Update AbstractExtractor interface; add `createUsedBlocksQuery` method that returns the query for used blocks
+- Update abstract database entity to be general; rename `boxId` columnt to `identifier`
+
+### Patch Changes
+
+- Update dependencies
+  - @rosen-bridge/abstract-logger@4.0.0
+
+## 2.1.2
+
+### Patch Changes
+
+- Fix package-lock and move typescript and types/node into root
+- Update eslint and plugins:
+  - Apply new rules such as sort imports and file name
+- Update dependencies
+  - @rosen-bridge/scanner-interfaces@0.2.1
+  - @rosen-bridge/abstract-scanner@0.2.1
+  - @rosen-bridge/extended-typeorm@1.0.1
+  - @rosen-clients/rate-limited-axios@1.1.0
+  - @rosen-bridge/rosen-extractor@10.1.1
+  - @rosen-bridge/tokens@4.0.1
+  - @rosen-bridge/abstract-logger@3.0.1
+  - @rosen-bridge/json-bigint@1.1.0
+  - @rosen-clients/ergo-explorer@2.1.0
+  - @rosen-clients/ergo-node@3.1.0
+
+## 2.1.1
+
+### Patch Changes
+
+- Update dependencies
+  - @rosen-bridge/extended-typeorm@1.0.0
+  - @rosen-bridge/abstract-logger@3.0.0
+  - @rosen-bridge/json-bigint@1.0.0
+  - @rosen-clients/ergo-explorer@2.0.0
+  - @rosen-clients/ergo-node@3.0.0
+
+## 2.1.0
+
+### Minor Changes
+
+- Upgrade to Node.js version 22.18.0
+
+### Patch Changes
+
+- Update dependencies
+  - @rosen-bridge/scanner-interfaces@0.2.0
+
+## 2.0.3
+
+### Patch Changes
+
+- Update package license to MIT
+- Update dependencies
+  - @rosen-bridge/scanner-interfaces@0.1.1
+
+## 2.0.2
+
+### Patch Changes
+
+- Update network clients and ethers and rateLimitedAxios packages
+
+## 2.0.1
+
+### Patch Changes
+
+- Use rate limiting methods using @rosen-bridge/rate-limited-axios to prevent overwhelming the endpoints
+
+## 2.0.0
+
+### Major Changes
+
+- Unify and move shared interfaces and update all package dependencies
+- Update extra information interfaces and extraction functions
+
+## 1.0.2
+
+### Patch Changes
+
+- Add input box extension to network api interfaces
+- Refactor query logic in abstract ergo extractor actions
+
+## 1.0.1
+
+### Patch Changes
+
+- Update node version to 20
+- Update logger package
+
+## 1.0.0
+
+### Major Changes
+
+- Move database action shared logic to abstract class
+- Add callback support to abstract ergo extractor and update abstract db action interface
+
+### Patch Changes
+
+- Ensure initialization with the node is stateful and resilient to network issues
+- Fix `processTransaction` to return false if data insertion encounters error
+- Modify the initialization procedure to retry upon failure
+
+## 0.3.1
+
+### Patch Changes
+
+- Remove unnecessary properties from abstract extracted data type
+- Add extras field to store extra information for spending
+
+## 0.3.0
+
+### Minor Changes
+
+- Add abstract extractor class that can be initialized using address transactions.
+
+### Patch Changes
+
+- Change processTransaction Block interface to use minimal information
+
+## 0.2.0
+
+### Minor Changes
+
+- Add spendIndex to extracted data in initialization
+
+## 0.1.5
+
+### Patch Changes
+
+- fix storing duplicate boxes
+
+## 0.1.4
+
+### Patch Changes
+
+- prevent to store multiple boxes on initialize
+
+## 0.1.3
+
+### Patch Changes
+
+- switch to using unspent boxes for initialization
+
+## 0.1.2
+
+### Patch Changes
+
+- fix spend info extraction in initialize process
+
+## 0.1.1
+
+### Patch Changes
+
+- Export constants and AbstractNetwork interface

package/README.md

@@ -0,0 +1,24 @@
+# extractor
+
+## Table of contents
+
+- [Introduction](#introduction)
+- [Installation](#installation)
+
+## Introduction
+
+Rosen Bridge extractor interfaces to work with scanner
+
+## Installation
+
+npm:
+
+```sh
+npm i @rosen-bridge/abstract-extractor
+```
+
+yarn:
+
+```sh
+yarn add @rosen-bridge/abstract-extractor
+```

package/dist/abstractExtractor.d.ts

@@ -0,0 +1,59 @@
+import { ObjectLiteral, SelectQueryBuilder } from '@rosen-bridge/extended-typeorm';
+import { BlockInfo } from '@rosen-bridge/scanner-interfaces';
+export declare abstract class AbstractExtractor<TransactionType, ExtractorEntity extends ObjectLiteral> {
+    /**
+     * Process a list of transactions (or other blockchain data) in a block and store required information.
+     * This method is the core of the extraction process and should be implemented to handle
+     * the specific data extraction logic for your blockchain.
+     *
+     * @param txs - List of transactions or blockchain data structures in the block
+     * @param block - Block information containing metadata about the block
+     * @returns Promise<boolean> - true if the process completed successfully, false otherwise
+     */
+    abstract processTransactions: (txs: Array<TransactionType>, block: BlockInfo) => Promise<boolean>;
+    /**
+     * Return a unique identifier for this extractor.
+     * This ID must be unique across all extractors in the system to prevent conflicts.
+     *
+     * @returns string - Unique extractor identifier
+     */
+    abstract getId: () => string;
+    /**
+     * Fork (rollback) one block and remove all stored information for this block.
+     * This is essential for handling blockchain reorganizations where blocks
+     * need to be removed from the database.
+     *
+     * @param hash - Block hash to fork/remove
+     */
+    abstract forkBlock: (hash: string) => Promise<void>;
+    /**
+     * Initialize extractor database with historical data created below the initial height.
+     * This method is called during extractor setup to populate the database with
+     * data that existed before the scanner started monitoring.
+     *
+     * @param initialBlock - The block from which to start scanning (initial height)
+     */
+    abstract initializeData: (initialBlock: BlockInfo) => Promise<void>;
+    /**
+     * hasEventInHeightRange used by the scanner's fast-forward mechanism.
+     * During a large sync, instead of fetching and processing thousands of blocks one by one,
+     * the scanner checks this method. If an external API or node can confirm that *no relevant events*
+     * exist in the `[fromHeight, toHeight]` range, return `false`. The scanner will then skip fetching
+     * these blocks entirely, vastly improving sync speed.
+     * Returns `true`, forcing the scanner to safely process every single block sequentially.
+     *
+     * @param fromHeight - The starting block height of the chunk being evaluated.
+     * @param toHeight - The ending block height of the chunk.
+     * @returns {Promise<boolean>} `true` if events exist (or if unknown). `false` ONLY if it's guaranteed the range is empty.
+     */
+    hasEventInHeightRange: (fromHeight: number, toHeight: number) => Promise<boolean>;
+    /**
+     * Create a query for used blocks associated with the given `extractorId`
+     * This method only builds the query and does not execute it
+     *
+     * @returns A TypeORM SelectQueryBuilder that selects used block values or
+     * `undefined` if the extractor has no associated entity
+     */
+    abstract createUsedBlocksQuery: () => SelectQueryBuilder<ExtractorEntity> | undefined;
+}
+//# sourceMappingURL=abstractExtractor.d.ts.map

package/dist/abstractExtractor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstractExtractor.d.ts","sourceRoot":"","sources":["../lib/abstractExtractor.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,kBAAkB,EACnB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAE7D,8BAAsB,iBAAiB,CACrC,eAAe,EACf,eAAe,SAAS,aAAa;IAErC;;;;;;;;OAQG;IACH,QAAQ,CAAC,mBAAmB,EAAE,CAC5B,GAAG,EAAE,KAAK,CAAC,eAAe,CAAC,EAC3B,KAAK,EAAE,SAAS,KACb,OAAO,CAAC,OAAO,CAAC,CAAC;IAEtB;;;;;OAKG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,MAAM,CAAC;IAE7B;;;;;;OAMG;IACH,QAAQ,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpD;;;;;;OAMG;IACH,QAAQ,CAAC,cAAc,EAAE,CAAC,YAAY,EAAE,SAAS,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpE;;;;;;;;;;;OAWG;IACI,qBAAqB,GAE1B,YAAY,MAAM,EAElB,UAAU,MAAM,KACf,OAAO,CAAC,OAAO,CAAC,CAEjB;IAEF;;;;;;OAMG;IACH,QAAQ,CAAC,qBAAqB,EAAE,MAC5B,kBAAkB,CAAC,eAAe,CAAC,GACnC,SAAS,CAAC;CACf"}

package/dist/abstractExtractor.js

@@ -0,0 +1,22 @@
+export class AbstractExtractor {
+    /**
+     * hasEventInHeightRange used by the scanner's fast-forward mechanism.
+     * During a large sync, instead of fetching and processing thousands of blocks one by one,
+     * the scanner checks this method. If an external API or node can confirm that *no relevant events*
+     * exist in the `[fromHeight, toHeight]` range, return `false`. The scanner will then skip fetching
+     * these blocks entirely, vastly improving sync speed.
+     * Returns `true`, forcing the scanner to safely process every single block sequentially.
+     *
+     * @param fromHeight - The starting block height of the chunk being evaluated.
+     * @param toHeight - The ending block height of the chunk.
+     * @returns {Promise<boolean>} `true` if events exist (or if unknown). `false` ONLY if it's guaranteed the range is empty.
+     */
+    hasEventInHeightRange = async (
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    fromHeight, 
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    toHeight) => {
+        return true;
+    };
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWJzdHJhY3RFeHRyYWN0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9saWIvYWJzdHJhY3RFeHRyYWN0b3IudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBTUEsTUFBTSxPQUFnQixpQkFBaUI7SUE0Q3JDOzs7Ozs7Ozs7OztPQVdHO0lBQ0kscUJBQXFCLEdBQUcsS0FBSztJQUNsQyw2REFBNkQ7SUFDN0QsVUFBa0I7SUFDbEIsNkRBQTZEO0lBQzdELFFBQWdCLEVBQ0UsRUFBRTtRQUNwQixPQUFPLElBQUksQ0FBQztJQUNkLENBQUMsQ0FBQztDQVlIIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHtcbiAgT2JqZWN0TGl0ZXJhbCxcbiAgU2VsZWN0UXVlcnlCdWlsZGVyLFxufSBmcm9tICdAcm9zZW4tYnJpZGdlL2V4dGVuZGVkLXR5cGVvcm0nO1xuaW1wb3J0IHsgQmxvY2tJbmZvIH0gZnJvbSAnQHJvc2VuLWJyaWRnZS9zY2FubmVyLWludGVyZmFjZXMnO1xuXG5leHBvcnQgYWJzdHJhY3QgY2xhc3MgQWJzdHJhY3RFeHRyYWN0b3I8XG4gIFRyYW5zYWN0aW9uVHlwZSxcbiAgRXh0cmFjdG9yRW50aXR5IGV4dGVuZHMgT2JqZWN0TGl0ZXJhbCxcbj4ge1xuICAvKipcbiAgICogUHJvY2VzcyBhIGxpc3Qgb2YgdHJhbnNhY3Rpb25zIChvciBvdGhlciBibG9ja2NoYWluIGRhdGEpIGluIGEgYmxvY2sgYW5kIHN0b3JlIHJlcXVpcmVkIGluZm9ybWF0aW9uLlxuICAgKiBUaGlzIG1ldGhvZCBpcyB0aGUgY29yZSBvZiB0aGUgZXh0cmFjdGlvbiBwcm9jZXNzIGFuZCBzaG91bGQgYmUgaW1wbGVtZW50ZWQgdG8gaGFuZGxlXG4gICAqIHRoZSBzcGVjaWZpYyBkYXRhIGV4dHJhY3Rpb24gbG9naWMgZm9yIHlvdXIgYmxvY2tjaGFpbi5cbiAgICpcbiAgICogQHBhcmFtIHR4cyAtIExpc3Qgb2YgdHJhbnNhY3Rpb25zIG9yIGJsb2NrY2hhaW4gZGF0YSBzdHJ1Y3R1cmVzIGluIHRoZSBibG9ja1xuICAgKiBAcGFyYW0gYmxvY2sgLSBCbG9jayBpbmZvcm1hdGlvbiBjb250YWluaW5nIG1ldGFkYXRhIGFib3V0IHRoZSBibG9ja1xuICAgKiBAcmV0dXJucyBQcm9taXNlPGJvb2xlYW4+IC0gdHJ1ZSBpZiB0aGUgcHJvY2VzcyBjb21wbGV0ZWQgc3VjY2Vzc2Z1bGx5LCBmYWxzZSBvdGhlcndpc2VcbiAgICovXG4gIGFic3RyYWN0IHByb2Nlc3NUcmFuc2FjdGlvbnM6IChcbiAgICB0eHM6IEFycmF5PFRyYW5zYWN0aW9uVHlwZT4sXG4gICAgYmxvY2s6IEJsb2NrSW5mbyxcbiAgKSA9PiBQcm9taXNlPGJvb2xlYW4+O1xuXG4gIC8qKlxuICAgKiBSZXR1cm4gYSB1bmlxdWUgaWRlbnRpZmllciBmb3IgdGhpcyBleHRyYWN0b3IuXG4gICAqIFRoaXMgSUQgbXVzdCBiZSB1bmlxdWUgYWNyb3NzIGFsbCBleHRyYWN0b3JzIGluIHRoZSBzeXN0ZW0gdG8gcHJldmVudCBjb25mbGljdHMuXG4gICAqXG4gICAqIEByZXR1cm5zIHN0cmluZyAtIFVuaXF1ZSBleHRyYWN0b3IgaWRlbnRpZmllclxuICAgKi9cbiAgYWJzdHJhY3QgZ2V0SWQ6ICgpID0+IHN0cmluZztcblxuICAvKipcbiAgICogRm9yayAocm9sbGJhY2spIG9uZSBibG9jayBhbmQgcmVtb3ZlIGFsbCBzdG9yZWQgaW5mb3JtYXRpb24gZm9yIHRoaXMgYmxvY2suXG4gICAqIFRoaXMgaXMgZXNzZW50aWFsIGZvciBoYW5kbGluZyBibG9ja2NoYWluIHJlb3JnYW5pemF0aW9ucyB3aGVyZSBibG9ja3NcbiAgICogbmVlZCB0byBiZSByZW1vdmVkIGZyb20gdGhlIGRhdGFiYXNlLlxuICAgKlxuICAgKiBAcGFyYW0gaGFzaCAtIEJsb2NrIGhhc2ggdG8gZm9yay9yZW1vdmVcbiAgICovXG4gIGFic3RyYWN0IGZvcmtCbG9jazogKGhhc2g6IHN0cmluZykgPT4gUHJvbWlzZTx2b2lkPjtcblxuICAvKipcbiAgICogSW5pdGlhbGl6ZSBleHRyYWN0b3IgZGF0YWJhc2Ugd2l0aCBoaXN0b3JpY2FsIGRhdGEgY3JlYXRlZCBiZWxvdyB0aGUgaW5pdGlhbCBoZWlnaHQuXG4gICAqIFRoaXMgbWV0aG9kIGlzIGNhbGxlZCBkdXJpbmcgZXh0cmFjdG9yIHNldHVwIHRvIHBvcHVsYXRlIHRoZSBkYXRhYmFzZSB3aXRoXG4gICAqIGRhdGEgdGhhdCBleGlzdGVkIGJlZm9yZSB0aGUgc2Nhbm5lciBzdGFydGVkIG1vbml0b3JpbmcuXG4gICAqXG4gICAqIEBwYXJhbSBpbml0aWFsQmxvY2sgLSBUaGUgYmxvY2sgZnJvbSB3aGljaCB0byBzdGFydCBzY2FubmluZyAoaW5pdGlhbCBoZWlnaHQpXG4gICAqL1xuICBhYnN0cmFjdCBpbml0aWFsaXplRGF0YTogKGluaXRpYWxCbG9jazogQmxvY2tJbmZvKSA9PiBQcm9taXNlPHZvaWQ+O1xuXG4gIC8qKlxuICAgKiBoYXNFdmVudEluSGVpZ2h0UmFuZ2UgdXNlZCBieSB0aGUgc2Nhbm5lcidzIGZhc3QtZm9yd2FyZCBtZWNoYW5pc20uXG4gICAqIER1cmluZyBhIGxhcmdlIHN5bmMsIGluc3RlYWQgb2YgZmV0Y2hpbmcgYW5kIHByb2Nlc3NpbmcgdGhvdXNhbmRzIG9mIGJsb2NrcyBvbmUgYnkgb25lLFxuICAgKiB0aGUgc2Nhbm5lciBjaGVja3MgdGhpcyBtZXRob2QuIElmIGFuIGV4dGVybmFsIEFQSSBvciBub2RlIGNhbiBjb25maXJtIHRoYXQgKm5vIHJlbGV2YW50IGV2ZW50cypcbiAgICogZXhpc3QgaW4gdGhlIGBbZnJvbUhlaWdodCwgdG9IZWlnaHRdYCByYW5nZSwgcmV0dXJuIGBmYWxzZWAuIFRoZSBzY2FubmVyIHdpbGwgdGhlbiBza2lwIGZldGNoaW5nXG4gICAqIHRoZXNlIGJsb2NrcyBlbnRpcmVseSwgdmFzdGx5IGltcHJvdmluZyBzeW5jIHNwZWVkLlxuICAgKiBSZXR1cm5zIGB0cnVlYCwgZm9yY2luZyB0aGUgc2Nhbm5lciB0byBzYWZlbHkgcHJvY2VzcyBldmVyeSBzaW5nbGUgYmxvY2sgc2VxdWVudGlhbGx5LlxuICAgKlxuICAgKiBAcGFyYW0gZnJvbUhlaWdodCAtIFRoZSBzdGFydGluZyBibG9jayBoZWlnaHQgb2YgdGhlIGNodW5rIGJlaW5nIGV2YWx1YXRlZC5cbiAgICogQHBhcmFtIHRvSGVpZ2h0IC0gVGhlIGVuZGluZyBibG9jayBoZWlnaHQgb2YgdGhlIGNodW5rLlxuICAgKiBAcmV0dXJucyB7UHJvbWlzZTxib29sZWFuPn0gYHRydWVgIGlmIGV2ZW50cyBleGlzdCAob3IgaWYgdW5rbm93bikuIGBmYWxzZWAgT05MWSBpZiBpdCdzIGd1YXJhbnRlZWQgdGhlIHJhbmdlIGlzIGVtcHR5LlxuICAgKi9cbiAgcHVibGljIGhhc0V2ZW50SW5IZWlnaHRSYW5nZSA9IGFzeW5jIChcbiAgICAvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVudXNlZC12YXJzXG4gICAgZnJvbUhlaWdodDogbnVtYmVyLFxuICAgIC8vIGVzbGludC1kaXNhYmxlLW5leHQtbGluZSBAdHlwZXNjcmlwdC1lc2xpbnQvbm8tdW51c2VkLXZhcnNcbiAgICB0b0hlaWdodDogbnVtYmVyLFxuICApOiBQcm9taXNlPGJvb2xlYW4+ID0+IHtcbiAgICByZXR1cm4gdHJ1ZTtcbiAgfTtcblxuICAvKipcbiAgICogQ3JlYXRlIGEgcXVlcnkgZm9yIHVzZWQgYmxvY2tzIGFzc29jaWF0ZWQgd2l0aCB0aGUgZ2l2ZW4gYGV4dHJhY3RvcklkYFxuICAgKiBUaGlzIG1ldGhvZCBvbmx5IGJ1aWxkcyB0aGUgcXVlcnkgYW5kIGRvZXMgbm90IGV4ZWN1dGUgaXRcbiAgICpcbiAgICogQHJldHVybnMgQSBUeXBlT1JNIFNlbGVjdFF1ZXJ5QnVpbGRlciB0aGF0IHNlbGVjdHMgdXNlZCBibG9jayB2YWx1ZXMgb3JcbiAgICogYHVuZGVmaW5lZGAgaWYgdGhlIGV4dHJhY3RvciBoYXMgbm8gYXNzb2NpYXRlZCBlbnRpdHlcbiAgICovXG4gIGFic3RyYWN0IGNyZWF0ZVVzZWRCbG9ja3NRdWVyeTogKCkgPT5cbiAgICB8IFNlbGVjdFF1ZXJ5QnVpbGRlcjxFeHRyYWN0b3JFbnRpdHk+XG4gICAgfCB1bmRlZmluZWQ7XG59XG4iXX0=

package/dist/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const API_LIMIT = 100;
+export declare const RETRIAL_COUNT = 10;
+export declare const DB_CHUNK_SIZE = 100;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../lib/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS,MAAM,CAAC;AAC7B,eAAO,MAAM,aAAa,KAAK,CAAC;AAChC,eAAO,MAAM,aAAa,MAAM,CAAC"}

package/dist/constants.js

@@ -0,0 +1,4 @@
+export const API_LIMIT = 100;
+export const RETRIAL_COUNT = 10;
+export const DB_CHUNK_SIZE = 100;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uc3RhbnRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vbGliL2NvbnN0YW50cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxNQUFNLENBQUMsTUFBTSxTQUFTLEdBQUcsR0FBRyxDQUFDO0FBQzdCLE1BQU0sQ0FBQyxNQUFNLGFBQWEsR0FBRyxFQUFFLENBQUM7QUFDaEMsTUFBTSxDQUFDLE1BQU0sYUFBYSxHQUFHLEdBQUcsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCBjb25zdCBBUElfTElNSVQgPSAxMDA7XG5leHBvcnQgY29uc3QgUkVUUklBTF9DT1VOVCA9IDEwO1xuZXhwb3J0IGNvbnN0IERCX0NIVU5LX1NJWkUgPSAxMDA7XG4iXX0=

package/dist/ergo/database/actions/abstractErgoAction.d.ts

@@ -0,0 +1,91 @@
+import { AbstractLogger } from '@rosen-bridge/abstract-logger';
+import { DataSource, EntityTarget, QueryRunner, Repository, SelectQueryBuilder } from '@rosen-bridge/extended-typeorm';
+import { BlockInfo } from '@rosen-bridge/scanner-interfaces';
+import { AbstractEntityData, EntityInfo } from '../../interfaces';
+import { AbstractErgoEntity } from '../entities/abstractErgoEntity';
+export declare abstract class AbstractErgoAction<ExtractedData extends AbstractEntityData, ExtractorEntity extends AbstractErgoEntity> {
+    protected readonly dataSource: DataSource;
+    protected readonly repo: EntityTarget<ExtractorEntity>;
+    protected readonly logger: AbstractLogger;
+    protected readonly repository: Repository<ExtractorEntity>;
+    constructor(dataSource: DataSource, repo: EntityTarget<ExtractorEntity>, logger?: AbstractLogger);
+    /**
+     * create the database entity from extracted data and block information
+     */
+    protected abstract createEntity: (data: ExtractedData[], block: BlockInfo, extractor: string) => Array<Omit<ExtractorEntity, 'id'>>;
+    /**
+     * convert the database entity back to raw data
+     */
+    protected abstract convertEntityToData: (entities: ExtractorEntity[]) => ExtractedData[];
+    /**
+     * insert entities extracted from a block to database
+     * @param queryRunner
+     * @param entitiesToInsert
+     * @param block
+     * @param extractor
+     */
+    protected insertEntities: (queryRunner: QueryRunner, entitiesToInsert: Array<ExtractedData>, block: BlockInfo, extractor: string) => Promise<void>;
+    /**
+     * update an entity in the database
+     * @param queryRunner
+     * @param updateEntity
+     * @param block
+     * @param extractor
+     */
+    protected updateEntity: (queryRunner: QueryRunner, updatedEntity: ExtractedData, block: BlockInfo, extractor: string) => Promise<void>;
+    /**
+     * delete all database records that were created from a specific block
+     * @param queryRunner
+     * @param extractor
+     * @param block
+     * @returns
+     */
+    protected deleteBlockRecords: (queryRunner: QueryRunner, extractor: string, block: string) => Promise<ExtractedData[]>;
+    /**
+     * override this method to revert the updates made to entities when a block is deleted
+     * e.g., mark boxes as unspent, update related entities, etc.
+     * @param queryRunner
+     * @param extractor
+     * @param block
+     * @returns
+     */
+    protected revertBlockUpdates: (queryRunner: QueryRunner, // eslint-disable-line @typescript-eslint/no-unused-vars
+    extractor: string, // eslint-disable-line @typescript-eslint/no-unused-vars
+    block: string) => Promise<ExtractorEntity[]>;
+    /**
+     * delete extracted data from a specific block
+     * if an entity is updated using the data in this block revert the update
+     * if an entity is created in this block remove it from database
+     * @param block
+     * @param extractor
+     * @return deleted items and updated entity identifiers
+     */
+    deleteBlockData: (block: string, extractor: string) => Promise<{
+        deletedData: ExtractedData[];
+        updatedData: EntityInfo[];
+    }>;
+    /**
+     * insert all extracted entity data in an atomic transaction
+     * update the data if a entity with the same id is already stored in db
+     * @param entities
+     * @param block
+     * @param extractor
+     * @return inserted items and updated entity identifiers
+     * returns undefined in case of any problem
+     */
+    storeEntities: (entities: Array<ExtractedData>, block: BlockInfo, extractor: string) => Promise<boolean>;
+    /**
+     * remove all existing data for the extractor
+     * @param extractorId
+     */
+    removeAllData: (extractorId: string) => Promise<void>;
+    /**
+     * Builds a query that returns used blocks by selecting the `block` column from the `ExtractorEntity` repository,
+     * filtered by the provided `extractorId`
+     *
+     * @param extractorId - Identifier of the extractor
+     * @returns A query builder selecting used blocks
+     */
+    createUsedBlocksQuery: (extractorId: string) => SelectQueryBuilder<ExtractorEntity>;
+}
+//# sourceMappingURL=abstractErgoAction.d.ts.map

package/dist/ergo/database/actions/abstractErgoAction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abstractErgoAction.d.ts","sourceRoot":"","sources":["../../../../lib/ergo/database/actions/abstractErgoAction.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAe,MAAM,+BAA+B,CAAC;AAC5E,OAAO,EACL,UAAU,EACV,YAAY,EAGZ,WAAW,EACX,UAAU,EACV,kBAAkB,EACnB,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAE7D,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AAEpE,8BAAsB,kBAAkB,CACtC,aAAa,SAAS,kBAAkB,EACxC,eAAe,SAAS,kBAAkB;IAKxC,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,UAAU;IACzC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,eAAe,CAAC;IACtD,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,cAAc;IAL3C,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC;gBAGtC,UAAU,EAAE,UAAU,EACtB,IAAI,EAAE,YAAY,CAAC,eAAe,CAAC,EACnC,MAAM,GAAE,cAAkC;IAK/D;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY,EAAE,CAC/B,IAAI,EAAE,aAAa,EAAE,EACrB,KAAK,EAAE,SAAS,EAChB,SAAS,EAAE,MAAM,KACd,KAAK,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC,CAAC;IAExC;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,mBAAmB,EAAE,CACtC,QAAQ,EAAE,eAAe,EAAE,KACxB,aAAa,EAAE,CAAC;IAErB;;;;;;OAMG;IACH,SAAS,CAAC,cAAc,GACtB,aAAa,WAAW,EACxB,kBAAkB,KAAK,CAAC,aAAa,CAAC,EACtC,OAAO,SAAS,EAChB,WAAW,MAAM,mBAMjB;IAEF;;;;;;OAMG;IACH,SAAS,CAAC,YAAY,GACpB,aAAa,WAAW,EACxB,eAAe,aAAa,EAC5B,OAAO,SAAS,EAChB,WAAW,MAAM,mBAWjB;IAEF;;;;;;OAMG;IACH,SAAS,CAAC,kBAAkB,GAC1B,aAAa,WAAW,EACxB,WAAW,MAAM,EACjB,OAAO,MAAM,KACZ,OAAO,CAAC,aAAa,EAAE,CAAC,CAazB;IAEF;;;;;;;OAOG;IACH,SAAS,CAAC,kBAAkB,GAC1B,aAAa,WAAW,EAAE,wDAAwD;IAClF,WAAW,MAAM,EAAE,wDAAwD;IAC3E,OAAO,MAAM,KACZ,OAAO,CAAC,eAAe,EAAE,CAAC,CAE3B;IAEF;;;;;;;OAOG;IACH,eAAe,GACb,OAAO,MAAM,EACb,WAAW,MAAM,KAChB,OAAO,CAAC;QAAE,WAAW,EAAE,aAAa,EAAE,CAAC;QAAC,WAAW,EAAE,UAAU,EAAE,CAAA;KAAE,CAAC,CAgCrE;IAEF;;;;;;;;OAQG;IACH,aAAa,GACX,UAAU,KAAK,CAAC,aAAa,CAAC,EAC9B,OAAO,SAAS,EAChB,WAAW,MAAM,KAChB,OAAO,CAAC,OAAO,CAAC,CA4DjB;IAEF;;;OAGG;IACH,aAAa,GAAU,aAAa,MAAM,mBAKxC;IAEF;;;;;;OAMG;IACH,qBAAqB,GACnB,aAAa,MAAM,KAClB,kBAAkB,CAAC,eAAe,CAAC,CAKpC;CACH"}