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

Client only Wallet Storage

import { sdk } from '../../index.client';
import { Monitor } from '../Monitor';
import { WalletMonitorTask } from './WalletMonitorTask';
/**
 * The database stores a variety of data that may be considered transient.
 *
 * At one extreme, the data that must be preserved:
 *   - unspent outputs (UTXOs)
 *   - in-use metadata (labels, baskets, tags...)
 *
 * At the other extreme, everything can be preserved to fully log all transaction creation and processing actions.
 *
 * The following purge actions are available to support sustained operation:
 *   - Failed transactions, delete all associated data including:
 *       + Delete tag and label mapping records
 *       + Delete output records
 *       + Delete transaction records
 *       + Delete mapi_responses records
 *       + Delete proven_tx_reqs records
 *       + Delete commissions records
 *       + Update output records marked spentBy failed transactions
 *   - Completed transactions, delete transient data including:
 *       + transactions table set truncatedExternalInputs = null
 *       + transactions table set beef = null
 *       + transactions table set rawTx = null
 *       + Delete mapi_responses records
 *       + proven_tx_reqs table delete records
 */
export interface TaskPurgeParams extends sdk.PurgeParams {
}
export declare class TaskPurge extends WalletMonitorTask {
    params: TaskPurgeParams;
    triggerMsecs: number;
    static taskName: string;
    /**
     * Set to true to trigger running this task
     */
    static checkNow: boolean;
    constructor(monitor: Monitor, params: TaskPurgeParams, triggerMsecs?: number);
    trigger(nowMsecsSinceEpoch: number): {
        run: boolean;
    };
    runTask(): Promise<string>;
}
//# sourceMappingURL=TaskPurge.d.ts.map