@bsv/wallet-toolbox-client 1.1.0

package/out/src/storage/schema/entities/ProvenTx.js

@@ -0,0 +1,283 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProvenTx = void 0;
+const sdk_1 = require("@bsv/sdk");
+const index_client_1 = require("../../../index.client");
+const _1 = require(".");
+class ProvenTx extends _1.EntityBase {
+    /**
+     * Given a txid and optionally its rawTx, create a new ProvenTx object.
+     *
+     * rawTx is fetched if not provided.
+     *
+     * Only succeeds (proven is not undefined) if a proof is confirmed for rawTx,
+     * and hash of rawTx is confirmed to match txid
+     *
+     * The returned ProvenTx and ProvenTxReq objects have not been added to the storage database,
+     * this is optional and can be done by the caller if appropriate.
+     *
+     * @param txid
+     * @param services
+     * @param rawTx
+     * @returns
+     */
+    static async fromTxid(txid, services, rawTx) {
+        var _a;
+        const r = { proven: undefined, rawTx };
+        const chain = services.chain;
+        if (!r.rawTx) {
+            const gr = await services.getRawTx(txid);
+            if (!(gr === null || gr === void 0 ? void 0 : gr.rawTx))
+                // Failing to find anything...
+                return r;
+            r.rawTx = gr.rawTx;
+        }
+        const gmpr = await services.getMerklePath(txid);
+        if (gmpr.merklePath && gmpr.header) {
+            const index = (_a = gmpr.merklePath.path[0].find(l => l.hash === txid)) === null || _a === void 0 ? void 0 : _a.offset;
+            if (index !== undefined) {
+                const api = {
+                    created_at: new Date(),
+                    updated_at: new Date(),
+                    provenTxId: 0,
+                    txid,
+                    height: gmpr.header.height,
+                    index,
+                    merklePath: gmpr.merklePath.toBinary(),
+                    rawTx: r.rawTx,
+                    blockHash: gmpr.header.hash,
+                    merkleRoot: gmpr.header.merkleRoot
+                };
+                r.proven = new ProvenTx(api);
+            }
+        }
+        return r;
+    }
+    constructor(api) {
+        const now = new Date();
+        super(api || {
+            provenTxId: 0,
+            created_at: now,
+            updated_at: now,
+            txid: '',
+            height: 0,
+            index: 0,
+            merklePath: [],
+            rawTx: [],
+            blockHash: '',
+            merkleRoot: ''
+        });
+    }
+    updateApi() {
+        /* nothing needed yet... */
+    }
+    /**
+     * @returns desirialized `MerklePath` object, value is cached.
+     */
+    getMerklePath() {
+        if (!this._mp)
+            this._mp = sdk_1.MerklePath.fromBinary(this.api.merklePath);
+        return this._mp;
+    }
+    get provenTxId() {
+        return this.api.provenTxId;
+    }
+    set provenTxId(v) {
+        this.api.provenTxId = v;
+    }
+    get created_at() {
+        return this.api.created_at;
+    }
+    set created_at(v) {
+        this.api.created_at = v;
+    }
+    get updated_at() {
+        return this.api.updated_at;
+    }
+    set updated_at(v) {
+        this.api.updated_at = v;
+    }
+    get txid() {
+        return this.api.txid;
+    }
+    set txid(v) {
+        this.api.txid = v;
+    }
+    get height() {
+        return this.api.height;
+    }
+    set height(v) {
+        this.api.height = v;
+    }
+    get index() {
+        return this.api.index;
+    }
+    set index(v) {
+        this.api.index = v;
+    }
+    get merklePath() {
+        return this.api.merklePath;
+    }
+    set merklePath(v) {
+        this.api.merklePath = v;
+    }
+    get rawTx() {
+        return this.api.rawTx;
+    }
+    set rawTx(v) {
+        this.api.rawTx = v;
+    }
+    get blockHash() {
+        return this.api.blockHash;
+    }
+    set blockHash(v) {
+        this.api.blockHash = v;
+    }
+    get merkleRoot() {
+        return this.api.merkleRoot;
+    }
+    set merkleRoot(v) {
+        this.api.merkleRoot = v;
+    }
+    get id() {
+        return this.api.provenTxId;
+    }
+    set id(v) {
+        this.api.provenTxId = v;
+    }
+    get entityName() {
+        return 'ProvenTx';
+    }
+    get entityTable() {
+        return 'proven_txs';
+    }
+    equals(ei, syncMap) {
+        const eo = this.toApi();
+        if (eo.txid != ei.txid ||
+            eo.height != ei.height ||
+            eo.index != ei.index ||
+            !(0, index_client_1.arraysEqual)(eo.merklePath, ei.merklePath) ||
+            !(0, index_client_1.arraysEqual)(eo.rawTx, ei.rawTx) ||
+            eo.blockHash !== ei.blockHash ||
+            eo.merkleRoot !== ei.merkleRoot
+        // equality does not depend on timestamps.
+        // || eo.created_at !== ei.created_at
+        // || eo.updated_at !== ei.updated_at
+        )
+            return false;
+        if (syncMap) {
+            if (eo.provenTxId !== syncMap.provenTx.idMap[ei.provenTxId])
+                return false;
+        }
+        else {
+            if (eo.provenTxId !== ei.provenTxId)
+                return false;
+        }
+        return true;
+    }
+    static async mergeFind(storage, userId, ei, syncMap, trx) {
+        const ef = (0, index_client_1.verifyOneOrNone)(await storage.findProvenTxs({ partial: { txid: ei.txid }, trx }));
+        return {
+            found: !!ef,
+            eo: new ProvenTx(ef || { ...ei }),
+            eiId: (0, index_client_1.verifyId)(ei.provenTxId)
+        };
+    }
+    async mergeNew(storage, userId, syncMap, trx) {
+        this.provenTxId = 0;
+        // TODO: Since these records are a shared resource, the record must be validated before accepting it...
+        this.provenTxId = await storage.insertProvenTx(this.toApi(), trx);
+    }
+    async mergeExisting(storage, since, ei, syncMap, trx) {
+        // ProvenTxs are never updated.
+        return false;
+    }
+    /**
+     * Try to create a new ProvenTx from a ProvenTxReq and GetMerkleProofResultApi
+     *
+     * Otherwise it returns undefined and updates req.status to either 'unknown', 'invalid', or 'unconfirmed'
+     *
+     * @param req
+     * @param gmpResult
+     * @returns
+     */
+    static async fromReq(req, gmpResult, countsAsAttempt) {
+        if (!req.txid)
+            throw new index_client_1.sdk.WERR_MISSING_PARAMETER('req.txid');
+        if (!req.rawTx)
+            throw new index_client_1.sdk.WERR_MISSING_PARAMETER('req.rawTx');
+        if (!req.rawTx)
+            throw new index_client_1.sdk.WERR_INTERNAL('rawTx must be valid');
+        req.addHistoryNote({
+            what: 'getMerkleProof result',
+            result: gmpResult,
+            attempts: req.attempts
+        });
+        if (!gmpResult.name && !gmpResult.merklePath && !gmpResult.error) {
+            // Most likely offline or now services configured.
+            // Does not count as a proof attempt.
+            return undefined;
+        }
+        if (!gmpResult.merklePath) {
+            if (req.created_at) {
+                const reqAgeInMsecs = Date.now() - req.created_at.getTime();
+                const reqAgeInMinutes = Math.ceil(reqAgeInMsecs < 1 ? 0 : reqAgeInMsecs / (1000 * 60));
+                if (req.attempts > index_client_1.entity.ProvenTx.getProofAttemptsLimit &&
+                    reqAgeInMinutes > index_client_1.entity.ProvenTx.getProofMinutes) {
+                    // Start the process of setting transactions to 'failed'
+                    req.addHistoryNote({
+                        what: 'getMerkleProof invalid',
+                        attempts: req.attempts,
+                        ageInMinutes: reqAgeInMinutes
+                    });
+                    req.notified = false;
+                    req.status = 'invalid';
+                }
+            }
+            return undefined;
+        }
+        if (countsAsAttempt)
+            req.attempts++;
+        const merklePaths = Array.isArray(gmpResult.merklePath)
+            ? gmpResult.merklePath
+            : [gmpResult.merklePath];
+        for (const proof of merklePaths) {
+            try {
+                const now = new Date();
+                const leaf = proof.path[0].find(leaf => leaf.txid === true && leaf.hash === req.txid);
+                if (!leaf)
+                    throw new index_client_1.sdk.WERR_INTERNAL('merkle path does not contain leaf for txid');
+                const proven = new ProvenTx({
+                    created_at: now,
+                    updated_at: now,
+                    provenTxId: 0,
+                    txid: req.txid,
+                    height: proof.blockHeight,
+                    index: leaf.offset,
+                    merklePath: proof.toBinary(),
+                    rawTx: req.rawTx,
+                    merkleRoot: gmpResult.header.merkleRoot,
+                    blockHash: gmpResult.header.hash
+                });
+                return proven;
+            }
+            catch (err) {
+                req.addHistoryNote({
+                    what: 'getMerkleProof catch',
+                    proof,
+                    error: index_client_1.sdk.WalletError.fromUnknown(err)
+                });
+            }
+        }
+    }
+}
+exports.ProvenTx = ProvenTx;
+/**
+ * How high attempts can go before status is forced to invalid
+ */
+ProvenTx.getProofAttemptsLimit = 8;
+/**
+ * How many hours we have to try for a poof
+ */
+ProvenTx.getProofMinutes = 60;
+//# sourceMappingURL=ProvenTx.js.map

package/out/src/storage/schema/entities/ProvenTx.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProvenTx.js","sourceRoot":"","sources":["../../../../../../src/storage/schema/entities/ProvenTx.ts"],"names":[],"mappings":";;;AAAA,kCAAqC;AACrC,wDAO8B;AAC9B,wBAA8B;AAE9B,MAAa,QAAS,SAAQ,aAA0B;IACtD;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,KAAK,CAAC,QAAQ,CACnB,IAAY,EACZ,QAA4B,EAC5B,KAAgB;;QAEhB,MAAM,CAAC,GAA2B,EAAE,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,CAAA;QAE9D,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAA;QAE5B,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;YACb,MAAM,EAAE,GAAG,MAAM,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;YACxC,IAAI,CAAC,CAAA,EAAE,aAAF,EAAE,uBAAF,EAAE,CAAE,KAAK,CAAA;gBACZ,8BAA8B;gBAC9B,OAAO,CAAC,CAAA;YACV,CAAC,CAAC,KAAK,GAAG,EAAE,CAAC,KAAM,CAAA;QACrB,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;QAE/C,IAAI,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACnC,MAAM,KAAK,GAAG,MAAA,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,0CAAE,MAAM,CAAA;YACxE,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,MAAM,GAAG,GAAmB;oBAC1B,UAAU,EAAE,IAAI,IAAI,EAAE;oBACtB,UAAU,EAAE,IAAI,IAAI,EAAE;oBACtB,UAAU,EAAE,CAAC;oBACb,IAAI;oBACJ,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM;oBAC1B,KAAK;oBACL,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE;oBACtC,KAAK,EAAE,CAAC,CAAC,KAAK;oBACd,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;oBAC3B,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,UAAU;iBACnC,CAAA;gBACD,CAAC,CAAC,MAAM,GAAG,IAAI,QAAQ,CAAC,GAAG,CAAC,CAAA;YAC9B,CAAC;QACH,CAAC;QAED,OAAO,CAAC,CAAA;IACV,CAAC;IAED,YAAY,GAAoB;QAC9B,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAA;QACtB,KAAK,CACH,GAAG,IAAI;YACL,UAAU,EAAE,CAAC;YACb,UAAU,EAAE,GAAG;YACf,UAAU,EAAE,GAAG;YACf,IAAI,EAAE,EAAE;YACR,MAAM,EAAE,CAAC;YACT,KAAK,EAAE,CAAC;YACR,UAAU,EAAE,EAAE;YACd,KAAK,EAAE,EAAE;YACT,SAAS,EAAE,EAAE;YACb,UAAU,EAAE,EAAE;SACf,CACF,CAAA;IACH,CAAC;IACQ,SAAS;QAChB,2BAA2B;IAC7B,CAAC;IAED;;OAEG;IACH,aAAa;QACX,IAAI,CAAC,IAAI,CAAC,GAAG;YAAE,IAAI,CAAC,GAAG,GAAG,gBAAU,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;QACpE,OAAO,IAAI,CAAC,GAAG,CAAA;IACjB,CAAC;IAGD,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,CAAA;IAC5B,CAAC;IACD,IAAI,UAAU,CAAC,CAAS;QACtB,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,CAAC,CAAA;IACzB,CAAC;IACD,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,CAAA;IAC5B,CAAC;IACD,IAAI,UAAU,CAAC,CAAO;QACpB,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,CAAC,CAAA;IACzB,CAAC;IACD,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,CAAA;IAC5B,CAAC;IACD,IAAI,UAAU,CAAC,CAAO;QACpB,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,CAAC,CAAA;IACzB,CAAC;IACD,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAA;IACtB,CAAC;IACD,IAAI,IAAI,CAAC,CAAS;QAChB,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,CAAA;IACnB,CAAC;IACD,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAA;IACxB,CAAC;IACD,IAAI,MAAM,CAAC,CAAS;QAClB,IAAI,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAA;IACrB,CAAC;IACD,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAA;IACvB,CAAC;IACD,IAAI,KAAK,CAAC,CAAS;QACjB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAA;IACpB,CAAC;IACD,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,CAAA;IAC5B,CAAC;IACD,IAAI,UAAU,CAAC,CAAW;QACxB,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,CAAC,CAAA;IACzB,CAAC;IACD,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAA;IACvB,CAAC;IACD,IAAI,KAAK,CAAC,CAAW;QACnB,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAA;IACpB,CAAC;IACD,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,CAAA;IAC3B,CAAC;IACD,IAAI,SAAS,CAAC,CAAS;QACrB,IAAI,CAAC,GAAG,CAAC,SAAS,GAAG,CAAC,CAAA;IACxB,CAAC;IACD,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,CAAA;IAC5B,CAAC;IACD,IAAI,UAAU,CAAC,CAAS;QACtB,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,CAAC,CAAA;IACzB,CAAC;IAED,IAAa,EAAE;QACb,OAAO,IAAI,CAAC,GAAG,CAAC,UAAU,CAAA;IAC5B,CAAC;IACD,IAAa,EAAE,CAAC,CAAS;QACvB,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,CAAC,CAAA;IACzB,CAAC;IACD,IAAa,UAAU;QACrB,OAAO,UAAU,CAAA;IACnB,CAAC;IACD,IAAa,WAAW;QACtB,OAAO,YAAY,CAAA;IACrB,CAAC;IAEQ,MAAM,CACb,EAAkB,EAClB,OAAoC;QAEpC,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,EAAE,CAAA;QACvB,IACE,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,IAAI;YAClB,EAAE,CAAC,MAAM,IAAI,EAAE,CAAC,MAAM;YACtB,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,KAAK;YACpB,CAAC,IAAA,0BAAW,EAAC,EAAE,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC;YAC1C,CAAC,IAAA,0BAAW,EAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC;YAChC,EAAE,CAAC,SAAS,KAAK,EAAE,CAAC,SAAS;YAC7B,EAAE,CAAC,UAAU,KAAK,EAAE,CAAC,UAAU;QAC/B,0CAA0C;QAC1C,qCAAqC;QACrC,qCAAqC;;YAErC,OAAO,KAAK,CAAA;QACd,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,EAAE,CAAC,UAAU,KAAK,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,UAAU,CAAC;gBAAE,OAAO,KAAK,CAAA;QAC3E,CAAC;aAAM,CAAC;YACN,IAAI,EAAE,CAAC,UAAU,KAAK,EAAE,CAAC,UAAU;gBAAE,OAAO,KAAK,CAAA;QACnD,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,SAAS,CACpB,OAA6B,EAC7B,MAAc,EACd,EAAkB,EAClB,OAAuB,EACvB,GAAkB;QAElB,MAAM,EAAE,GAAG,IAAA,8BAAe,EACxB,MAAM,OAAO,CAAC,aAAa,CAAC,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CACjE,CAAA;QACD,OAAO;YACL,KAAK,EAAE,CAAC,CAAC,EAAE;YACX,EAAE,EAAE,IAAI,QAAQ,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,EAAE,CAAC;YACjC,IAAI,EAAE,IAAA,uBAAQ,EAAC,EAAE,CAAC,UAAU,CAAC;SAC9B,CAAA;IACH,CAAC;IAEQ,KAAK,CAAC,QAAQ,CACrB,OAA6B,EAC7B,MAAc,EACd,OAAuB,EACvB,GAAkB;QAElB,IAAI,CAAC,UAAU,GAAG,CAAC,CAAA;QACnB,uGAAuG;QACvG,IAAI,CAAC,UAAU,GAAG,MAAM,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,GAAG,CAAC,CAAA;IACnE,CAAC;IAEQ,KAAK,CAAC,aAAa,CAC1B,OAA6B,EAC7B,KAAuB,EACvB,EAAkB,EAClB,OAAuB,EACvB,GAAkB;QAElB,+BAA+B;QAC/B,OAAO,KAAK,CAAA;IACd,CAAC;IAYD;;;;;;;;OAQG;IACH,MAAM,CAAC,KAAK,CAAC,OAAO,CAClB,GAAuB,EACvB,SAAkC,EAClC,eAAwB;QAExB,IAAI,CAAC,GAAG,CAAC,IAAI;YAAE,MAAM,IAAI,kBAAG,CAAC,sBAAsB,CAAC,UAAU,CAAC,CAAA;QAC/D,IAAI,CAAC,GAAG,CAAC,KAAK;YAAE,MAAM,IAAI,kBAAG,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAA;QAEjE,IAAI,CAAC,GAAG,CAAC,KAAK;YAAE,MAAM,IAAI,kBAAG,CAAC,aAAa,CAAC,qBAAqB,CAAC,CAAA;QAElE,GAAG,CAAC,cAAc,CAAC;YACjB,IAAI,EAAE,uBAAuB;YAC7B,MAAM,EAAE,SAAS;YACjB,QAAQ,EAAE,GAAG,CAAC,QAAQ;SACvB,CAAC,CAAA;QAEF,IAAI,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,UAAU,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;YACjE,kDAAkD;YAClD,qCAAqC;YACrC,OAAO,SAAS,CAAA;QAClB,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;YAC1B,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;gBACnB,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,UAAU,CAAC,OAAO,EAAE,CAAA;gBAC3D,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAC/B,aAAa,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,IAAI,GAAG,EAAE,CAAC,CACpD,CAAA;gBAED,IACE,GAAG,CAAC,QAAQ,GAAG,qBAAM,CAAC,QAAQ,CAAC,qBAAqB;oBACpD,eAAe,GAAG,qBAAM,CAAC,QAAQ,CAAC,eAAe,EACjD,CAAC;oBACD,wDAAwD;oBACxD,GAAG,CAAC,cAAc,CAAC;wBACjB,IAAI,EAAE,wBAAwB;wBAC9B,QAAQ,EAAE,GAAG,CAAC,QAAQ;wBACtB,YAAY,EAAE,eAAe;qBAC9B,CAAC,CAAA;oBACF,GAAG,CAAC,QAAQ,GAAG,KAAK,CAAA;oBACpB,GAAG,CAAC,MAAM,GAAG,SAAS,CAAA;gBACxB,CAAC;YACH,CAAC;YACD,OAAO,SAAS,CAAA;QAClB,CAAC;QAED,IAAI,eAAe;YAAE,GAAG,CAAC,QAAQ,EAAE,CAAA;QAEnC,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC;YACrD,CAAC,CAAC,SAAS,CAAC,UAAU;YACtB,CAAC,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;QAE1B,KAAK,MAAM,KAAK,IAAI,WAAW,EAAE,CAAC;YAChC,IAAI,CAAC;gBACH,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAA;gBACtB,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAC7B,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,CACrD,CAAA;gBACD,IAAI,CAAC,IAAI;oBACP,MAAM,IAAI,kBAAG,CAAC,aAAa,CACzB,4CAA4C,CAC7C,CAAA;gBAEH,MAAM,MAAM,GAAG,IAAI,QAAQ,CAAC;oBAC1B,UAAU,EAAE,GAAG;oBACf,UAAU,EAAE,GAAG;oBACf,UAAU,EAAE,CAAC;oBACb,IAAI,EAAE,GAAG,CAAC,IAAI;oBACd,MAAM,EAAE,KAAK,CAAC,WAAW;oBACzB,KAAK,EAAE,IAAI,CAAC,MAAM;oBAClB,UAAU,EAAE,KAAK,CAAC,QAAQ,EAAE;oBAC5B,KAAK,EAAE,GAAG,CAAC,KAAK;oBAChB,UAAU,EAAE,SAAS,CAAC,MAAO,CAAC,UAAU;oBACxC,SAAS,EAAE,SAAS,CAAC,MAAO,CAAC,IAAI;iBAClC,CAAC,CAAA;gBAEF,OAAO,MAAM,CAAA;YACf,CAAC;YAAC,OAAO,GAAY,EAAE,CAAC;gBACtB,GAAG,CAAC,cAAc,CAAC;oBACjB,IAAI,EAAE,sBAAsB;oBAC5B,KAAK;oBACL,KAAK,EAAE,kBAAG,CAAC,WAAW,CAAC,WAAW,CAAC,GAAG,CAAC;iBACxC,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;IACH,CAAC;;AA3UH,4BA4UC;AAzGC;;GAEG;AACI,8BAAqB,GAAG,CAAC,CAAA;AAEhC;;GAEG;AACI,wBAAe,GAAG,EAAE,CAAA"}

package/out/src/storage/schema/entities/ProvenTxReq.d.ts

@@ -0,0 +1,130 @@
+import { entity, sdk, StorageProvider, table, WalletStorageManager } from '../../../index.client';
+import { EntityBase } from '.';
+export declare class ProvenTxReq extends EntityBase<table.ProvenTxReq> {
+    static fromStorageTxid(storage: entity.EntityStorage, txid: string, trx?: sdk.TrxToken): Promise<ProvenTxReq | undefined>;
+    static fromStorageId(storage: entity.EntityStorage, id: number, trx?: sdk.TrxToken): Promise<ProvenTxReq>;
+    static fromTxid(txid: string, rawTx: number[], inputBEEF?: number[]): ProvenTxReq;
+    history: ProvenTxReqHistory;
+    notify: ProvenTxReqNotify;
+    packApiHistory(): void;
+    packApiNotify(): void;
+    unpackApiHistory(): void;
+    unpackApiNotify(): void;
+    get apiHistory(): string;
+    get apiNotify(): string;
+    set apiHistory(v: string);
+    set apiNotify(v: string);
+    updateApi(): void;
+    unpackApi(): void;
+    refreshFromStorage(storage: entity.EntityStorage | WalletStorageManager): Promise<void>;
+    constructor(api?: table.ProvenTxReq);
+    /**
+     * Returns history to only what followed since date.
+     */
+    historySince(since: Date): ProvenTxReqHistory;
+    historyPretty(since?: Date, indent?: number): string;
+    getHistorySummary(): ProvenTxReqHistorySummaryApi;
+    parseHistoryNote(note: string, summary?: ProvenTxReqHistorySummaryApi): string;
+    addNotifyTransactionId(id: number): void;
+    addHistoryNote<T extends {
+        what: string;
+    }>(note: string | T, when?: Date, noDupes?: boolean): void;
+    /**
+       * Updates database record with current state of this entity.
+  
+       * @param storage
+       * @param trx
+       */
+    updateStorage(storage: entity.EntityStorage, trx?: sdk.TrxToken): Promise<void>;
+    /**
+     * Update storage with changes to non-static properties:
+     *   updated_at
+     *   provenTxId
+     *   status
+     *   history
+     *   notify
+     *   notified
+     *   attempts
+     *   batch
+     *
+     * @param storage
+     * @param trx
+     */
+    updateStorageDynamicProperties(storage: WalletStorageManager | StorageProvider, trx?: sdk.TrxToken): Promise<void>;
+    insertOrMerge(storage: entity.EntityStorage, trx?: sdk.TrxToken): Promise<ProvenTxReq>;
+    /**
+     * See `ProvenTxReqStatusApi`
+     */
+    get status(): sdk.ProvenTxReqStatus;
+    set status(v: sdk.ProvenTxReqStatus);
+    get provenTxReqId(): number;
+    set provenTxReqId(v: number);
+    get created_at(): Date;
+    set created_at(v: Date);
+    get updated_at(): Date;
+    set updated_at(v: Date);
+    get txid(): string;
+    set txid(v: string);
+    get inputBEEF(): number[] | undefined;
+    set inputBEEF(v: number[] | undefined);
+    get rawTx(): number[];
+    set rawTx(v: number[]);
+    get attempts(): number;
+    set attempts(v: number);
+    get provenTxId(): number | undefined;
+    set provenTxId(v: number | undefined);
+    get notified(): boolean;
+    set notified(v: boolean);
+    get batch(): string | undefined;
+    set batch(v: string | undefined);
+    get id(): number;
+    set id(v: number);
+    get entityName(): string;
+    get entityTable(): string;
+    /**
+     * 'convergent' equality must satisfy (A sync B) equals (B sync A)
+     */
+    equals(ei: table.ProvenTxReq, syncMap?: entity.SyncMap | undefined): boolean;
+    static mergeFind(storage: entity.EntityStorage, userId: number, ei: table.ProvenTxReq, syncMap: entity.SyncMap, trx?: sdk.TrxToken): Promise<{
+        found: boolean;
+        eo: ProvenTxReq;
+        eiId: number;
+    }>;
+    mapNotifyTransactionIds(syncMap: entity.SyncMap): void;
+    mergeNotifyTransactionIds(ei: table.ProvenTxReq, syncMap?: entity.SyncMap): void;
+    mergeHistory(ei: table.ProvenTxReq, syncMap?: entity.SyncMap, noDupes?: boolean): void;
+    static isTerminalStatus(status: sdk.ProvenTxReqStatus): boolean;
+    mergeNew(storage: entity.EntityStorage, userId: number, syncMap: entity.SyncMap, trx?: sdk.TrxToken): Promise<void>;
+    /**
+     * When merging `ProvenTxReq`, care is taken to avoid short-cirtuiting notification: `status` must not transition to `completed` without
+     * passing through `notifying`. Thus a full convergent merge passes through these sequence steps:
+     * 1. Remote storage completes before local storage.
+     * 2. The remotely completed req and ProvenTx sync to local storage.
+     * 3. The local storage transitions to `notifying`, after merging the remote attempts and history.
+     * 4. The local storage notifies, transitioning to `completed`.
+     * 5. Having been updated, the local req, but not ProvenTx sync to remote storage, but do not merge because the earlier `completed` wins.
+     * 6. Convergent equality is achieved (completing work - history and attempts are equal)
+     *
+     * On terminal failure: `doubleSpend` trumps `invalid` as it contains more data.
+     */
+    mergeExisting(storage: entity.EntityStorage, since: Date | undefined, ei: table.ProvenTxReq, syncMap: entity.SyncMap, trx?: sdk.TrxToken): Promise<boolean>;
+}
+export interface ProvenTxReqHistorySummaryApi {
+    setToCompleted: boolean;
+    setToCallback: boolean;
+    setToUnmined: boolean;
+    setToDoubleSpend: boolean;
+    setToSending: boolean;
+    setToUnconfirmed: boolean;
+}
+export interface ProvenTxReqHistory {
+    /**
+     * Keys are Date().toISOString()
+     * Values are a description of what happened.
+     */
+    notes?: Record<string, string>;
+}
+export interface ProvenTxReqNotify {
+    transactionIds?: number[];
+}
+//# sourceMappingURL=ProvenTxReq.d.ts.map

package/out/src/storage/schema/entities/ProvenTxReq.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProvenTxReq.d.ts","sourceRoot":"","sources":["../../../../../../src/storage/schema/entities/ProvenTxReq.ts"],"names":[],"mappings":"AACA,OAAO,EAGL,MAAM,EACN,GAAG,EACH,eAAe,EACf,KAAK,EAKL,oBAAoB,EACrB,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,UAAU,EAAE,MAAM,GAAG,CAAA;AAI9B,qBAAa,WAAY,SAAQ,UAAU,CAAC,KAAK,CAAC,WAAW,CAAC;WAC/C,eAAe,CAC1B,OAAO,EAAE,MAAM,CAAC,aAAa,EAC7B,IAAI,EAAE,MAAM,EACZ,GAAG,CAAC,EAAE,GAAG,CAAC,QAAQ,GACjB,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;WAQtB,aAAa,CACxB,OAAO,EAAE,MAAM,CAAC,aAAa,EAC7B,EAAE,EAAE,MAAM,EACV,GAAG,CAAC,EAAE,GAAG,CAAC,QAAQ,GACjB,OAAO,CAAC,WAAW,CAAC;IASvB,MAAM,CAAC,QAAQ,CACb,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,MAAM,EAAE,EACf,SAAS,CAAC,EAAE,MAAM,EAAE,GACnB,WAAW;IAiBd,OAAO,EAAE,kBAAkB,CAAA;IAC3B,MAAM,EAAE,iBAAiB,CAAA;IAEzB,cAAc;IAGd,aAAa;IAIb,gBAAgB;IAGhB,eAAe;IAIf,IAAI,UAAU,IAAI,MAAM,CAGvB;IACD,IAAI,SAAS,IAAI,MAAM,CAGtB;IAED,IAAI,UAAU,CAAC,CAAC,EAAE,MAAM,EAGvB;IACD,IAAI,SAAS,CAAC,CAAC,EAAE,MAAM,EAGtB;IAED,SAAS,IAAI,IAAI;IAKjB,SAAS,IAAI,IAAI;IAcX,kBAAkB,CACtB,OAAO,EAAE,MAAM,CAAC,aAAa,GAAG,oBAAoB,GACnD,OAAO,CAAC,IAAI,CAAC;gBAQJ,GAAG,CAAC,EAAE,KAAK,CAAC,WAAW;IAqBnC;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,IAAI,GAAG,kBAAkB;IAW7C,aAAa,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,MAAM,SAAI,GAAG,MAAM;IAc/C,iBAAiB,IAAI,4BAA4B;IAkBjD,gBAAgB,CACd,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,4BAA4B,GACrC,MAAM;IA8DT,sBAAsB,CAAC,EAAE,EAAE,MAAM;IAWjC,cAAc,CAAC,CAAC,SAAS;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,EACvC,IAAI,EAAE,MAAM,GAAG,CAAC,EAChB,IAAI,CAAC,EAAE,IAAI,EACX,OAAO,CAAC,EAAE,OAAO;IAoBnB;;;;;SAKK;IACC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,aAAa,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,QAAQ;IAUrE;;;;;;;;;;;;;OAaG;IACG,8BAA8B,CAClC,OAAO,EAAE,oBAAoB,GAAG,eAAe,EAC/C,GAAG,CAAC,EAAE,GAAG,CAAC,QAAQ;IAyBd,aAAa,CACjB,OAAO,EAAE,MAAM,CAAC,aAAa,EAC7B,GAAG,CAAC,EAAE,GAAG,CAAC,QAAQ,GACjB,OAAO,CAAC,WAAW,CAAC;IAoBvB;;OAEG;IACH,IAAI,MAAM,IAGI,GAAG,CAAC,iBAAiB,CADlC;IACD,IAAI,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,iBAAiB,EASlC;IACD,IAAI,aAAa,IAGI,MAAM,CAD1B;IACD,IAAI,aAAa,CAAC,CAAC,EAAE,MAAM,EAE1B;IACD,IAAI,UAAU,IAGI,IAAI,CADrB;IACD,IAAI,UAAU,CAAC,CAAC,EAAE,IAAI,EAErB;IACD,IAAI,UAAU,IAGI,IAAI,CADrB;IACD,IAAI,UAAU,CAAC,CAAC,EAAE,IAAI,EAErB;IACD,IAAI,IAAI,IAGI,MAAM,CADjB;IACD,IAAI,IAAI,CAAC,CAAC,EAAE,MAAM,EAEjB;IACD,IAAI,SAAS,IAGI,MAAM,EAAE,GAAG,SAAS,CADpC;IACD,IAAI,SAAS,CAAC,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,EAEpC;IACD,IAAI,KAAK,IAGI,MAAM,EAAE,CADpB;IACD,IAAI,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,EAEpB;IACD,IAAI,QAAQ,IAGI,MAAM,CADrB;IACD,IAAI,QAAQ,CAAC,CAAC,EAAE,MAAM,EAErB;IACD,IAAI,UAAU,IAGI,MAAM,GAAG,SAAS,CADnC;IACD,IAAI,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,EAEnC;IACD,IAAI,QAAQ,IAGI,OAAO,CADtB;IACD,IAAI,QAAQ,CAAC,CAAC,EAAE,OAAO,EAEtB;IACD,IAAI,KAAK,IAGI,MAAM,GAAG,SAAS,CAD9B;IACD,IAAI,KAAK,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,EAE9B;IAED,IAAa,EAAE,IAGI,MAAM,CADxB;IACD,IAAa,EAAE,CAAC,CAAC,EAAE,MAAM,EAExB;IACD,IAAa,UAAU,IAAI,MAAM,CAEhC;IACD,IAAa,WAAW,IAAI,MAAM,CAEjC;IAED;;OAEG;IACM,MAAM,CACb,EAAE,EAAE,KAAK,CAAC,WAAW,EACrB,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,GACnC,OAAO;WA2CG,SAAS,CACpB,OAAO,EAAE,MAAM,CAAC,aAAa,EAC7B,MAAM,EAAE,MAAM,EACd,EAAE,EAAE,KAAK,CAAC,WAAW,EACrB,OAAO,EAAE,MAAM,CAAC,OAAO,EACvB,GAAG,CAAC,EAAE,GAAG,CAAC,QAAQ,GACjB,OAAO,CAAC;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,EAAE,EAAE,WAAW,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAW7D,uBAAuB,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,GAAG,IAAI;IAatD,yBAAyB,CACvB,EAAE,EAAE,KAAK,CAAC,WAAW,EACrB,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,GACvB,IAAI;IAiBP,YAAY,CACV,EAAE,EAAE,KAAK,CAAC,WAAW,EACrB,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,EACxB,OAAO,CAAC,EAAE,OAAO,GAChB,IAAI;IASP,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,CAAC,iBAAiB,GAAG,OAAO;IAIhD,QAAQ,CACrB,OAAO,EAAE,MAAM,CAAC,aAAa,EAC7B,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,CAAC,OAAO,EACvB,GAAG,CAAC,EAAE,GAAG,CAAC,QAAQ,GACjB,OAAO,CAAC,IAAI,CAAC;IAQhB;;;;;;;;;;;OAWG;IACY,aAAa,CAC1B,OAAO,EAAE,MAAM,CAAC,aAAa,EAC7B,KAAK,EAAE,IAAI,GAAG,SAAS,EACvB,EAAE,EAAE,KAAK,CAAC,WAAW,EACrB,OAAO,EAAE,MAAM,CAAC,OAAO,EACvB,GAAG,CAAC,EAAE,GAAG,CAAC,QAAQ,GACjB,OAAO,CAAC,OAAO,CAAC;CAYpB;AAED,MAAM,WAAW,4BAA4B;IAC3C,cAAc,EAAE,OAAO,CAAA;IACvB,aAAa,EAAE,OAAO,CAAA;IACtB,YAAY,EAAE,OAAO,CAAA;IACrB,gBAAgB,EAAE,OAAO,CAAA;IACzB,YAAY,EAAE,OAAO,CAAA;IACrB,gBAAgB,EAAE,OAAO,CAAA;CAC1B;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B;AAED,MAAM,WAAW,iBAAiB;IAChC,cAAc,CAAC,EAAE,MAAM,EAAE,CAAA;CAC1B"}