wallet-storage-client/out/src/monitor/tasks/WalletMonitorTask.d.ts

Client only Wallet Storage

import { MonitorStorage, Monitor } from '../Monitor';
/**
 * A monitor task performs some periodic or state triggered maintenance function
 * on the data managed by a wallet (Bitcoin UTXO manager, aka wallet)
 *
 * The monitor maintains a collection of tasks.
 *
 * It runs each task's non-asynchronous trigger to determine if the runTask method needs to run.
 *
 * Tasks that need to be run are run consecutively by awaiting their async runTask override method.
 *
 * The monitor then waits a fixed interval before repeating...
 *
 * Tasks may use the monitor_events table to persist their execution history.
 * This is done by accessing the wathman.storage object.
 */
export declare abstract class WalletMonitorTask {
    monitor: Monitor;
    name: string;
    /**
     * Set by monitor each time runTask completes
     */
    lastRunMsecsSinceEpoch: number;
    storage: MonitorStorage;
    constructor(monitor: Monitor, name: string);
    /**
     * Override to handle async task setup configuration.
     *
     * Called before first call to `trigger`
     */
    asyncSetup(): Promise<void>;
    /**
     * Return true if `runTask` needs to be called now.
     */
    abstract trigger(nowMsecsSinceEpoch: number): {
        run: boolean;
    };
    abstract runTask(): Promise<string>;
}
//# sourceMappingURL=WalletMonitorTask.d.ts.map