@bsv/wallet-toolbox 1.1.0

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

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBeefForTransaction = getBeefForTransaction;
+const sdk_1 = require("@bsv/sdk");
+const index_client_1 = require("../../index.client");
+/**
+ * Creates a `Beef` to support the validity of a transaction identified by its `txid`.
+ *
+ * `storage` is used to retrieve proven transactions and their merkle paths,
+ * or proven_tx_req record with beef of external inputs (internal inputs meged by recursion).
+ * Otherwise external services are used.
+ *
+ * `options.maxRecursionDepth` can be set to prevent overly deep chained dependencies. Will throw ERR_EXTSVS_ENVELOPE_DEPTH if exceeded.
+ *
+ * If `trustSelf` is true, a partial `Beef` will be returned where transactions known by `storage` to
+ * be valid by verified proof are represented solely by 'txid'.
+ *
+ * If `knownTxids` is defined, any 'txid' required by the `Beef` that appears in the array is represented solely as a 'known' txid.
+ *
+ * @param storage the chain on which txid exists.
+ * @param txid the transaction hash for which an envelope is requested.
+ * @param options
+ */
+async function getBeefForTransaction(storage, txid, options) {
+    const beef = 
+    // deserialize mergeToBeef if it is an array
+    Array.isArray(options.mergeToBeef)
+        ? sdk_1.Beef.fromBinary(options.mergeToBeef)
+        : // otherwise if undefined create a new Beef
+            options.mergeToBeef || new sdk_1.Beef();
+    await mergeBeefForTransactionRecurse(beef, storage, txid, options, 0);
+    return beef;
+}
+/**
+ * @returns rawTx if txid known to network, if merkle proof available then also proven result is valid.
+ */
+async function getProvenOrRawTxFromServices(storage, txid, options) {
+    var _a;
+    const services = storage.getServices();
+    const por = await index_client_1.entity.ProvenTx.fromTxid(txid, await storage.getServices());
+    if (por.proven && !options.ignoreStorage && !options.ignoreNewProven) {
+        por.proven.provenTxId = await storage.insertProvenTx(por.proven.toApi());
+    }
+    return { proven: (_a = por.proven) === null || _a === void 0 ? void 0 : _a.toApi(), rawTx: por.rawTx };
+}
+async function mergeBeefForTransactionRecurse(beef, storage, txid, options, recursionDepth) {
+    const maxDepth = storage.maxRecursionDepth;
+    if (maxDepth && maxDepth <= recursionDepth)
+        throw new index_client_1.sdk.WERR_INVALID_OPERATION(`Maximum BEEF depth exceeded. Limit is ${storage.maxRecursionDepth}`);
+    if (options.knownTxids && options.knownTxids.indexOf(txid) > -1) {
+        // This txid is one of the txids the caller claims to already know are valid...
+        beef.mergeTxidOnly(txid);
+        return beef;
+    }
+    if (!options.ignoreStorage) {
+        // if we can use storage, ask storage if it has the txid
+        const knownBeef = await storage.getValidBeefForTxid(txid, beef, options.trustSelf, options.knownTxids);
+        if (knownBeef)
+            return knownBeef;
+    }
+    if (options.ignoreServices)
+        throw new index_client_1.sdk.WERR_INVALID_PARAMETER(`txid ${txid}`, `valid transaction on chain ${storage.chain}`);
+    // if storage doesn't know about txid, use services
+    // to find it and if it has a proof, remember it.
+    const r = await getProvenOrRawTxFromServices(storage, txid, options);
+    if (r.proven &&
+        options.minProofLevel &&
+        options.minProofLevel > recursionDepth) {
+        // ignore proof at this recursion depth
+        r.proven = undefined;
+    }
+    if (r.proven) {
+        // storage has proven this txid,
+        // merge both the raw transaction and its merkle path
+        beef.mergeRawTx(r.proven.rawTx);
+        beef.mergeBump(new index_client_1.entity.ProvenTx(r.proven).getMerklePath());
+        return beef;
+    }
+    if (!r.rawTx)
+        throw new index_client_1.sdk.WERR_INVALID_PARAMETER(`txid ${txid}`, `valid transaction on chain ${storage.chain}`);
+    // merge the raw transaction and recurse over its inputs.
+    beef.mergeRawTx(r.rawTx);
+    // recurse inputs
+    const tx = (0, index_client_1.asBsvSdkTx)(r.rawTx);
+    for (const input of tx.inputs) {
+        const inputTxid = (0, index_client_1.verifyTruthy)(input.sourceTXID);
+        if (!beef.findTxid(inputTxid)) {
+            // Only if the txid is not already in the list of beef transactions.
+            await mergeBeefForTransactionRecurse(beef, storage, inputTxid, options, recursionDepth + 1);
+        }
+    }
+    return beef;
+}
+//# sourceMappingURL=getBeefForTransaction.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getBeefForTransaction.js","sourceRoot":"","sources":["../../../../src/storage/methods/getBeefForTransaction.ts"],"names":[],"mappings":";;AA2BA,sDAeC;AA1CD,kCAA+B;AAC/B,qDAM2B;AAE3B;;;;;;;;;;;;;;;;;GAiBG;AACI,KAAK,UAAU,qBAAqB,CACzC,OAAwB,EACxB,IAAY,EACZ,OAAkC;IAElC,MAAM,IAAI;IACR,4CAA4C;IAC5C,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;QAChC,CAAC,CAAC,UAAI,CAAC,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC;QACtC,CAAC,CAAC,2CAA2C;YAC3C,OAAO,CAAC,WAAW,IAAI,IAAI,UAAI,EAAE,CAAA;IAEvC,MAAM,8BAA8B,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAA;IAErE,OAAO,IAAI,CAAA;AACb,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,4BAA4B,CACzC,OAAwB,EACxB,IAAY,EACZ,OAAkC;;IAElC,MAAM,QAAQ,GAAG,OAAO,CAAC,WAAW,EAAE,CAAA;IACtC,MAAM,GAAG,GAAG,MAAM,qBAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IAC7E,IAAI,GAAG,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,CAAC;QACrE,GAAG,CAAC,MAAM,CAAC,UAAU,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAA;IAC1E,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,MAAA,GAAG,CAAC,MAAM,0CAAE,KAAK,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,KAAK,EAAE,CAAA;AAC1D,CAAC;AAED,KAAK,UAAU,8BAA8B,CAC3C,IAAU,EACV,OAAwB,EACxB,IAAY,EACZ,OAAkC,EAClC,cAAsB;IAEtB,MAAM,QAAQ,GAAG,OAAO,CAAC,iBAAiB,CAAA;IAC1C,IAAI,QAAQ,IAAI,QAAQ,IAAI,cAAc;QACxC,MAAM,IAAI,kBAAG,CAAC,sBAAsB,CAClC,yCAAyC,OAAO,CAAC,iBAAiB,EAAE,CACrE,CAAA;IAEH,IAAI,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QAChE,+EAA+E;QAC/E,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;QACxB,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;QAC3B,wDAAwD;QACxD,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,mBAAmB,CACjD,IAAI,EACJ,IAAI,EACJ,OAAO,CAAC,SAAS,EACjB,OAAO,CAAC,UAAU,CACnB,CAAA;QACD,IAAI,SAAS;YAAE,OAAO,SAAS,CAAA;IACjC,CAAC;IAED,IAAI,OAAO,CAAC,cAAc;QACxB,MAAM,IAAI,kBAAG,CAAC,sBAAsB,CAClC,QAAQ,IAAI,EAAE,EACd,8BAA8B,OAAO,CAAC,KAAK,EAAE,CAC9C,CAAA;IAEH,mDAAmD;IACnD,iDAAiD;IACjD,MAAM,CAAC,GAAG,MAAM,4BAA4B,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CAAA;IAEpE,IACE,CAAC,CAAC,MAAM;QACR,OAAO,CAAC,aAAa;QACrB,OAAO,CAAC,aAAa,GAAG,cAAc,EACtC,CAAC;QACD,uCAAuC;QACvC,CAAC,CAAC,MAAM,GAAG,SAAS,CAAA;IACtB,CAAC;IAED,IAAI,CAAC,CAAC,MAAM,EAAE,CAAC;QACb,gCAAgC;QAChC,qDAAqD;QACrD,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAC/B,IAAI,CAAC,SAAS,CAAC,IAAI,qBAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,aAAa,EAAE,CAAC,CAAA;QAC7D,OAAO,IAAI,CAAA;IACb,CAAC;IAED,IAAI,CAAC,CAAC,CAAC,KAAK;QACV,MAAM,IAAI,kBAAG,CAAC,sBAAsB,CAClC,QAAQ,IAAI,EAAE,EACd,8BAA8B,OAAO,CAAC,KAAK,EAAE,CAC9C,CAAA;IAEH,yDAAyD;IACzD,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,KAAM,CAAC,CAAA;IACzB,iBAAiB;IACjB,MAAM,EAAE,GAAG,IAAA,yBAAU,EAAC,CAAC,CAAC,KAAM,CAAC,CAAA;IAC/B,KAAK,MAAM,KAAK,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC;QAC9B,MAAM,SAAS,GAAG,IAAA,2BAAY,EAAC,KAAK,CAAC,UAAU,CAAC,CAAA;QAChD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YAC9B,oEAAoE;YACpE,MAAM,8BAA8B,CAClC,IAAI,EACJ,OAAO,EACP,SAAS,EACT,OAAO,EACP,cAAc,GAAG,CAAC,CACnB,CAAA;QACH,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC"}

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

@@ -0,0 +1,10 @@
+import { sdk } from '../../index.client';
+import { StorageReader } from '../StorageReader';
+/**
+ * Gets the next sync chunk of updated data from un-remoted storage (could be using a remote DB connection).
+ * @param storage
+ * @param args
+ * @returns
+ */
+export declare function getSyncChunk(storage: StorageReader, args: sdk.RequestSyncChunkArgs): Promise<sdk.SyncChunk>;
+//# sourceMappingURL=getSyncChunk.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getSyncChunk.d.ts","sourceRoot":"","sources":["../../../../src/storage/methods/getSyncChunk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAuB,MAAM,oBAAoB,CAAA;AAC7D,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAEhD;;;;;GAKG;AACH,wBAAsB,YAAY,CAChC,OAAO,EAAE,aAAa,EACtB,IAAI,EAAE,GAAG,CAAC,oBAAoB,GAC7B,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAqSxB"}

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

@@ -0,0 +1,271 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSyncChunk = getSyncChunk;
+const index_client_1 = require("../../index.client");
+/**
+ * Gets the next sync chunk of updated data from un-remoted storage (could be using a remote DB connection).
+ * @param storage
+ * @param args
+ * @returns
+ */
+async function getSyncChunk(storage, args) {
+    const r = {
+        fromStorageIdentityKey: '',
+        toStorageIdentityKey: '',
+        userIdentityKey: args.identityKey
+    };
+    let itemCount = args.maxItems;
+    let roughSize = args.maxRoughSize;
+    let i = 0;
+    let done = false;
+    const user = (0, index_client_1.verifyTruthy)(await storage.findUserByIdentityKey(args.identityKey));
+    if (!args.since || user.updated_at > args.since)
+        r.user = user;
+    const chunkers = [
+        {
+            name: 'provenTx',
+            maxDivider: 100,
+            preAdd: () => {
+                r.provenTxs = [];
+            },
+            addItem: (i) => {
+                r.provenTxs.push(i);
+            },
+            findItems: async (storage, args) => {
+                return await storage.getProvenTxsForUser(args);
+            }
+        },
+        {
+            name: 'outputBasket',
+            maxDivider: 1,
+            preAdd: () => {
+                r.outputBaskets = [];
+            },
+            addItem: (i) => {
+                r.outputBaskets.push(i);
+            },
+            findItems: async (storage, args) => {
+                return await storage.findOutputBaskets({
+                    partial: { userId: args.userId },
+                    since: args.since,
+                    paged: args.paged
+                });
+            }
+        },
+        {
+            name: 'outputTag',
+            maxDivider: 1,
+            preAdd: () => {
+                r.outputTags = [];
+            },
+            addItem: (i) => {
+                r.outputTags.push(i);
+            },
+            findItems: async (storage, args) => {
+                return await storage.findOutputTags({
+                    partial: { userId: args.userId },
+                    since: args.since,
+                    paged: args.paged
+                });
+            }
+        },
+        {
+            name: 'txLabel',
+            maxDivider: 1,
+            preAdd: () => {
+                r.txLabels = [];
+            },
+            addItem: (i) => {
+                r.txLabels.push(i);
+            },
+            findItems: async (storage, args) => {
+                return await storage.findTxLabels({
+                    partial: { userId: args.userId },
+                    since: args.since,
+                    paged: args.paged
+                });
+            }
+        },
+        {
+            name: 'transaction',
+            maxDivider: 25,
+            preAdd: () => {
+                r.transactions = [];
+            },
+            addItem: (i) => {
+                r.transactions.push(i);
+            },
+            findItems: async (storage, args) => {
+                return await storage.findTransactions({
+                    partial: { userId: args.userId },
+                    since: args.since,
+                    paged: args.paged
+                });
+            }
+        },
+        {
+            name: 'output',
+            maxDivider: 25,
+            preAdd: () => {
+                r.outputs = [];
+            },
+            addItem: (i) => {
+                r.outputs.push(i);
+            },
+            findItems: async (storage, args) => {
+                return await storage.findOutputs({
+                    partial: { userId: args.userId },
+                    since: args.since,
+                    paged: args.paged
+                });
+            }
+        },
+        {
+            name: 'txLabelMap',
+            maxDivider: 1,
+            preAdd: () => {
+                r.txLabelMaps = [];
+            },
+            addItem: (i) => {
+                r.txLabelMaps.push(i);
+            },
+            findItems: async (storage, args) => {
+                return await storage.getTxLabelMapsForUser(args);
+            }
+        },
+        {
+            name: 'outputTagMap',
+            maxDivider: 1,
+            preAdd: () => {
+                r.outputTagMaps = [];
+            },
+            addItem: (i) => {
+                r.outputTagMaps.push(i);
+            },
+            findItems: async (storage, args) => {
+                return await storage.getOutputTagMapsForUser(args);
+            }
+        },
+        {
+            name: 'certificate',
+            maxDivider: 25,
+            preAdd: () => {
+                r.certificates = [];
+            },
+            addItem: (i) => {
+                r.certificates.push(i);
+            },
+            findItems: async (storage, args) => {
+                return await storage.findCertificates({
+                    partial: { userId: args.userId },
+                    since: args.since,
+                    paged: args.paged
+                });
+            }
+        },
+        {
+            name: 'certificateField',
+            maxDivider: 25,
+            preAdd: () => {
+                r.certificateFields = [];
+            },
+            addItem: (i) => {
+                r.certificateFields.push(i);
+            },
+            findItems: async (storage, args) => {
+                return await storage.findCertificateFields({
+                    partial: { userId: args.userId },
+                    since: args.since,
+                    paged: args.paged
+                });
+            }
+        },
+        {
+            name: 'commission',
+            maxDivider: 25,
+            preAdd: () => {
+                r.commissions = [];
+            },
+            addItem: (i) => {
+                r.commissions.push(i);
+            },
+            findItems: async (storage, args) => {
+                return await storage.findCommissions({
+                    partial: { userId: args.userId },
+                    since: args.since,
+                    paged: args.paged
+                });
+            }
+        },
+        {
+            name: 'provenTxReq',
+            maxDivider: 100,
+            preAdd: () => {
+                r.provenTxReqs = [];
+            },
+            addItem: (i) => {
+                r.provenTxReqs.push(i);
+            },
+            findItems: async (storage, args) => {
+                return await storage.getProvenTxReqsForUser(args);
+            }
+        }
+    ];
+    const addItems = async (a) => {
+        if (i >= args.offsets.length) {
+            done = true;
+            return;
+        }
+        let { offset, name: oname } = args.offsets[i++];
+        if (a.name !== oname)
+            throw new index_client_1.sdk.WERR_INVALID_PARAMETER('offsets', `in dependency order. '${a.name}' expected, found ${oname}.`);
+        let preAddCalled = false;
+        for (; !done;) {
+            const limit = Math.min(itemCount, Math.max(10, args.maxItems / a.maxDivider));
+            if (limit <= 0)
+                break;
+            const items = await a.findItems(storage, {
+                userId: user.userId,
+                since: args.since,
+                paged: { limit, offset }
+            });
+            checkEntityValues(items);
+            if (!preAddCalled) {
+                a.preAdd();
+                preAddCalled = true;
+            }
+            if (items.length === 0)
+                break;
+            for (const item of items) {
+                offset++;
+                a.addItem(item);
+                itemCount--;
+                roughSize -= JSON.stringify(item).length;
+                if (itemCount <= 0 || roughSize < 0) {
+                    done = true;
+                    break;
+                }
+            }
+        }
+    };
+    for (; !done;) {
+        for (const c of chunkers) {
+            await addItems(c);
+        }
+    }
+    return r;
+}
+function checkIsDate(v) {
+    if (!(v instanceof Date))
+        throw new index_client_1.sdk.WERR_INVALID_OPERATION('bad date');
+}
+function checkEntityValues(es) {
+    for (const e of es) {
+        checkIsDate(e['created_at']);
+        checkIsDate(e['updated_at']);
+        for (const key of Object.keys(e))
+            if (e[key] === null)
+                throw new index_client_1.sdk.WERR_INVALID_OPERATION();
+    }
+}
+//# sourceMappingURL=getSyncChunk.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"getSyncChunk.js","sourceRoot":"","sources":["../../../../src/storage/methods/getSyncChunk.ts"],"names":[],"mappings":";;AASA,oCAwSC;AAjTD,qDAA6D;AAG7D;;;;;GAKG;AACI,KAAK,UAAU,YAAY,CAChC,OAAsB,EACtB,IAA8B;IAE9B,MAAM,CAAC,GAAkB;QACvB,sBAAsB,EAAE,EAAE;QAC1B,oBAAoB,EAAE,EAAE;QACxB,eAAe,EAAE,IAAI,CAAC,WAAW;KAClC,CAAA;IAED,IAAI,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAA;IAC7B,IAAI,SAAS,GAAG,IAAI,CAAC,YAAY,CAAA;IACjC,IAAI,CAAC,GAAG,CAAC,CAAA;IACT,IAAI,IAAI,GAAG,KAAK,CAAA;IAEhB,MAAM,IAAI,GAAG,IAAA,2BAAY,EACvB,MAAM,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,WAAW,CAAC,CACtD,CAAA;IACD,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,KAAK;QAAE,CAAC,CAAC,IAAI,GAAG,IAAI,CAAA;IAE9D,MAAM,QAAQ,GAAkB;QAC9B;YACE,IAAI,EAAE,UAAU;YAChB,UAAU,EAAE,GAAG;YACf,MAAM,EAAE,GAAG,EAAE;gBACX,CAAC,CAAC,SAAS,GAAG,EAAE,CAAA;YAClB,CAAC;YACD,OAAO,EAAE,CAAC,CAAiB,EAAE,EAAE;gBAC7B,CAAC,CAAC,SAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACtB,CAAC;YACD,SAAS,EAAE,KAAK,EACd,OAAsB,EACtB,IAAmC,EACnC,EAAE;gBACF,OAAO,MAAM,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;YAChD,CAAC;SACF;QACD;YACE,IAAI,EAAE,cAAc;YACpB,UAAU,EAAE,CAAC;YACb,MAAM,EAAE,GAAG,EAAE;gBACX,CAAC,CAAC,aAAa,GAAG,EAAE,CAAA;YACtB,CAAC;YACD,OAAO,EAAE,CAAC,CAAqB,EAAE,EAAE;gBACjC,CAAC,CAAC,aAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YAC1B,CAAC;YACD,SAAS,EAAE,KAAK,EACd,OAAsB,EACtB,IAAmC,EACnC,EAAE;gBACF,OAAO,MAAM,OAAO,CAAC,iBAAiB,CAAC;oBACrC,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;oBAChC,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,KAAK,EAAE,IAAI,CAAC,KAAK;iBAClB,CAAC,CAAA;YACJ,CAAC;SACF;QACD;YACE,IAAI,EAAE,WAAW;YACjB,UAAU,EAAE,CAAC;YACb,MAAM,EAAE,GAAG,EAAE;gBACX,CAAC,CAAC,UAAU,GAAG,EAAE,CAAA;YACnB,CAAC;YACD,OAAO,EAAE,CAAC,CAAkB,EAAE,EAAE;gBAC9B,CAAC,CAAC,UAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACvB,CAAC;YACD,SAAS,EAAE,KAAK,EACd,OAAsB,EACtB,IAAmC,EACnC,EAAE;gBACF,OAAO,MAAM,OAAO,CAAC,cAAc,CAAC;oBAClC,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;oBAChC,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,KAAK,EAAE,IAAI,CAAC,KAAK;iBAClB,CAAC,CAAA;YACJ,CAAC;SACF;QACD;YACE,IAAI,EAAE,SAAS;YACf,UAAU,EAAE,CAAC;YACb,MAAM,EAAE,GAAG,EAAE;gBACX,CAAC,CAAC,QAAQ,GAAG,EAAE,CAAA;YACjB,CAAC;YACD,OAAO,EAAE,CAAC,CAAgB,EAAE,EAAE;gBAC5B,CAAC,CAAC,QAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACrB,CAAC;YACD,SAAS,EAAE,KAAK,EACd,OAAsB,EACtB,IAAmC,EACnC,EAAE;gBACF,OAAO,MAAM,OAAO,CAAC,YAAY,CAAC;oBAChC,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;oBAChC,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,KAAK,EAAE,IAAI,CAAC,KAAK;iBAClB,CAAC,CAAA;YACJ,CAAC;SACF;QACD;YACE,IAAI,EAAE,aAAa;YACnB,UAAU,EAAE,EAAE;YACd,MAAM,EAAE,GAAG,EAAE;gBACX,CAAC,CAAC,YAAY,GAAG,EAAE,CAAA;YACrB,CAAC;YACD,OAAO,EAAE,CAAC,CAAoB,EAAE,EAAE;gBAChC,CAAC,CAAC,YAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACzB,CAAC;YACD,SAAS,EAAE,KAAK,EACd,OAAsB,EACtB,IAAmC,EACnC,EAAE;gBACF,OAAO,MAAM,OAAO,CAAC,gBAAgB,CAAC;oBACpC,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;oBAChC,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,KAAK,EAAE,IAAI,CAAC,KAAK;iBAClB,CAAC,CAAA;YACJ,CAAC;SACF;QACD;YACE,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,EAAE;YACd,MAAM,EAAE,GAAG,EAAE;gBACX,CAAC,CAAC,OAAO,GAAG,EAAE,CAAA;YAChB,CAAC;YACD,OAAO,EAAE,CAAC,CAAe,EAAE,EAAE;gBAC3B,CAAC,CAAC,OAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACpB,CAAC;YACD,SAAS,EAAE,KAAK,EACd,OAAsB,EACtB,IAAmC,EACnC,EAAE;gBACF,OAAO,MAAM,OAAO,CAAC,WAAW,CAAC;oBAC/B,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;oBAChC,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,KAAK,EAAE,IAAI,CAAC,KAAK;iBAClB,CAAC,CAAA;YACJ,CAAC;SACF;QACD;YACE,IAAI,EAAE,YAAY;YAClB,UAAU,EAAE,CAAC;YACb,MAAM,EAAE,GAAG,EAAE;gBACX,CAAC,CAAC,WAAW,GAAG,EAAE,CAAA;YACpB,CAAC;YACD,OAAO,EAAE,CAAC,CAAmB,EAAE,EAAE;gBAC/B,CAAC,CAAC,WAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACxB,CAAC;YACD,SAAS,EAAE,KAAK,EACd,OAAsB,EACtB,IAAmC,EACnC,EAAE;gBACF,OAAO,MAAM,OAAO,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAA;YAClD,CAAC;SACF;QACD;YACE,IAAI,EAAE,cAAc;YACpB,UAAU,EAAE,CAAC;YACb,MAAM,EAAE,GAAG,EAAE;gBACX,CAAC,CAAC,aAAa,GAAG,EAAE,CAAA;YACtB,CAAC;YACD,OAAO,EAAE,CAAC,CAAqB,EAAE,EAAE;gBACjC,CAAC,CAAC,aAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YAC1B,CAAC;YACD,SAAS,EAAE,KAAK,EACd,OAAsB,EACtB,IAAmC,EACnC,EAAE;gBACF,OAAO,MAAM,OAAO,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAA;YACpD,CAAC;SACF;QACD;YACE,IAAI,EAAE,aAAa;YACnB,UAAU,EAAE,EAAE;YACd,MAAM,EAAE,GAAG,EAAE;gBACX,CAAC,CAAC,YAAY,GAAG,EAAE,CAAA;YACrB,CAAC;YACD,OAAO,EAAE,CAAC,CAAoB,EAAE,EAAE;gBAChC,CAAC,CAAC,YAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACzB,CAAC;YACD,SAAS,EAAE,KAAK,EACd,OAAsB,EACtB,IAAmC,EACnC,EAAE;gBACF,OAAO,MAAM,OAAO,CAAC,gBAAgB,CAAC;oBACpC,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;oBAChC,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,KAAK,EAAE,IAAI,CAAC,KAAK;iBAClB,CAAC,CAAA;YACJ,CAAC;SACF;QACD;YACE,IAAI,EAAE,kBAAkB;YACxB,UAAU,EAAE,EAAE;YACd,MAAM,EAAE,GAAG,EAAE;gBACX,CAAC,CAAC,iBAAiB,GAAG,EAAE,CAAA;YAC1B,CAAC;YACD,OAAO,EAAE,CAAC,CAAyB,EAAE,EAAE;gBACrC,CAAC,CAAC,iBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YAC9B,CAAC;YACD,SAAS,EAAE,KAAK,EACd,OAAsB,EACtB,IAAmC,EACnC,EAAE;gBACF,OAAO,MAAM,OAAO,CAAC,qBAAqB,CAAC;oBACzC,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;oBAChC,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,KAAK,EAAE,IAAI,CAAC,KAAK;iBAClB,CAAC,CAAA;YACJ,CAAC;SACF;QACD;YACE,IAAI,EAAE,YAAY;YAClB,UAAU,EAAE,EAAE;YACd,MAAM,EAAE,GAAG,EAAE;gBACX,CAAC,CAAC,WAAW,GAAG,EAAE,CAAA;YACpB,CAAC;YACD,OAAO,EAAE,CAAC,CAAmB,EAAE,EAAE;gBAC/B,CAAC,CAAC,WAAY,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACxB,CAAC;YACD,SAAS,EAAE,KAAK,EACd,OAAsB,EACtB,IAAmC,EACnC,EAAE;gBACF,OAAO,MAAM,OAAO,CAAC,eAAe,CAAC;oBACnC,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE;oBAChC,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,KAAK,EAAE,IAAI,CAAC,KAAK;iBAClB,CAAC,CAAA;YACJ,CAAC;SACF;QACD;YACE,IAAI,EAAE,aAAa;YACnB,UAAU,EAAE,GAAG;YACf,MAAM,EAAE,GAAG,EAAE;gBACX,CAAC,CAAC,YAAY,GAAG,EAAE,CAAA;YACrB,CAAC;YACD,OAAO,EAAE,CAAC,CAAoB,EAAE,EAAE;gBAChC,CAAC,CAAC,YAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YACzB,CAAC;YACD,SAAS,EAAE,KAAK,EACd,OAAsB,EACtB,IAAmC,EACnC,EAAE;gBACF,OAAO,MAAM,OAAO,CAAC,sBAAsB,CAAC,IAAI,CAAC,CAAA;YACnD,CAAC;SACF;KACF,CAAA;IAED,MAAM,QAAQ,GAAG,KAAK,EAAE,CAAc,EAAE,EAAE;QACxC,IAAI,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YAC7B,IAAI,GAAG,IAAI,CAAA;YACX,OAAM;QACR,CAAC;QACD,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAA;QAC/C,IAAI,CAAC,CAAC,IAAI,KAAK,KAAK;YAClB,MAAM,IAAI,kBAAG,CAAC,sBAAsB,CAClC,SAAS,EACT,yBAAyB,CAAC,CAAC,IAAI,qBAAqB,KAAK,GAAG,CAC7D,CAAA;QACH,IAAI,YAAY,GAAG,KAAK,CAAA;QACxB,OAAO,CAAC,IAAI,GAAI,CAAC;YACf,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CACpB,SAAS,EACT,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,UAAU,CAAC,CAC3C,CAAA;YACD,IAAI,KAAK,IAAI,CAAC;gBAAE,MAAK;YACrB,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,SAAS,CAAC,OAAO,EAAE;gBACvC,MAAM,EAAE,IAAI,CAAC,MAAM;gBACnB,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;aACzB,CAAC,CAAA;YACF,iBAAiB,CAAC,KAAK,CAAC,CAAA;YACxB,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,CAAC,CAAC,MAAM,EAAE,CAAA;gBACV,YAAY,GAAG,IAAI,CAAA;YACrB,CAAC;YACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;gBAAE,MAAK;YAC7B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,EAAE,CAAA;gBACR,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;gBACf,SAAS,EAAE,CAAA;gBACX,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,MAAM,CAAA;gBACxC,IAAI,SAAS,IAAI,CAAC,IAAI,SAAS,GAAG,CAAC,EAAE,CAAC;oBACpC,IAAI,GAAG,IAAI,CAAA;oBACX,MAAK;gBACP,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC,CAAA;IAED,OAAO,CAAC,IAAI,GAAI,CAAC;QACf,KAAK,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC;YACzB,MAAM,QAAQ,CAAC,CAAC,CAAC,CAAA;QACnB,CAAC;IACH,CAAC;IAED,OAAO,CAAC,CAAA;AACV,CAAC;AAaD,SAAS,WAAW,CAAC,CAAM;IACzB,IAAI,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC;QAAE,MAAM,IAAI,kBAAG,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAA;AAC5E,CAAC;AAED,SAAS,iBAAiB,CAAC,EAAY;IACrC,KAAK,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;QACnB,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAA;QAC5B,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAA;QAC5B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;YAC9B,IAAI,CAAC,CAAC,GAAG,CAAC,KAAK,IAAI;gBAAE,MAAM,IAAI,kBAAG,CAAC,sBAAsB,EAAE,CAAA;IAC/D,CAAC;AACH,CAAC"}

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

@@ -0,0 +1,38 @@
+import { InternalizeActionArgs, InternalizeActionResult } from '@bsv/sdk';
+import { sdk, StorageProvider } from '../../index.client';
+export interface StorageInternalizeActionResult extends InternalizeActionResult {
+    /** true if internalizing outputs on an existing storage transaction */
+    isMerge: boolean;
+    /** txid of transaction being internalized */
+    txid: string;
+    /** net change in change balance for user due to this internalization */
+    satoshis: number;
+}
+/**
+ * Internalize Action allows a wallet to take ownership of outputs in a pre-existing transaction.
+ * The transaction may, or may not already be known to both the storage and user.
+ *
+ * Two types of outputs are handled: "wallet payments" and "basket insertions".
+ *
+ * A "basket insertion" output is considered a custom output and has no effect on the wallet's "balance".
+ *
+ * A "wallet payment" adds an outputs value to the wallet's change "balance". These outputs are assigned to the "default" basket.
+ *
+ * Processing starts with simple validation and then checks for a pre-existing transaction.
+ * If the transaction is already known to the user, then the outputs are reviewed against the existing outputs treatment,
+ * and merge rules are added to the arguments passed to the storage layer.
+ * The existing transaction must be in the 'unproven' or 'completed' status. Any other status is an error.
+ *
+ * When the transaction already exists, the description is updated. The isOutgoing sense is not changed.
+ *
+ * "basket insertion" Merge Rules:
+ * 1. The "default" basket may not be specified as the insertion basket.
+ * 2. A change output in the "default" basket may not be target of an insertion into a different basket.
+ * 3. These baskets do not affect the wallet's balance and are typed "custom".
+ *
+ * "wallet payment" Merge Rules:
+ * 1. Targetting an existing change "default" basket output results in a no-op. No error. No alterations made.
+ * 2. Targetting a previously "custom" non-change output converts it into a change output. This alters the transaction's `satoshis`, and the wallet balance.
+ */
+export declare function internalizeAction(storage: StorageProvider, auth: sdk.AuthId, args: InternalizeActionArgs): Promise<InternalizeActionResult>;
+//# sourceMappingURL=internalizeAction.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"internalizeAction.d.ts","sourceRoot":"","sources":["../../../../src/storage/methods/internalizeAction.ts"],"names":[],"mappings":"AAEA,OAAO,EAIL,qBAAqB,EACrB,uBAAuB,EAGxB,MAAM,UAAU,CAAA;AACjB,OAAO,EAGL,GAAG,EAEH,eAAe,EAKhB,MAAM,oBAAoB,CAAA;AAE3B,MAAM,WAAW,8BACf,SAAQ,uBAAuB;IAC/B,uEAAuE;IACvE,OAAO,EAAE,OAAO,CAAA;IAChB,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAA;IACZ,wEAAwE;IACxE,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,eAAe,EACxB,IAAI,EAAE,GAAG,CAAC,MAAM,EAChB,IAAI,EAAE,qBAAqB,GAC1B,OAAO,CAAC,uBAAuB,CAAC,CAQlC"}