@bopen-io/wallet-toolbox 1.7.18 → 1.7.19

package/out/src/storage/methods/reviewStatus.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reviewStatus.js","sourceRoot":"","sources":["../../../../src/storage/methods/reviewStatus.ts"],"names":[],"mappings":";;AAkBA,oCA4EC;AA3FD,uDAAmD;AAInD;;;;;;;;;;GAUG;AACI,KAAK,UAAU,YAAY,CAChC,OAAoB,EACpB,IAAyC;IAEzC,MAAM,CAAC,GAAoB,EAAE,GAAG,EAAE,EAAE,EAAE,CAAA;IAEtC,MAAM,oBAAoB,GAAG,KAAK,EAAoB,EAAqB,EAAiB,EAAE;QAC5F,IAAI,CAAC;YACH,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;YACxB,MAAM,KAAK,GAAG,MAAM,EAAE,CAAC,CAAC,CAAA;YACxB,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;gBACd,CAAC,CAAC,GAAG,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC,GAAG,IAAI,CAAA;YACjC,CAAC;QACH,CAAC;QAAC,OAAO,EAAW,EAAE,CAAC;YACrB,6DAA6D;YAC7D,MAAM,CAAC,GAAG,yBAAW,CAAC,WAAW,CAAC,EAAE,CAAC,CAAA;YACrC,MAAM,EAAE,CAAA;QACV,CAAC;IACH,CAAC,CAAA;IAED,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAEhC,MAAM,EAAE,GAAwB,EAAE,CAAA;IAElC,EAAE,CAAC,IAAI,CAAC;QACN,GAAG,EAAE,8FAA8F;QACnG;;;cAGM;QACN,CAAC,EAAE,CAAC,CAAmB,cAAc,CAAC;aACnC,MAAM,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;aAC5B,QAAQ,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;aAC9B,WAAW,CAAC;YACX,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;iBAClB,IAAI,CAAC,qBAAqB,CAAC;iBAC3B,QAAQ,CAAC,qDAAqD,CAAC,CAAA;QACpE,CAAC,CAAC;KACL,CAAC,CAAA;IAEF,EAAE,CAAC,IAAI,CAAC;QACN,GAAG,EAAE,kFAAkF;QACvF;;;cAGM;QACN,CAAC,EAAE,CAAC,CAAc,SAAS,CAAC;aACzB,MAAM,CAAC,EAAE,OAAO,EAAE,IAA4B,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;aAClE,WAAW,CAAC;YACX,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;iBAClB,IAAI,CAAC,mBAAmB,CAAC;iBACzB,QAAQ,CAAC,2DAA2D,CAAC,CAAA;QAC1E,CAAC,CAAC;KACL,CAAC,CAAA;IAEF,EAAE,CAAC,IAAI,CAAC;QACN,GAAG,EAAE,yGAAyG;QAC9G;;;;cAIM;QACN,CAAC,EAAE,CAAC,CAAmB,cAAc,CAAC;aACnC,MAAM,CAAC;YACN,MAAM,EAAE,WAAW;YACnB,UAAU,EAAE,CAAC,CAAC,GAAG,CAAC,2EAA2E,CAAC;SAC/F,CAAC;aACD,SAAS,CAAC,YAAY,CAAC;aACvB,WAAW,CAAC;YACX,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAC,4BAA4B,CAAC,CAAA;QACtF,CAAC,CAAC;KACL,CAAC,CAAA;IAEF,KAAK,MAAM,CAAC,IAAI,EAAE;QAAE,MAAM,oBAAoB,CAAC,CAAC,CAAC,CAAA;IAEjD,OAAO,CAAC,CAAA;AACV,CAAC"}

package/out/src/storage/methods/reviewStatusIdb.d.ts

@@ -0,0 +1,20 @@
+import { sdk } from '../../index.client';
+import { StorageIdb } from '../StorageIdb';
+/**
+ * Looks for unpropagated state:
+ *
+ * 1. set transactions to 'failed' if not already failed and provenTxReq with matching txid has status of 'invalid'.
+ * 2. sets transactions to 'completed' if provenTx with matching txid exists and current provenTxId is null.
+ * 3. sets outputs to spendable true, spentBy undefined if spentBy is a transaction with status 'failed'.
+ *
+ * @param storage
+ * @param args
+ * @returns
+ */
+export declare function reviewStatusIdb(storage: StorageIdb, args: {
+    agedLimit: Date;
+    trx?: sdk.TrxToken;
+}): Promise<{
+    log: string;
+}>;
+//# sourceMappingURL=reviewStatusIdb.d.ts.map

package/out/src/storage/methods/reviewStatusIdb.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reviewStatusIdb.d.ts","sourceRoot":"","sources":["../../../../src/storage/methods/reviewStatusIdb.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,GAAG,EAAE,MAAM,oBAAoB,CAAA;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAE1C;;;;;;;;;;GAUG;AACH,wBAAsB,eAAe,CACnC,OAAO,EAAE,UAAU,EACnB,IAAI,EAAE;IAAE,SAAS,EAAE,IAAI,CAAC;IAAC,GAAG,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAA;CAAE,GAC5C,OAAO,CAAC;IAAE,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC,CAsB1B"}

package/out/src/storage/methods/reviewStatusIdb.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.reviewStatusIdb = reviewStatusIdb;
+/**
+ * Looks for unpropagated state:
+ *
+ * 1. set transactions to 'failed' if not already failed and provenTxReq with matching txid has status of 'invalid'.
+ * 2. sets transactions to 'completed' if provenTx with matching txid exists and current provenTxId is null.
+ * 3. sets outputs to spendable true, spentBy undefined if spentBy is a transaction with status 'failed'.
+ *
+ * @param storage
+ * @param args
+ * @returns
+ */
+async function reviewStatusIdb(storage, args) {
+    const r = { log: '' };
+    // 1. set transactions to 'failed' if not already failed and provenTxReq with matching txid has status of 'invalid'.
+    const invalidTxids = [];
+    await storage.filterProvenTxReqs({ partial: { status: 'invalid' } }, txReq => {
+        invalidTxids.push(txReq.txid);
+    });
+    for (const txid of invalidTxids) {
+        const txs = await storage.findTransactions({ partial: { txid } });
+        for (const tx of txs) {
+            if (tx.status !== 'failed') {
+                r.log += `transaction ${tx.transactionId} updated to status of 'failed' was ${tx.status}\n`;
+                await storage.updateTransactionStatus('failed', tx.transactionId);
+            }
+        }
+    }
+    // 2. sets transactions to 'completed' if provenTx with matching txid exists and current provenTxId is null.
+    // 3. sets outputs to spendable true, spentBy undefined if spentBy is a transaction with status 'failed'.
+    return r;
+}
+//# sourceMappingURL=reviewStatusIdb.js.map

package/out/src/storage/methods/reviewStatusIdb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reviewStatusIdb.js","sourceRoot":"","sources":["../../../../src/storage/methods/reviewStatusIdb.ts"],"names":[],"mappings":";;AAiBA,0CAyBC;AApCD;;;;;;;;;;GAUG;AACI,KAAK,UAAU,eAAe,CACnC,OAAmB,EACnB,IAA6C;IAE7C,MAAM,CAAC,GAAoB,EAAE,GAAG,EAAE,EAAE,EAAE,CAAA;IAEtC,oHAAoH;IACpH,MAAM,YAAY,GAAa,EAAE,CAAA;IACjC,MAAM,OAAO,CAAC,kBAAkB,CAAC,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE;QAC3E,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAC/B,CAAC,CAAC,CAAA;IACF,KAAK,MAAM,IAAI,IAAI,YAAY,EAAE,CAAC;QAChC,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,gBAAgB,CAAC,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,CAAA;QACjE,KAAK,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;YACrB,IAAI,EAAE,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC3B,CAAC,CAAC,GAAG,IAAI,eAAe,EAAE,CAAC,aAAa,sCAAsC,EAAE,CAAC,MAAM,IAAI,CAAA;gBAC3F,MAAM,OAAO,CAAC,uBAAuB,CAAC,QAAQ,EAAE,EAAE,CAAC,aAAa,CAAC,CAAA;YACnE,CAAC;QACH,CAAC;IACH,CAAC;IAED,4GAA4G;IAC5G,yGAAyG;IAEzG,OAAO,CAAC,CAAA;AACV,CAAC"}

package/out/src/storage/methods/utils.Buffer.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Returns a copy of a Buffer with byte order reversed.
+ * @returns new buffer with byte order reversed.
+ * @publicbody
+ */
+export declare function swapByteOrder(buffer: Buffer): Buffer;
+/**
+ * @param num a number value in the Uint32 value range
+ * @param littleEndian true for little-endian byte order in Buffer
+ * @returns four byte buffer with Uint32 number encoded
+ * @publicbody
+ */
+export declare function convertUint32ToBuffer(num: number, littleEndian?: boolean): Buffer;
+/**
+ * @param buffer four byte buffer with Uint32 number encoded
+ * @param littleEndian true for little-endian byte order in Buffer
+ * @returns a number value in the Uint32 value range
+ * @publicbody
+ */
+export declare function convertBufferToUint32(buffer: Buffer, littleEndian?: boolean): number;
+//# sourceMappingURL=utils.Buffer.d.ts.map

package/out/src/storage/methods/utils.Buffer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.Buffer.d.ts","sourceRoot":"","sources":["../../../../src/storage/methods/utils.Buffer.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEpD;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,YAAY,UAAO,GAAG,MAAM,CAK9E;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,UAAO,GAAG,MAAM,CAIjF"}

package/out/src/storage/methods/utils.Buffer.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.swapByteOrder = swapByteOrder;
+exports.convertUint32ToBuffer = convertUint32ToBuffer;
+exports.convertBufferToUint32 = convertBufferToUint32;
+/**
+ * Returns a copy of a Buffer with byte order reversed.
+ * @returns new buffer with byte order reversed.
+ * @publicbody
+ */
+function swapByteOrder(buffer) {
+    return Buffer.from(buffer).reverse();
+}
+/**
+ * @param num a number value in the Uint32 value range
+ * @param littleEndian true for little-endian byte order in Buffer
+ * @returns four byte buffer with Uint32 number encoded
+ * @publicbody
+ */
+function convertUint32ToBuffer(num, littleEndian = true) {
+    const arr = new ArrayBuffer(4);
+    const view = new DataView(arr);
+    view.setUint32(0, num, littleEndian); // byteOffset = 0
+    return Buffer.from(arr);
+}
+/**
+ * @param buffer four byte buffer with Uint32 number encoded
+ * @param littleEndian true for little-endian byte order in Buffer
+ * @returns a number value in the Uint32 value range
+ * @publicbody
+ */
+function convertBufferToUint32(buffer, littleEndian = true) {
+    const arr = buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength);
+    const view = new DataView(arr);
+    return view.getUint32(0, littleEndian);
+}
+//# sourceMappingURL=utils.Buffer.js.map

package/out/src/storage/methods/utils.Buffer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.Buffer.js","sourceRoot":"","sources":["../../../../src/storage/methods/utils.Buffer.ts"],"names":[],"mappings":";;AAKA,sCAEC;AAQD,sDAKC;AAQD,sDAIC;AAhCD;;;;GAIG;AACH,SAAgB,aAAa,CAAC,MAAc;IAC1C,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,CAAA;AACtC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,GAAW,EAAE,YAAY,GAAG,IAAI;IACpE,MAAM,GAAG,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAA;IAC9B,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAA;IAC9B,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,YAAY,CAAC,CAAA,CAAC,iBAAiB;IACtD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AACzB,CAAC;AAED;;;;;GAKG;AACH,SAAgB,qBAAqB,CAAC,MAAc,EAAE,YAAY,GAAG,IAAI;IACvE,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,MAAM,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,CAAA;IACzF,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAA;IAC9B,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,YAAY,CAAC,CAAA;AACxC,CAAC"}

package/out/src/storage/methods/utils.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Returns the byte size required to encode number as Bitcoin VarUint
+ * @publicbody
+ */
+export declare function varUintSize(val: number): 1 | 3 | 5 | 9;
+/**
+ * @param scriptSize byte length of input script
+ * @returns serialized byte length a transaction input
+ */
+export declare function transactionInputSize(scriptSize: number): number;
+/**
+ * @param scriptSize byte length of output script
+ * @returns serialized byte length a transaction output
+ */
+export declare function transactionOutputSize(scriptSize: number): number;
+/**
+ * Compute the serialized binary transaction size in bytes
+ * given the number of inputs and outputs,
+ * and the size of each script.
+ * @param inputs array of input script lengths, in bytes
+ * @param outputs array of output script lengths, in bytes
+ * @returns total transaction size in bytes
+ */
+export declare function transactionSize(inputs: number[], outputs: number[]): number;
+//# sourceMappingURL=utils.d.ts.map

package/out/src/storage/methods/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../src/storage/methods/utils.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAGtD;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAQ/D;AAED;;;GAGG;AAEH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAMhE;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAS3E"}

package/out/src/storage/methods/utils.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.varUintSize = varUintSize;
+exports.transactionInputSize = transactionInputSize;
+exports.transactionOutputSize = transactionOutputSize;
+exports.transactionSize = transactionSize;
+const WERR_errors_1 = require("../../sdk/WERR_errors");
+/**
+ * Returns the byte size required to encode number as Bitcoin VarUint
+ * @publicbody
+ */
+function varUintSize(val) {
+    if (val < 0)
+        throw new WERR_errors_1.WERR_INVALID_PARAMETER('varUint', 'non-negative');
+    return val <= 0xfc ? 1 : val <= 0xffff ? 3 : val <= 0xffffffff ? 5 : 9;
+}
+/**
+ * @param scriptSize byte length of input script
+ * @returns serialized byte length a transaction input
+ */
+function transactionInputSize(scriptSize) {
+    return (32 + // txid
+        4 + // vout
+        varUintSize(scriptSize) + // script length, this is already in bytes
+        scriptSize + // script
+        4); // sequence number
+}
+/**
+ * @param scriptSize byte length of output script
+ * @returns serialized byte length a transaction output
+ */
+function transactionOutputSize(scriptSize) {
+    return (varUintSize(scriptSize) + // output script length, from script encoded as hex string
+        scriptSize + // output script
+        8); // output amount (satoshis)
+}
+/**
+ * Compute the serialized binary transaction size in bytes
+ * given the number of inputs and outputs,
+ * and the size of each script.
+ * @param inputs array of input script lengths, in bytes
+ * @param outputs array of output script lengths, in bytes
+ * @returns total transaction size in bytes
+ */
+function transactionSize(inputs, outputs) {
+    return (4 + // Version
+        varUintSize(inputs.length) + // Number of inputs
+        inputs.reduce((a, e) => a + transactionInputSize(e), 0) + // all inputs
+        varUintSize(outputs.length) + // Number of outputs
+        outputs.reduce((a, e) => a + transactionOutputSize(e), 0) + // all outputs
+        4); // lock time
+}
+//# sourceMappingURL=utils.js.map

package/out/src/storage/methods/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/storage/methods/utils.ts"],"names":[],"mappings":";;AAMA,kCAGC;AAMD,oDAQC;AAOD,sDAMC;AAUD,0CASC;AAvDD,uDAA8D;AAE9D;;;GAGG;AACH,SAAgB,WAAW,CAAC,GAAW;IACrC,IAAI,GAAG,GAAG,CAAC;QAAE,MAAM,IAAI,oCAAsB,CAAC,SAAS,EAAE,cAAc,CAAC,CAAA;IACxE,OAAO,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AACxE,CAAC;AAED;;;GAGG;AACH,SAAgB,oBAAoB,CAAC,UAAkB;IACrD,OAAO,CACL,EAAE,GAAG,OAAO;QACZ,CAAC,GAAG,OAAO;QACX,WAAW,CAAC,UAAU,CAAC,GAAG,0CAA0C;QACpE,UAAU,GAAG,SAAS;QACtB,CAAC,CACF,CAAA,CAAC,kBAAkB;AACtB,CAAC;AAED;;;GAGG;AAEH,SAAgB,qBAAqB,CAAC,UAAkB;IACtD,OAAO,CACL,WAAW,CAAC,UAAU,CAAC,GAAG,0DAA0D;QACpF,UAAU,GAAG,gBAAgB;QAC7B,CAAC,CACF,CAAA,CAAC,2BAA2B;AAC/B,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,eAAe,CAAC,MAAgB,EAAE,OAAiB;IACjE,OAAO,CACL,CAAC,GAAG,UAAU;QACd,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,mBAAmB;QAChD,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,aAAa;QACvE,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,oBAAoB;QAClD,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,cAAc;QAC1E,CAAC,CACF,CAAA,CAAC,YAAY;AAChB,CAAC"}

package/out/src/storage/remoting/StorageClient.d.ts

@@ -0,0 +1,292 @@
+import { AbortActionArgs, AbortActionResult, InternalizeActionArgs, ListActionsResult, ListCertificatesResult, ListOutputsResult, RelinquishCertificateArgs, RelinquishOutputArgs, WalletInterface, Validation } from '@bsv/sdk';
+import { AuthId, FindCertificatesArgs, FindOutputBasketsArgs, FindOutputsArgs, FindProvenTxReqsArgs, ProcessSyncChunkResult, RequestSyncChunkArgs, StorageCreateActionResult, StorageInternalizeActionResult, StorageProcessActionArgs, StorageProcessActionResults, SyncChunk, UpdateProvenTxReqWithNewProvenTxArgs, UpdateProvenTxReqWithNewProvenTxResult, WalletStorageProvider } from '../../sdk/WalletStorage.interfaces';
+import { TableSettings } from '../schema/tables/TableSettings';
+import { WalletServices } from '../../sdk/WalletServices.interfaces';
+import { TableUser } from '../schema/tables/TableUser';
+import { TableSyncState } from '../schema/tables/TableSyncState';
+import { TableCertificateX } from '../schema/tables/TableCertificate';
+import { TableOutputBasket } from '../schema/tables/TableOutputBasket';
+import { TableOutput } from '../schema/tables/TableOutput';
+import { TableProvenTxReq } from '../schema/tables/TableProvenTxReq';
+import { EntityTimeStamp } from '../../sdk/types';
+/**
+ * `StorageClient` implements the `WalletStorageProvider` interface which allows it to
+ * serve as a BRC-100 wallet's active storage.
+ *
+ * Internally, it uses JSON-RPC over HTTPS to make requests of a remote server.
+ * Typically this server uses the `StorageServer` class to implement the service.
+ *
+ * The `AuthFetch` component is used to secure and authenticate the requests to the remote server.
+ *
+ * `AuthFetch` is initialized with a BRC-100 wallet which establishes the identity of
+ * the party making requests of the remote service.
+ *
+ * For details of the API implemented, follow the "See also" link for the `WalletStorageProvider` interface.
+ */
+export declare class StorageClient implements WalletStorageProvider {
+    readonly endpointUrl: string;
+    private readonly authClient;
+    private nextId;
+    settings?: TableSettings;
+    constructor(wallet: WalletInterface, endpointUrl: string);
+    /**
+     * The `StorageClient` implements the `WalletStorageProvider` interface.
+     * It does not implement the lower level `StorageProvider` interface.
+     *
+     * @returns false
+     */
+    isStorageProvider(): boolean;
+    /**
+     * Make a JSON-RPC call to the remote server.
+     * @param method The WalletStorage method name to call.
+     * @param params The array of parameters to pass to the method in order.
+     */
+    private rpcCall;
+    /**
+     * @returns true once storage `TableSettings` have been retreived from remote storage.
+     */
+    isAvailable(): boolean;
+    /**
+     * @returns remote storage `TableSettings` if they have been retreived by `makeAvailable`.
+     * @throws WERR_INVALID_OPERATION if `makeAvailable` has not yet been called.
+     */
+    getSettings(): TableSettings;
+    /**
+     * Must be called prior to making use of storage.
+     * Retreives `TableSettings` from remote storage provider.
+     * @returns remote storage `TableSettings`
+     */
+    makeAvailable(): Promise<TableSettings>;
+    /**
+     * Called to cleanup resources when no further use of this object will occur.
+     */
+    destroy(): Promise<void>;
+    /**
+     * Requests schema migration to latest.
+     * Typically remote storage will ignore this request.
+     * @param storageName Unique human readable name for remote storage if it does not yet exist.
+     * @param storageIdentityKey Unique identity key for remote storage if it does not yet exist.
+     * @returns current schema migration identifier
+     */
+    migrate(storageName: string, storageIdentityKey: string): Promise<string>;
+    /**
+     * Remote storage does not offer `Services` to remote clients.
+     * @throws WERR_INVALID_OPERATION
+     */
+    getServices(): WalletServices;
+    /**
+     * Ignored. Remote storage cannot share `Services` with remote clients.
+     */
+    setServices(v: WalletServices): void;
+    /**
+     * Storage level processing for wallet `internalizeAction`.
+     * Updates internalized outputs in remote storage.
+     * Triggers proof validation of containing transaction.
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args Original wallet `internalizeAction` arguments.
+     * @returns `internalizeAction` results
+     */
+    internalizeAction(auth: AuthId, args: InternalizeActionArgs): Promise<StorageInternalizeActionResult>;
+    /**
+     * Storage level processing for wallet `createAction`.
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args Validated extension of original wallet `createAction` arguments.
+     * @returns `StorageCreateActionResults` supporting additional wallet processing to yield `createAction` results.
+     */
+    createAction(auth: AuthId, args: Validation.ValidCreateActionArgs): Promise<StorageCreateActionResult>;
+    /**
+     * Storage level processing for wallet `createAction` and `signAction`.
+     *
+     * Handles remaining storage tasks once a fully signed transaction has been completed. This is common to both `createAction` and `signAction`.
+     *
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args `StorageProcessActionArgs` convey completed signed transaction to storage.
+     * @returns `StorageProcessActionResults` supporting final wallet processing to yield `createAction` or `signAction` results.
+     */
+    processAction(auth: AuthId, args: StorageProcessActionArgs): Promise<StorageProcessActionResults>;
+    /**
+     * Aborts an action by `reference` string.
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args original wallet `abortAction` args.
+     * @returns `abortAction` result.
+     */
+    abortAction(auth: AuthId, args: AbortActionArgs): Promise<AbortActionResult>;
+    /**
+     * Used to both find and initialize a new user by identity key.
+     * It is up to the remote storage whether to allow creation of new users by this method.
+     * @param identityKey of the user.
+     * @returns `TableUser` for the user and whether a new user was created.
+     */
+    findOrInsertUser(identityKey: any): Promise<{
+        user: TableUser;
+        isNew: boolean;
+    }>;
+    /**
+     * Used to both find and insert a `TableSyncState` record for the user to track wallet data replication across storage providers.
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param storageName the name of the remote storage being sync'd
+     * @param storageIdentityKey the identity key of the remote storage being sync'd
+     * @returns `TableSyncState` and whether a new record was created.
+     */
+    findOrInsertSyncStateAuth(auth: AuthId, storageIdentityKey: string, storageName: string): Promise<{
+        syncState: TableSyncState;
+        isNew: boolean;
+    }>;
+    /**
+     * Inserts a new certificate with fields and keyring into remote storage.
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param certificate the certificate to insert.
+     * @returns record Id of the inserted `TableCertificate` record.
+     */
+    insertCertificateAuth(auth: AuthId, certificate: TableCertificateX): Promise<number>;
+    /**
+     * Storage level processing for wallet `listActions`.
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args Validated extension of original wallet `listActions` arguments.
+     * @returns `listActions` results.
+     */
+    listActions(auth: AuthId, vargs: Validation.ValidListActionsArgs): Promise<ListActionsResult>;
+    /**
+     * Storage level processing for wallet `listOutputs`.
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args Validated extension of original wallet `listOutputs` arguments.
+     * @returns `listOutputs` results.
+     */
+    listOutputs(auth: AuthId, vargs: Validation.ValidListOutputsArgs): Promise<ListOutputsResult>;
+    /**
+     * Storage level processing for wallet `listCertificates`.
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args Validated extension of original wallet `listCertificates` arguments.
+     * @returns `listCertificates` results.
+     */
+    listCertificates(auth: AuthId, vargs: Validation.ValidListCertificatesArgs): Promise<ListCertificatesResult>;
+    /**
+     * Find user certificates, optionally with fields.
+     *
+     * This certificate retrieval method supports internal wallet operations.
+     * Field values are stored and retrieved encrypted.
+     *
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args `FindCertificatesArgs` determines which certificates to retrieve and whether to include fields.
+     * @returns array of certificates matching args.
+     */
+    findCertificatesAuth(auth: AuthId, args: FindCertificatesArgs): Promise<TableCertificateX[]>;
+    /**
+     * Find output baskets.
+     *
+     * This retrieval method supports internal wallet operations.
+     *
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args `FindOutputBasketsArgs` determines which baskets to retrieve.
+     * @returns array of output baskets matching args.
+     */
+    findOutputBasketsAuth(auth: AuthId, args: FindOutputBasketsArgs): Promise<TableOutputBasket[]>;
+    /**
+     * Find outputs.
+     *
+     * This retrieval method supports internal wallet operations.
+     *
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args `FindOutputsArgs` determines which outputs to retrieve.
+     * @returns array of outputs matching args.
+     */
+    findOutputsAuth(auth: AuthId, args: FindOutputsArgs): Promise<TableOutput[]>;
+    /**
+     * Find requests for transaction proofs.
+     *
+     * This retrieval method supports internal wallet operations.
+     *
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args `FindProvenTxReqsArgs` determines which proof requests to retrieve.
+     * @returns array of proof requests matching args.
+     */
+    findProvenTxReqs(args: FindProvenTxReqsArgs): Promise<TableProvenTxReq[]>;
+    /**
+     * Relinquish a certificate.
+     *
+     * For storage supporting replication records must be kept of deletions. Therefore certificates are marked as deleted
+     * when relinquished, and no longer returned by `listCertificates`, but are still retained by storage.
+     *
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args original wallet `relinquishCertificate` args.
+     */
+    relinquishCertificate(auth: AuthId, args: RelinquishCertificateArgs): Promise<number>;
+    /**
+     * Relinquish an output.
+     *
+     * Relinquishing an output removes the output from whatever basket was tracking it.
+     *
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param args original wallet `relinquishOutput` args.
+     */
+    relinquishOutput(auth: AuthId, args: RelinquishOutputArgs): Promise<number>;
+    /**
+     * Process a "chunk" of replication data for the user.
+     *
+     * The normal data flow is for the active storage to push backups as a sequence of data chunks to backup storage providers.
+     *
+     * @param args a copy of the replication request args that initiated the sequence of data chunks.
+     * @param chunk the current data chunk to process.
+     * @returns whether processing is done, counts of inserts and udpates, and related progress tracking properties.
+     */
+    processSyncChunk(args: RequestSyncChunkArgs, chunk: SyncChunk): Promise<ProcessSyncChunkResult>;
+    /**
+     * Request a "chunk" of replication data for a specific user and storage provider.
+     *
+     * The normal data flow is for the active storage to push backups as a sequence of data chunks to backup storage providers.
+     * Also supports recovery where non-active storage can attempt to merge available data prior to becoming active.
+     *
+     * @param args that identify the non-active storage which will receive replication data and constrains the replication process.
+     * @returns the next "chunk" of replication data
+     */
+    getSyncChunk(args: RequestSyncChunkArgs): Promise<SyncChunk>;
+    /**
+     * Handles the data received when a new transaction proof is found in response to an outstanding request for proof data:
+     *
+     *   - Creates a new `TableProvenTx` record.
+     *   - Notifies all user transaction records of the new status.
+     *   - Updates the proof request record to 'completed' status which enables delayed deletion.
+     *
+     * @param args proof request and new transaction proof data
+     * @returns results of updates
+     */
+    updateProvenTxReqWithNewProvenTx(args: UpdateProvenTxReqWithNewProvenTxArgs): Promise<UpdateProvenTxReqWithNewProvenTxResult>;
+    /**
+     * Ensures up-to-date wallet data replication to all configured backup storage providers,
+     * then promotes one of the configured backups to active,
+     * demoting the current active to new backup.
+     *
+     * @param auth Identifies client by identity key and the storage identity key of their currently active storage.
+     * This must match the `AuthFetch` identity securing the remote conneciton.
+     * @param newActiveStorageIdentityKey which must be a currently configured backup storage provider.
+     */
+    setActive(auth: AuthId, newActiveStorageIdentityKey: string): Promise<number>;
+    validateDate(date: Date | string | number): Date;
+    /**
+     * Helper to force uniform behavior across database engines.
+     * Use to process all individual records with time stamps retreived from database.
+     */
+    validateEntity<T extends EntityTimeStamp>(entity: T, dateFields?: string[]): T;
+    /**
+     * Helper to force uniform behavior across database engines.
+     * Use to process all arrays of records with time stamps retreived from database.
+     * @returns input `entities` array with contained values validated.
+     */
+    validateEntities<T extends EntityTimeStamp>(entities: T[], dateFields?: string[]): T[];
+}
+//# sourceMappingURL=StorageClient.d.ts.map

package/out/src/storage/remoting/StorageClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"StorageClient.d.ts","sourceRoot":"","sources":["../../../../src/storage/remoting/StorageClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,qBAAqB,EACrB,iBAAiB,EACjB,sBAAsB,EACtB,iBAAiB,EACjB,yBAAyB,EACzB,oBAAoB,EACpB,eAAe,EAEf,UAAU,EAEX,MAAM,UAAU,CAAA;AACjB,OAAO,EACL,MAAM,EACN,oBAAoB,EACpB,qBAAqB,EACrB,eAAe,EACf,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,yBAAyB,EACzB,8BAA8B,EAC9B,wBAAwB,EACxB,2BAA2B,EAC3B,SAAS,EACT,oCAAoC,EACpC,sCAAsC,EACtC,qBAAqB,EACtB,MAAM,oCAAoC,CAAA;AAC3C,OAAO,EAAE,aAAa,EAAE,MAAM,gCAAgC,CAAA;AAE9D,OAAO,EAAE,cAAc,EAAE,MAAM,qCAAqC,CAAA;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AACtD,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAA;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mCAAmC,CAAA;AACrE,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAA;AACtE,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAC1D,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAKjD;;;;;;;;;;;;;GAaG;AACH,qBAAa,aAAc,YAAW,qBAAqB;IACzD,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAW;IACtC,OAAO,CAAC,MAAM,CAAI;IAGX,QAAQ,CAAC,EAAE,aAAa,CAAA;gBAEnB,MAAM,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM;IAKxD;;;;;OAKG;IACH,iBAAiB,IAAI,OAAO;IAQ5B;;;;OAIG;YACW,OAAO;IA4DrB;;OAEG;IACH,WAAW,IAAI,OAAO;IAKtB;;;OAGG;IACH,WAAW,IAAI,aAAa;IAO5B;;;;OAIG;IACG,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC;IAe7C;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI9B;;;;;;OAMG;IACG,OAAO,CAAC,WAAW,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI/E;;;OAGG;IACH,WAAW,IAAI,cAAc;IAQ7B;;OAEG;IACH,WAAW,CAAC,CAAC,EAAE,cAAc,GAAG,IAAI;IAKpC;;;;;;;;OAQG;IACG,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAI3G;;;;;;OAMG;IACG,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,CAAC,qBAAqB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAI5G;;;;;;;;;OASG;IACG,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAIvG;;;;;;OAMG;IACG,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIlF;;;;;OAKG;IACG,gBAAgB,CAAC,WAAW,KAAA,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,SAAS,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC;IAIjF;;;;;;;OAOG;IACG,yBAAyB,CAC7B,IAAI,EAAE,MAAM,EACZ,kBAAkB,EAAE,MAAM,EAC1B,WAAW,EAAE,MAAM,GAClB,OAAO,CAAC;QAAE,SAAS,EAAE,cAAc,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC;IAUzD;;;;;;OAMG;IACG,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,iBAAiB,GAAG,OAAO,CAAC,MAAM,CAAC;IAK1F;;;;;;OAMG;IACG,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,oBAAoB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKnG;;;;;;OAMG;IACG,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,oBAAoB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAKnG;;;;;;OAMG;IACG,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,CAAC,yBAAyB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAKlH;;;;;;;;;;OAUG;IACG,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAWlG;;;;;;;;;OASG;IACG,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,qBAAqB,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAMpG;;;;;;;;;OASG;IACG,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IAMlF;;;;;;;;;OASG;IACG,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAM/E;;;;;;;;;OASG;IACG,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,yBAAyB,GAAG,OAAO,CAAC,MAAM,CAAC;IAI3F;;;;;;;;OAQG;IACG,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IAIjF;;;;;;;;OAQG;IACG,gBAAgB,CAAC,IAAI,EAAE,oBAAoB,EAAE,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAKrG;;;;;;;;OAQG;IACG,YAAY,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,SAAS,CAAC;IAkBlE;;;;;;;;;OASG;IACG,gCAAgC,CACpC,IAAI,EAAE,oCAAoC,GACzC,OAAO,CAAC,sCAAsC,CAAC;IAKlD;;;;;;;;OAQG;IACG,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,2BAA2B,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAInF,YAAY,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI;IAOhD;;;OAGG;IACH,cAAc,CAAC,CAAC,SAAS,eAAe,EAAE,MAAM,EAAE,CAAC,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC;IAmB9E;;;;OAIG;IACH,gBAAgB,CAAC,CAAC,SAAS,eAAe,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,UAAU,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;CAMvF"}