@bopen-io/wallet-toolbox 1.7.18 → 1.7.20-idb-fix.1

package/out/src/index.client.js

@@ -0,0 +1,62 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sdk = void 0;
+exports.sdk = __importStar(require("./sdk/index"));
+__exportStar(require("./utility/index.client"), exports);
+__exportStar(require("./storage/index.client"), exports);
+__exportStar(require("./services/chaintracker/index.client"), exports);
+__exportStar(require("./SetupClient"), exports);
+__exportStar(require("./SetupWallet"), exports);
+__exportStar(require("./CWIStyleWalletManager"), exports);
+__exportStar(require("./monitor/Monitor"), exports);
+__exportStar(require("./sdk/PrivilegedKeyManager"), exports);
+__exportStar(require("./services/Services"), exports);
+__exportStar(require("./services/createDefaultWalletServicesOptions"), exports);
+__exportStar(require("./signer/WalletSigner"), exports);
+__exportStar(require("./SimpleWalletManager"), exports);
+__exportStar(require("./wab-client/auth-method-interactors/AuthMethodInteractor"), exports);
+__exportStar(require("./wab-client/auth-method-interactors/PersonaIDInteractor"), exports);
+__exportStar(require("./wab-client/auth-method-interactors/TwilioPhoneInteractor"), exports);
+__exportStar(require("./wab-client/auth-method-interactors/DevConsoleInteractor"), exports);
+__exportStar(require("./wab-client/WABClient"), exports);
+__exportStar(require("./Wallet"), exports);
+__exportStar(require("./WalletLogger"), exports);
+__exportStar(require("./WalletAuthenticationManager"), exports);
+__exportStar(require("./WalletPermissionsManager"), exports);
+//# sourceMappingURL=index.client.js.map

package/out/src/index.client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.client.js","sourceRoot":"","sources":["../../src/index.client.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAkC;AAElC,yDAAsC;AACtC,yDAAsC;AACtC,uEAAoD;AAEpD,gDAA6B;AAC7B,gDAA6B;AAE7B,0DAAuC;AACvC,oDAAiC;AACjC,6DAA0C;AAC1C,sDAAmC;AACnC,gFAA6D;AAC7D,wDAAqC;AACrC,wDAAqC;AACrC,4FAAyE;AACzE,2FAAwE;AACxE,6FAA0E;AAC1E,4FAAyE;AACzE,yDAAsC;AACtC,2CAAwB;AACxB,iDAA8B;AAC9B,gEAA6C;AAC7C,6DAA0C"}

package/out/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './index.all';
+//# sourceMappingURL=index.d.ts.map

package/out/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA"}

package/out/src/index.js

@@ -0,0 +1,18 @@
+"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./index.all"), exports);
+//# sourceMappingURL=index.js.map

package/out/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B"}

package/out/src/index.mobile.d.ts

@@ -0,0 +1,20 @@
+export * as sdk from './sdk/index';
+export * from './utility/index.client';
+export * from './storage/index.mobile';
+export * from './services/chaintracker/chaintracks/index.mobile';
+export * from './CWIStyleWalletManager';
+export * from './monitor/Monitor';
+export * from './sdk/PrivilegedKeyManager';
+export * from './services/Services';
+export * from './signer/WalletSigner';
+export * from './SimpleWalletManager';
+export * from './wab-client/auth-method-interactors/AuthMethodInteractor';
+export * from './wab-client/auth-method-interactors/PersonaIDInteractor';
+export * from './wab-client/auth-method-interactors/TwilioPhoneInteractor';
+export * from './wab-client/auth-method-interactors/DevConsoleInteractor';
+export * from './wab-client/WABClient';
+export * from './Wallet';
+export * from './WalletLogger';
+export * from './WalletAuthenticationManager';
+export * from './WalletPermissionsManager';
+//# sourceMappingURL=index.mobile.d.ts.map

package/out/src/index.mobile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mobile.d.ts","sourceRoot":"","sources":["../../src/index.mobile.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,aAAa,CAAA;AAElC,cAAc,wBAAwB,CAAA;AACtC,cAAc,wBAAwB,CAAA;AACtC,cAAc,kDAAkD,CAAA;AAEhE,cAAc,yBAAyB,CAAA;AACvC,cAAc,mBAAmB,CAAA;AACjC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,qBAAqB,CAAA;AACnC,cAAc,uBAAuB,CAAA;AACrC,cAAc,uBAAuB,CAAA;AACrC,cAAc,2DAA2D,CAAA;AACzE,cAAc,0DAA0D,CAAA;AACxE,cAAc,4DAA4D,CAAA;AAC1E,cAAc,2DAA2D,CAAA;AACzE,cAAc,wBAAwB,CAAA;AACtC,cAAc,UAAU,CAAA;AACxB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,+BAA+B,CAAA;AAC7C,cAAc,4BAA4B,CAAA"}

package/out/src/index.mobile.js

@@ -0,0 +1,59 @@
+"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 () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sdk = void 0;
+exports.sdk = __importStar(require("./sdk/index"));
+__exportStar(require("./utility/index.client"), exports);
+__exportStar(require("./storage/index.mobile"), exports);
+__exportStar(require("./services/chaintracker/chaintracks/index.mobile"), exports);
+__exportStar(require("./CWIStyleWalletManager"), exports);
+__exportStar(require("./monitor/Monitor"), exports);
+__exportStar(require("./sdk/PrivilegedKeyManager"), exports);
+__exportStar(require("./services/Services"), exports);
+__exportStar(require("./signer/WalletSigner"), exports);
+__exportStar(require("./SimpleWalletManager"), exports);
+__exportStar(require("./wab-client/auth-method-interactors/AuthMethodInteractor"), exports);
+__exportStar(require("./wab-client/auth-method-interactors/PersonaIDInteractor"), exports);
+__exportStar(require("./wab-client/auth-method-interactors/TwilioPhoneInteractor"), exports);
+__exportStar(require("./wab-client/auth-method-interactors/DevConsoleInteractor"), exports);
+__exportStar(require("./wab-client/WABClient"), exports);
+__exportStar(require("./Wallet"), exports);
+__exportStar(require("./WalletLogger"), exports);
+__exportStar(require("./WalletAuthenticationManager"), exports);
+__exportStar(require("./WalletPermissionsManager"), exports);
+//# sourceMappingURL=index.mobile.js.map

package/out/src/index.mobile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mobile.js","sourceRoot":"","sources":["../../src/index.mobile.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAkC;AAElC,yDAAsC;AACtC,yDAAsC;AACtC,mFAAgE;AAEhE,0DAAuC;AACvC,oDAAiC;AACjC,6DAA0C;AAC1C,sDAAmC;AACnC,wDAAqC;AACrC,wDAAqC;AACrC,4FAAyE;AACzE,2FAAwE;AACxE,6FAA0E;AAC1E,4FAAyE;AACzE,yDAAsC;AACtC,2CAAwB;AACxB,iDAA8B;AAC9B,gEAA6C;AAC7C,6DAA0C"}

package/out/src/monitor/Monitor.d.ts

@@ -0,0 +1,148 @@
+import { WalletMonitorTask } from './tasks/WalletMonitorTask';
+import { WalletStorageManager } from '../storage/WalletStorageManager';
+import { TaskPurgeParams } from './tasks/TaskPurge';
+import { Chain, ProvenTransactionStatus } from '../sdk/types';
+import { ReviewActionResult } from '../sdk/WalletStorage.interfaces';
+import { BlockHeader } from '../sdk/WalletServices.interfaces';
+import { Services } from '../services/Services';
+import { ChaintracksClientApi } from '../services/chaintracker/chaintracks/Api/ChaintracksClientApi';
+import { Chaintracks } from '../services/chaintracker/chaintracks/Chaintracks';
+export type MonitorStorage = WalletStorageManager;
+export interface MonitorOptions {
+    chain: Chain;
+    services: Services;
+    storage: MonitorStorage;
+    chaintracks: ChaintracksClientApi;
+    chaintracksWithEvents?: Chaintracks;
+    /**
+     * How many msecs to wait after each getMerkleProof service request.
+     */
+    msecsWaitPerMerkleProofServiceReq: number;
+    taskRunWaitMsecs: number;
+    abandonedMsecs: number;
+    unprovenAttemptsLimitTest: number;
+    unprovenAttemptsLimitMain: number;
+    /**
+     * These are hooks for a wallet-toolbox client to get transaction updates.
+     */
+    onTransactionBroadcasted?: (broadcastResult: ReviewActionResult) => Promise<void>;
+    onTransactionProven?: (txStatus: ProvenTransactionStatus) => Promise<void>;
+}
+/**
+ * Background task to make sure transactions are processed, transaction proofs are received and propagated,
+ * and potentially that reorgs update proofs that were already received.
+ */
+export declare class Monitor {
+    static createDefaultWalletMonitorOptions(chain: Chain, storage: MonitorStorage, services?: Services, chaintracks?: Chaintracks): MonitorOptions;
+    options: MonitorOptions;
+    services: Services;
+    chain: Chain;
+    storage: MonitorStorage;
+    chaintracks: ChaintracksClientApi;
+    chaintracksWithEvents?: Chaintracks;
+    reorgSubscriptionPromise?: Promise<string>;
+    headersSubscriptionPromise?: Promise<string>;
+    onTransactionBroadcasted?: (broadcastResult: ReviewActionResult) => Promise<void>;
+    onTransactionProven?: (txStatus: ProvenTransactionStatus) => Promise<void>;
+    constructor(options: MonitorOptions);
+    destroy(): Promise<void>;
+    static readonly oneSecond = 1000;
+    static readonly oneMinute: number;
+    static readonly oneHour: number;
+    static readonly oneDay: number;
+    static readonly oneWeek: number;
+    /**
+     * _tasks are typically run by the scheduler but may also be run by runTask.
+     */
+    _tasks: WalletMonitorTask[];
+    /**
+     * _otherTasks can be run by runTask but not by scheduler.
+     */
+    _otherTasks: WalletMonitorTask[];
+    _tasksRunning: boolean;
+    defaultPurgeParams: TaskPurgeParams;
+    addAllTasksToOther(): void;
+    /**
+     * Default tasks with settings appropriate for a single user storage
+     * possibly with sync'ing enabled
+     */
+    addDefaultTasks(): void;
+    /**
+     * Tasks appropriate for multi-user storage
+     * without sync'ing enabled.
+     */
+    addMultiUserTasks(): void;
+    addTask(task: WalletMonitorTask): void;
+    removeTask(name: string): void;
+    runTask(name: string): Promise<string>;
+    runOnce(): Promise<void>;
+    _runAsyncSetup: boolean;
+    _tasksRunningPromise?: PromiseLike<void>;
+    resolveCompletion: ((value: void | PromiseLike<void>) => void) | undefined;
+    startTasks(): Promise<void>;
+    logEvent(event: string, details?: string): Promise<void>;
+    stopTasks(): void;
+    lastNewHeader: BlockHeader | undefined;
+    lastNewHeaderWhen: Date | undefined;
+    /**
+     * Process new chain header event received from Chaintracks
+     *
+     * Kicks processing 'unconfirmed' and 'unmined' request processing.
+     *
+     * @param reqs
+     */
+    processNewBlockHeader(header: BlockHeader): void;
+    /**
+     * This is a function run from a TaskSendWaiting Monitor task.
+     *
+     * This allows the user of wallet-toolbox to 'subscribe' for transaction broadcast updates.
+     *
+     * @param broadcastResult
+     */
+    callOnBroadcastedTransaction(broadcastResult: ReviewActionResult): void;
+    /**
+     * This is a function run from a TaskCheckForProofs Monitor task.
+     *
+     * This allows the user of wallet-toolbox to 'subscribe' for transaction updates.
+     *
+     * @param txStatus
+     */
+    callOnProvenTransaction(txStatus: ProvenTransactionStatus): void;
+    deactivatedHeaders: DeactivedHeader[];
+    /**
+     * Process reorg event received from Chaintracks
+     *
+     * Reorgs can move recent transactions to new blocks at new index positions.
+     * Affected transaction proofs become invalid and must be updated.
+     *
+     * It is possible for a transaction to become invalid.
+     *
+     * Coinbase transactions always become invalid.
+     */
+    processReorg(depth: number, oldTip: BlockHeader, newTip: BlockHeader, deactivatedHeaders?: BlockHeader[]): void;
+    /**
+     * Handler for new header events from Chaintracks.
+     *
+     * To minimize reorg processing, new headers are aged before processing via TaskNewHeader.
+     * Therefore this handler is intentionally a no-op.
+     *
+     * @param header
+     */
+    processHeader(header: BlockHeader): void;
+}
+export interface DeactivedHeader {
+    /**
+     * To control aging of notification before pursuing updated proof data.
+     */
+    whenMsecs: number;
+    /**
+     * Number of attempts made to process the header.
+     * Supports returning deactivation notification to the queue if proof data is not yet available.
+     */
+    tries: number;
+    /**
+     * The deactivated block header.
+     */
+    header: BlockHeader;
+}
+//# sourceMappingURL=Monitor.d.ts.map

package/out/src/monitor/Monitor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Monitor.d.ts","sourceRoot":"","sources":["../../../src/monitor/Monitor.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAA;AAC7D,OAAO,EAAE,oBAAoB,EAAE,MAAM,iCAAiC,CAAA;AAEtE,OAAO,EAAa,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAa9D,OAAO,EAAE,KAAK,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAA;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAA;AAGpE,OAAO,EAAE,WAAW,EAAE,MAAM,kCAAkC,CAAA;AAC9D,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAC/C,OAAO,EAAE,oBAAoB,EAAiB,MAAM,+DAA+D,CAAA;AACnH,OAAO,EAAE,WAAW,EAAE,MAAM,kDAAkD,CAAA;AAE9E,MAAM,MAAM,cAAc,GAAG,oBAAoB,CAAA;AAEjD,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,KAAK,CAAA;IAEZ,QAAQ,EAAE,QAAQ,CAAA;IAElB,OAAO,EAAE,cAAc,CAAA;IAEvB,WAAW,EAAE,oBAAoB,CAAA;IAEjC,qBAAqB,CAAC,EAAE,WAAW,CAAA;IAEnC;;OAEG;IACH,iCAAiC,EAAE,MAAM,CAAA;IAEzC,gBAAgB,EAAE,MAAM,CAAA;IAExB,cAAc,EAAE,MAAM,CAAA;IAEtB,yBAAyB,EAAE,MAAM,CAAA;IAEjC,yBAAyB,EAAE,MAAM,CAAA;IAEjC;;OAEG;IACH,wBAAwB,CAAC,EAAE,CAAC,eAAe,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACjF,mBAAmB,CAAC,EAAE,CAAC,QAAQ,EAAE,uBAAuB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CAC3E;AAED;;;GAGG;AACH,qBAAa,OAAO;IAClB,MAAM,CAAC,iCAAiC,CACtC,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,cAAc,EACvB,QAAQ,CAAC,EAAE,QAAQ,EACnB,WAAW,CAAC,EAAE,WAAW,GACxB,cAAc;IAkBjB,OAAO,EAAE,cAAc,CAAA;IACvB,QAAQ,EAAE,QAAQ,CAAA;IAClB,KAAK,EAAE,KAAK,CAAA;IACZ,OAAO,EAAE,cAAc,CAAA;IACvB,WAAW,EAAE,oBAAoB,CAAA;IACjC,qBAAqB,CAAC,EAAE,WAAW,CAAA;IACnC,wBAAwB,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;IAC1C,0BAA0B,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;IAC5C,wBAAwB,CAAC,EAAE,CAAC,eAAe,EAAE,kBAAkB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACjF,mBAAmB,CAAC,EAAE,CAAC,QAAQ,EAAE,uBAAuB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;gBAE9D,OAAO,EAAE,cAAc;IAiB7B,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ9B,MAAM,CAAC,QAAQ,CAAC,SAAS,QAAO;IAChC,MAAM,CAAC,QAAQ,CAAC,SAAS,SAAyB;IAClD,MAAM,CAAC,QAAQ,CAAC,OAAO,SAAyB;IAChD,MAAM,CAAC,QAAQ,CAAC,MAAM,SAAuB;IAC7C,MAAM,CAAC,QAAQ,CAAC,OAAO,SAAqB;IAE5C;;OAEG;IACH,MAAM,EAAE,iBAAiB,EAAE,CAAK;IAChC;;OAEG;IACH,WAAW,EAAE,iBAAiB,EAAE,CAAK;IACrC,aAAa,UAAQ;IAErB,kBAAkB,EAAE,eAAe,CAOlC;IAED,kBAAkB,IAAI,IAAI;IAiB1B;;;OAGG;IACH,eAAe,IAAI,IAAI;IAcvB;;;OAGG;IACH,iBAAiB,IAAI,IAAI;IAczB,OAAO,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI;IAMtC,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAIxB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAWtC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAmD9B,cAAc,EAAE,OAAO,CAAO;IAC9B,oBAAoB,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC,CAAA;IACxC,iBAAiB,EAAE,CAAC,CAAC,KAAK,EAAE,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,GAAG,SAAS,CAAY;IAEhF,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAqB3B,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAY9D,SAAS,IAAI,IAAI;IAIjB,aAAa,EAAE,WAAW,GAAG,SAAS,CAAA;IACtC,iBAAiB,EAAE,IAAI,GAAG,SAAS,CAAA;IAEnC;;;;;;OAMG;IACH,qBAAqB,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI;IAShD;;;;;;OAMG;IACH,4BAA4B,CAAC,eAAe,EAAE,kBAAkB,GAAG,IAAI;IAMvE;;;;;;OAMG;IACH,uBAAuB,CAAC,QAAQ,EAAE,uBAAuB,GAAG,IAAI;IAMhE,kBAAkB,EAAE,eAAe,EAAE,CAAK;IAE1C;;;;;;;;;OASG;IAEH,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,EAAE,kBAAkB,CAAC,EAAE,WAAW,EAAE,GAAG,IAAI;IAY/G;;;;;;;OAOG;IAEH,aAAa,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI;CACzC;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,EAAE,WAAW,CAAA;CACpB"}

package/out/src/monitor/Monitor.js

@@ -0,0 +1,317 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Monitor = void 0;
+const utilityHelpers_1 = require("../utility/utilityHelpers");
+const TaskPurge_1 = require("./tasks/TaskPurge");
+const TaskReviewStatus_1 = require("./tasks/TaskReviewStatus");
+const TaskSyncWhenIdle_1 = require("./tasks/TaskSyncWhenIdle");
+const TaskFailAbandoned_1 = require("./tasks/TaskFailAbandoned");
+const TaskCheckForProofs_1 = require("./tasks/TaskCheckForProofs");
+const TaskClock_1 = require("./tasks/TaskClock");
+const TaskNewHeader_1 = require("./tasks/TaskNewHeader");
+const TaskMonitorCallHistory_1 = require("./tasks/TaskMonitorCallHistory");
+const TaskReorg_1 = require("./tasks/TaskReorg");
+const TaskSendWaiting_1 = require("./tasks/TaskSendWaiting");
+const TaskCheckNoSends_1 = require("./tasks/TaskCheckNoSends");
+const TaskUnFail_1 = require("./tasks/TaskUnFail");
+const WERR_errors_1 = require("../sdk/WERR_errors");
+const WalletError_1 = require("../sdk/WalletError");
+const Services_1 = require("../services/Services");
+/**
+ * Background task to make sure transactions are processed, transaction proofs are received and propagated,
+ * and potentially that reorgs update proofs that were already received.
+ */
+class Monitor {
+    static createDefaultWalletMonitorOptions(chain, storage, services, chaintracks) {
+        services || (services = new Services_1.Services(chain));
+        if (!services.options.chaintracks)
+            throw new WERR_errors_1.WERR_INVALID_PARAMETER('services.options.chaintracks', 'valid');
+        const o = {
+            chain,
+            services,
+            storage,
+            msecsWaitPerMerkleProofServiceReq: 500,
+            taskRunWaitMsecs: 5000,
+            abandonedMsecs: 1000 * 60 * 5,
+            unprovenAttemptsLimitTest: 10,
+            unprovenAttemptsLimitMain: 144,
+            chaintracks: services.options.chaintracks,
+            chaintracksWithEvents: chaintracks
+        };
+        return o;
+    }
+    constructor(options) {
+        /**
+         * _tasks are typically run by the scheduler but may also be run by runTask.
+         */
+        this._tasks = [];
+        /**
+         * _otherTasks can be run by runTask but not by scheduler.
+         */
+        this._otherTasks = [];
+        this._tasksRunning = false;
+        this.defaultPurgeParams = {
+            purgeSpent: false,
+            purgeCompleted: false,
+            purgeFailed: true,
+            purgeSpentAge: 2 * Monitor.oneWeek,
+            purgeCompletedAge: 2 * Monitor.oneWeek,
+            purgeFailedAge: 5 * Monitor.oneDay
+        };
+        this._runAsyncSetup = true;
+        this.resolveCompletion = undefined;
+        this.deactivatedHeaders = [];
+        this.options = { ...options };
+        this.services = options.services;
+        this.chain = this.services.chain;
+        this.storage = options.storage;
+        this.chaintracks = options.chaintracks;
+        this.chaintracksWithEvents = options.chaintracksWithEvents;
+        this.onTransactionProven = options.onTransactionProven;
+        this.onTransactionBroadcasted = options.onTransactionBroadcasted;
+        if (this.chaintracksWithEvents) {
+            const c = this.chaintracksWithEvents;
+            this.reorgSubscriptionPromise = c.subscribeReorgs(this.processReorg.bind(this));
+            this.headersSubscriptionPromise = c.subscribeHeaders(this.processHeader.bind(this));
+        }
+    }
+    async destroy() {
+        if (this.chaintracksWithEvents) {
+            const c = this.chaintracksWithEvents;
+            if (this.reorgSubscriptionPromise)
+                await c.unsubscribe(await this.reorgSubscriptionPromise);
+            if (this.headersSubscriptionPromise)
+                await c.unsubscribe(await this.headersSubscriptionPromise);
+        }
+    }
+    addAllTasksToOther() {
+        this._otherTasks.push(new TaskClock_1.TaskClock(this));
+        this._otherTasks.push(new TaskNewHeader_1.TaskNewHeader(this));
+        this._otherTasks.push(new TaskMonitorCallHistory_1.TaskMonitorCallHistory(this));
+        this._otherTasks.push(new TaskPurge_1.TaskPurge(this, this.defaultPurgeParams));
+        this._otherTasks.push(new TaskReviewStatus_1.TaskReviewStatus(this));
+        this._otherTasks.push(new TaskSendWaiting_1.TaskSendWaiting(this));
+        this._otherTasks.push(new TaskCheckForProofs_1.TaskCheckForProofs(this));
+        this._otherTasks.push(new TaskCheckNoSends_1.TaskCheckNoSends(this));
+        this._otherTasks.push(new TaskUnFail_1.TaskUnFail(this));
+        this._otherTasks.push(new TaskReorg_1.TaskReorg(this));
+        this._otherTasks.push(new TaskFailAbandoned_1.TaskFailAbandoned(this));
+        this._otherTasks.push(new TaskSyncWhenIdle_1.TaskSyncWhenIdle(this));
+    }
+    /**
+     * Default tasks with settings appropriate for a single user storage
+     * possibly with sync'ing enabled
+     */
+    addDefaultTasks() {
+        this._tasks.push(new TaskClock_1.TaskClock(this));
+        this._tasks.push(new TaskNewHeader_1.TaskNewHeader(this));
+        this._tasks.push(new TaskMonitorCallHistory_1.TaskMonitorCallHistory(this));
+        this._tasks.push(new TaskSendWaiting_1.TaskSendWaiting(this, 8 * Monitor.oneSecond, 7 * Monitor.oneSecond)); // Check every 8 seconds but must be 7 seconds old
+        this._tasks.push(new TaskCheckForProofs_1.TaskCheckForProofs(this, 2 * Monitor.oneHour)); // Every two hours if no block found
+        this._tasks.push(new TaskCheckNoSends_1.TaskCheckNoSends(this));
+        this._tasks.push(new TaskFailAbandoned_1.TaskFailAbandoned(this, 8 * Monitor.oneMinute));
+        this._tasks.push(new TaskUnFail_1.TaskUnFail(this));
+        //this._tasks.push(new TaskPurge(this, this.defaultPurgeParams, 6 * Monitor.oneHour))
+        this._tasks.push(new TaskReviewStatus_1.TaskReviewStatus(this));
+        this._tasks.push(new TaskReorg_1.TaskReorg(this));
+    }
+    /**
+     * Tasks appropriate for multi-user storage
+     * without sync'ing enabled.
+     */
+    addMultiUserTasks() {
+        this._tasks.push(new TaskClock_1.TaskClock(this));
+        this._tasks.push(new TaskNewHeader_1.TaskNewHeader(this));
+        this._tasks.push(new TaskMonitorCallHistory_1.TaskMonitorCallHistory(this));
+        this._tasks.push(new TaskSendWaiting_1.TaskSendWaiting(this, 8 * Monitor.oneSecond, 7 * Monitor.oneSecond)); // Check every 8 seconds but must be 7 seconds old
+        this._tasks.push(new TaskCheckForProofs_1.TaskCheckForProofs(this, 2 * Monitor.oneHour)); // Every two hours if no block found
+        this._tasks.push(new TaskCheckNoSends_1.TaskCheckNoSends(this));
+        this._tasks.push(new TaskFailAbandoned_1.TaskFailAbandoned(this, 8 * Monitor.oneMinute));
+        this._tasks.push(new TaskUnFail_1.TaskUnFail(this));
+        //this._tasks.push(new TaskPurge(this, this.defaultPurgeParams, 6 * Monitor.oneHour))
+        this._tasks.push(new TaskReviewStatus_1.TaskReviewStatus(this));
+        this._tasks.push(new TaskReorg_1.TaskReorg(this));
+    }
+    addTask(task) {
+        if (this._tasks.some(t => t.name === task.name))
+            throw new WERR_errors_1.WERR_BAD_REQUEST(`task ${task.name} has already been added.`);
+        this._tasks.push(task);
+    }
+    removeTask(name) {
+        this._tasks = this._tasks.filter(t => t.name !== name);
+    }
+    async runTask(name) {
+        let task = this._tasks.find(t => t.name === name);
+        let log = '';
+        if (!task)
+            task = this._otherTasks.find(t => t.name === name);
+        if (task) {
+            await task.asyncSetup();
+            log = await task.runTask();
+        }
+        return log;
+    }
+    async runOnce() {
+        if (this._runAsyncSetup) {
+            for (const t of this._tasks) {
+                try {
+                    await t.asyncSetup();
+                }
+                catch (eu) {
+                    const e = WalletError_1.WalletError.fromUnknown(eu);
+                    const details = `monitor task ${t.name} asyncSetup error ${e.code} ${e.description}`;
+                    console.log(details);
+                    await this.logEvent('error0', details);
+                }
+                if (!this._tasksRunning)
+                    break;
+            }
+            this._runAsyncSetup = false;
+        }
+        if (this.storage.getActive().isStorageProvider()) {
+            const tasksToRun = [];
+            const now = new Date().getTime();
+            for (const t of this._tasks) {
+                try {
+                    if (t.trigger(now).run)
+                        tasksToRun.push(t);
+                }
+                catch (eu) {
+                    const e = WalletError_1.WalletError.fromUnknown(eu);
+                    const details = `monitor task ${t.name} trigger error ${e.code} ${e.description}`;
+                    console.log(details);
+                    await this.logEvent('error0', details);
+                }
+            }
+            for (const ttr of tasksToRun) {
+                try {
+                    if (this.storage.getActive().isStorageProvider()) {
+                        const log = await ttr.runTask();
+                        if (log && log.length > 0) {
+                            console.log(`Task${ttr.name} ${log.slice(0, 256)}`);
+                            await this.logEvent(ttr.name, log);
+                        }
+                    }
+                }
+                catch (eu) {
+                    const e = WalletError_1.WalletError.fromUnknown(eu);
+                    const details = `monitor task ${ttr.name} runTask error ${e.code} ${e.description}\n${e.stack}`;
+                    console.log(details);
+                    await this.logEvent('error1', details);
+                }
+                finally {
+                    ttr.lastRunMsecsSinceEpoch = new Date().getTime();
+                }
+            }
+        }
+    }
+    async startTasks() {
+        if (this._tasksRunning)
+            throw new WERR_errors_1.WERR_BAD_REQUEST('monitor tasks are already runnining.');
+        this._tasksRunning = true;
+        this._tasksRunningPromise = new Promise(resolve => {
+            this.resolveCompletion = resolve;
+        });
+        for (; this._tasksRunning;) {
+            await this.runOnce();
+            // console.log(`${new Date().toISOString()} tasks run, waiting...`)
+            await (0, utilityHelpers_1.wait)(this.options.taskRunWaitMsecs);
+        }
+        if (this.resolveCompletion) {
+            this.resolveCompletion();
+            this.resolveCompletion = undefined;
+        }
+    }
+    async logEvent(event, details) {
+        await this.storage.runAsStorageProvider(async (sp) => {
+            await sp.insertMonitorEvent({
+                created_at: new Date(),
+                updated_at: new Date(),
+                id: 0,
+                event,
+                details
+            });
+        });
+    }
+    stopTasks() {
+        this._tasksRunning = false;
+    }
+    /**
+     * Process new chain header event received from Chaintracks
+     *
+     * Kicks processing 'unconfirmed' and 'unmined' request processing.
+     *
+     * @param reqs
+     */
+    processNewBlockHeader(header) {
+        const h = header;
+        this.lastNewHeader = h;
+        this.lastNewHeaderWhen = new Date();
+        // console.log(`WalletMonitor notified of new block header ${h.height}`)
+        // Nudge the proof checker to try again.
+        TaskCheckForProofs_1.TaskCheckForProofs.checkNow = true;
+    }
+    /**
+     * This is a function run from a TaskSendWaiting Monitor task.
+     *
+     * This allows the user of wallet-toolbox to 'subscribe' for transaction broadcast updates.
+     *
+     * @param broadcastResult
+     */
+    callOnBroadcastedTransaction(broadcastResult) {
+        if (this.onTransactionBroadcasted) {
+            this.onTransactionBroadcasted(broadcastResult);
+        }
+    }
+    /**
+     * This is a function run from a TaskCheckForProofs Monitor task.
+     *
+     * This allows the user of wallet-toolbox to 'subscribe' for transaction updates.
+     *
+     * @param txStatus
+     */
+    callOnProvenTransaction(txStatus) {
+        if (this.onTransactionProven) {
+            this.onTransactionProven(txStatus);
+        }
+    }
+    /**
+     * Process reorg event received from Chaintracks
+     *
+     * Reorgs can move recent transactions to new blocks at new index positions.
+     * Affected transaction proofs become invalid and must be updated.
+     *
+     * It is possible for a transaction to become invalid.
+     *
+     * Coinbase transactions always become invalid.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    processReorg(depth, oldTip, newTip, deactivatedHeaders) {
+        if (deactivatedHeaders) {
+            for (const header of deactivatedHeaders) {
+                this.deactivatedHeaders.push({
+                    whenMsecs: Date.now(),
+                    tries: 0,
+                    header
+                });
+            }
+        }
+    }
+    /**
+     * Handler for new header events from Chaintracks.
+     *
+     * To minimize reorg processing, new headers are aged before processing via TaskNewHeader.
+     * Therefore this handler is intentionally a no-op.
+     *
+     * @param header
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    processHeader(header) { }
+}
+exports.Monitor = Monitor;
+Monitor.oneSecond = 1000;
+Monitor.oneMinute = 60 * Monitor.oneSecond;
+Monitor.oneHour = 60 * Monitor.oneMinute;
+Monitor.oneDay = 24 * Monitor.oneHour;
+Monitor.oneWeek = 7 * Monitor.oneDay;
+//# sourceMappingURL=Monitor.js.map