@hackerhouse/xpub-scan 1.0.0

package/lib/api/defaultProvider.js

@@ -0,0 +1,275 @@
+"use strict";
+// Here, the raw data is fetched from default (i.e., free of charge) providers:
+//  - balance,
+//  - total spent and received, and
+//  - operations
+// per address
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAccountBasedTransactions = exports.getBitcoinCashTransactions = exports.getTransactions = exports.getStats = void 0;
+const helpers_1 = require("../helpers");
+const settings_1 = require("../configuration/settings");
+const transaction_1 = require("../models/transaction");
+const operation_1 = require("../models/operation");
+const currencies_1 = require("../configuration/currencies");
+const bignumber_js_1 = __importDefault(require("bignumber.js"));
+const date_fns_1 = require("date-fns");
+/**
+ * fetch the structured basic stats related to an address
+ * its balance, funded and spend sums and counts
+ * @param address the address being analyzed
+ */
+function getStats(address) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // important: coin name is required to be upper case for default provider
+        let coin = settings_1.configuration.currency.symbol.toUpperCase();
+        if (coin === currencies_1.currencies.bch.symbol) {
+            return getBchStats(address);
+        }
+        if (coin === currencies_1.currencies.eth.symbol) {
+            return getAccountBasedStats(address);
+        }
+        let url = settings_1.configuration.externalProviderURL.replace("{address}", address.toString());
+        if (coin === currencies_1.currencies.btc.symbol.toUpperCase()) {
+            url = url.replace("{network}", settings_1.configuration.testnet ? "testnet" : "");
+        }
+        const res = yield (0, helpers_1.getJSON)(url);
+        // TODO: check potential errors here (API returning invalid data...)
+        const fundedSum = res.chain_stats.funded_txo_sum;
+        const spentSum = res.chain_stats.spent_txo_sum;
+        const balance = fundedSum - spentSum;
+        address.setStats(res.chain_stats.tx_count, (0, helpers_1.toAccountUnit)((0, bignumber_js_1.default)(fundedSum)), (0, helpers_1.toAccountUnit)((0, bignumber_js_1.default)(spentSum)));
+        address.setBalance((0, helpers_1.toAccountUnit)((0, bignumber_js_1.default)(balance)));
+        if (res.chain_stats.tx_count > 0) {
+            // get transactions per address
+            address.setRawTransactions(yield (0, helpers_1.getJSON)(url + "/txs"));
+        }
+    });
+}
+exports.getStats = getStats;
+/**
+ * get all structured transactions related to an address
+ * @param address the address being analyzed
+ */
+function getTransactions(address) {
+    // Because the general default API is not compatible with Bitcoin Cash,
+    // these transactions have to be specifically handled
+    if (settings_1.configuration.currency.symbol === currencies_1.currencies.bch.symbol) {
+        return getBitcoinCashTransactions(address);
+    }
+    if (settings_1.configuration.currency.symbol === currencies_1.currencies.eth.symbol) {
+        return getAccountBasedTransactions(address);
+    }
+    // 1. get raw transactions
+    const rawTransactions = address.getRawTransactions();
+    // 2. parse raw transactions
+    const transactions = [];
+    rawTransactions.forEach((tx) => {
+        const ins = [];
+        const outs = [];
+        tx.vout.forEach((txout) => {
+            // the address currently being analyzed is a — recipient —
+            if (txout.scriptpubkey_address.toLowerCase() ===
+                address.toString().toLowerCase()) {
+                tx.vin.forEach((txin) => {
+                    const op = new operation_1.Operation((0, date_fns_1.format)(new Date(tx.status.block_time * 1000), "yyyy-MM-dd HH:mm:ss"), (0, helpers_1.toAccountUnit)((0, bignumber_js_1.default)(txout.value)));
+                    op.setTxid(tx.txid);
+                    op.setAddress(txin.prevout.scriptpubkey_address);
+                    op.setOperationType("Received");
+                    ins.push(op);
+                });
+            }
+            // the address currently being analyzed is a — sender —
+            // (it is part of at least one vin's prevout)
+            if (tx.vin.some((t) => t.prevout.scriptpubkey_address.toLowerCase() ===
+                address.toString().toLowerCase())) {
+                const op = new operation_1.Operation((0, date_fns_1.format)(new Date(tx.status.block_time * 1000), "yyyy-MM-dd HH:mm:ss"), (0, helpers_1.toAccountUnit)((0, bignumber_js_1.default)(txout.value)));
+                op.setTxid(tx.txid);
+                op.setAddress(txout.scriptpubkey_address);
+                op.setOperationType("Sent");
+                outs.push(op);
+            }
+        });
+        transactions.push(new transaction_1.Transaction(tx.status.block_height, (0, date_fns_1.format)(new Date(tx.status.block_time * 1000), "yyyy-MM-dd HH:mm:ss"), // unix time to readable format
+        tx.txid, ins, outs));
+    });
+    address.setTransactions(transactions);
+}
+exports.getTransactions = getTransactions;
+/**
+ * fetch the structured basic stats related to a Bitcoin Cash address
+ * its balance, funded and spend sums and counts
+ * @param address the address being analyzed
+ */
+function getBchStats(address) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const urlStats = settings_1.configuration.externalProviderURL
+            .replace("{type}", "details")
+            .replace("{address}", address.asCashAddress());
+        const res = yield (0, helpers_1.getJSON)(urlStats);
+        // TODO: check potential errors here (API returning invalid data...)
+        const fundedSum = res.totalReceived;
+        const balance = res.balance;
+        const spentSum = res.totalSent;
+        address.setStats(res.txApperances, fundedSum, spentSum);
+        address.setBalance(balance);
+        const urlTxs = settings_1.configuration.externalProviderURL
+            .replace("{type}", "transactions")
+            .replace("{address}", address.asCashAddress());
+        const payloads = [];
+        let totalPages = 1;
+        for (let i = 0; i < totalPages; i++) {
+            const response = yield (0, helpers_1.getJSON)(urlTxs.concat("?page=").concat(i.toString()));
+            totalPages = response.pagesTotal;
+            payloads.push(response.txs);
+        }
+        // flatten the payloads
+        const rawTransactions = [].concat(...payloads);
+        address.setRawTransactions(rawTransactions);
+    });
+}
+/**
+ * get all structured transactions related to a Bitcoin Cash address
+ * @param address the address being analyzed
+ */
+function getBitcoinCashTransactions(address) {
+    // 1. get raw transactions
+    const rawTransactions = address.getRawTransactions();
+    // 2. parse raw transactions
+    const transactions = [];
+    rawTransactions.forEach((tx) => {
+        const ins = [];
+        const outs = [];
+        let amount = new bignumber_js_1.default(0);
+        let processIn = false;
+        let processOut = false;
+        // 1. Detect operation type
+        for (const txin of tx.vin) {
+            if (txin.addr.includes(address.toString())) {
+                processOut = true;
+                break;
+            }
+        }
+        for (const txout of tx.vout) {
+            if (typeof txout.scriptPubKey.addresses === "undefined") {
+                continue;
+            }
+            for (const outAddress of txout.scriptPubKey.addresses) {
+                if (outAddress.includes(address.toString())) {
+                    // when IN op, amount corresponds to txout
+                    amount = new bignumber_js_1.default(txout.value);
+                    processIn = true;
+                    break;
+                }
+            }
+        }
+        if (processIn) {
+            tx.vin.forEach((txin) => {
+                const op = new operation_1.Operation(String(tx.time), amount);
+                op.setAddress(txin.addr);
+                op.setTxid(tx.txid);
+                op.setOperationType("Received");
+                ins.push(op);
+            });
+        }
+        if (processOut) {
+            tx.vout.forEach((txout) => {
+                if (parseFloat(txout.value) === 0) {
+                    return;
+                }
+                const op = new operation_1.Operation(String(tx.time), txout.value);
+                op.setAddress(txout.scriptPubKey.addresses[0]);
+                op.setTxid(tx.txid);
+                op.setOperationType("Sent");
+                outs.push(op);
+            });
+        }
+        transactions.push(new transaction_1.Transaction(tx.blockheight, (0, date_fns_1.format)(new Date(tx.time * 1000), "yyyy-MM-dd HH:mm:ss"), // unix time to readable format
+        tx.txid, ins, outs));
+    });
+    address.setTransactions(transactions);
+}
+exports.getBitcoinCashTransactions = getBitcoinCashTransactions;
+/**
+ * fetch the structured basic stats related to an Ethereum address
+ * its balance, funded and spend sums and counts
+ * @param address the address being analyzed
+ */
+function getAccountBasedStats(address) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const url = settings_1.configuration.externalProviderURL
+            .replace("{type}", "addrs")
+            .replace("{item}", address.toString());
+        const res = yield (0, helpers_1.getJSON)(url);
+        // eslint-disable-next-line  @typescript-eslint/no-explicit-any
+        const removeScientificNotation = (value) => value.toLocaleString("fullwide", { useGrouping: false });
+        const fundedSum = (0, helpers_1.toAccountUnit)(new bignumber_js_1.default(removeScientificNotation(res.total_received)));
+        const balance = (0, helpers_1.toAccountUnit)(new bignumber_js_1.default(removeScientificNotation(res.balance)));
+        const spentSum = (0, helpers_1.toAccountUnit)(new bignumber_js_1.default(removeScientificNotation(res.total_sent)));
+        address.setStats(res.n_tx, fundedSum, spentSum);
+        address.setBalance(balance);
+        // additional request to get the fees
+        for (const txref of res.txrefs) {
+            // if not a Sent transaction, skip
+            if (txref.tx_output_n !== -1) {
+                continue;
+            }
+            const urlTxs = settings_1.configuration.externalProviderURL
+                .replace("{type}", "txs")
+                .replace("{item}", txref.tx_hash);
+            const resTxs = yield (0, helpers_1.getJSON)(urlTxs);
+            txref.total = resTxs.total;
+        }
+        address.setRawTransactions(res.txrefs);
+    });
+}
+/**
+ * get all structured transactions related to an account-based address (generally Ethereum)
+ * @param address the address being analyzed
+ */
+function getAccountBasedTransactions(address) {
+    // 1. get raw transactions
+    const rawTransactions = address.getRawTransactions();
+    // 2. parse raw transactions
+    const transactions = [];
+    rawTransactions.forEach((tx) => {
+        const ins = [];
+        const outs = [];
+        const isRecipient = tx.tx_input_n === -1;
+        const isSender = tx.tx_output_n === -1;
+        let amount = tx.value;
+        if (isSender) {
+            amount = tx.total;
+        }
+        amount /= settings_1.configuration.currency.precision;
+        const op = new operation_1.Operation(String(tx.confirmed), amount.toFixed(settings_1.ETH_FIXED_PRECISION));
+        const txHash = "0x".concat(tx.tx_hash);
+        op.setAddress(address.toString());
+        op.setTxid(txHash);
+        op.setBlockNumber(tx.block_height);
+        if (isRecipient) {
+            op.setOperationType("Received");
+            address.addFundedOperation(op);
+            ins.push(op);
+        }
+        else if (isSender) {
+            op.setOperationType("Sent");
+            address.addSentOperation(op);
+            outs.push(op);
+        }
+        transactions.push(new transaction_1.Transaction(tx.block_height, (0, date_fns_1.format)(new Date(tx.confirmed), "yyyy-MM-dd'T'HH:mm:ss'Z'"), txHash, ins, outs));
+    });
+    address.setTransactions(transactions);
+}
+exports.getAccountBasedTransactions = getAccountBasedTransactions;

package/lib/comparison/compareOperations.d.ts

@@ -0,0 +1,13 @@
+import { Address } from "../models/address";
+import { Operation } from "../models/operation";
+import { Comparison } from "../models/comparison";
+/**
+ * Compare the imported operations with the actual ones
+ * @param importedOperations operations from the product
+ * @param actualOperations operations from the provider (source of truth)
+ * @param actualAddresses actual addresses
+ * @param partialComparison (optional) partial comparison
+ * @returns list of comparisons
+ */
+declare const checkImportedOperations: (importedOperations: Array<Operation>, actualOperations: Array<Operation>, actualAddresses: Array<Address>, partialComparison?: boolean) => Array<Comparison>;
+export { checkImportedOperations };