@bsv/sdk 1.1.33 → 1.2.0

package/dist/esm/src/script/templates/PushDrop.js

@@ -0,0 +1,215 @@
+import { LockingScript, UnlockingScript, OP } from '../index.js';
+import { Utils, Hash, TransactionSignature, Signature, PublicKey } from '../../primitives/index.js';
+/**
+ * For a given piece of data to push onto the stack in script, creates the correct minimally-encoded script chunk,
+ * including the correct push operation.
+ *
+ * TODO: This should be made into a TS-SDK util (distinct from the `minimallyEncode` util)
+ */
+const createMinimallyEncodedScriptChunk = (data) => {
+    if (data.length === 0) {
+        // Could have used OP_0.
+        return { op: 0 };
+    }
+    if (data.length === 1 && data[0] === 0) {
+        // Could have used OP_0.
+        return { op: 0 };
+    }
+    if (data.length === 1 && data[0] > 0 && data[0] <= 16) {
+        // Could have used OP_0 .. OP_16.
+        return { op: 0x50 + data[0] };
+    }
+    if (data.length === 1 && data[0] === 0x81) {
+        // Could have used OP_1NEGATE.
+        return { op: 0x4f };
+    }
+    if (data.length <= 75) {
+        // Could have used a direct push (opcode indicating number of bytes
+        // pushed + those bytes).
+        return { op: data.length, data };
+    }
+    if (data.length <= 255) {
+        // Could have used OP_PUSHDATA.
+        return { op: 0x4c, data };
+    }
+    if (data.length <= 65535) {
+        // Could have used OP_PUSHDATA2.
+        return { op: 0x4d, data };
+    }
+    return { op: 0x4e, data };
+};
+export default class PushDrop {
+    wallet;
+    /**
+     * Decodes a PushDrop script back into its token fields and the locking public key. If a signature was present, it will be the last field returned.
+     * Warning: Only works with a P2PK lock at the beginning of the script.
+     * @param script PushDrop script to decode back into token fields
+     * @returns An object containing PushDrop token fields and the locking public key. If a signature was included, it will be the last field.
+     */
+    static decode(script) {
+        const lockingPublicKey = PublicKey.fromString(Utils.toHex(script.chunks[0].data));
+        const fields = [];
+        for (let i = 2; i < script.chunks.length; i++) {
+            const nextOpcode = script.chunks[i + 1].op;
+            let chunk = script.chunks[i].data;
+            if (!chunk) {
+                if (script.chunks[i].op >= 80 && script.chunks[i].op <= 95) {
+                    chunk = [script.chunks[i].op - 80];
+                }
+                else if (script.chunks[i].op === 0) {
+                    chunk = [0];
+                }
+                else if (script.chunks[i].op === 0x4f) {
+                    chunk = [0x81];
+                }
+            }
+            fields.push(chunk);
+            // If the next value is DROP or 2DROP then this is the final field
+            if (nextOpcode === OP.OP_DROP || nextOpcode === OP.OP_2DROP) {
+                break;
+            }
+        }
+        return {
+            fields,
+            lockingPublicKey
+        };
+    }
+    /**
+     * Constructs a new instance of the PushDrop class.
+     *
+     * @param {Wallet} wallet - The wallet interface used for creating signatures and accessing public keys.
+     */
+    constructor(wallet) {
+        this.wallet = wallet;
+    }
+    /**
+     * Creates a PushDrop locking script with arbitrary data fields and a public key lock.
+     *
+     * @param {number[][]} fields - The token fields to include in the locking script.
+     * @param {[0 | 1 | 2, string]} protocolID - The protocol ID to use.
+     * @param {string} keyID - The key ID to use.
+     * @param {string} counterparty - The counterparty involved in the transaction, "self" or "anyone".
+     * @param {boolean} [forSelf=false] - Flag indicating if the lock is for the creator (default no).
+     * @param {boolean} [includeSignature=true] - Flag indicating if a signature should be included in the script (default yes).
+     * @returns {Promise<LockingScript>} The generated PushDrop locking script.
+     */
+    async lock(fields, protocolID, keyID, counterparty, forSelf = false, includeSignature = true, lockPosition = 'before') {
+        const { publicKey } = await this.wallet.getPublicKey({
+            protocolID,
+            keyID,
+            counterparty,
+            forSelf
+        });
+        const lockChunks = [];
+        const pushDropChunks = [];
+        lockChunks.push({ op: publicKey.length / 2, data: Utils.toArray(publicKey, 'hex') });
+        lockChunks.push({ op: OP.OP_CHECKSIG });
+        if (includeSignature) {
+            const dataToSign = fields.reduce((a, e) => [...a, ...e], []);
+            const { signature } = await this.wallet.createSignature({
+                data: dataToSign,
+                protocolID,
+                keyID,
+                counterparty
+            });
+            fields.push(signature);
+        }
+        for (const field of fields) {
+            pushDropChunks.push(createMinimallyEncodedScriptChunk(field));
+        }
+        let notYetDropped = fields.length;
+        while (notYetDropped > 1) {
+            pushDropChunks.push({ op: OP.OP_2DROP });
+            notYetDropped -= 2;
+        }
+        if (notYetDropped) {
+            pushDropChunks.push({ op: OP.OP_DROP });
+        }
+        if (lockPosition === 'before') {
+            return new LockingScript([
+                ...lockChunks,
+                ...pushDropChunks
+            ]);
+        }
+        else {
+            return new LockingScript([
+                ...pushDropChunks,
+                ...lockChunks
+            ]);
+        }
+    }
+    /**
+     * Creates an unlocking script for spending a PushDrop token output.
+     *
+     * @param {[0 | 1 | 2, string]} protocolID - The protocol ID to use.
+     * @param {string} keyID - The key ID to use.
+     * @param {string} counterparty - The counterparty involved in the transaction, "self" or "anyone".
+     * @param {string} [sourceTXID] - The TXID of the source transaction.
+     * @param {number} [sourceSatoshis] - The number of satoshis in the source output.
+     * @param {LockingScript} [lockingScript] - The locking script of the source output.
+     * @param {'all' | 'none' | 'single'} [signOutputs='all'] - Specifies which outputs to sign.
+     * @param {boolean} [anyoneCanPay=false] - Specifies if the anyone-can-pay flag is set.
+     * @returns {Object} An object containing functions to sign the transaction and estimate the script length.
+     */
+    unlock(protocolID, keyID, counterparty, signOutputs = 'all', anyoneCanPay = false, sourceSatoshis, lockingScript) {
+        return {
+            sign: async (tx, inputIndex) => {
+                let signatureScope = TransactionSignature.SIGHASH_FORKID;
+                if (signOutputs === 'all') {
+                    signatureScope |= TransactionSignature.SIGHASH_ALL;
+                }
+                if (signOutputs === 'none') {
+                    signatureScope |= TransactionSignature.SIGHASH_NONE;
+                }
+                if (signOutputs === 'single') {
+                    signatureScope |= TransactionSignature.SIGHASH_SINGLE;
+                }
+                if (anyoneCanPay) {
+                    signatureScope |= TransactionSignature.SIGHASH_ANYONECANPAY;
+                }
+                const input = tx.inputs[inputIndex];
+                const otherInputs = tx.inputs.filter((_, index) => index !== inputIndex);
+                const sourceTXID = input.sourceTXID ? input.sourceTXID : input.sourceTransaction?.id('hex');
+                if (!sourceTXID) {
+                    throw new Error('The input sourceTXID or sourceTransaction is required for transaction signing.');
+                }
+                sourceSatoshis ||= input.sourceTransaction?.outputs[input.sourceOutputIndex].satoshis;
+                if (!sourceSatoshis) {
+                    throw new Error('The sourceSatoshis or input sourceTransaction is required for transaction signing.');
+                }
+                lockingScript ||= input.sourceTransaction?.outputs[input.sourceOutputIndex].lockingScript;
+                if (!lockingScript) {
+                    throw new Error('The lockingScript or input sourceTransaction is required for transaction signing.');
+                }
+                const preimage = TransactionSignature.format({
+                    sourceTXID,
+                    sourceOutputIndex: input.sourceOutputIndex,
+                    sourceSatoshis,
+                    transactionVersion: tx.version,
+                    otherInputs,
+                    inputIndex,
+                    outputs: tx.outputs,
+                    inputSequence: input.sequence,
+                    subscript: lockingScript,
+                    lockTime: tx.lockTime,
+                    scope: signatureScope
+                });
+                const preimageHash = Hash.sha256(preimage);
+                const { signature: bareSignature } = await this.wallet.createSignature({
+                    data: preimageHash,
+                    protocolID,
+                    keyID,
+                    counterparty
+                });
+                const signature = Signature.fromDER([...bareSignature]);
+                const txSignature = new TransactionSignature(signature.r, signature.s, signatureScope);
+                const sigForScript = txSignature.toChecksigFormat();
+                return new UnlockingScript([
+                    { op: sigForScript.length, data: sigForScript }
+                ]);
+            },
+            estimateLength: async () => 73
+        };
+    }
+}
+//# sourceMappingURL=PushDrop.js.map

package/dist/esm/src/script/templates/PushDrop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PushDrop.js","sourceRoot":"","sources":["../../../../../src/script/templates/PushDrop.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,aAAa,EAAE,eAAe,EAAE,EAAE,EAAE,MAAM,aAAa,CAAA;AAChF,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,oBAAoB,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAInG;;;;;GAKG;AACH,MAAM,iCAAiC,GAAG,CAAC,IAAc,EAAmC,EAAE;IAC5F,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,wBAAwB;QACxB,OAAO,EAAE,EAAE,EAAE,CAAC,EAAE,CAAA;IAClB,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;QACvC,wBAAwB;QACxB,OAAO,EAAE,EAAE,EAAE,CAAC,EAAE,CAAA;IAClB,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;QACtD,iCAAiC;QACjC,OAAO,EAAE,EAAE,EAAE,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;IAC/B,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;QAC1C,8BAA8B;QAC9B,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAA;IACrB,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,IAAI,EAAE,EAAE,CAAC;QACtB,mEAAmE;QACnE,yBAAyB;QACzB,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,CAAA;IAClC,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;QACvB,+BAA+B;QAC/B,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;IAC3B,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK,EAAE,CAAC;QACzB,gCAAgC;QAChC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;IAC3B,CAAC;IACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA;AAC3B,CAAC,CAAA;AAED,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B,MAAM,CAAQ;IAEd;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,MAAqB;QACjC,MAAM,gBAAgB,GAAG,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAA;QACjF,MAAM,MAAM,GAAG,EAAE,CAAA;QACjB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC9C,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;YAC1C,IAAI,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;YACjC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACX,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,CAAC;oBAC3D,KAAK,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,CAAA;gBACpC,CAAC;qBAAM,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC;oBACrC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAA;gBACb,CAAC;qBAAM,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC;oBACxC,KAAK,GAAG,CAAC,IAAI,CAAC,CAAA;gBAChB,CAAC;YACH,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAElB,kEAAkE;YAClE,IAAI,UAAU,KAAK,EAAE,CAAC,OAAO,IAAI,UAAU,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC;gBAC5D,MAAK;YACP,CAAC;QACH,CAAC;QAED,OAAO;YACL,MAAM;YACN,gBAAgB;SACjB,CAAA;IACH,CAAC;IAED;;;;OAIG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,IAAI,CAAC,MAAkB,EAAE,UAA+B,EAAE,KAAa,EAAE,YAAoB,EAAE,OAAO,GAAG,KAAK,EAAE,gBAAgB,GAAG,IAAI,EAAE,eAAmC,QAAQ;QACxL,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YACnD,UAAU;YACV,KAAK;YACL,YAAY;YACZ,OAAO;SACR,CAAC,CAAA;QACF,MAAM,UAAU,GAA2C,EAAE,CAAA;QAC7D,MAAM,cAAc,GAA2C,EAAE,CAAA;QACjE,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,EAAE,CAAC,CAAA;QACpF,UAAU,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,WAAW,EAAE,CAAC,CAAA;QACvC,IAAI,gBAAgB,EAAE,CAAC;YACrB,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;YAC5D,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;gBACtD,IAAI,EAAE,UAAU;gBAChB,UAAU;gBACV,KAAK;gBACL,YAAY;aACb,CAAC,CAAA;YACF,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACxB,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,cAAc,CAAC,IAAI,CAAC,iCAAiC,CAAC,KAAK,CAAC,CAAC,CAAA;QAC/D,CAAC;QACD,IAAI,aAAa,GAAG,MAAM,CAAC,MAAM,CAAA;QACjC,OAAO,aAAa,GAAG,CAAC,EAAE,CAAC;YACzB,cAAc,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;YACxC,aAAa,IAAI,CAAC,CAAA;QACpB,CAAC;QACD,IAAI,aAAa,EAAE,CAAC;YAClB,cAAc,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,CAAA;QACzC,CAAC;QACD,IAAI,YAAY,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO,IAAI,aAAa,CAAC;gBACvB,GAAG,UAAU;gBACb,GAAG,cAAc;aAClB,CAAC,CAAA;QACJ,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,aAAa,CAAC;gBACvB,GAAG,cAAc;gBACjB,GAAG,UAAU;aACd,CAAC,CAAA;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CACJ,UAA+B,EAC/B,KAAa,EACb,YAAoB,EACpB,cAAyC,KAAK,EAC9C,YAAY,GAAG,KAAK,EACpB,cAAuB,EACvB,aAA6B;QAK7B,OAAO;YACL,IAAI,EAAE,KAAK,EAAE,EAAe,EAAE,UAAkB,EAA4B,EAAE;gBAC5E,IAAI,cAAc,GAAG,oBAAoB,CAAC,cAAc,CAAA;gBACxD,IAAI,WAAW,KAAK,KAAK,EAAE,CAAC;oBAC1B,cAAc,IAAI,oBAAoB,CAAC,WAAW,CAAA;gBACpD,CAAC;gBACD,IAAI,WAAW,KAAK,MAAM,EAAE,CAAC;oBAC3B,cAAc,IAAI,oBAAoB,CAAC,YAAY,CAAA;gBACrD,CAAC;gBACD,IAAI,WAAW,KAAK,QAAQ,EAAE,CAAC;oBAC7B,cAAc,IAAI,oBAAoB,CAAC,cAAc,CAAA;gBACvD,CAAC;gBACD,IAAI,YAAY,EAAE,CAAC;oBACjB,cAAc,IAAI,oBAAoB,CAAC,oBAAoB,CAAA;gBAC7D,CAAC;gBAED,MAAM,KAAK,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;gBAEnC,MAAM,WAAW,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC,CAAA;gBAExE,MAAM,UAAU,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB,EAAE,EAAE,CAAC,KAAK,CAAC,CAAA;gBAC3F,IAAI,CAAC,UAAU,EAAE,CAAC;oBAChB,MAAM,IAAI,KAAK,CACb,gFAAgF,CACjF,CAAA;gBACH,CAAC;gBACD,cAAc,KAAK,KAAK,CAAC,iBAAiB,EAAE,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAA;gBACrF,IAAI,CAAC,cAAc,EAAE,CAAC;oBACpB,MAAM,IAAI,KAAK,CACb,oFAAoF,CACrF,CAAA;gBACH,CAAC;gBACD,aAAa,KAAK,KAAK,CAAC,iBAAiB,EAAE,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,aAAa,CAAA;gBACzF,IAAI,CAAC,aAAa,EAAE,CAAC;oBACnB,MAAM,IAAI,KAAK,CACb,mFAAmF,CACpF,CAAA;gBACH,CAAC;gBAED,MAAM,QAAQ,GAAG,oBAAoB,CAAC,MAAM,CAAC;oBAC3C,UAAU;oBACV,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;oBAC1C,cAAc;oBACd,kBAAkB,EAAE,EAAE,CAAC,OAAO;oBAC9B,WAAW;oBACX,UAAU;oBACV,OAAO,EAAE,EAAE,CAAC,OAAO;oBACnB,aAAa,EAAE,KAAK,CAAC,QAAQ;oBAC7B,SAAS,EAAE,aAAa;oBACxB,QAAQ,EAAE,EAAE,CAAC,QAAQ;oBACrB,KAAK,EAAE,cAAc;iBACtB,CAAC,CAAA;gBACF,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;gBAC1C,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;oBACrE,IAAI,EAAE,YAAY;oBAClB,UAAU;oBACV,KAAK;oBACL,YAAY;iBACb,CAAC,CAAA;gBACF,MAAM,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAA;gBACvD,MAAM,WAAW,GAAG,IAAI,oBAAoB,CAC1C,SAAS,CAAC,CAAC,EACX,SAAS,CAAC,CAAC,EACX,cAAc,CACf,CAAA;gBACD,MAAM,YAAY,GAAG,WAAW,CAAC,gBAAgB,EAAE,CAAA;gBACnD,OAAO,IAAI,eAAe,CAAC;oBACzB,EAAE,EAAE,EAAE,YAAY,CAAC,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE;iBAChD,CAAC,CAAA;YACJ,CAAC;YACD,cAAc,EAAE,KAAK,IAAI,EAAE,CAAC,EAAE;SAC/B,CAAA;IACH,CAAC;CACF"}

package/dist/esm/src/script/templates/index.js

@@ -1,3 +1,4 @@
 export { default as P2PKH } from './P2PKH.js';
 export { default as RPuzzle } from './RPuzzle.js';
+export { default as PushDrop } from './PushDrop.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/src/script/templates/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/script/templates/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,YAAY,CAAA;AAC7C,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,cAAc,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/script/templates/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,IAAI,KAAK,EAAE,MAAM,YAAY,CAAA;AAC7C,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,eAAe,CAAA"}

package/dist/esm/src/transaction/http/DefaultHttpClient.js

@@ -13,7 +13,7 @@ export function defaultHttpClient() {
     };
     if (typeof window !== 'undefined' && typeof window.fetch === 'function') {
         // Use fetch in a browser environment
-        return new FetchHttpClient(window.fetch);
+        return new FetchHttpClient(window.fetch.bind(window));
     }
     else if (typeof require !== 'undefined') {
         // Use Node.js https module

package/dist/esm/src/transaction/http/DefaultHttpClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"DefaultHttpClient.js","sourceRoot":"","sources":["../../../../../src/transaction/http/DefaultHttpClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD;;;;GAIG;AACH,MAAM,UAAU,iBAAiB;IAC/B,MAAM,YAAY,GAAe;QAC/B,KAAK,CAAC,OAAO,CAAE,GAAG,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;QAChE,CAAC;KACF,CAAA;IAED,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;QACxE,qCAAqC;QACrC,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAC1C,CAAC;SAAM,IAAI,OAAO,OAAO,KAAK,WAAW,EAAE,CAAC;QAC1C,2BAA2B;QAC3B,2BAA2B;QAC3B,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;YAC9B,OAAO,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAA;QACpC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,YAAY,CAAA;QACrB,CAAC;IACH,CAAC;SAAM,CAAC;QACN,OAAO,YAAY,CAAA;IACrB,CAAC;AACH,CAAC"}
+{"version":3,"file":"DefaultHttpClient.js","sourceRoot":"","sources":["../../../../../src/transaction/http/DefaultHttpClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD;;;;GAIG;AACH,MAAM,UAAU,iBAAiB;IAC/B,MAAM,YAAY,GAAe;QAC/B,KAAK,CAAC,OAAO,CAAE,GAAG,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;QAChE,CAAC;KACF,CAAA;IAED,IAAI,OAAO,MAAM,KAAK,WAAW,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;QACxE,qCAAqC;QACrC,OAAO,IAAI,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;IACvD,CAAC;SAAM,IAAI,OAAO,OAAO,KAAK,WAAW,EAAE,CAAC;QAC1C,2BAA2B;QAC3B,2BAA2B;QAC3B,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;YAC9B,OAAO,IAAI,gBAAgB,CAAC,KAAK,CAAC,CAAA;QACpC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,YAAY,CAAA;QACrB,CAAC;IACH,CAAC;SAAM,CAAC;QACN,OAAO,YAAY,CAAA;IACrB,CAAC;AACH,CAAC"}

package/dist/esm/src/wallet/CachedKeyDeriver.js

@@ -0,0 +1,174 @@
+import { PrivateKey, PublicKey } from '../primitives/index.js';
+import KeyDeriver from './KeyDeriver.js';
+/**
+ * A cached version of KeyDeriver that caches the results of key derivation methods.
+ * This is useful for optimizing performance when the same keys are derived multiple times.
+ * It supports configurable cache size with sane defaults and maintains cache entries using LRU (Least Recently Used) eviction policy.
+ */
+export default class CachedKeyDeriver {
+    keyDeriver;
+    cache;
+    maxCacheSize;
+    /**
+       * Initializes the CachedKeyDeriver instance with a root private key and optional cache settings.
+       * @param {PrivateKey | 'anyone'} rootKey - The root private key or the string 'anyone'.
+       * @param {Object} [options] - Optional settings for the cache.
+       * @param {number} [options.maxCacheSize=1000] - The maximum number of entries to store in the cache.
+       */
+    constructor(rootKey, options) {
+        this.keyDeriver = new KeyDeriver(rootKey);
+        this.cache = new Map();
+        this.maxCacheSize = options?.maxCacheSize || 1000;
+    }
+    /**
+       * Derives a public key based on protocol ID, key ID, and counterparty.
+       * Caches the result for future calls with the same parameters.
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @param {boolean} [forSelf=false] - Whether deriving for self.
+       * @returns {PublicKey} - The derived public key.
+       */
+    derivePublicKey(protocolID, keyID, counterparty, forSelf = false) {
+        const cacheKey = this.generateCacheKey('derivePublicKey', protocolID, keyID, counterparty, forSelf);
+        if (this.cache.has(cacheKey)) {
+            return this.cacheGet(cacheKey);
+        }
+        else {
+            const result = this.keyDeriver.derivePublicKey(protocolID, keyID, counterparty, forSelf);
+            this.cacheSet(cacheKey, result);
+            return result;
+        }
+    }
+    /**
+       * Derives a private key based on protocol ID, key ID, and counterparty.
+       * Caches the result for future calls with the same parameters.
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {PrivateKey} - The derived private key.
+       */
+    derivePrivateKey(protocolID, keyID, counterparty) {
+        const cacheKey = this.generateCacheKey('derivePrivateKey', protocolID, keyID, counterparty);
+        if (this.cache.has(cacheKey)) {
+            return this.cacheGet(cacheKey);
+        }
+        else {
+            const result = this.keyDeriver.derivePrivateKey(protocolID, keyID, counterparty);
+            this.cacheSet(cacheKey, result);
+            return result;
+        }
+    }
+    /**
+       * Derives a symmetric key based on protocol ID, key ID, and counterparty.
+       * Caches the result for future calls with the same parameters.
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {SymmetricKey} - The derived symmetric key.
+       * @throws {Error} - Throws an error if attempting to derive a symmetric key for 'anyone'.
+       */
+    deriveSymmetricKey(protocolID, keyID, counterparty) {
+        const cacheKey = this.generateCacheKey('deriveSymmetricKey', protocolID, keyID, counterparty);
+        if (this.cache.has(cacheKey)) {
+            return this.cacheGet(cacheKey);
+        }
+        else {
+            const result = this.keyDeriver.deriveSymmetricKey(protocolID, keyID, counterparty);
+            this.cacheSet(cacheKey, result);
+            return result;
+        }
+    }
+    /**
+       * Reveals the shared secret between the root key and the counterparty.
+       * Caches the result for future calls with the same parameters.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {number[]} - The shared secret as a number array.
+       * @throws {Error} - Throws an error if attempting to reveal a shared secret for 'self'.
+       */
+    revealCounterpartySecret(counterparty) {
+        const cacheKey = this.generateCacheKey('revealCounterpartySecret', counterparty);
+        if (this.cache.has(cacheKey)) {
+            return this.cacheGet(cacheKey);
+        }
+        else {
+            const result = this.keyDeriver.revealCounterpartySecret(counterparty);
+            this.cacheSet(cacheKey, result);
+            return result;
+        }
+    }
+    /**
+       * Reveals the specific key association for a given protocol ID, key ID, and counterparty.
+       * Caches the result for future calls with the same parameters.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @returns {number[]} - The specific key association as a number array.
+       */
+    revealSpecificSecret(counterparty, protocolID, keyID) {
+        const cacheKey = this.generateCacheKey('revealSpecificSecret', counterparty, protocolID, keyID);
+        if (this.cache.has(cacheKey)) {
+            return this.cacheGet(cacheKey);
+        }
+        else {
+            const result = this.keyDeriver.revealSpecificSecret(counterparty, protocolID, keyID);
+            this.cacheSet(cacheKey, result);
+            return result;
+        }
+    }
+    /**
+       * Generates a unique cache key based on the method name and input parameters.
+       * @param {string} methodName - The name of the method.
+       * @param {...any} args - The arguments passed to the method.
+       * @returns {string} - The generated cache key.
+       */
+    generateCacheKey(methodName, ...args) {
+        const serializedArgs = args.map((arg) => this.serializeArgument(arg)).join('|');
+        return `${methodName}|${serializedArgs}`;
+    }
+    /**
+       * Serializes an argument to a string for use in a cache key.
+       * @param {any} arg - The argument to serialize.
+       * @returns {string} - The serialized argument.
+       */
+    serializeArgument(arg) {
+        if (arg instanceof PublicKey || arg instanceof PrivateKey) {
+            return arg.toString();
+        }
+        else if (Array.isArray(arg)) {
+            return arg.map((item) => this.serializeArgument(item)).join(',');
+        }
+        else if (typeof arg === 'object' && arg !== null) {
+            return JSON.stringify(arg);
+        }
+        else {
+            return String(arg);
+        }
+    }
+    /**
+       * Retrieves an item from the cache and updates its position to reflect recent use.
+       * @param {string} cacheKey - The key of the cached item.
+       * @returns {any} - The cached value.
+       */
+    cacheGet(cacheKey) {
+        const value = this.cache.get(cacheKey);
+        // Update the entry to reflect recent use
+        this.cache.delete(cacheKey);
+        this.cache.set(cacheKey, value);
+        return value;
+    }
+    /**
+       * Adds an item to the cache and evicts the least recently used item if necessary.
+       * @param {string} cacheKey - The key of the item to cache.
+       * @param {any} value - The value to cache.
+       */
+    cacheSet(cacheKey, value) {
+        if (this.cache.size >= this.maxCacheSize) {
+            // Evict the least recently used item (first item in Map)
+            const firstKey = this.cache.keys().next().value;
+            this.cache.delete(firstKey);
+        }
+        this.cache.set(cacheKey, value);
+    }
+}
+//# sourceMappingURL=CachedKeyDeriver.js.map

package/dist/esm/src/wallet/CachedKeyDeriver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CachedKeyDeriver.js","sourceRoot":"","sources":["../../../../src/wallet/CachedKeyDeriver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAgB,MAAM,wBAAwB,CAAA;AAC5E,OAAO,UAAU,MAAM,iBAAiB,CAAA;AAExC;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAgB;IAClB,UAAU,CAAY;IACtB,KAAK,CAAkB;IACvB,YAAY,CAAQ;IAErC;;;;;SAKK;IACL,YAAY,OAA8B,EAAE,OAAmC;QAC7E,IAAI,CAAC,UAAU,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,CAAA;QACzC,IAAI,CAAC,KAAK,GAAG,IAAI,GAAG,EAAe,CAAA;QACnC,IAAI,CAAC,YAAY,GAAG,OAAO,EAAE,YAAY,IAAI,IAAI,CAAA;IACnD,CAAC;IAED;;;;;;;;SAQK;IACL,eAAe,CACb,UAA+B,EAC/B,KAAa,EACb,YAAoD,EACpD,UAAmB,KAAK;QAExB,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,CAAA;QACnG,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAChC,CAAC;aAAM,CAAC;YACN,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,UAAU,EAAE,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,CAAA;YACxF,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;YAC/B,OAAO,MAAM,CAAA;QACf,CAAC;IACH,CAAC;IAED;;;;;;;SAOK;IACL,gBAAgB,CACd,UAA+B,EAC/B,KAAa,EACb,YAAoD;QAEpD,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,kBAAkB,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,CAAC,CAAA;QAC3F,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAChC,CAAC;aAAM,CAAC;YACN,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,EAAE,YAAY,CAAC,CAAA;YAChF,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;YAC/B,OAAO,MAAM,CAAA;QACf,CAAC;IACH,CAAC;IAED;;;;;;;;SAQK;IACL,kBAAkB,CAChB,UAA+B,EAC/B,KAAa,EACb,YAAoD;QAEpD,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,EAAE,UAAU,EAAE,KAAK,EAAE,YAAY,CAAC,CAAA;QAC7F,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAChC,CAAC;aAAM,CAAC;YACN,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC,UAAU,EAAE,KAAK,EAAE,YAAY,CAAC,CAAA;YAClF,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;YAC/B,OAAO,MAAM,CAAA;QACf,CAAC;IACH,CAAC;IAED;;;;;;SAMK;IACL,wBAAwB,CAAC,YAAoD;QAC3E,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,0BAA0B,EAAE,YAAY,CAAC,CAAA;QAChF,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAChC,CAAC;aAAM,CAAC;YACN,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC,YAAY,CAAC,CAAA;YACrE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;YAC/B,OAAO,MAAM,CAAA;QACf,CAAC;IACH,CAAC;IAED;;;;;;;SAOK;IACL,oBAAoB,CAClB,YAAoD,EACpD,UAA+B,EAC/B,KAAa;QAEb,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,sBAAsB,EAAE,YAAY,EAAE,UAAU,EAAE,KAAK,CAAC,CAAA;QAC/F,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;QAChC,CAAC;aAAM,CAAC;YACN,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC,YAAY,EAAE,UAAU,EAAE,KAAK,CAAC,CAAA;YACpF,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;YAC/B,OAAO,MAAM,CAAA;QACf,CAAC;IACH,CAAC;IAED;;;;;SAKK;IACG,gBAAgB,CAAC,UAAkB,EAAE,GAAG,IAAW;QACzD,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAC/E,OAAO,GAAG,UAAU,IAAI,cAAc,EAAE,CAAA;IAC1C,CAAC;IAED;;;;SAIK;IACG,iBAAiB,CAAC,GAAQ;QAChC,IAAI,GAAG,YAAY,SAAS,IAAI,GAAG,YAAY,UAAU,EAAE,CAAC;YAC1D,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAA;QACvB,CAAC;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;QAClE,CAAC;aAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACnD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;QAC5B,CAAC;aAAM,CAAC;YACN,OAAO,MAAM,CAAC,GAAG,CAAC,CAAA;QACpB,CAAC;IACH,CAAC;IAED;;;;SAIK;IACG,QAAQ,CAAC,QAAgB;QAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACtC,yCAAyC;QACzC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAC3B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;QAC/B,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;SAIK;IACG,QAAQ,CAAC,QAAgB,EAAE,KAAU;QAC3C,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACzC,yDAAyD;YACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAA;YAC/C,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAC7B,CAAC;QACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;IACjC,CAAC;CACF"}

package/dist/esm/src/wallet/KeyDeriver.js

@@ -0,0 +1,172 @@
+import { PrivateKey, PublicKey, SymmetricKey, Hash, Utils } from '../primitives/index.js';
+/**
+ * Class responsible for deriving various types of keys using a root private key.
+ * It supports deriving public and private keys, symmetric keys, and revealing key linkages.
+ */
+export default class KeyDeriver {
+    rootKey;
+    /**
+       * Initializes the KeyDeriver instance with a root private key.
+       * @param {PrivateKey | 'anyone'} rootKey - The root private key or the string 'anyone'.
+       */
+    constructor(rootKey) {
+        if (rootKey === 'anyone') {
+            this.rootKey = new PrivateKey(1);
+        }
+        else {
+            this.rootKey = rootKey;
+        }
+    }
+    /**
+       * Derives a public key based on protocol ID, key ID, and counterparty.
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @param {boolean} [forSelf=false] - Whether deriving for self.
+       * @returns {PublicKey} - The derived public key.
+       */
+    derivePublicKey(protocolID, keyID, counterparty, forSelf = false) {
+        counterparty = this.normalizeCounterparty(counterparty);
+        if (forSelf) {
+            return this.rootKey.deriveChild(counterparty, this.computeInvoiceNumber(protocolID, keyID)).toPublicKey();
+        }
+        else {
+            return counterparty.deriveChild(this.rootKey, this.computeInvoiceNumber(protocolID, keyID));
+        }
+    }
+    /**
+       * Derives a private key based on protocol ID, key ID, and counterparty.
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {PrivateKey} - The derived private key.
+       */
+    derivePrivateKey(protocolID, keyID, counterparty) {
+        counterparty = this.normalizeCounterparty(counterparty);
+        return this.rootKey.deriveChild(counterparty, this.computeInvoiceNumber(protocolID, keyID));
+    }
+    /**
+       * Derives a symmetric key based on protocol ID, key ID, and counterparty.
+       * Note: Symmetric keys should not be derivable by everyone due to security risks.
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {SymmetricKey} - The derived symmetric key.
+       * @throws {Error} - Throws an error if attempting to derive a symmetric key for 'anyone'.
+       */
+    deriveSymmetricKey(protocolID, keyID, counterparty) {
+        if (counterparty === 'anyone') {
+            throw new Error('Symmetric keys (such as encryption keys or HMAC keys) should not be derivable by everyone, because messages would be decryptable by anyone who knows the identity public key of the user, and HMACs would be similarly forgeable.');
+        }
+        counterparty = this.normalizeCounterparty(counterparty);
+        const derivedPublicKey = this.derivePublicKey(protocolID, keyID, counterparty);
+        const derivedPrivateKey = this.derivePrivateKey(protocolID, keyID, counterparty);
+        return new SymmetricKey(derivedPrivateKey.deriveSharedSecret(derivedPublicKey).x.toArray());
+    }
+    /**
+       * Reveals the shared secret between the root key and the counterparty.
+       * Note: This should not be used for 'self'.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {number[]} - The shared secret as a number array.
+       * @throws {Error} - Throws an error if attempting to reveal a shared secret for 'self'.
+       */
+    revealCounterpartySecret(counterparty) {
+        if (counterparty === 'self') {
+            throw new Error('Counterparty secrets cannot be revealed for counterparty=self.');
+        }
+        counterparty = this.normalizeCounterparty(counterparty);
+        // Double-check to ensure not revealing the secret for 'self'
+        const self = this.rootKey.toPublicKey();
+        const keyDerivedBySelf = this.rootKey.deriveChild(self, 'test').toHex();
+        const keyDerivedByCounterparty = this.rootKey.deriveChild(counterparty, 'test').toHex();
+        if (keyDerivedBySelf === keyDerivedByCounterparty) {
+            throw new Error('Counterparty secrets cannot be revealed for counterparty=self.');
+        }
+        return this.rootKey.deriveSharedSecret(counterparty).encode(true);
+    }
+    /**
+       * Reveals the specific key association for a given protocol ID, key ID, and counterparty.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @returns {number[]} - The specific key association as a number array.
+       */
+    revealSpecificSecret(counterparty, protocolID, keyID) {
+        counterparty = this.normalizeCounterparty(counterparty);
+        const sharedSecret = this.rootKey.deriveSharedSecret(counterparty);
+        const invoiceNumberBin = Utils.toArray(this.computeInvoiceNumber(protocolID, keyID), 'utf8');
+        return Hash.sha256hmac(sharedSecret.encode(true), invoiceNumberBin);
+    }
+    /**
+       * Normalizes the counterparty to a public key.
+       * @param {PublicKey | string | 'self' | 'anyone'} counterparty - The counterparty's public key or a predefined value ('self' or 'anyone').
+       * @returns {PublicKey} - The normalized counterparty public key.
+       * @throws {Error} - Throws an error if the counterparty is invalid.
+       */
+    normalizeCounterparty(counterparty) {
+        if (!counterparty) {
+            throw new Error('counterparty must be self, anyone or a public key!');
+        }
+        else if (counterparty === 'self') {
+            return this.rootKey.toPublicKey();
+        }
+        else if (counterparty === 'anyone') {
+            return new PrivateKey(1).toPublicKey();
+        }
+        else if (typeof counterparty === 'string') {
+            return PublicKey.fromString(counterparty);
+        }
+        else {
+            return counterparty;
+        }
+    }
+    /**
+       * Computes the invoice number based on the protocol ID and key ID.
+       * @param {[0 | 1 | 2, string]} protocolID - The protocol ID including a security level and protocol name.
+       * @param {string} keyID - The key identifier.
+       * @returns {string} - The computed invoice number.
+       * @throws {Error} - Throws an error if protocol ID or key ID are invalid.
+       */
+    computeInvoiceNumber(protocolID, keyID) {
+        const securityLevel = protocolID[0];
+        if (!Number.isInteger(securityLevel) || securityLevel < 0 || securityLevel > 2) {
+            throw new Error('Protocol security level must be 0, 1, or 2');
+        }
+        const protocolName = protocolID[1].toLowerCase().trim();
+        if (keyID.length > 800) {
+            throw new Error('Key IDs must be 800 characters or less');
+        }
+        if (keyID.length < 1) {
+            throw new Error('Key IDs must be 1 character or more');
+        }
+        if (protocolName.length > 400) {
+            // Specific linkage revelation is the only protocol ID that can contain another protocol ID.
+            // Therefore, we allow it to be long enough to encapsulate the target protocol
+            if (protocolName.startsWith('specific linkage revelation ')) {
+                // The format is: 'specific linkage revelation x YYYYY'
+                // Where: x is the security level and YYYYY is the target protocol
+                // Thus, the max acceptable length is 30 + 400 = 430 bytes
+                if (protocolName.length > 430) {
+                    throw new Error('Specific linkage revelation protocol names must be 430 characters or less');
+                }
+            }
+            else {
+                throw new Error('Protocol names must be 400 characters or less');
+            }
+        }
+        if (protocolName.length < 5) {
+            throw new Error('Protocol names must be 5 characters or more');
+        }
+        if (protocolName.includes('  ')) {
+            throw new Error('Protocol names cannot contain multiple consecutive spaces ("  ")');
+        }
+        if (!/^[a-z0-9 ]+$/g.test(protocolName)) {
+            throw new Error('Protocol names can only contain letters, numbers and spaces');
+        }
+        if (protocolName.endsWith(' protocol')) {
+            throw new Error('No need to end your protocol name with " protocol"');
+        }
+        return `${securityLevel}-${protocolName}-${keyID}`;
+    }
+}
+//# sourceMappingURL=KeyDeriver.js.map

package/dist/esm/src/wallet/KeyDeriver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"KeyDeriver.js","sourceRoot":"","sources":["../../../../src/wallet/KeyDeriver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAA;AAEzF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,UAAU;IAC7B,OAAO,CAAY;IAEnB;;;SAGK;IACL,YAAY,OAA8B;QACxC,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;YACzB,IAAI,CAAC,OAAO,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;QAClC,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACxB,CAAC;IACH,CAAC;IAED;;;;;;;SAOK;IACL,eAAe,CAAC,UAA+B,EAAE,KAAa,EAAE,YAAoD,EAAE,UAAmB,KAAK;QAC5I,YAAY,GAAG,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAA;QACvD,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,YAAY,EAAE,IAAI,CAAC,oBAAoB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,WAAW,EAAE,CAAA;QAC3G,CAAC;aAAM,CAAC;YACN,OAAO,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,oBAAoB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAA;QAC7F,CAAC;IACH,CAAC;IAED;;;;;;SAMK;IACL,gBAAgB,CAAC,UAA+B,EAAE,KAAa,EAAE,YAAoD;QACnH,YAAY,GAAG,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAA;QACvD,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,YAAY,EAAE,IAAI,CAAC,oBAAoB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAA;IAC7F,CAAC;IAED;;;;;;;;SAQK;IACL,kBAAkB,CAAC,UAA+B,EAAE,KAAa,EAAE,YAAoD;QACrH,IAAI,YAAY,KAAK,QAAQ,EAAE,CAAC;YAC9B,MAAM,IAAI,KAAK,CACb,mOAAmO,CACpO,CAAA;QACH,CAAC;QACD,YAAY,GAAG,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAA;QACvD,MAAM,gBAAgB,GAAG,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,KAAK,EAAE,YAAY,CAAC,CAAA;QAC9E,MAAM,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,EAAE,YAAY,CAAC,CAAA;QAChF,OAAO,IAAI,YAAY,CAAC,iBAAiB,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAA;IAC7F,CAAC;IAED;;;;;;SAMK;IACL,wBAAwB,CAAC,YAAoD;QAC3E,IAAI,YAAY,KAAK,MAAM,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;QACnF,CAAC;QACD,YAAY,GAAG,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAA;QAEvD,6DAA6D;QAC7D,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAA;QACvC,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,KAAK,EAAE,CAAA;QACvE,MAAM,wBAAwB,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC,KAAK,EAAE,CAAA;QAEvF,IAAI,gBAAgB,KAAK,wBAAwB,EAAE,CAAC;YAClD,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;QACnF,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,IAAI,CAAa,CAAA;IAC/E,CAAC;IAED;;;;;;SAMK;IACL,oBAAoB,CAAC,YAAoD,EAAE,UAA+B,EAAE,KAAa;QACvH,YAAY,GAAG,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAA;QACvD,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAA;QAClE,MAAM,gBAAgB,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,UAAU,EAAE,KAAK,CAAC,EAAE,MAAM,CAAC,CAAA;QAC5F,OAAO,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC,CAAA;IACrE,CAAC;IAED;;;;;SAKK;IACG,qBAAqB,CAAC,YAAoD;QAChF,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAA;QACvE,CAAC;aAAM,IAAI,YAAY,KAAK,MAAM,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAA;QACnC,CAAC;aAAM,IAAI,YAAY,KAAK,QAAQ,EAAE,CAAC;YACrC,OAAO,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAA;QACxC,CAAC;aAAM,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;YAC5C,OAAO,SAAS,CAAC,UAAU,CAAC,YAAY,CAAC,CAAA;QAC3C,CAAC;aAAM,CAAC;YACN,OAAO,YAAY,CAAA;QACrB,CAAC;IACH,CAAC;IAED;;;;;;SAMK;IACG,oBAAoB,CAAC,UAA+B,EAAE,KAAa;QACzE,MAAM,aAAa,GAAG,UAAU,CAAC,CAAC,CAAC,CAAA;QACnC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,aAAa,GAAG,CAAC,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;YAC/E,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;QAC/D,CAAC;QACD,MAAM,YAAY,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAA;QACvD,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;QAC3D,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACxD,CAAC;QACD,IAAI,YAAY,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YAC9B,4FAA4F;YAC5F,8EAA8E;YAC9E,IAAI,YAAY,CAAC,UAAU,CAAC,8BAA8B,CAAC,EAAE,CAAC;gBAC5D,uDAAuD;gBACvD,kEAAkE;gBAClE,0DAA0D;gBAC1D,IAAI,YAAY,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;oBAC9B,MAAM,IAAI,KAAK,CAAC,2EAA2E,CAAC,CAAA;gBAC9F,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;YAClE,CAAC;QACH,CAAC;QACD,IAAI,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;QAChE,CAAC;QACD,IAAI,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAA;QACrF,CAAC;QACD,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAA;QAChF,CAAC;QACD,IAAI,YAAY,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAA;QACvE,CAAC;QACD,OAAO,GAAG,aAAa,IAAI,YAAY,IAAI,KAAK,EAAE,CAAA;IACpD,CAAC;CACF"}