@rosen-bridge/address-extractor 0.1.0

package/README.md

@@ -0,0 +1,92 @@
+# Address Extractor
+
+
+
+## Getting started
+
+To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+
+Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+
+## Add your files
+
+- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
+- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+
+```
+cd existing_repo
+git remote add origin https://git.ergopool.io/rosen-bridge/scanner/address-extractor.git
+git branch -M master
+git push -uf origin master
+```
+
+## Integrate with your tools
+
+- [ ] [Set up project integrations](https://git.ergopool.io/rosen-bridge/scanner/address-extractor/-/settings/integrations)
+
+## Collaborate with your team
+
+- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
+- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
+- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
+- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
+- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+
+## Test and Deploy
+
+Use the built-in continuous integration in GitLab.
+
+- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
+- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
+- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
+- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
+- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+
+***
+
+# Editing this README
+
+When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!).  Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
+
+## Suggestions for a good README
+Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+
+## Name
+Choose a self-explaining name for your project.
+
+## Description
+Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+
+## Badges
+On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+
+## Visuals
+Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+
+## Installation
+Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+
+## Usage
+Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+
+## Support
+Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+
+## Roadmap
+If you have ideas for releases in the future, it is a good idea to list them in the README.
+
+## Contributing
+State if you are open to contributions and what your requirements are for accepting them.
+
+For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+
+You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+
+## Authors and acknowledgment
+Show your appreciation to those who have contributed to the project.
+
+## License
+For open source projects, say how it is licensed.
+
+## Project status
+If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

package/dist/actions/db.d.ts

@@ -0,0 +1,22 @@
+import { DataSource } from "typeorm";
+import ExtractedBox from "../interfaces/ExtractedBox";
+import { BlockEntity } from "@rosen-bridge/scanner";
+export declare class BoxEntityAction {
+    private readonly datasource;
+    constructor(dataSource: DataSource);
+    /**
+     * It stores list of blocks in the dataSource with block id
+     * @param boxes
+     * @param spendBoxes
+     * @param block
+     * @param extractor
+     */
+    storeBox: (boxes: Array<ExtractedBox>, spendBoxes: Array<string>, block: BlockEntity, extractor: string) => Promise<boolean>;
+    /**
+     * delete boxes in specific block from database. if box spend in this block marked as unspent
+     * and if created in this block remove it from database
+     * @param block
+     * @param extractor
+     */
+    deleteBlockBoxes: (block: string, extractor: string) => Promise<void>;
+}

package/dist/actions/db.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BoxEntityAction = void 0;
+const boxEntity_1 = require("../entities/boxEntity");
+class BoxEntityAction {
+    datasource;
+    constructor(dataSource) {
+        this.datasource = dataSource;
+    }
+    /**
+     * It stores list of blocks in the dataSource with block id
+     * @param boxes
+     * @param spendBoxes
+     * @param block
+     * @param extractor
+     */
+    storeBox = async (boxes, spendBoxes, block, extractor) => {
+        const boxEntities = boxes.map((box) => {
+            const row = new boxEntity_1.BoxEntity();
+            row.address = box.address;
+            row.boxId = box.boxId;
+            row.createBlock = block.hash;
+            row.creationHeight = block.height;
+            row.serialized = box.serialized;
+            row.extractor = extractor;
+            return row;
+        });
+        let success = true;
+        const queryRunner = this.datasource.createQueryRunner();
+        await queryRunner.connect();
+        await queryRunner.startTransaction();
+        try {
+            await queryRunner.manager.save(boxEntities);
+            await this.datasource.getRepository(boxEntity_1.BoxEntity).createQueryBuilder()
+                .update()
+                .set({ spendBlock: block.hash })
+                .where("boxId IN (:boxes) AND extractor = :extractor", {
+                boxes: spendBoxes,
+                extractor: extractor
+            }).execute();
+            await queryRunner.commitTransaction();
+        }
+        catch (e) {
+            console.log(`An error occurred during store boxes action: ${e}`);
+            await queryRunner.rollbackTransaction();
+            success = false;
+        }
+        finally {
+            await queryRunner.release();
+        }
+        return success;
+    };
+    /**
+     * delete boxes in specific block from database. if box spend in this block marked as unspent
+     * and if created in this block remove it from database
+     * @param block
+     * @param extractor
+     */
+    deleteBlockBoxes = async (block, extractor) => {
+        await this.datasource.createQueryBuilder()
+            .delete()
+            .from(boxEntity_1.BoxEntity)
+            .where("extractor = :extractor AND createBlock = :block", {
+            "block": block,
+            "extractor": extractor
+        }).execute();
+        await this.datasource.getRepository(boxEntity_1.BoxEntity).createQueryBuilder()
+            .update()
+            .set({ spendBlock: null })
+            .where("spendBlock = :block AND extractor = :extractor", {
+            "block": block,
+            "extractor": extractor
+        }).execute();
+    };
+}
+exports.BoxEntityAction = BoxEntityAction;

package/dist/entities/boxEntity.d.ts

@@ -0,0 +1,10 @@
+export declare class BoxEntity {
+    id: number;
+    address: string;
+    boxId: string;
+    createBlock: string;
+    creationHeight: number;
+    serialized: string;
+    spendBlock?: string | null;
+    extractor: string;
+}

package/dist/entities/boxEntity.js

@@ -0,0 +1,59 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BoxEntity = void 0;
+const typeorm_1 = require("typeorm");
+let BoxEntity = class BoxEntity {
+    id;
+    address;
+    boxId;
+    createBlock;
+    creationHeight;
+    serialized;
+    spendBlock;
+    extractor;
+};
+__decorate([
+    (0, typeorm_1.PrimaryGeneratedColumn)(),
+    __metadata("design:type", Number)
+], BoxEntity.prototype, "id", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], BoxEntity.prototype, "address", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], BoxEntity.prototype, "boxId", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], BoxEntity.prototype, "createBlock", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", Number)
+], BoxEntity.prototype, "creationHeight", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], BoxEntity.prototype, "serialized", void 0);
+__decorate([
+    (0, typeorm_1.Column)({ nullable: true, type: "text" }),
+    __metadata("design:type", Object)
+], BoxEntity.prototype, "spendBlock", void 0);
+__decorate([
+    (0, typeorm_1.Column)(),
+    __metadata("design:type", String)
+], BoxEntity.prototype, "extractor", void 0);
+BoxEntity = __decorate([
+    (0, typeorm_1.Entity)()
+], BoxEntity);
+exports.BoxEntity = BoxEntity;

package/dist/extractor/ergoUtxoExtractor.d.ts

@@ -0,0 +1,29 @@
+import { DataSource } from "typeorm";
+import * as ergoLib from 'ergo-lib-wasm-nodejs';
+import { AbstractExtractor } from "@rosen-bridge/scanner/dist/interfaces";
+import { BlockEntity } from "@rosen-bridge/scanner";
+export declare class ErgoUTXOExtractor implements AbstractExtractor<ergoLib.Transaction> {
+    private readonly dataSource;
+    private readonly actions;
+    private readonly id;
+    private readonly networkType;
+    private readonly ergoTree?;
+    private readonly tokens;
+    constructor(dataSource: DataSource, id: string, networkType: ergoLib.NetworkPrefix, address?: string, tokens?: Array<string>);
+    /**
+     * get Id for current extractor
+     */
+    getId: () => string;
+    /**
+     * gets block id and transactions corresponding to the block and saves if they are valid rosen
+     *  transactions and in case of success return true and in case of failure returns false
+     * @param txs
+     * @param block
+     */
+    processTransactions: (txs: Array<ergoLib.Transaction>, block: BlockEntity) => Promise<boolean>;
+    /**
+     * fork one block and remove all stored information for this block
+     * @param hash: block hash
+     */
+    forkBlock: (hash: string) => Promise<void>;
+}

package/dist/extractor/ergoUtxoExtractor.js

@@ -0,0 +1,107 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErgoUTXOExtractor = void 0;
+const ergoLib = __importStar(require("ergo-lib-wasm-nodejs"));
+const buffer_1 = require("buffer");
+const db_1 = require("../actions/db");
+class ErgoUTXOExtractor {
+    dataSource;
+    actions;
+    id;
+    networkType;
+    ergoTree;
+    tokens;
+    constructor(dataSource, id, networkType, address, tokens) {
+        this.dataSource = dataSource;
+        this.actions = new db_1.BoxEntityAction(dataSource);
+        this.id = id;
+        this.networkType = networkType;
+        this.ergoTree = address ? ergoLib.Address.from_base58(address).to_ergo_tree().to_base16_bytes() : undefined;
+        this.tokens = tokens ? tokens : [];
+    }
+    /**
+     * get Id for current extractor
+     */
+    getId = () => `${this.id}`;
+    /**
+     * gets block id and transactions corresponding to the block and saves if they are valid rosen
+     *  transactions and in case of success return true and in case of failure returns false
+     * @param txs
+     * @param block
+     */
+    processTransactions = (txs, block) => {
+        return new Promise((resolve, reject) => {
+            try {
+                const boxes = [];
+                const spendBoxes = [];
+                txs.forEach(transaction => {
+                    for (let index = 0; index < transaction.outputs().len(); index++) {
+                        const output = transaction.outputs().get(index);
+                        if (this.ergoTree && output.ergo_tree().to_base16_bytes() !== this.ergoTree) {
+                            continue;
+                        }
+                        const filteredTokens = this.tokens.filter(token => {
+                            for (let tokenIndex = 0; tokenIndex < output.tokens().len(); tokenIndex++) {
+                                if (output.tokens().get(tokenIndex).id().to_str() === token) {
+                                    return true;
+                                }
+                            }
+                        });
+                        if (this.tokens.filter(token => filteredTokens.indexOf(token) === -1).length > 0) {
+                            continue;
+                        }
+                        boxes.push({
+                            boxId: output.box_id().to_str(),
+                            address: ergoLib.Address.recreate_from_ergo_tree(output.ergo_tree()).to_base58(this.networkType),
+                            serialized: buffer_1.Buffer.from(output.sigma_serialize_bytes()).toString("hex")
+                        });
+                    }
+                    for (let index2 = 0; index2 < transaction.inputs().len(); index2++) {
+                        const input = transaction.inputs().get(index2);
+                        spendBoxes.push(input.box_id().to_str());
+                    }
+                });
+                this.actions.storeBox(boxes, spendBoxes, block, this.getId()).then((status) => {
+                    resolve(status);
+                }).catch((e) => {
+                    console.log(`An error uncached exception occurred during store ergo observation: ${e}`);
+                    reject(e);
+                });
+            }
+            catch (e) {
+                reject(e);
+            }
+        });
+    };
+    /**
+     * fork one block and remove all stored information for this block
+     * @param hash: block hash
+     */
+    forkBlock = async (hash) => {
+        await this.actions.deleteBlockBoxes(hash, this.getId());
+    };
+}
+exports.ErgoUTXOExtractor = ErgoUTXOExtractor;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { ErgoUTXOExtractor } from './extractor/ergoUtxoExtractor';
+export { BoxEntity } from './entities/boxEntity';
+export { migrations } from './migrations/index';

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.migrations = exports.BoxEntity = exports.ErgoUTXOExtractor = void 0;
+var ergoUtxoExtractor_1 = require("./extractor/ergoUtxoExtractor");
+Object.defineProperty(exports, "ErgoUTXOExtractor", { enumerable: true, get: function () { return ergoUtxoExtractor_1.ErgoUTXOExtractor; } });
+var boxEntity_1 = require("./entities/boxEntity");
+Object.defineProperty(exports, "BoxEntity", { enumerable: true, get: function () { return boxEntity_1.BoxEntity; } });
+var index_1 = require("./migrations/index");
+Object.defineProperty(exports, "migrations", { enumerable: true, get: function () { return index_1.migrations; } });

package/dist/interfaces/ExtractedBox.d.ts

@@ -0,0 +1,5 @@
+export default class ExtractedBox {
+    boxId: string;
+    address: string;
+    serialized: string;
+}

package/dist/interfaces/ExtractedBox.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ExtractedBox {
+    boxId;
+    address;
+    serialized;
+}
+exports.default = ExtractedBox;

package/dist/migrations/boxEntity1659770552000.d.ts

@@ -0,0 +1,6 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+export declare class boxEntity1659770552000 implements MigrationInterface {
+    name: string;
+    up(queryRunner: QueryRunner): Promise<void>;
+    down(queryRunner: QueryRunner): Promise<void>;
+}

package/dist/migrations/boxEntity1659770552000.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.boxEntity1659770552000 = void 0;
+class boxEntity1659770552000 {
+    name = 'boxEntity1659770552000';
+    async up(queryRunner) {
+        await queryRunner.query(`CREATE TABLE "box_entity" (
+                        "id" integer PRIMARY KEY AUTOINCREMENT NOT NULL,
+                        "address" varchar NOT NULL, 
+                        "boxId" varchar NOT NULL, 
+                        "createBlock" varchar NOT NULL, 
+                        "creationHeight" integer NOT NULL, 
+                        "serialized" varchar NOT NULL, 
+                        "spendBlock" text, 
+                        "extractor" varchar NOT NULL)`);
+    }
+    async down(queryRunner) {
+        await queryRunner.query(`DROP TABLE "box_entity"`);
+    }
+}
+exports.boxEntity1659770552000 = boxEntity1659770552000;

package/dist/migrations/index.d.ts

@@ -0,0 +1,2 @@
+import { boxEntity1659770552000 } from "./boxEntity1659770552000";
+export declare const migrations: (typeof boxEntity1659770552000)[];

package/dist/migrations/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.migrations = void 0;
+const boxEntity1659770552000_1 = require("./boxEntity1659770552000");
+exports.migrations = [boxEntity1659770552000_1.boxEntity1659770552000];

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@rosen-bridge/address-extractor",
+  "version": "0.1.0",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "lint": "eslint --fix .",
+    "test": "rimraf sqlite; tsc --noEmit && npm run lint && jest --detectOpenHandles ; rimraf sqlite",
+    "coverage": "c8 npm run test",
+    "build": "rimraf dist && tsc",
+    "release": "npm run test && npm run build && npm publish --access public"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@rosen-bridge/scanner": "^0.1.5",
+    "blakejs": "^1.2.1",
+    "ergo-lib-wasm-nodejs": "^0.18.0",
+    "reflect-metadata": "^0.1.13",
+    "sqlite3": "^5.0.9",
+    "typeorm": "^0.3.7"
+  },
+  "type": "module",
+  "devDependencies": {
+    "@types/jest": "^28.1.6",
+    "@types/node": "^18.0.6",
+    "@typescript-eslint/eslint-plugin": "^5.30.7",
+    "@typescript-eslint/parser": "^5.26.0",
+    "c8": "^7.11.3",
+    "eslint": "^8.16.0",
+    "jest": "^28.1.3",
+    "rimraf": "^3.0.2",
+    "ts-jest": "^28.0.7",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4"
+  }
+}