@sidhujag/sysweb3-keyring 1.0.611 → 1.0.613

package/cjs/utils/psbt-account-scope.js

@@ -0,0 +1,347 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPsbtDerivationGuard = createPsbtDerivationGuard;
+exports.assertPsbtAccountScope = assertPsbtAccountScope;
+const ecc = __importStar(require("@bitcoinerlab/secp256k1"));
+const sysweb3_network_1 = require("@sidhujag/sysweb3-network");
+const bip32_1 = require("bip32");
+const bitcoinjs_lib_1 = require("bitcoinjs-lib");
+const types_1 = require("../types");
+const derivation_paths_1 = require("./derivation-paths");
+const bip32 = (0, bip32_1.BIP32Factory)(ecc);
+const SCOPE_ERROR = 'PSBT input is outside the approved account';
+const fail = () => {
+    throw new Error(SCOPE_ERROR);
+};
+const clearSigningHints = (input) => {
+    delete input.bip32Derivation;
+    delete input.tapBip32Derivation;
+    input.unknownKeyVals = (input.unknownKeyVals || []).filter((field) => Buffer.from(field.key).toString() !== 'path');
+};
+const equal = (a, b) => Boolean(a && b && Buffer.from(a).equals(Buffer.from(b)));
+const childIndex = (value) => {
+    if (!/^(0|[1-9][0-9]*)$/.test(value))
+        return fail();
+    const index = Number(value);
+    if (!Number.isSafeInteger(index) || index >= 0x80000000)
+        return fail();
+    return index;
+};
+const publicAccountNode = (xpub) => {
+    // Account keys use coin-specific xpub/zpub/vpub version bytes. Preserve the
+    // checked public payload instead of guessing its network from that prefix.
+    const codec = require('bs58check');
+    const payload = Buffer.from((codec.default || codec).decode(xpub));
+    if (payload.length !== 78 || (payload[45] !== 2 && payload[45] !== 3))
+        return fail();
+    return bip32.fromBase58(xpub, {
+        ...bitcoinjs_lib_1.networks.bitcoin,
+        bip32: { public: payload.readUInt32BE(0), private: 0x0488ade4 },
+    });
+};
+function createPsbtDerivationGuard(scope) {
+    const { account, accountId, accountType, network } = scope;
+    const node = publicAccountNode(account.xpub);
+    const prefix = accountType === types_1.KeyringAccountType.HDAccount
+        ? `m/84'/${network.slip44}'/${accountId}'`
+        : (0, derivation_paths_1.getAccountDerivationPath)(network.currency, network.slip44, accountType === types_1.KeyringAccountType.Imported && node.depth === 3
+            ? node.index & 0x7fffffff
+            : accountId);
+    return (path) => {
+        let relative = path;
+        if (relative.startsWith(`${prefix}/`))
+            relative = relative.slice(prefix.length + 1);
+        else if (relative.startsWith('m/') ||
+            accountType !== types_1.KeyringAccountType.Imported)
+            return fail();
+        const parts = relative.split('/');
+        if (parts.length !== 2)
+            return fail();
+        if (![0, 1].includes(childIndex(parts[0])))
+            return fail();
+        childIndex(parts[1]);
+        return relative;
+    };
+}
+/** Verify key ownership from public derivation and the actual spent script.
+ * Proprietary address metadata is deliberately never an authority here.
+ */
+function assertPsbtAccountScope(psbt, scope) {
+    const { account, accountType, network } = scope;
+    const config = (0, sysweb3_network_1.getNetworkConfig)(network.slip44, network.currency);
+    const bitcoinNetwork = network.slip44 === 1 ? config.networks.testnet : config.networks.mainnet;
+    const singleAddress = accountType === types_1.KeyringAccountType.Imported &&
+        account.xpub === account.address;
+    const node = singleAddress ? undefined : publicAccountNode(account.xpub);
+    const guardPath = singleAddress
+        ? undefined
+        : createPsbtDerivationGuard(scope);
+    if (!singleAddress && !node?.isNeutered())
+        return fail();
+    if (!Array.isArray(psbt.data?.inputs) || psbt.data.inputs.length === 0)
+        return fail();
+    const derivedKeys = new Map();
+    let ownedInputs = 0;
+    let hasUnfinishedInputs = false;
+    psbt.data.inputs.forEach((input, inputIndex) => {
+        // Finalized co-signer inputs may remain in a PSBT. Remove signing hints so
+        // even a permissive underlying signer cannot add another signature there.
+        if (input.finalScriptSig || input.finalScriptWitness) {
+            clearSigningHints(input);
+            return;
+        }
+        hasUnfinishedInputs = true;
+        const txInput = psbt.txInputs[inputIndex];
+        let spent = input.witnessUtxo;
+        if (input.nonWitnessUtxo) {
+            const previous = bitcoinjs_lib_1.Transaction.fromBuffer(input.nonWitnessUtxo);
+            if (!equal(previous.getHash(), txInput.hash))
+                return fail();
+            const output = previous.outs[txInput.index];
+            if (!output ||
+                (spent &&
+                    (!equal(output.script, spent.script) || output.value !== spent.value)))
+                return fail();
+            spent = output;
+        }
+        if (!spent)
+            return fail();
+        try {
+            let multisigKeys;
+            const multisigScript = input.witnessScript || input.redeemScript;
+            if (multisigScript) {
+                try {
+                    // Only standard multisig is supported here. The scripts, not the
+                    // cosigners' supplied derivation metadata, authenticate membership.
+                    const multisig = bitcoinjs_lib_1.payments.p2ms({
+                        output: multisigScript,
+                        network: bitcoinNetwork,
+                    });
+                    if (!multisig.pubkeys?.length)
+                        return fail();
+                    if (input.witnessScript) {
+                        const witness = bitcoinjs_lib_1.payments.p2wsh({
+                            redeem: multisig,
+                            network: bitcoinNetwork,
+                        });
+                        if (input.redeemScript &&
+                            !equal(input.redeemScript, witness.output))
+                            return fail();
+                        const output = input.redeemScript
+                            ? bitcoinjs_lib_1.payments.p2sh({ redeem: witness, network: bitcoinNetwork })
+                                .output
+                            : witness.output;
+                        if (!equal(output, spent.script))
+                            return fail();
+                    }
+                    else if (!equal(bitcoinjs_lib_1.payments.p2sh({ redeem: multisig, network: bitcoinNetwork })
+                        .output, spent.script)) {
+                        // Nested single-key P2WPKH is validated below, not as multisig.
+                        return fail();
+                    }
+                    multisigKeys = multisig.pubkeys;
+                }
+                catch {
+                    // A wrapped single-key input has a redeemScript but no multisig.
+                    // Its normal derived-key output check below still authenticates it.
+                    if (input.witnessScript)
+                        return fail();
+                }
+            }
+            if (singleAddress) {
+                const approvedScript = bitcoinjs_lib_1.address.toOutputScript(account.address, bitcoinNetwork);
+                if (multisigKeys) {
+                    const ownsKey = multisigKeys.some((pubkey) => {
+                        const witness = bitcoinjs_lib_1.payments.p2wpkh({
+                            pubkey,
+                            network: bitcoinNetwork,
+                        });
+                        return [
+                            bitcoinjs_lib_1.payments.p2pkh({ pubkey, network: bitcoinNetwork }).output,
+                            witness.output,
+                            bitcoinjs_lib_1.payments.p2sh({ redeem: witness, network: bitcoinNetwork })
+                                .output,
+                        ].some((output) => equal(output, approvedScript));
+                    });
+                    if (!ownsKey)
+                        return fail();
+                    delete input.bip32Derivation;
+                    delete input.tapBip32Derivation;
+                    input.unknownKeyVals = (input.unknownKeyVals || []).filter((field) => Buffer.from(field.key).toString() !== 'path');
+                }
+                else if (!equal(spent.script, approvedScript))
+                    return fail();
+                ownedInputs += 1;
+                return;
+            }
+            const derivations = [
+                ...(input.bip32Derivation || []),
+                ...(input.tapBip32Derivation || []),
+            ];
+            const paths = derivations.map((derivation) => ({
+                path: derivation.path,
+                pubkey: derivation.pubkey,
+                source: derivation,
+            }));
+            for (const field of input.unknownKeyVals || []) {
+                if (Buffer.from(field.key).toString() === 'path')
+                    paths.push({
+                        path: Buffer.from(field.value).toString(),
+                        pubkey: undefined,
+                        source: field,
+                    });
+            }
+            if (!paths.length)
+                return fail();
+            const approvedHints = new Set();
+            for (const candidate of paths) {
+                let relative;
+                try {
+                    relative = guardPath(candidate.path);
+                }
+                catch (error) {
+                    if (multisigKeys)
+                        continue;
+                    throw error;
+                }
+                const parts = relative.split('/');
+                if (parts.length !== 2)
+                    return fail();
+                const branch = childIndex(parts[0]);
+                const index = childIndex(parts[1]);
+                if (branch !== 0 && branch !== 1)
+                    return fail();
+                let derived = derivedKeys.get(relative);
+                if (!derived) {
+                    const publicKey = node.derive(branch).derive(index).publicKey;
+                    const p2pkh = bitcoinjs_lib_1.payments.p2pkh({
+                        pubkey: publicKey,
+                        network: bitcoinNetwork,
+                    });
+                    const p2wpkh = bitcoinjs_lib_1.payments.p2wpkh({
+                        pubkey: publicKey,
+                        network: bitcoinNetwork,
+                    });
+                    const p2sh = bitcoinjs_lib_1.payments.p2sh({
+                        redeem: p2wpkh,
+                        network: bitcoinNetwork,
+                    });
+                    derived = {
+                        publicKey,
+                        scripts: [p2pkh.output, p2wpkh.output, p2sh.output],
+                    };
+                    derivedKeys.set(relative, derived);
+                }
+                const { publicKey } = derived;
+                if (candidate.pubkey &&
+                    !equal(candidate.pubkey, publicKey) &&
+                    !equal(candidate.pubkey, publicKey.slice(1))) {
+                    if (multisigKeys)
+                        continue;
+                    return fail();
+                }
+                if (multisigKeys) {
+                    if (!multisigKeys.some((key) => equal(key, publicKey)))
+                        continue;
+                    approvedHints.add(candidate.source);
+                    continue;
+                }
+                const ordinary = derived.scripts.some((script) => equal(script, spent.script));
+                let taproot = false;
+                // Key-path signing can reconstruct an omitted internal key from this
+                // approved derivation. Commit any supplied Merkle root when checking
+                // the output, but do not infer script-path keys or accept a conflicting
+                // explicit internal key.
+                if (input.tapInternalKey === undefined
+                    ? !ordinary &&
+                        !input.tapLeafScript?.length &&
+                        !input.tapScriptSig?.length &&
+                        !input.tapBip32Derivation?.some((derivation) => derivation.leafHashes.length > 0)
+                    : equal(input.tapInternalKey, publicKey.slice(1))) {
+                    const p2tr = bitcoinjs_lib_1.payments.p2tr({
+                        internalPubkey: publicKey.slice(1),
+                        hash: input.tapMerkleRoot,
+                        network: bitcoinNetwork,
+                    });
+                    taproot = equal(p2tr.output, spent.script);
+                }
+                if (!ordinary && !taproot)
+                    return fail();
+            }
+            if (multisigKeys) {
+                if (!approvedHints.size)
+                    return fail();
+                // Keep cosigner signatures, but expose only the approved account's paths
+                // to the underlying signer, including its full-root HD fallback.
+                if (input.bip32Derivation)
+                    input.bip32Derivation = input.bip32Derivation.filter((value) => approvedHints.has(value));
+                if (input.tapBip32Derivation)
+                    input.tapBip32Derivation = input.tapBip32Derivation.filter((value) => approvedHints.has(value));
+                if (input.unknownKeyVals)
+                    input.unknownKeyVals = input.unknownKeyVals.filter((field) => Buffer.from(field.key).toString() !== 'path' ||
+                        approvedHints.has(field));
+            }
+            ownedInputs += 1;
+        }
+        catch (error) {
+            if (singleAddress ||
+                !(error instanceof Error) ||
+                error.message !== SCOPE_ERROR)
+                throw error;
+            // A joint PSBT may include inputs for another signer. Hide every HD
+            // hint before our private signer runs; even another account in this
+            // wallet must remain unsigned. The public API restores metadata later.
+            clearSigningHints(input);
+        }
+    });
+    if (hasUnfinishedInputs && ownedInputs === 0)
+        return fail();
+    // An imported extended key is already the account node, so the signer must
+    // receive only the validated relative children, never another full root path.
+    if (accountType === types_1.KeyringAccountType.Imported && !singleAddress) {
+        for (const input of psbt.data.inputs) {
+            for (const derivation of [
+                ...(input.bip32Derivation || []),
+                ...(input.tapBip32Derivation || []),
+            ])
+                derivation.path = guardPath(derivation.path);
+            for (const field of input.unknownKeyVals || [])
+                if (Buffer.from(field.key).toString() === 'path')
+                    field.value = Buffer.from(guardPath(Buffer.from(field.value).toString()));
+        }
+    }
+}
+//# sourceMappingURL=psbt-account-scope.js.map

package/cjs/utils/psbt-account-scope.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"psbt-account-scope.js","sourceRoot":"","sources":["../../../src/utils/psbt-account-scope.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgDA,8DA8BC;AAKD,wDA6QC;AAhWD,6DAA+C;AAC/C,+DAAuE;AACvE,iCAAqC;AACrC,iDAA+E;AAE/E,oCAA8C;AAC9C,yDAA8D;AAE9D,MAAM,KAAK,GAAG,IAAA,oBAAY,EAAC,GAAG,CAAC,CAAC;AAChC,MAAM,WAAW,GAAG,4CAA4C,CAAC;AACjE,MAAM,IAAI,GAAG,GAAU,EAAE;IACvB,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;AAC/B,CAAC,CAAC;AACF,MAAM,iBAAiB,GAAG,CAAC,KAAqC,EAAE,EAAE;IAClE,OAAO,KAAK,CAAC,eAAe,CAAC;IAC7B,OAAO,KAAK,CAAC,kBAAkB,CAAC;IAChC,KAAK,CAAC,cAAc,GAAG,CAAC,KAAK,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,MAAM,CACxD,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,MAAM,CACxD,CAAC;AACJ,CAAC,CAAC;AACF,MAAM,KAAK,GAAG,CAAC,CAAc,EAAE,CAAc,EAAE,EAAE,CAC/C,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3D,MAAM,UAAU,GAAG,CAAC,KAAa,EAAU,EAAE;IAC3C,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,EAAE,CAAC;IACpD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IAC5B,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,UAAU;QAAE,OAAO,IAAI,EAAE,CAAC;IACvE,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AACF,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAE,EAAE;IACzC,4EAA4E;IAC5E,2EAA2E;IAC3E,MAAM,KAAK,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACnC,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACnE,IAAI,OAAO,CAAC,MAAM,KAAK,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;QACnE,OAAO,IAAI,EAAE,CAAC;IAChB,OAAO,KAAK,CAAC,UAAU,CAAC,IAAI,EAAE;QAC5B,GAAG,wBAAQ,CAAC,OAAO;QACnB,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE;KAChE,CAAC,CAAC;AACL,CAAC,CAAC;AASF,SAAgB,yBAAyB,CACvC,KAAuB;IAEvB,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;IAC3D,MAAM,IAAI,GAAG,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C,MAAM,MAAM,GACV,WAAW,KAAK,0BAAkB,CAAC,SAAS;QAC1C,CAAC,CAAC,SAAS,OAAO,CAAC,MAAM,KAAK,SAAS,GAAG;QAC1C,CAAC,CAAC,IAAA,2CAAwB,EACtB,OAAO,CAAC,QAAQ,EAChB,OAAO,CAAC,MAAM,EACd,WAAW,KAAK,0BAAkB,CAAC,QAAQ,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC;YAC7D,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,UAAU;YACzB,CAAC,CAAC,SAAS,CACd,CAAC;IACR,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,IAAI,QAAQ,GAAG,IAAI,CAAC;QACpB,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,MAAM,GAAG,CAAC;YACnC,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;aAC1C,IACH,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC;YACzB,WAAW,KAAK,0BAAkB,CAAC,QAAQ;YAE3C,OAAO,IAAI,EAAE,CAAC;QAChB,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAClC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,EAAE,CAAC;QACtC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAAE,OAAO,IAAI,EAAE,CAAC;QAC1D,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACrB,OAAO,QAAQ,CAAC;IAClB,CAAC,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,sBAAsB,CACpC,IAAU,EACV,KAAuB;IAEvB,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;IAChD,MAAM,MAAM,GAAG,IAAA,kCAAgB,EAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAClE,MAAM,cAAc,GAClB,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;IAC3E,MAAM,aAAa,GACjB,WAAW,KAAK,0BAAkB,CAAC,QAAQ;QAC3C,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,OAAO,CAAC;IACnC,MAAM,IAAI,GAAG,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACzE,MAAM,SAAS,GAAG,aAAa;QAC7B,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;IACrC,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE;QAAE,OAAO,IAAI,EAAE,CAAC;IACzD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC;QACpE,OAAO,IAAI,EAAE,CAAC;IAChB,MAAM,WAAW,GAAG,IAAI,GAAG,EAGxB,CAAC;IAEJ,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,IAAI,mBAAmB,GAAG,KAAK,CAAC;IAChC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,UAAU,EAAE,EAAE;QAC7C,2EAA2E;QAC3E,0EAA0E;QAC1E,IAAI,KAAK,CAAC,cAAc,IAAI,KAAK,CAAC,kBAAkB,EAAE,CAAC;YACrD,iBAAiB,CAAC,KAAK,CAAC,CAAC;YACzB,OAAO;QACT,CAAC;QACD,mBAAmB,GAAG,IAAI,CAAC;QAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC1C,IAAI,KAAK,GAAG,KAAK,CAAC,WAAW,CAAC;QAC9B,IAAI,KAAK,CAAC,cAAc,EAAE,CAAC;YACzB,MAAM,QAAQ,GAAG,2BAAW,CAAC,UAAU,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YAC9D,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,IAAI,CAAC;gBAAE,OAAO,IAAI,EAAE,CAAC;YAC5D,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC5C,IACE,CAAC,MAAM;gBACP,CAAC,KAAK;oBACJ,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,CAAC,CAAC;gBAExE,OAAO,IAAI,EAAE,CAAC;YAChB,KAAK,GAAG,MAAM,CAAC;QACjB,CAAC;QACD,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,EAAE,CAAC;QAC1B,IAAI,CAAC;YACH,IAAI,YAAsC,CAAC;YAC3C,MAAM,cAAc,GAAG,KAAK,CAAC,aAAa,IAAI,KAAK,CAAC,YAAY,CAAC;YACjE,IAAI,cAAc,EAAE,CAAC;gBACnB,IAAI,CAAC;oBACH,iEAAiE;oBACjE,oEAAoE;oBACpE,MAAM,QAAQ,GAAG,wBAAQ,CAAC,IAAI,CAAC;wBAC7B,MAAM,EAAE,cAAc;wBACtB,OAAO,EAAE,cAAc;qBACxB,CAAC,CAAC;oBACH,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM;wBAAE,OAAO,IAAI,EAAE,CAAC;oBAC7C,IAAI,KAAK,CAAC,aAAa,EAAE,CAAC;wBACxB,MAAM,OAAO,GAAG,wBAAQ,CAAC,KAAK,CAAC;4BAC7B,MAAM,EAAE,QAAQ;4BAChB,OAAO,EAAE,cAAc;yBACxB,CAAC,CAAC;wBACH,IACE,KAAK,CAAC,YAAY;4BAClB,CAAC,KAAK,CAAC,KAAK,CAAC,YAAY,EAAE,OAAO,CAAC,MAAM,CAAC;4BAE1C,OAAO,IAAI,EAAE,CAAC;wBAChB,MAAM,MAAM,GAAG,KAAK,CAAC,YAAY;4BAC/B,CAAC,CAAC,wBAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;iCACxD,MAAM;4BACX,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;wBACnB,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC;4BAAE,OAAO,IAAI,EAAE,CAAC;oBAClD,CAAC;yBAAM,IACL,CAAC,KAAK,CACJ,wBAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;yBACzD,MAAM,EACT,KAAK,CAAC,MAAM,CACb,EACD,CAAC;wBACD,gEAAgE;wBAChE,OAAO,IAAI,EAAE,CAAC;oBAChB,CAAC;oBACD,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC;gBAClC,CAAC;gBAAC,MAAM,CAAC;oBACP,iEAAiE;oBACjE,oEAAoE;oBACpE,IAAI,KAAK,CAAC,aAAa;wBAAE,OAAO,IAAI,EAAE,CAAC;gBACzC,CAAC;YACH,CAAC;YACD,IAAI,aAAa,EAAE,CAAC;gBAClB,MAAM,cAAc,GAAG,uBAAO,CAAC,cAAc,CAC3C,OAAO,CAAC,OAAO,EACf,cAAc,CACf,CAAC;gBACF,IAAI,YAAY,EAAE,CAAC;oBACjB,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;wBAC3C,MAAM,OAAO,GAAG,wBAAQ,CAAC,MAAM,CAAC;4BAC9B,MAAM;4BACN,OAAO,EAAE,cAAc;yBACxB,CAAC,CAAC;wBACH,OAAO;4BACL,wBAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC,MAAM;4BAC1D,OAAO,CAAC,MAAM;4BACd,wBAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC;iCACxD,MAAM;yBACV,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC;oBACpD,CAAC,CAAC,CAAC;oBACH,IAAI,CAAC,OAAO;wBAAE,OAAO,IAAI,EAAE,CAAC;oBAC5B,OAAO,KAAK,CAAC,eAAe,CAAC;oBAC7B,OAAO,KAAK,CAAC,kBAAkB,CAAC;oBAChC,KAAK,CAAC,cAAc,GAAG,CAAC,KAAK,CAAC,cAAc,IAAI,EAAE,CAAC,CAAC,MAAM,CACxD,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,MAAM,CACxD,CAAC;gBACJ,CAAC;qBAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,cAAc,CAAC;oBAAE,OAAO,IAAI,EAAE,CAAC;gBAC/D,WAAW,IAAI,CAAC,CAAC;gBACjB,OAAO;YACT,CAAC;YAED,MAAM,WAAW,GAAG;gBAClB,GAAG,CAAC,KAAK,CAAC,eAAe,IAAI,EAAE,CAAC;gBAChC,GAAG,CAAC,KAAK,CAAC,kBAAkB,IAAI,EAAE,CAAC;aACpC,CAAC;YACF,MAAM,KAAK,GAIN,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;gBACpC,IAAI,EAAE,UAAU,CAAC,IAAI;gBACrB,MAAM,EAAE,UAAU,CAAC,MAAM;gBACzB,MAAM,EAAE,UAAU;aACnB,CAAC,CAAC,CAAC;YACJ,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,cAAc,IAAI,EAAE,EAAE,CAAC;gBAC/C,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,MAAM;oBAC9C,KAAK,CAAC,IAAI,CAAC;wBACT,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE;wBACzC,MAAM,EAAE,SAAS;wBACjB,MAAM,EAAE,KAAK;qBACd,CAAC,CAAC;YACP,CAAC;YACD,IAAI,CAAC,KAAK,CAAC,MAAM;gBAAE,OAAO,IAAI,EAAE,CAAC;YACjC,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;YACxC,KAAK,MAAM,SAAS,IAAI,KAAK,EAAE,CAAC;gBAC9B,IAAI,QAAgB,CAAC;gBACrB,IAAI,CAAC;oBACH,QAAQ,GAAG,SAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;gBACxC,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,IAAI,YAAY;wBAAE,SAAS;oBAC3B,MAAM,KAAK,CAAC;gBACd,CAAC;gBACD,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;gBAClC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;oBAAE,OAAO,IAAI,EAAE,CAAC;gBACtC,MAAM,MAAM,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBACpC,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnC,IAAI,MAAM,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC;oBAAE,OAAO,IAAI,EAAE,CAAC;gBAChD,IAAI,OAAO,GAAG,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;gBACxC,IAAI,CAAC,OAAO,EAAE,CAAC;oBACb,MAAM,SAAS,GAAG,IAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC;oBAC/D,MAAM,KAAK,GAAG,wBAAQ,CAAC,KAAK,CAAC;wBAC3B,MAAM,EAAE,SAAS;wBACjB,OAAO,EAAE,cAAc;qBACxB,CAAC,CAAC;oBACH,MAAM,MAAM,GAAG,wBAAQ,CAAC,MAAM,CAAC;wBAC7B,MAAM,EAAE,SAAS;wBACjB,OAAO,EAAE,cAAc;qBACxB,CAAC,CAAC;oBACH,MAAM,IAAI,GAAG,wBAAQ,CAAC,IAAI,CAAC;wBACzB,MAAM,EAAE,MAAM;wBACd,OAAO,EAAE,cAAc;qBACxB,CAAC,CAAC;oBACH,OAAO,GAAG;wBACR,SAAS;wBACT,OAAO,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC;qBACpD,CAAC;oBACF,WAAW,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;gBACrC,CAAC;gBACD,MAAM,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;gBAC9B,IACE,SAAS,CAAC,MAAM;oBAChB,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC;oBACnC,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAC5C,CAAC;oBACD,IAAI,YAAY;wBAAE,SAAS;oBAC3B,OAAO,IAAI,EAAE,CAAC;gBAChB,CAAC;gBACD,IAAI,YAAY,EAAE,CAAC;oBACjB,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;wBAAE,SAAS;oBACjE,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;oBACpC,SAAS;gBACX,CAAC;gBACD,MAAM,QAAQ,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAC/C,KAAK,CAAC,MAAM,EAAE,KAAM,CAAC,MAAM,CAAC,CAC7B,CAAC;gBACF,IAAI,OAAO,GAAG,KAAK,CAAC;gBACpB,qEAAqE;gBACrE,qEAAqE;gBACrE,wEAAwE;gBACxE,yBAAyB;gBACzB,IACE,KAAK,CAAC,cAAc,KAAK,SAAS;oBAChC,CAAC,CAAC,CAAC,QAAQ;wBACT,CAAC,KAAK,CAAC,aAAa,EAAE,MAAM;wBAC5B,CAAC,KAAK,CAAC,YAAY,EAAE,MAAM;wBAC3B,CAAC,KAAK,CAAC,kBAAkB,EAAE,IAAI,CAC7B,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,CACjD;oBACH,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,cAAc,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACnD,CAAC;oBACD,MAAM,IAAI,GAAG,wBAAQ,CAAC,IAAI,CAAC;wBACzB,cAAc,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;wBAClC,IAAI,EAAE,KAAK,CAAC,aAAa;wBACzB,OAAO,EAAE,cAAc;qBACxB,CAAC,CAAC;oBACH,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;gBAC7C,CAAC;gBACD,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO;oBAAE,OAAO,IAAI,EAAE,CAAC;YAC3C,CAAC;YACD,IAAI,YAAY,EAAE,CAAC;gBACjB,IAAI,CAAC,aAAa,CAAC,IAAI;oBAAE,OAAO,IAAI,EAAE,CAAC;gBACvC,yEAAyE;gBACzE,iEAAiE;gBACjE,IAAI,KAAK,CAAC,eAAe;oBACvB,KAAK,CAAC,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAC7D,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CACzB,CAAC;gBACJ,IAAI,KAAK,CAAC,kBAAkB;oBAC1B,KAAK,CAAC,kBAAkB,GAAG,KAAK,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CACnE,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CACzB,CAAC;gBACJ,IAAI,KAAK,CAAC,cAAc;oBACtB,KAAK,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,CAAC,MAAM,CAChD,CAAC,KAAK,EAAE,EAAE,CACR,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,MAAM;wBAC5C,aAAa,CAAC,GAAG,CAAC,KAAK,CAAC,CAC3B,CAAC;YACN,CAAC;YACD,WAAW,IAAI,CAAC,CAAC;QACnB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IACE,aAAa;gBACb,CAAC,CAAC,KAAK,YAAY,KAAK,CAAC;gBACzB,KAAK,CAAC,OAAO,KAAK,WAAW;gBAE7B,MAAM,KAAK,CAAC;YACd,oEAAoE;YACpE,oEAAoE;YACpE,uEAAuE;YACvE,iBAAiB,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,CAAC,CAAC;IACH,IAAI,mBAAmB,IAAI,WAAW,KAAK,CAAC;QAAE,OAAO,IAAI,EAAE,CAAC;IAC5D,2EAA2E;IAC3E,8EAA8E;IAC9E,IAAI,WAAW,KAAK,0BAAkB,CAAC,QAAQ,IAAI,CAAC,aAAa,EAAE,CAAC;QAClE,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACrC,KAAK,MAAM,UAAU,IAAI;gBACvB,GAAG,CAAC,KAAK,CAAC,eAAe,IAAI,EAAE,CAAC;gBAChC,GAAG,CAAC,KAAK,CAAC,kBAAkB,IAAI,EAAE,CAAC;aACpC;gBACC,UAAU,CAAC,IAAI,GAAG,SAAU,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YAChD,KAAK,MAAM,KAAK,IAAI,KAAK,CAAC,cAAc,IAAI,EAAE;gBAC5C,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,MAAM;oBAC9C,KAAK,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CACvB,SAAU,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC,CAChD,CAAC;QACR,CAAC;IACH,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sidhujag/sysweb3-keyring",
-  "version": "1.0.611",
+  "version": "1.0.613",
   "description": "Keyring Manager for UTXO and Web3 Wallets",
   "main": "cjs/index.js",
   "types": "types/index.d.ts",
@@ -17,7 +17,7 @@
     "@ledgerhq/hw-transport-webhid": "^6.30.5",
     "@ledgerhq/logs": "^6.10.1",
     "@metamask/eth-sig-util": "^8.2.0",
-    "@sidhujag/sysweb3-core": "^1.0.28",
+    "@sidhujag/sysweb3-core": "^1.0.29",
     "@sidhujag/sysweb3-network": "^1.0.109",
     "@sidhujag/sysweb3-utils": "^1.1.278",
     "@trezor/connect-web": "^9.7.1",
@@ -27,6 +27,7 @@
     "bip32-path": "^0.4.2",
     "bitcoin-ops": "^1.4.1",
     "bitcoinjs-lib": "^7.0.1",
+    "bs58check": "^3.0.1",
     "crypto-js": "^4.1.1",
     "ethers": "^6.17.0"
   },

package/types/keyring-manager.d.ts

@@ -56,6 +56,11 @@ export declare class KeyringManager implements IKeyringManager {
     receiveSessionOwnership: (sessionPassword: SecureBuffer, sessionMnemonic: SecureBuffer) => void;
     addNewAccount: (label?: string) => Promise<IKeyringAccountState>;
     createSmartAccount: ({ address, deriveAccount, label, metadata, }: ICreateSmartAccountParams) => Promise<IKeyringAccountState>;
+    /**
+     * Returns canLogin:false only when the first vault authentication fails.
+     * Storage, platform and session restoration failures reject so callers do
+     * not charge a failed password attempt for an operational error.
+     */
     unlock(password: string): Promise<{
         canLogin: boolean;
         needsAccountCreation?: boolean;
@@ -143,8 +148,10 @@ export declare class KeyringManager implements IKeyringManager {
      * PRIVATE METHODS
      */
     private getDecryptedPrivateKey;
+    private capturePsbtSigningContext;
     private getSigner;
     private getReadOnlySigner;
+    private writeUtf8Diagnostic;
     private validateAndHandleErrorByMessage;
     private getAccountsState;
     /**
@@ -160,6 +167,8 @@ export declare class KeyringManager implements IKeyringManager {
     private getEncIterations;
     private pbkdf2WebCryptoHex;
     private encryptSHA512Async;
+    private deriveLegacySessionKey;
+    private deriveStoredSessionKey;
     private getSysActivePrivateKey;
     private getInitialAccountData;
     private _createTrezorAccount;

package/types/storage.d.ts

@@ -1,2 +1,8 @@
-export declare const setEncryptedVault: (decryptedVault: any, pwd: string) => Promise<void>;
-export declare const getDecryptedVault: (pwd: string) => Promise<any>;
+export declare class VaultAuthenticationError extends Error {
+    readonly code = "INVALID_PASSWORD";
+    constructor();
+}
+export declare const setEncryptedVault: (decryptedVault: any, pwd: string, freshVaultKeys?: {
+    salt: string;
+}) => Promise<void>;
+export declare const getDecryptedVault: (pwd: string, legacyPassword?: string) => Promise<any>;

package/types/transactions/ethereum.d.ts

@@ -60,6 +60,7 @@ export declare class EthereumTransactions implements IEthereumTransactions {
         transaction?: TransactionResponse;
     }>;
     sendFormattedTransaction: (params: SimpleTransactionRequest, isLegacy?: boolean) => Promise<any>;
+    private sendFormattedTransactionInternal;
     sendTransactionWithEditedFee: (txHash: string, isLegacy?: boolean) => Promise<{
         error?: boolean;
         isSpeedUp: boolean;

package/types/transactions/evm-local-signer.d.ts

@@ -20,5 +20,5 @@ export declare const hashPersonalMessage: (message: Uint8Array) => string;
 export declare const signPersonalMessage: (message: string | Uint8Array, privateKey: string | Uint8Array) => string;
 export declare const parsePersonalMessage: (hexMessage: string) => string;
 export declare const signTransaction: (transaction: TransactionRequest, privateKey: string | Uint8Array) => string;
-export declare const sendLocalEvmTransaction: (provider: CustomJsonRpcProvider, privateKey: string, transaction: Deferrable<Record<string, any>>) => Promise<any>;
+export declare const sendLocalEvmTransaction: (provider: CustomJsonRpcProvider, privateKey: string, transaction: Deferrable<Record<string, any>>, beforeBroadcast?: () => void) => Promise<any>;
 export declare const sameAddress: (left: string, right: string) => boolean;

package/types/transactions/syscoin.d.ts

@@ -11,6 +11,7 @@ export declare class SyscoinTransactions implements ISyscoinTransactions {
     private ledger;
     private getState;
     private getAddress;
+    private captureSigningContext?;
     constructor(getSyscoinSigner: () => {
         hd: SyscoinHDSigner;
         main: any;
@@ -26,7 +27,7 @@ export declare class SyscoinTransactions implements ISyscoinTransactions {
         activeAccountId: number;
         activeAccountType: KeyringAccountType;
         activeNetwork: INetwork;
-    }, getAddress: (xpub: string, isChangeAddress: boolean) => Promise<string>, ledgerSigner: LedgerKeyring, trezorSigner: TrezorKeyring);
+    }, getAddress: (xpub: string, isChangeAddress: boolean) => Promise<string>, ledgerSigner: LedgerKeyring, trezorSigner: TrezorKeyring, captureSigningContext?: () => () => void);
     private getTransactionPSBT;
     decodeRawTransaction: (psbtOrHex: any, isRawHex?: boolean) => any;
     private feeCache;

package/types/utils/psbt-account-scope.d.ts

@@ -0,0 +1,17 @@
+import { INetwork } from '@sidhujag/sysweb3-network';
+import { Psbt } from 'bitcoinjs-lib';
+import { KeyringAccountType } from '../types';
+export type PsbtAccountScope = {
+    account: {
+        address: string;
+        xpub: string;
+    };
+    accountId: number;
+    accountType: KeyringAccountType;
+    network: INetwork;
+};
+export declare function createPsbtDerivationGuard(scope: PsbtAccountScope): (path: string) => string;
+/** Verify key ownership from public derivation and the actual spent script.
+ * Proprietary address metadata is deliberately never an authority here.
+ */
+export declare function assertPsbtAccountScope(psbt: Psbt, scope: PsbtAccountScope): void;