@bsv/wallet-toolbox 2.4.3 → 2.4.20

package/out/src/storage/StorageIdb.js

@@ -11,6 +11,7 @@ const reviewStatusIdb_1 = require("./methods/reviewStatusIdb");
 const purgeDataIdb_1 = require("./methods/purgeDataIdb");
 const WERR_errors_1 = require("../sdk/WERR_errors");
 const managedChange_1 = require("./methods/managedChange");
+const actionPlanning_1 = require("./methods/actionPlanning");
 /**
  * Shared cursor-scan loop used by all `filterXxx` methods of StorageIdb.
  *
@@ -31,7 +32,7 @@ cursor, since, offset, limit, matches, accept) {
         const r = cursor.value;
         if (since != null && since > r.updated_at)
             continue;
-        if (!await matches(r))
+        if (!(await matches(r)))
             continue;
         if (skipped < offset) {
             skipped++;
@@ -55,6 +56,9 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
         super(options);
         this.dbName = `wallet-toolbox-${this.chain}net`;
     }
+    supportsActionBatchPersistence() {
+        return true;
+    }
     /**
      * This method must be called at least once before any other method accesses the database,
      * and each time the schema may have updated.
@@ -115,16 +119,17 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
      *
      * @param trx
      */
-    async readSettings(trx) {
+    async readSettings(_trx) {
         await this.verifyDB();
         return this._settings;
     }
     async initDB(storageName, storageIdentityKey) {
         const chain = this.chain;
         const maxOutputScript = 1024;
-        const db = await (0, idb_1.openDB)(this.dbName, 1, {
+        const db = await (0, idb_1.openDB)(this.dbName, 2, {
             upgrade(db) {
                 (0, idbHelpers_1.upgradeAllStoresV1)(db);
+                (0, idbHelpers_1.upgradeActionBatchStoresV2)(db);
                 if (!db.objectStoreNames.contains('settings')) {
                     if (storageName == null || storageName === '' || storageIdentityKey == null || storageIdentityKey === '') {
                         throw new WERR_errors_1.WERR_INVALID_OPERATION('migrate must be called before first access');
@@ -174,7 +179,7 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
      * @returns next funding output to add to transaction or undefined if there are none.
      */
     async allocateChangeInput(userId, basketId, targetSatoshis, exactSatoshis, excludeSending, transactionId) {
-        const dbTrx = this.toDbTrx(['outputs', 'transactions', 'proven_txs', 'proven_tx_reqs'], 'readwrite');
+        const dbTrx = this.toDbTrx(['outputs', 'transactions', 'proven_txs', 'proven_tx_reqs', 'action_batch_outputs'], 'readwrite');
         try {
             const txStatus = ['completed', 'unproven'];
             if (!excludeSending)
@@ -188,35 +193,15 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
                 noScript: true,
                 trx: dbTrx
             };
-            const outputs = (await this.findOutputs(args)).filter(managedChange_1.isAutoSpendableChangeOutput);
-            let output;
-            let scores = [];
-            for (const o of outputs) {
-                if (exactSatoshis != null && exactSatoshis !== 0 && o.satoshis === exactSatoshis) {
-                    output = o;
-                    break;
-                }
-                const score = o.satoshis - targetSatoshis;
-                scores.push({ output: o, score });
-            }
-            if (output == null) {
-                // sort scores increasing by score property
-                scores = scores.sort((a, b) => a.score - b.score);
-                // find the first score that is greater than or equal to 0
-                const o = scores.find(s => s.score >= 0);
-                if (o != null) {
-                    // stage 2 satisfied (minimally funded)
-                    output = o.output;
-                }
-                else if (scores.length > 0) {
-                    // stage 3 satisfied (minimally under-funded)
-                    output = scores.at(-1).output;
-                }
-                else {
-                    // no available funding outputs
-                    output = undefined;
-                }
+            const reservationStore = dbTrx.objectStore('action_batch_outputs');
+            if (reservationStore.get == null)
+                throw new WERR_errors_1.WERR_INTERNAL('IndexedDB action_batch_outputs store does not support get');
+            const outputs = [];
+            for (const candidate of (await this.findOutputs(args)).filter(managedChange_1.isAutoSpendableChangeOutput)) {
+                if ((await reservationStore.get(candidate.outputId)) == null)
+                    outputs.push(candidate);
             }
+            const output = (0, actionPlanning_1.selectCanonicalChange)(outputs, targetSatoshis, exactSatoshis);
             if (output != null) {
                 // mark output as spent by transactionId
                 await this.updateOutput(output.outputId, { spendable: false, spentBy: transactionId }, dbTrx);
@@ -240,7 +225,7 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
         r.proven = (0, utilityHelpers_1.verifyOneOrNone)(await this.findProvenTxs({ partial: { txid }, trx }));
         if (r.proven == null) {
             const req = (0, utilityHelpers_1.verifyOneOrNone)(await this.findProvenTxReqs({ partial: { txid }, trx }));
-            if ((req != null) && ['unsent', 'unmined', 'unconfirmed', 'sending', 'nosend', 'completed'].includes(req.status)) {
+            if (req != null && ['unsent', 'unmined', 'unconfirmed', 'sending', 'nosend', 'completed'].includes(req.status)) {
                 r.rawTx = req.rawTx;
                 r.inputBEEF = req.inputBEEF;
             }
@@ -256,9 +241,7 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
         // Slice path uses an extended status set that includes 'unfail' — matches Knex
         // canon at StorageKnex.ts:131. The non-slice path continues to delegate to
         // getProvenOrRawTx which uses the narrower set.
-        const rawTx = sliceRequested
-            ? await this.getRawTxForSlice(txid, trx)
-            : await this.getRawTxFull(txid, trx);
+        const rawTx = sliceRequested ? await this.getRawTxForSlice(txid, trx) : await this.getRawTxFull(txid, trx);
         if (rawTx != null && sliceRequested) {
             return rawTx.slice(offset, offset + length);
         }
@@ -338,25 +321,29 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
         return count;
     }
     async findCertificatesAuth(auth, args) {
-        if (auth.userId == null || (args.partial.userId != null && args.partial.userId !== 0 && args.partial.userId !== auth.userId))
+        if (auth.userId == null ||
+            (args.partial.userId != null && args.partial.userId !== 0 && args.partial.userId !== auth.userId))
             throw new WERR_errors_1.WERR_UNAUTHORIZED();
         args.partial.userId = auth.userId;
         return await this.findCertificates(args);
     }
     async findOutputBasketsAuth(auth, args) {
-        if (auth.userId == null || (args.partial.userId != null && args.partial.userId !== 0 && args.partial.userId !== auth.userId))
+        if (auth.userId == null ||
+            (args.partial.userId != null && args.partial.userId !== 0 && args.partial.userId !== auth.userId))
             throw new WERR_errors_1.WERR_UNAUTHORIZED();
         args.partial.userId = auth.userId;
         return await this.findOutputBaskets(args);
     }
     async findOutputsAuth(auth, args) {
-        if (auth.userId == null || (args.partial.userId != null && args.partial.userId !== 0 && args.partial.userId !== auth.userId))
+        if (auth.userId == null ||
+            (args.partial.userId != null && args.partial.userId !== 0 && args.partial.userId !== auth.userId))
             throw new WERR_errors_1.WERR_UNAUTHORIZED();
         args.partial.userId = auth.userId;
         return await this.findOutputs(args);
     }
     async insertCertificateAuth(auth, certificate) {
-        if (auth.userId == null || (certificate.userId != null && certificate.userId !== 0 && certificate.userId !== auth.userId))
+        if (auth.userId == null ||
+            (certificate.userId != null && certificate.userId !== 0 && certificate.userId !== auth.userId))
             throw new WERR_errors_1.WERR_UNAUTHORIZED();
         certificate.userId = auth.userId;
         return await this.insertCertificate(certificate);
@@ -404,7 +391,10 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
             if (!(0, idbHelpers_1.matchesOutputTagMapPartial)(r, args.partial))
                 return false;
             if (userId !== undefined) {
-                const tagsForUser = await this.countOutputTags({ partial: { userId, outputTagId: r.outputTagId }, trx: dbTrx });
+                const tagsForUser = await this.countOutputTags({
+                    partial: { userId, outputTagId: r.outputTagId },
+                    trx: dbTrx
+                });
                 if (tagsForUser === 0)
                     return false;
             }
@@ -823,7 +813,8 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
         return user.userId;
     }
     async updateIdb(id, update, keyProp, storeName, trx) {
-        if (update[keyProp] !== undefined && (Array.isArray(id) || update[keyProp] !== id)) {
+        const indexedUpdate = update;
+        if (indexedUpdate[keyProp] !== undefined && (Array.isArray(id) || indexedUpdate[keyProp] !== id)) {
             throw new WERR_errors_1.WERR_INVALID_PARAMETER(`update.${keyProp}`, 'undefined');
         }
         const u = this.validatePartialForUpdate(update);
@@ -843,8 +834,10 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
                     ...u
                 };
                 const uid = await store.put(v);
-                if (uid !== i)
-                    throw new WERR_errors_1.WERR_INTERNAL(`updated id ${String(uid)} does not match original ${String(id)}`);
+                if (uid !== i) {
+                    const uidText = typeof uid === 'object' ? JSON.stringify(uid) : String(uid);
+                    throw new WERR_errors_1.WERR_INTERNAL(`updated id ${uidText} does not match original ${String(id)}`);
+                }
                 updated++;
             }
         }
@@ -855,11 +848,12 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
         return updated;
     }
     async updateIdbKey(key, update, keyProps, storeName, trx) {
+        const indexedUpdate = update;
         if (key.length !== keyProps.length) {
             throw new WERR_errors_1.WERR_INTERNAL(`key.length ${key.length} !== keyProps.length ${keyProps.length}`);
         }
         for (let i = 0; i < key.length; i++) {
-            if (update[keyProps[i]] !== undefined && update[keyProps[i]] !== key[i]) {
+            if (indexedUpdate[keyProps[i]] !== undefined && indexedUpdate[keyProps[i]] !== key[i]) {
                 throw new WERR_errors_1.WERR_INVALID_PARAMETER(`update.${keyProps[i]}`, 'undefined');
             }
         }
@@ -943,6 +937,9 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
         this._settings = undefined;
     }
     allStores = [
+        'action_batches',
+        'action_batch_outputs',
+        'action_batch_blobs',
         'certificates',
         'certificate_fields',
         'commissions',
@@ -959,6 +956,180 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
         'tx_labels_map',
         'users'
     ];
+    async insertActionBatch(batch, trx) {
+        const tx = this.toDbTrx(['action_batches'], 'readwrite', trx);
+        const { actionBatchId: _actionBatchId, ...withoutId } = batch;
+        const entity = batch.actionBatchId === 0 ? withoutId : batch;
+        const store = tx.objectStore('action_batches');
+        if (store.add == null)
+            throw new WERR_errors_1.WERR_INTERNAL('IndexedDB action_batches store does not support add');
+        const id = await store.add(entity);
+        batch.actionBatchId = Number(id);
+        if (trx == null)
+            await tx.done;
+        return Number(id);
+    }
+    async findActionBatch(userId, batchId, trx) {
+        const tx = this.toDbTrx(['action_batches'], 'readonly', trx);
+        const index = tx.objectStore('action_batches').index('userId_batchId');
+        if (index.get == null)
+            throw new WERR_errors_1.WERR_INTERNAL('IndexedDB action_batches userId_batchId index does not support get');
+        const batch = await index.get([userId, batchId]);
+        if (trx == null)
+            await tx.done;
+        return batch;
+    }
+    async findExpiredActionBatches(now, trx) {
+        const tx = this.toDbTrx(['action_batches'], 'readonly', trx);
+        const store = tx.objectStore('action_batches');
+        if (store.getAll == null)
+            throw new WERR_errors_1.WERR_INTERNAL('IndexedDB action_batches store does not support getAll');
+        const rows = await store.getAll();
+        if (trx == null)
+            await tx.done;
+        return rows.filter(r => (r.status === 'active' || r.status === 'prepared') &&
+            (r.expiresAt.getTime() <= now.getTime() || r.hardExpiresAt.getTime() <= now.getTime()));
+    }
+    async updateActionBatch(actionBatchId, update, trx) {
+        const tx = this.toDbTrx(['action_batches'], 'readwrite', trx);
+        const store = tx.objectStore('action_batches');
+        if (store.get == null || store.put == null) {
+            throw new WERR_errors_1.WERR_INTERNAL('IndexedDB action_batches store does not support get and put');
+        }
+        const batch = await store.get(actionBatchId);
+        if (batch == null) {
+            if (trx == null)
+                await tx.done;
+            return 0;
+        }
+        await store.put({ ...batch, ...update, updated_at: new Date() });
+        if (trx == null)
+            await tx.done;
+        return 1;
+    }
+    async deleteActionBatch(actionBatchId, trx) {
+        const tx = this.toDbTrx(['action_batches'], 'readwrite', trx);
+        const store = tx.objectStore('action_batches');
+        if (store.delete == null)
+            throw new WERR_errors_1.WERR_INTERNAL('IndexedDB action_batches store does not support delete');
+        await store.delete(actionBatchId);
+        if (trx == null)
+            await tx.done;
+    }
+    async reserveActionBatchOutputs(reservations, trx) {
+        if (reservations.length === 0)
+            return;
+        const tx = this.toDbTrx(['action_batch_outputs'], 'readwrite', trx);
+        const store = tx.objectStore('action_batch_outputs');
+        if (store.add == null)
+            throw new WERR_errors_1.WERR_INTERNAL('IndexedDB action_batch_outputs store does not support add');
+        for (const reservation of reservations)
+            await store.add(reservation);
+        if (trx == null)
+            await tx.done;
+    }
+    async findActionBatchOutputIds(actionBatchId, trx) {
+        const tx = this.toDbTrx(['action_batch_outputs'], 'readonly', trx);
+        const index = tx.objectStore('action_batch_outputs').index('actionBatchId');
+        if (index.getAll == null)
+            throw new WERR_errors_1.WERR_INTERNAL('IndexedDB action_batch_outputs index does not support getAll');
+        const rows = await index.getAll(actionBatchId);
+        if (trx == null)
+            await tx.done;
+        return rows.map(r => r.outputId);
+    }
+    async findReservedActionBatchOutputIds(outputIds, trx) {
+        const tx = this.toDbTrx(['action_batch_outputs'], 'readonly', trx);
+        const store = tx.objectStore('action_batch_outputs');
+        if (store.get == null)
+            throw new WERR_errors_1.WERR_INTERNAL('IndexedDB action_batch_outputs store does not support get');
+        const reserved = [];
+        for (const outputId of outputIds)
+            if ((await store.get(outputId)) != null)
+                reserved.push(outputId);
+        if (trx == null)
+            await tx.done;
+        return reserved;
+    }
+    async deleteActionBatchOutputReservations(actionBatchId, trx) {
+        const tx = this.toDbTrx(['action_batch_outputs'], 'readwrite', trx);
+        const store = tx.objectStore('action_batch_outputs');
+        const index = store.index('actionBatchId');
+        if (index.getAllKeys == null || store.delete == null) {
+            throw new WERR_errors_1.WERR_INTERNAL('IndexedDB action_batch_outputs store does not support indexed deletion');
+        }
+        const keys = await index.getAllKeys(actionBatchId);
+        for (const key of keys)
+            await store.delete(key);
+        if (trx == null)
+            await tx.done;
+    }
+    async putActionBatchBlobRecord(blob, trx) {
+        const tx = this.toDbTrx(['action_batch_blobs'], 'readwrite', trx);
+        const store = tx.objectStore('action_batch_blobs');
+        if (store.put == null)
+            throw new WERR_errors_1.WERR_INTERNAL('IndexedDB action_batch_blobs store does not support put');
+        await store.put({
+            ...blob,
+            bytes: blob.bytes instanceof Uint8Array ? blob.bytes : Uint8Array.from(blob.bytes)
+        });
+        if (trx == null)
+            await tx.done;
+    }
+    async findActionBatchBlobRecord(actionBatchId, digest, trx) {
+        const tx = this.toDbTrx(['action_batch_blobs'], 'readonly', trx);
+        const store = tx.objectStore('action_batch_blobs');
+        if (store.get == null)
+            throw new WERR_errors_1.WERR_INTERNAL('IndexedDB action_batch_blobs store does not support get');
+        const blob = await store.get([actionBatchId, digest]);
+        if (trx == null)
+            await tx.done;
+        return blob;
+    }
+    async findActionBatchBlobRecords(actionBatchId, digests, trx) {
+        const tx = this.toDbTrx(['action_batch_blobs'], 'readonly', trx);
+        const store = tx.objectStore('action_batch_blobs');
+        if (store.get == null)
+            throw new WERR_errors_1.WERR_INTERNAL('IndexedDB action_batch_blobs store does not support get');
+        const blobs = [];
+        for (const digest of new Set(digests)) {
+            const blob = await store.get([actionBatchId, digest]);
+            if (blob != null)
+                blobs.push(blob);
+        }
+        if (trx == null)
+            await tx.done;
+        return blobs;
+    }
+    async putActionBatchBlobRecords(blobs, trx) {
+        if (blobs.length === 0)
+            return;
+        const tx = this.toDbTrx(['action_batch_blobs'], 'readwrite', trx);
+        const store = tx.objectStore('action_batch_blobs');
+        if (store.put == null)
+            throw new WERR_errors_1.WERR_INTERNAL('IndexedDB action_batch_blobs store does not support put');
+        for (const blob of blobs) {
+            await store.put({
+                ...blob,
+                bytes: blob.bytes instanceof Uint8Array ? blob.bytes : Uint8Array.from(blob.bytes)
+            });
+        }
+        if (trx == null)
+            await tx.done;
+    }
+    async deleteActionBatchBlobRecords(actionBatchId, trx) {
+        const tx = this.toDbTrx(['action_batch_blobs'], 'readwrite', trx);
+        const store = tx.objectStore('action_batch_blobs');
+        const index = store.index('actionBatchId');
+        if (index.getAllKeys == null || store.delete == null) {
+            throw new WERR_errors_1.WERR_INTERNAL('IndexedDB action_batch_blobs store does not support indexed deletion');
+        }
+        const keys = await index.getAllKeys(actionBatchId);
+        for (const key of keys)
+            await store.delete(key);
+        if (trx == null)
+            await tx.done;
+    }
     /**
      * @param scope
      * @param trx
@@ -1091,7 +1262,9 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
         this.assertNoUndefinedInPartial(args.partial);
         const dbTrx = this.toDbTrx(['monitor_events'], 'readonly', args.trx);
         const store = dbTrx.objectStore('monitor_events');
-        const cursor = (args.partial?.id != null && args.partial.id !== 0) ? await store.openCursor(args.partial.id) : await store.openCursor();
+        const cursor = args.partial?.id != null && args.partial.id !== 0
+            ? await store.openCursor(args.partial.id)
+            : await store.openCursor();
         await scanCursor(cursor, args.since, args.paged?.offset ?? 0, args.paged?.limit, r => (0, idbHelpers_1.matchesMonitorEventPartial)(r, args.partial), filtered);
         if (args.trx == null)
             await dbTrx.done;
@@ -1144,7 +1317,9 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
             return store.openCursor(partial.outputId, direction);
         if (partial?.userId !== undefined) {
             if (partial?.transactionId != null && partial.transactionId !== 0 && partial?.vout !== undefined) {
-                return store.index('transactionId_vout_userId').openCursor([partial.transactionId, partial.vout, partial.userId], direction);
+                return store
+                    .index('transactionId_vout_userId')
+                    .openCursor([partial.transactionId, partial.vout, partial.userId], direction);
             }
             return store.index('userId').openCursor(partial.userId, direction);
         }
@@ -1182,7 +1357,9 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
                 if (txCount === 0)
                     return false;
             }
-            if (tagIds != null && tagIds.length > 0 && !await this.outputMatchesTags(r.outputId, tagIds, isQueryModeAll, dbTrx))
+            if (tagIds != null &&
+                tagIds.length > 0 &&
+                !(await this.outputMatchesTags(r.outputId, tagIds, isQueryModeAll, dbTrx)))
                 return false;
             return true;
         }, r => {
@@ -1335,7 +1512,9 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
                 return false;
             if (!(0, idbHelpers_1.matchesTransactionPartial)(r, args.partial))
                 return false;
-            if (labelIds != null && labelIds.length > 0 && !await this.transactionMatchesLabels(r.transactionId, labelIds, isQueryModeAll, dbTrx))
+            if (labelIds != null &&
+                labelIds.length > 0 &&
+                !(await this.transactionMatchesLabels(r.transactionId, labelIds, isQueryModeAll, dbTrx)))
                 return false;
             return true;
         }, filtered);
@@ -1408,9 +1587,9 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
             return true;
         if (partial.userId != null && partial.userId !== 0 && r.userId !== partial.userId)
             return false;
-        if ((partial.created_at != null) && r.created_at.getTime() !== partial.created_at.getTime())
+        if (partial.created_at != null && r.created_at.getTime() !== partial.created_at.getTime())
             return false;
-        if ((partial.updated_at != null) && r.updated_at.getTime() !== partial.updated_at.getTime())
+        if (partial.updated_at != null && r.updated_at.getTime() !== partial.updated_at.getTime())
             return false;
         if (partial.identityKey != null && partial.identityKey !== '' && r.identityKey !== partial.identityKey)
             return false;
@@ -1561,7 +1740,7 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
         }, args.userId);
         return results;
     }
-    async verifyReadyForDatabaseAccess(trx) {
+    async verifyReadyForDatabaseAccess(_trx) {
         this._settings ??= await this.readSettings();
         return this._settings.dbtype;
     }
@@ -1693,7 +1872,7 @@ class StorageIdb extends StorageProvider_1.StorageProvider {
             return;
         t.rawTx = rawTx;
     }
-    async adminStats(adminIdentityKey) {
+    async adminStats(_adminIdentityKey) {
         throw new Error('Method intentionally not implemented for personal storage.');
     }
 }