@bsv/templates 1.0.0 → 1.1.0

package/dist/esm/src/MultiPushDrop.js

@@ -0,0 +1,275 @@
+import { LockingScript, UnlockingScript, OP, Utils, Hash, TransactionSignature, Signature } from '@bsv/sdk';
+// Helper to ensure a value is not null or undefined
+function verifyTruthy(v, err) {
+    if (v === null || v === undefined)
+        throw new Error(err || 'Value must not be null or undefined');
+    return v;
+}
+// Helper to create minimally encoded script chunks (same as in PushDrop)
+const createMinimallyEncodedScriptChunk = (data) => {
+    if (data.length === 0)
+        return { op: 0 }; // OP_0
+    if (data.length === 1 && data[0] === 0)
+        return { op: 0 }; // OP_0
+    if (data.length === 1 && data[0] > 0 && data[0] <= 16)
+        return { op: 0x50 + data[0] }; // OP_1 to OP_16
+    if (data.length === 1 && data[0] === 0x81)
+        return { op: 0x4f }; // OP_1NEGATE
+    if (data.length <= 75)
+        return { op: data.length, data };
+    if (data.length <= 255)
+        return { op: 0x4c, data }; // OP_PUSHDATA1
+    if (data.length <= 65535)
+        return { op: 0x4d, data }; // OP_PUSHDATA2
+    return { op: 0x4e, data }; // OP_PUSHDATA4
+};
+/**
+ * MultiPushDrop Script Template
+ *
+ * This template creates locking scripts that allow spending by any one of multiple
+ * specified public keys (1-of-N). It also pushes arbitrary data fields onto the stack,
+ * which are dropped after the signature check.
+ *
+ * When using this among adversarial or non-trusted groups, the MASSIVE caveat is that
+ * there is no constraint enforcing that any group members are kept in the loop. Any group
+ * member can trivially destroy the token. For more practical non-trusted arrangements,
+ * techniques like OP_PUSH_TX should be used instead.
+ *
+ * There's also a known bug in this implementation where it won't work with over around 120
+ * keys but involving more than a few people than just a few into a FULLY TRUST BASED exchange
+ * is never a good idea. Use a more robust, application-specific mechanism.
+ */
+export default class MultiPushDrop {
+    wallet;
+    originator;
+    /**
+       * Decodes a MultiPushDrop locking script back into its data fields and the list of locking public keys.
+       * @param script The MultiPushDrop locking script to decode.
+       * @returns {MultiPushDropDecoded} An object containing the locking public keys and data fields.
+       * @throws {Error} If the script structure is not a valid MultiPushDrop script.
+       */
+    static decode(script) {
+        const chunks = script.chunks;
+        let cursor = 0;
+        // Decode keys until they stop being 33 bytes long
+        const lockingPublicKeys = [];
+        while (chunks[cursor].data?.length === 33) {
+            const keyChunk = verifyTruthy(chunks[cursor], `Missing public key chunk ${cursor}`);
+            const keyData = verifyTruthy(keyChunk.data, `Public key chunk ${cursor} has no data`);
+            lockingPublicKeys.push(Utils.toHex(keyData));
+            cursor++;
+        }
+        // Skip the nPublicKeys chunk and opcodes.
+        // This amounts to 8 items to skip.
+        cursor += 8;
+        // Decode Data Fields
+        const fields = [];
+        for (let i = cursor; i < chunks.length; i++) {
+            const nextOpcode = chunks[i + 1]?.op;
+            const chunkData = chunks[i].data ?? []; // Use OP code for OP_0-OP_16 etc. if data is null
+            let currentField = [];
+            if (chunkData.length > 0) {
+                currentField = chunkData;
+            }
+            else if (chunks[i].op >= OP.OP_1 && chunks[i].op <= OP.OP_16) {
+                currentField = [chunks[i].op - OP.OP_1 + 1];
+            }
+            else if (chunks[i].op === OP.OP_0) {
+                currentField = []; // Represent OP_0 as empty array
+            }
+            else if (chunks[i].op === OP.OP_1NEGATE) {
+                currentField = [0x81];
+            }
+            else if (chunks[i].op === OP.OP_DROP || chunks[i].op === OP.OP_2DROP) {
+                // Stop before the drops
+                break;
+            }
+            else {
+                // Assume it's a data push even if data is empty for some reason
+                currentField = chunkData;
+            }
+            fields.push(currentField);
+            // If the next opcode is a DROP, we've found the last field
+            if (nextOpcode === OP.OP_DROP || nextOpcode === OP.OP_2DROP) {
+                break;
+            }
+        }
+        return {
+            lockingPublicKeys,
+            fields
+        };
+    }
+    /**
+      * Constructs a new instance of the MultiPushDrop class.
+      *
+      * @param {WalletInterface} wallet - The wallet interface used for deriving keys and signing.
+      * @param {string} [originator] - The originator domain for wallet requests.
+      */
+    constructor(wallet, originator) {
+        this.wallet = wallet;
+        this.originator = originator;
+    }
+    /**
+      * Creates a MultiPushDrop locking script.
+      *
+      * @param {number[][]} fields - The arbitrary data fields to include in the script.
+      * @param {[SecurityLevel, string]} protocolID - The protocol ID used for key derivation.
+      * @param {string} keyID - The key ID used for key derivation.
+      * @param {WalletCounterparty[]} counterparties - An array of counterparties ('self' or PubKeyHex) whose derived keys can unlock the script. Must contain at least one.
+      * @returns {Promise<LockingScript>} The generated MultiPushDrop locking script.
+      * @throws {Error} If counterparties array is empty.
+      */
+    async lock(fields, protocolID, keyID, counterparties) {
+        if (!Array.isArray(counterparties) || counterparties.length === 0) {
+            throw new Error('MultiPushDrop requires at least one counterparty.');
+        }
+        const publicKeys = [];
+        for (const counterparty of counterparties) {
+            const { publicKey } = await this.wallet.getPublicKey({
+                protocolID,
+                keyID,
+                counterparty
+            }, this.originator);
+            publicKeys.push(publicKey);
+        }
+        const nPublicKeys = publicKeys.length;
+        const lockPart = [];
+        // Push Public Keys
+        for (const publicKeyHex of publicKeys) {
+            lockPart.push({
+                op: publicKeyHex.length / 2, // Length of compressed pubkey is 33 bytes (66 hex)
+                data: Utils.toArray(publicKeyHex, 'hex')
+            });
+        }
+        // Pick the value on the stack that's right before the locking script.
+        // This should be the index of the key to use in the unlock.
+        lockPart.push(createMinimallyEncodedScriptChunk([nPublicKeys]));
+        lockPart.push({ op: OP.OP_PICK });
+        // Now we use the index to get the actual key.
+        lockPart.push({ op: OP.OP_PICK });
+        // We pull the signature from the bottom of the stack, no matter the number of keys.
+        lockPart.push({ op: OP.OP_DEPTH });
+        lockPart.push({ op: OP.OP_1SUB });
+        lockPart.push({ op: OP.OP_PICK });
+        // We swap the signature and public key so they're in the correct order, then CHECKSIGVERIFY
+        lockPart.push({ op: OP.OP_SWAP });
+        lockPart.push({ op: OP.OP_CHECKSIGVERIFY });
+        // Construct PushDrop Part for fields
+        const pushDropPart = [];
+        for (const field of fields) {
+            pushDropPart.push(createMinimallyEncodedScriptChunk(field));
+        }
+        // Add Drop Opcodes
+        // We need to drop N keys, the number N itself, and M fields after verification succeeds.
+        // We also copied the signature itself so we need to drop that.
+        // Then we push a single true.
+        let itemsToDrop = fields.length + nPublicKeys + 2;
+        while (itemsToDrop > 1) {
+            pushDropPart.push({ op: OP.OP_2DROP });
+            itemsToDrop -= 2;
+        }
+        if (itemsToDrop === 1) {
+            pushDropPart.push({ op: OP.OP_DROP });
+        }
+        // Combine parts and return
+        return new LockingScript([
+            ...lockPart,
+            ...pushDropPart,
+            { op: OP.OP_TRUE }
+        ]);
+    }
+    /**
+       * Creates an unlocking script template for spending a MultiPushDrop output.
+       *
+       * @param {[SecurityLevel, string]} protocolID - The protocol ID used for key derivation.
+       * @param {string} keyID - The key ID used for key derivation.
+       * @param {WalletCounterparty} creator - The identity key of the person who made the locking script. Could come from one of the fields or be passed off chain.
+       * @param {'all' | 'none' | 'single'} [signOutputs='all'] - Specifies which transaction outputs to sign.
+       * @param {boolean} [anyoneCanPay=false] - Specifies if the SIGHASH_ANYONECANPAY flag should be used.
+       * @returns {ScriptTemplateUnlock} An object containing `sign` and `estimateLength` functions.
+       * @throws {Error} If we are not found in the list of keys, or if required signing info (sourceTXID, satoshis, lockingScript) is missing.
+       */
+    unlock(protocolID, keyID, creator, signOutputs = 'all', anyoneCanPay = false) {
+        return {
+            sign: async (tx, inputIndex) => {
+                // Prepare for signing
+                let signatureScope = TransactionSignature.SIGHASH_FORKID;
+                if (signOutputs === 'all')
+                    signatureScope |= TransactionSignature.SIGHASH_ALL;
+                else if (signOutputs === 'none')
+                    signatureScope |= TransactionSignature.SIGHASH_NONE;
+                else if (signOutputs === 'single')
+                    signatureScope |= TransactionSignature.SIGHASH_SINGLE;
+                if (anyoneCanPay)
+                    signatureScope |= TransactionSignature.SIGHASH_ANYONECANPAY;
+                const input = tx.inputs[inputIndex];
+                const currentSourceTXID = input.sourceTXID ?? input.sourceTransaction?.id('hex');
+                const currentSourceSatoshis = input.sourceTransaction?.outputs[input.sourceOutputIndex].satoshis;
+                const currentLockingScript = input.sourceTransaction?.outputs[input.sourceOutputIndex]?.lockingScript;
+                if (typeof currentSourceTXID !== 'string')
+                    throw new Error('Input sourceTXID or sourceTransaction required for signing.');
+                if (currentSourceSatoshis === undefined)
+                    throw new Error('Input sourceSatoshis or sourceTransaction required for signing.');
+                if (currentLockingScript == null)
+                    throw new Error('Input lockingScript or sourceTransaction required for signing.');
+                const otherInputs = tx.inputs.filter((_, index) => index !== inputIndex);
+                const decoded = MultiPushDrop.decode(currentLockingScript);
+                // Find the index of the unlocker's public key
+                let unlockerIndex = -1;
+                const { publicKey: unlockerPubKeyHex } = await this.wallet.getPublicKey({
+                    protocolID,
+                    keyID,
+                    counterparty: creator,
+                    forSelf: true
+                }, this.originator);
+                for (let i = 0; i < decoded.lockingPublicKeys.length; i++) {
+                    if (decoded.lockingPublicKeys[i] === unlockerPubKeyHex) {
+                        unlockerIndex = i;
+                        break;
+                    }
+                }
+                if (unlockerIndex === -1) {
+                    throw new Error(`Unlocker key derived for counterparty (creator) "${creator}" not found in the list of locking keys.`);
+                }
+                unlockerIndex = decoded.lockingPublicKeys.length - 1 - unlockerIndex;
+                // Calculate Preimage
+                const preimage = TransactionSignature.format({
+                    sourceTXID: currentSourceTXID,
+                    sourceOutputIndex: verifyTruthy(input.sourceOutputIndex),
+                    sourceSatoshis: currentSourceSatoshis,
+                    transactionVersion: tx.version,
+                    otherInputs,
+                    inputIndex,
+                    outputs: tx.outputs,
+                    inputSequence: input.sequence ?? 0xffffffff,
+                    subscript: currentLockingScript,
+                    lockTime: tx.lockTime,
+                    scope: signatureScope
+                });
+                // Create Signature
+                const preimageHash = Hash.hash256(preimage);
+                const { signature: bareSignature } = await this.wallet.createSignature({
+                    hashToDirectlySign: preimageHash,
+                    protocolID,
+                    keyID,
+                    counterparty: creator
+                }, this.originator);
+                const signature = Signature.fromDER([...bareSignature]);
+                const txSignature = new TransactionSignature(signature.r, signature.s, signatureScope);
+                const sigForScript = txSignature.toChecksigFormat();
+                // Create Unlocking Script Chunks: <Signature> <Index>
+                const unlockingChunks = [];
+                unlockingChunks.push({ op: sigForScript.length, data: sigForScript });
+                unlockingChunks.push(createMinimallyEncodedScriptChunk([unlockerIndex]));
+                return new UnlockingScript(unlockingChunks);
+            },
+            // Estimate length: Signature (~71-73 bytes) + Index push (1 byte for 0-15, potentially more)
+            estimateLength: async () => {
+                // A conservative estimate, usually 73 + 1 = 74
+                // Could potentially be larger if index > 15, but that's rare.
+                return 74;
+            }
+        };
+    }
+}
+//# sourceMappingURL=MultiPushDrop.js.map

package/dist/esm/src/MultiPushDrop.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MultiPushDrop.js","sourceRoot":"","sources":["../../../src/MultiPushDrop.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,aAAa,EACb,eAAe,EACf,EAAE,EAEF,KAAK,EACL,IAAI,EACJ,oBAAoB,EACpB,SAAS,EAIV,MAAM,UAAU,CAAA;AAEjB,oDAAoD;AACpD,SAAS,YAAY,CAAK,CAAuB,EAAE,GAAY;IAC7D,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,qCAAqC,CAAC,CAAA;IAChG,OAAO,CAAC,CAAA;AACV,CAAC;AAED,yEAAyE;AACzE,MAAM,iCAAiC,GAAG,CACxC,IAAc,EACmB,EAAE;IACnC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,CAAC,EAAE,CAAA,CAAC,OAAO;IAC/C,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;QAAE,OAAO,EAAE,EAAE,EAAE,CAAC,EAAE,CAAA,CAAC,OAAO;IAChE,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE;QAAE,OAAO,EAAE,EAAE,EAAE,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA,CAAC,gBAAgB;IACrG,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI;QAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAA,CAAC,aAAa;IAC5E,IAAI,IAAI,CAAC,MAAM,IAAI,EAAE;QAAE,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,CAAA;IACvD,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG;QAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA,CAAC,eAAe;IACjE,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK;QAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA,CAAC,eAAe;IACnE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAA,CAAC,eAAe;AAC3C,CAAC,CAAA;AAUD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,OAAO,OAAO,aAAa;IAChC,MAAM,CAAiB;IACvB,UAAU,CAAS;IAEnB;;;;;SAKK;IACL,MAAM,CAAC,MAAM,CAAE,MAAqB;QAClC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;QAC5B,IAAI,MAAM,GAAG,CAAC,CAAA;QAEd,kDAAkD;QAClD,MAAM,iBAAiB,GAAgB,EAAE,CAAA;QACzC,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,MAAM,KAAK,EAAE,EAAE,CAAC;YAC1C,MAAM,QAAQ,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,4BAA4B,MAAM,EAAE,CAAC,CAAA;YACnF,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,oBAAoB,MAAM,cAAc,CAAC,CAAA;YACrF,iBAAiB,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;YAC5C,MAAM,EAAE,CAAA;QACV,CAAC;QAED,0CAA0C;QAC1C,mCAAmC;QACnC,MAAM,IAAI,CAAC,CAAA;QAEX,qBAAqB;QACrB,MAAM,MAAM,GAAe,EAAE,CAAA;QAC7B,KAAK,IAAI,CAAC,GAAG,MAAM,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,CAAA;YACpC,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAA,CAAC,kDAAkD;YAEzF,IAAI,YAAY,GAAa,EAAE,CAAA;YAC/B,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACzB,YAAY,GAAG,SAAS,CAAA;YAC1B,CAAC;iBAAM,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,IAAI,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC;gBAC/D,YAAY,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,CAAA;YAC7C,CAAC;iBAAM,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC;gBACpC,YAAY,GAAG,EAAE,CAAA,CAAC,gCAAgC;YACpD,CAAC;iBAAM,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,UAAU,EAAE,CAAC;gBAC1C,YAAY,GAAG,CAAC,IAAI,CAAC,CAAA;YACvB,CAAC;iBAAM,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC;gBACvE,wBAAwB;gBACxB,MAAK;YACP,CAAC;iBAAM,CAAC;gBACN,gEAAgE;gBAChE,YAAY,GAAG,SAAS,CAAA;YAC1B,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;YACzB,2DAA2D;YAC3D,IAAI,UAAU,KAAK,EAAE,CAAC,OAAO,IAAI,UAAU,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC;gBAC5D,MAAK;YACP,CAAC;QACH,CAAC;QAED,OAAO;YACL,iBAAiB;YACjB,MAAM;SACP,CAAA;IACH,CAAC;IAED;;;;;QAKI;IACJ,YAAa,MAAuB,EAAE,UAAmB;QACvD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;IAED;;;;;;;;;QASI;IACJ,KAAK,CAAC,IAAI,CACR,MAAkB,EAClB,UAAmC,EACnC,KAAa,EACb,cAAoC;QAEpC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;QACtE,CAAC;QAED,MAAM,UAAU,GAAa,EAAE,CAAA;QAC/B,KAAK,MAAM,YAAY,IAAI,cAAc,EAAE,CAAC;YAC1C,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;gBACnD,UAAU;gBACV,KAAK;gBACL,YAAY;aACb,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;YACnB,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QAC5B,CAAC;QAED,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAA;QACrC,MAAM,QAAQ,GAA2C,EAAE,CAAA;QAE3D,mBAAmB;QACnB,KAAK,MAAM,YAAY,IAAI,UAAU,EAAE,CAAC;YACtC,QAAQ,CAAC,IAAI,CAAC;gBACZ,EAAE,EAAE,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,mDAAmD;gBAChF,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,KAAK,CAAC;aACzC,CAAC,CAAA;QACJ,CAAC;QAED,sEAAsE;QACtE,4DAA4D;QAC5D,QAAQ,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAA;QAC/D,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,CAAA;QAEjC,8CAA8C;QAC9C,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,CAAA;QAEjC,oFAAoF;QACpF,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;QAClC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,CAAA;QACjC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,CAAA;QAEjC,4FAA4F;QAC5F,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,CAAA;QACjC,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,iBAAiB,EAAE,CAAC,CAAA;QAE3C,qCAAqC;QACrC,MAAM,YAAY,GAA2C,EAAE,CAAA;QAC/D,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,YAAY,CAAC,IAAI,CAAC,iCAAiC,CAAC,KAAK,CAAC,CAAC,CAAA;QAC7D,CAAC;QAED,mBAAmB;QACnB,yFAAyF;QACzF,+DAA+D;QAC/D,8BAA8B;QAC9B,IAAI,WAAW,GAAG,MAAM,CAAC,MAAM,GAAG,WAAW,GAAG,CAAC,CAAA;QACjD,OAAO,WAAW,GAAG,CAAC,EAAE,CAAC;YACvB,YAAY,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;YACtC,WAAW,IAAI,CAAC,CAAA;QAClB,CAAC;QACD,IAAI,WAAW,KAAK,CAAC,EAAE,CAAC;YACtB,YAAY,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE,CAAC,CAAA;QACvC,CAAC;QAED,2BAA2B;QAC3B,OAAO,IAAI,aAAa,CAAC;YACvB,GAAG,QAAQ;YACX,GAAG,YAAY;YACf,EAAE,EAAE,EAAE,EAAE,CAAC,OAAO,EAAE;SACnB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;;;;SAUK;IACL,MAAM,CACJ,UAAmC,EACnC,KAAa,EACb,OAA2B,EAC3B,cAAyC,KAAK,EAC9C,YAAY,GAAG,KAAK;QAEpB,OAAO;YACL,IAAI,EAAE,KAAK,EACT,EAAe,EACf,UAAkB,EACQ,EAAE;gBAC5B,sBAAsB;gBACtB,IAAI,cAAc,GAAG,oBAAoB,CAAC,cAAc,CAAA;gBACxD,IAAI,WAAW,KAAK,KAAK;oBAAE,cAAc,IAAI,oBAAoB,CAAC,WAAW,CAAA;qBACxE,IAAI,WAAW,KAAK,MAAM;oBAAE,cAAc,IAAI,oBAAoB,CAAC,YAAY,CAAA;qBAC/E,IAAI,WAAW,KAAK,QAAQ;oBAAE,cAAc,IAAI,oBAAoB,CAAC,cAAc,CAAA;gBACxF,IAAI,YAAY;oBAAE,cAAc,IAAI,oBAAoB,CAAC,oBAAoB,CAAA;gBAC7E,MAAM,KAAK,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;gBACnC,MAAM,iBAAiB,GAAG,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,iBAAiB,EAAE,EAAE,CAAC,KAAK,CAAC,CAAA;gBAChF,MAAM,qBAAqB,GAAG,KAAK,CAAC,iBAAiB,EAAE,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAA;gBAChG,MAAM,oBAAoB,GAAG,KAAK,CAAC,iBAAiB,EAAE,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,EAAE,aAAa,CAAA;gBACrG,IAAI,OAAO,iBAAiB,KAAK,QAAQ;oBAAE,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAA;gBACzH,IAAI,qBAAqB,KAAK,SAAS;oBAAE,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAA;gBAC3H,IAAI,oBAAoB,IAAI,IAAI;oBAAE,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;gBACnH,MAAM,WAAW,GAAG,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC,CAAA;gBACxE,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAA;gBAE1D,8CAA8C;gBAC9C,IAAI,aAAa,GAAG,CAAC,CAAC,CAAA;gBACtB,MAAM,EAAE,SAAS,EAAE,iBAAiB,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;oBACtE,UAAU;oBACV,KAAK;oBACL,YAAY,EAAE,OAAO;oBACrB,OAAO,EAAE,IAAI;iBACd,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;gBACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC1D,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,KAAK,iBAAiB,EAAE,CAAC;wBACvD,aAAa,GAAG,CAAC,CAAA;wBACjB,MAAK;oBACP,CAAC;gBACH,CAAC;gBACD,IAAI,aAAa,KAAK,CAAC,CAAC,EAAE,CAAC;oBACzB,MAAM,IAAI,KAAK,CAAC,oDAAoD,OAAO,0CAA0C,CAAC,CAAA;gBACxH,CAAC;gBACD,aAAa,GAAG,OAAO,CAAC,iBAAiB,CAAC,MAAM,GAAG,CAAC,GAAG,aAAa,CAAA;gBAEpE,qBAAqB;gBACrB,MAAM,QAAQ,GAAG,oBAAoB,CAAC,MAAM,CAAC;oBAC3C,UAAU,EAAE,iBAAiB;oBAC7B,iBAAiB,EAAE,YAAY,CAAC,KAAK,CAAC,iBAAiB,CAAC;oBACxD,cAAc,EAAE,qBAAqB;oBACrC,kBAAkB,EAAE,EAAE,CAAC,OAAO;oBAC9B,WAAW;oBACX,UAAU;oBACV,OAAO,EAAE,EAAE,CAAC,OAAO;oBACnB,aAAa,EAAE,KAAK,CAAC,QAAQ,IAAI,UAAU;oBAC3C,SAAS,EAAE,oBAAoB;oBAC/B,QAAQ,EAAE,EAAE,CAAC,QAAQ;oBACrB,KAAK,EAAE,cAAc;iBACtB,CAAC,CAAA;gBAEF,mBAAmB;gBACnB,MAAM,YAAY,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;gBAC3C,MAAM,EAAE,SAAS,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;oBACrE,kBAAkB,EAAE,YAAY;oBAChC,UAAU;oBACV,KAAK;oBACL,YAAY,EAAE,OAAO;iBACtB,EAAE,IAAI,CAAC,UAAU,CAAC,CAAA;gBACnB,MAAM,SAAS,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAA;gBACvD,MAAM,WAAW,GAAG,IAAI,oBAAoB,CAAC,SAAS,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,EAAE,cAAc,CAAC,CAAA;gBACtF,MAAM,YAAY,GAAG,WAAW,CAAC,gBAAgB,EAAE,CAAA;gBAEnD,sDAAsD;gBACtD,MAAM,eAAe,GAA2C,EAAE,CAAA;gBAClE,eAAe,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,YAAY,CAAC,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC,CAAA;gBACrE,eAAe,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAA;gBACxE,OAAO,IAAI,eAAe,CAAC,eAAe,CAAC,CAAA;YAC7C,CAAC;YACD,6FAA6F;YAC7F,cAAc,EAAE,KAAK,IAAqB,EAAE;gBAC1C,+CAA+C;gBAC/C,8DAA8D;gBAC9D,OAAO,EAAE,CAAA;YACX,CAAC;SACF,CAAA;IACH,CAAC;CACF"}

package/dist/esm/src/OpReturn.js

@@ -6,12 +6,12 @@ import { OP, LockingScript, Utils } from '@bsv/sdk';
  */
 export default class OpReturn {
     /**
-     * Creates an OpReturn script
-     *
-     * @param {string | string[] | number[]} data The data or array of data to push after OP_RETURN.
-     * @param {('hex' | 'utf8' | 'base64')} enc The data encoding type, defaults to utf8.
-     * @returns {LockingScript} - An OpReturn locking script.
-     */
+       * Creates an OpReturn script
+       *
+       * @param {string | string[] | number[]} data The data or array of data to push after OP_RETURN.
+       * @param {('hex' | 'utf8' | 'base64')} enc The data encoding type, defaults to utf8.
+       * @returns {LockingScript} - An OpReturn locking script.
+       */
     lock(data, enc) {
         const script = [
             { op: OP.OP_FALSE },
@@ -20,7 +20,7 @@ export default class OpReturn {
         if (typeof data === 'string') {
             data = [data];
         }
-        if (data.length && typeof data[0] === 'number') {
+        if ((data.length > 0) && typeof data[0] === 'number') {
             script.push({ op: data.length, data: data });
         }
         else {
@@ -32,16 +32,16 @@ export default class OpReturn {
         return new LockingScript(script);
     }
     /**
-     * Unlock method is not available for OpReturn scripts, throws exception.
-     */
+       * Unlock method is not available for OpReturn scripts, throws exception.
+       */
     unlock() {
         throw new Error('Unlock is not supported for OpReturn scripts');
     }
     /**
- * Decodes an OpReturn script data to utf8
- * @param script The opreturn script
- * @returns An array of UTF8 encoded strings
- */
+   * Decodes an OpReturn script data to utf8
+   * @param script The opreturn script
+   * @returns An array of UTF8 encoded strings
+   */
     static decode(script) {
         const tokens = script.toASM().split(' ').slice(2);
         return tokens.map(token => Utils.toUTF8(Utils.toArray(token, 'hex')));

package/dist/esm/src/OpReturn.js.map

@@ -1 +1 @@
-{"version":3,"file":"OpReturn.js","sourceRoot":"","sources":["../../../src/OpReturn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAA0B,aAAa,EAAgC,KAAK,EAAE,MAAM,UAAU,CAAA;AAEzG;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IACzB;;;;;;OAMG;IACH,IAAI,CAAC,IAAkC,EAAE,GAA+B;QACpE,MAAM,MAAM,GAAsC;YAC9C,EAAE,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE;YACnB,EAAE,EAAE,EAAE,EAAE,CAAC,SAAS,EAAE;SACvB,CAAA;QAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3B,IAAI,GAAG,CAAC,IAAI,CAAC,CAAA;QACjB,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;YAC7C,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAgB,EAAE,CAAC,CAAA;QAC5D,CAAC;aAAM,CAAC;YACJ,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBACvC,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;gBACrC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAA;YAC9C,CAAC;QACL,CAAC;QAED,OAAO,IAAI,aAAa,CAAC,MAAM,CAAC,CAAA;IACpC,CAAC;IAED;;OAEG;IACH,MAAM;QAIF,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;IACnE,CAAC;IAED;;;;GAID;IACC,MAAM,CAAC,MAAM,CAAC,MAAc;QACxB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QACjD,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;IACzE,CAAC;CACJ"}
+{"version":3,"file":"OpReturn.js","sourceRoot":"","sources":["../../../src/OpReturn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAA0B,aAAa,EAAgC,KAAK,EAAE,MAAM,UAAU,CAAA;AAEzG;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAC3B;;;;;;SAMK;IACL,IAAI,CAAE,IAAkC,EAAE,GAA+B;QACvE,MAAM,MAAM,GAA2C;YACrD,EAAE,EAAE,EAAE,EAAE,CAAC,QAAQ,EAAE;YACnB,EAAE,EAAE,EAAE,EAAE,CAAC,SAAS,EAAE;SACrB,CAAA;QAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC7B,IAAI,GAAG,CAAC,IAAI,CAAC,CAAA;QACf,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;YACrD,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,IAAgB,EAAE,CAAC,CAAA;QAC1D,CAAC;aAAM,CAAC;YACN,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBACzC,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;gBACrC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAA;YAC5C,CAAC;QACH,CAAC;QAED,OAAO,IAAI,aAAa,CAAC,MAAM,CAAC,CAAA;IAClC,CAAC;IAED;;SAEK;IACL,MAAM;QAIJ,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;IACjE,CAAC;IAED;;;;KAIC;IACD,MAAM,CAAC,MAAM,CAAE,MAAc;QAC3B,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QACjD,OAAO,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;IACvE,CAAC;CACF"}