@1sat/templates 0.0.1

package/dist/lock/lock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock.d.ts","sourceRoot":"","sources":["../../src/lock/lock.ts"],"names":[],"mappings":"AAIA,OAAO,EAGN,KAAK,UAAU,EACf,MAAM,EACN,KAAK,WAAW,EAEhB,KAAK,eAAe,EAEpB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,MAAM,UAAU,CAAA;AAEjB;;GAEG;AACH,eAAO,MAAM,WAAW,OAAwC,CAAA;AAEhE;;GAEG;AACH,eAAO,MAAM,WAAW,OAAwC,CAAA;AAEhE;;GAEG;AACH,MAAM,WAAW,QAAQ;IACxB,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAA;IACf,iEAAiE;IACjE,KAAK,EAAE,MAAM,CAAA;CACb;AA0BD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,OAAO,OAAO,IAAI;IACxB;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,UAAO,GAAG,QAAQ,GAAG,IAAI;IAoD9D;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAOtC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;IASnD;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,CACZ,UAAU,EAAE,UAAU,EACtB,WAAW,GAAE,KAAK,GAAG,MAAM,GAAG,QAAgB,EAC9C,YAAY,UAAQ,EACpB,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,GACpB;QACF,IAAI,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;QACvE,cAAc,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;KACxE;IA2ED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,gBAAgB,CACtB,MAAM,EAAE,eAAe,EACvB,UAAU,EAAE,cAAc,EAC1B,KAAK,EAAE,MAAM,EACb,YAAY,SAAS,EACrB,WAAW,GAAE,KAAK,GAAG,MAAM,GAAG,QAAgB,EAC9C,YAAY,UAAQ,GAClB;QACF,IAAI,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;QACvE,cAAc,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;KACxE;CAsFD"}

package/dist/lock/lock.js

@@ -0,0 +1,283 @@
+import { LOCK_PREFIX as LOCK_PREFIX_HEX, LOCK_SUFFIX as LOCK_SUFFIX_HEX, } from '@1sat/types';
+import { Hash, P2PKH, Script, TransactionSignature, Utils, } from '@bsv/sdk';
+/**
+ * Lock PREFIX as number array - sCrypt contract prefix shared with OrdLock template
+ */
+export const LOCK_PREFIX = Utils.toArray(LOCK_PREFIX_HEX, 'hex');
+/**
+ * Lock SUFFIX as number array - time-lock contract validation script
+ */
+export const LOCK_SUFFIX = Utils.toArray(LOCK_SUFFIX_HEX, 'hex');
+/**
+ * Finds the index of a subarray within an array
+ */
+function indexOf(arr, subArr, fromIndex = 0) {
+    for (let i = fromIndex; i <= arr.length - subArr.length; i++) {
+        let found = true;
+        for (let j = 0; j < subArr.length; j++) {
+            if (arr[i + j] !== subArr[j]) {
+                found = false;
+                break;
+            }
+        }
+        if (found)
+            return i;
+    }
+    return -1;
+}
+/**
+ * Checks if an array contains a subarray
+ */
+function contains(arr, subArr, fromIndex = 0) {
+    return indexOf(arr, subArr, fromIndex) !== -1;
+}
+/**
+ * Lock - Time-lock template for locking outputs until a specific block height or timestamp
+ *
+ * The Lock template enables creating outputs that can only be spent after a certain
+ * block height or Unix timestamp has been reached.
+ *
+ * @example
+ * ```typescript
+ * // Decode a Lock from a script
+ * const lock = Lock.decode(script);
+ * if (lock) {
+ *   console.log(`Address: ${lock.address}`);
+ *   console.log(`Locked until: ${lock.until}`);
+ * }
+ * ```
+ */
+export default class Lock {
+    /**
+     * Decodes a Lock from a script
+     *
+     * @param script - The script to decode
+     * @param mainnet - Whether to use mainnet address prefix (default: true)
+     * @returns Decoded Lock data or null if not found/invalid
+     */
+    static decode(script, mainnet = true) {
+        try {
+            const scriptBinary = script.toBinary();
+            // Find PREFIX
+            const prefixIndex = indexOf(scriptBinary, LOCK_PREFIX);
+            if (prefixIndex === -1)
+                return null;
+            // Check that SUFFIX exists somewhere after PREFIX
+            if (!contains(scriptBinary, LOCK_SUFFIX, prefixIndex))
+                return null;
+            // Extract data starting after PREFIX
+            const pos = prefixIndex + LOCK_PREFIX.length;
+            // Parse the data as script chunks
+            const remainingBytes = scriptBinary.slice(pos);
+            const dataScript = Script.fromBinary(remainingBytes);
+            const chunks = dataScript.chunks;
+            if (chunks.length < 2)
+                return null;
+            // Chunk 0: address PKHash (20 bytes)
+            const addressChunk = chunks[0];
+            if (addressChunk?.data == null || addressChunk.data.length !== 20)
+                return null;
+            // Chunk 1: until value (variable length, little-endian)
+            const untilChunk = chunks[1];
+            if (untilChunk?.data == null)
+                return null;
+            // Read little-endian uint32 (pad to 4 bytes if needed)
+            const untilData = untilChunk.data;
+            const padded = new Uint8Array(4);
+            for (let i = 0; i < Math.min(untilData.length, 4); i++) {
+                padded[i] = untilData[i];
+            }
+            const until = padded[0] | (padded[1] << 8) | (padded[2] << 16) | (padded[3] << 24);
+            // Convert PKHash to address
+            const addressPrefix = mainnet ? [0x00] : [0x6f];
+            const address = Utils.toBase58Check(addressChunk.data, addressPrefix);
+            return {
+                address,
+                until: until >>> 0, // Ensure unsigned
+            };
+        }
+        catch {
+            return null;
+        }
+    }
+    /**
+     * Checks if a script contains a Lock pattern
+     *
+     * @param script - The script to check
+     * @returns true if the script contains Lock pattern
+     */
+    static isLock(script) {
+        const scriptBinary = script.toBinary();
+        const prefixIndex = indexOf(scriptBinary, LOCK_PREFIX);
+        if (prefixIndex === -1)
+            return false;
+        return contains(scriptBinary, LOCK_SUFFIX, prefixIndex);
+    }
+    /**
+     * Creates a Lock locking script
+     *
+     * @param address - The address whose PKH is embedded in the lock
+     * @param until - Block height until which the output is locked
+     * @returns The locking script
+     */
+    static lock(address, until) {
+        const pkh = Utils.fromBase58Check(address).data;
+        return new Script()
+            .writeScript(Script.fromBinary(LOCK_PREFIX))
+            .writeBin(pkh)
+            .writeNumber(until)
+            .writeScript(Script.fromBinary(LOCK_SUFFIX));
+    }
+    /**
+     * Creates an unlocking script template for spending a Lock output.
+     *
+     * @param privateKey - The private key corresponding to the locked address
+     * @param sighashType - Sighash type ('all', 'none', 'single')
+     * @param anyoneCanPay - Whether SIGHASH_ANYONECANPAY is set
+     * @param sourceSatoshis - Satoshis of the source output (optional if sourceTransaction is on the input)
+     * @param lockingScript - Locking script of the source output (optional if sourceTransaction is on the input)
+     * @returns Object with sign and estimateLength methods
+     */
+    static unlock(privateKey, sighashType = 'all', anyoneCanPay = false, sourceSatoshis, lockingScript) {
+        const unlock = {
+            sign: async (tx, inputIndex) => {
+                let signatureScope = TransactionSignature.SIGHASH_FORKID;
+                if (sighashType === 'all') {
+                    signatureScope |= TransactionSignature.SIGHASH_ALL;
+                }
+                if (sighashType === 'none') {
+                    signatureScope |= TransactionSignature.SIGHASH_NONE;
+                }
+                if (sighashType === '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,
+                    outputs: tx.outputs,
+                    inputIndex,
+                    subscript: lockingScript,
+                    inputSequence: input.sequence === undefined ? 0xffffffff : input.sequence,
+                    lockTime: tx.lockTime,
+                    scope: signatureScope,
+                });
+                const p2pkh = new P2PKH().unlock(privateKey, sighashType, anyoneCanPay, sourceSatoshis, lockingScript);
+                return (await p2pkh.sign(tx, inputIndex)).writeBin(preimage);
+            },
+            estimateLength: async (tx, inputIndex) => {
+                return (await unlock.sign(tx, inputIndex)).toBinary().length;
+            },
+        };
+        return unlock;
+    }
+    /**
+     * Creates an unlocking script template using a BRC-100 wallet for signing.
+     *
+     * Uses wallet.createSignature and wallet.getPublicKey instead of a raw PrivateKey,
+     * enabling key derivation via protocolID/keyID.
+     *
+     * @param wallet - A BRC-100 WalletInterface with createSignature and getPublicKey
+     * @param protocolID - The protocol ID for key derivation
+     * @param keyID - The key ID for key derivation
+     * @param counterparty - The counterparty for key derivation (default: 'self')
+     * @param sighashType - Sighash type ('all', 'none', 'single')
+     * @param anyoneCanPay - Whether SIGHASH_ANYONECANPAY is set
+     * @returns Object with sign and estimateLength methods
+     */
+    static unlockWithWallet(wallet, protocolID, keyID, counterparty = 'self', sighashType = 'all', anyoneCanPay = false) {
+        const unlock = {
+            sign: async (tx, inputIndex) => {
+                let signatureScope = TransactionSignature.SIGHASH_FORKID;
+                if (sighashType === 'all') {
+                    signatureScope |= TransactionSignature.SIGHASH_ALL;
+                }
+                if (sighashType === 'none') {
+                    signatureScope |= TransactionSignature.SIGHASH_NONE;
+                }
+                if (sighashType === '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.');
+                }
+                const sourceSatoshis = input.sourceTransaction?.outputs[input.sourceOutputIndex].satoshis;
+                if (!sourceSatoshis) {
+                    throw new Error('The sourceSatoshis or input sourceTransaction is required for transaction signing.');
+                }
+                const 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,
+                    outputs: tx.outputs,
+                    inputIndex,
+                    subscript: lockingScript,
+                    inputSequence: input.sequence === undefined ? 0xffffffff : input.sequence,
+                    lockTime: tx.lockTime,
+                    scope: signatureScope,
+                });
+                const sighash = Hash.sha256(Hash.sha256(preimage));
+                const { signature } = await wallet.createSignature({
+                    protocolID,
+                    keyID,
+                    counterparty,
+                    hashToDirectlySign: Array.from(sighash),
+                });
+                const { publicKey } = await wallet.getPublicKey({
+                    protocolID,
+                    keyID,
+                    counterparty,
+                    forSelf: true,
+                });
+                return new Script()
+                    .writeBin(signature)
+                    .writeBin(Utils.toArray(publicKey, 'hex'))
+                    .writeBin(Array.from(preimage));
+            },
+            estimateLength: async (tx, inputIndex) => {
+                return (await unlock.sign(tx, inputIndex)).toBinary().length;
+            },
+        };
+        return unlock;
+    }
+}
+//# sourceMappingURL=lock.js.map

package/dist/lock/lock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lock.js","sourceRoot":"","sources":["../../src/lock/lock.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,WAAW,IAAI,eAAe,EAC9B,WAAW,IAAI,eAAe,GAC9B,MAAM,aAAa,CAAA;AACpB,OAAO,EACN,IAAI,EACJ,KAAK,EAEL,MAAM,EAEN,oBAAoB,EAEpB,KAAK,GAGL,MAAM,UAAU,CAAA;AAEjB;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,KAAK,CAAC,CAAA;AAEhE;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,KAAK,CAAC,CAAA;AAYhE;;GAEG;AACH,SAAS,OAAO,CAAC,GAAa,EAAE,MAAgB,EAAE,SAAS,GAAG,CAAC;IAC9D,KAAK,IAAI,CAAC,GAAG,SAAS,EAAE,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC9D,IAAI,KAAK,GAAG,IAAI,CAAA;QAChB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACxC,IAAI,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC9B,KAAK,GAAG,KAAK,CAAA;gBACb,MAAK;YACN,CAAC;QACF,CAAC;QACD,IAAI,KAAK;YAAE,OAAO,CAAC,CAAA;IACpB,CAAC;IACD,OAAO,CAAC,CAAC,CAAA;AACV,CAAC;AAED;;GAEG;AACH,SAAS,QAAQ,CAAC,GAAa,EAAE,MAAgB,EAAE,SAAS,GAAG,CAAC;IAC/D,OAAO,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAA;AAC9C,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,OAAO,OAAO,IAAI;IACxB;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,MAAc,EAAE,OAAO,GAAG,IAAI;QAC3C,IAAI,CAAC;YACJ,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAA;YAEtC,cAAc;YACd,MAAM,WAAW,GAAG,OAAO,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;YACtD,IAAI,WAAW,KAAK,CAAC,CAAC;gBAAE,OAAO,IAAI,CAAA;YAEnC,kDAAkD;YAClD,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,WAAW,EAAE,WAAW,CAAC;gBAAE,OAAO,IAAI,CAAA;YAElE,qCAAqC;YACrC,MAAM,GAAG,GAAG,WAAW,GAAG,WAAW,CAAC,MAAM,CAAA;YAE5C,kCAAkC;YAClC,MAAM,cAAc,GAAG,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAC9C,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,CAAA;YACpD,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;YAEhC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;gBAAE,OAAO,IAAI,CAAA;YAElC,qCAAqC;YACrC,MAAM,YAAY,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;YAC9B,IAAI,YAAY,EAAE,IAAI,IAAI,IAAI,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,KAAK,EAAE;gBAChE,OAAO,IAAI,CAAA;YAEZ,wDAAwD;YACxD,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;YAC5B,IAAI,UAAU,EAAE,IAAI,IAAI,IAAI;gBAAE,OAAO,IAAI,CAAA;YAEzC,uDAAuD;YACvD,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAA;YACjC,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;YAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBACxD,MAAM,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;YACzB,CAAC;YACD,MAAM,KAAK,GACV,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAA;YAErE,4BAA4B;YAC5B,MAAM,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;YAC/C,MAAM,OAAO,GAAG,KAAK,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,EAAE,aAAa,CAAC,CAAA;YAErE,OAAO;gBACN,OAAO;gBACP,KAAK,EAAE,KAAK,KAAK,CAAC,EAAE,kBAAkB;aACtC,CAAA;QACF,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,IAAI,CAAA;QACZ,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,MAAc;QAC3B,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAA;QACtC,MAAM,WAAW,GAAG,OAAO,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;QACtD,IAAI,WAAW,KAAK,CAAC,CAAC;YAAE,OAAO,KAAK,CAAA;QACpC,OAAO,QAAQ,CAAC,YAAY,EAAE,WAAW,EAAE,WAAW,CAAC,CAAA;IACxD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,OAAe,EAAE,KAAa;QACzC,MAAM,GAAG,GAAG,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,IAAgB,CAAA;QAC3D,OAAO,IAAI,MAAM,EAAE;aACjB,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;aAC3C,QAAQ,CAAC,GAAG,CAAC;aACb,WAAW,CAAC,KAAK,CAAC;aAClB,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAA;IAC9C,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,MAAM,CACZ,UAAsB,EACtB,cAAyC,KAAK,EAC9C,YAAY,GAAG,KAAK,EACpB,cAAuB,EACvB,aAAsB;QAKtB,MAAM,MAAM,GAAG;YACd,IAAI,EAAE,KAAK,EAAE,EAAe,EAAE,UAAkB,EAAE,EAAE;gBACnD,IAAI,cAAc,GAAG,oBAAoB,CAAC,cAAc,CAAA;gBACxD,IAAI,WAAW,KAAK,KAAK,EAAE,CAAC;oBAC3B,cAAc,IAAI,oBAAoB,CAAC,WAAW,CAAA;gBACnD,CAAC;gBACD,IAAI,WAAW,KAAK,MAAM,EAAE,CAAC;oBAC5B,cAAc,IAAI,oBAAoB,CAAC,YAAY,CAAA;gBACpD,CAAC;gBACD,IAAI,WAAW,KAAK,QAAQ,EAAE,CAAC;oBAC9B,cAAc,IAAI,oBAAoB,CAAC,cAAc,CAAA;gBACtD,CAAC;gBACD,IAAI,YAAY,EAAE,CAAC;oBAClB,cAAc,IAAI,oBAAoB,CAAC,oBAAoB,CAAA;gBAC5D,CAAC;gBACD,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;oBAClC,CAAC,CAAC,KAAK,CAAC,UAAU;oBAClB,CAAC,CAAC,KAAK,CAAC,iBAAiB,EAAE,EAAE,CAAC,KAAK,CAAC,CAAA;gBACrC,IAAI,CAAC,UAAU,EAAE,CAAC;oBACjB,MAAM,IAAI,KAAK,CACd,gFAAgF,CAChF,CAAA;gBACF,CAAC;gBACD,cAAc;oBACb,KAAK,CAAC,iBAAiB,EAAE,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAA;gBACnE,IAAI,CAAC,cAAc,EAAE,CAAC;oBACrB,MAAM,IAAI,KAAK,CACd,oFAAoF,CACpF,CAAA;gBACF,CAAC;gBACD,aAAa;oBACZ,KAAK,CAAC,iBAAiB,EAAE,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC;yBACvD,aAAa,CAAA;gBAChB,IAAI,CAAC,aAAa,EAAE,CAAC;oBACpB,MAAM,IAAI,KAAK,CACd,mFAAmF,CACnF,CAAA;gBACF,CAAC;gBAED,MAAM,QAAQ,GAAG,oBAAoB,CAAC,MAAM,CAAC;oBAC5C,UAAU;oBACV,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;oBAC1C,cAAc;oBACd,kBAAkB,EAAE,EAAE,CAAC,OAAO;oBAC9B,WAAW;oBACX,OAAO,EAAE,EAAE,CAAC,OAAO;oBACnB,UAAU;oBACV,SAAS,EAAE,aAAa;oBACxB,aAAa,EACZ,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ;oBAC3D,QAAQ,EAAE,EAAE,CAAC,QAAQ;oBACrB,KAAK,EAAE,cAAc;iBACrB,CAAC,CAAA;gBAEF,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC,MAAM,CAC/B,UAAU,EACV,WAAW,EACX,YAAY,EACZ,cAAc,EACd,aAAa,CACb,CAAA;gBACD,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;YAC7D,CAAC;YACD,cAAc,EAAE,KAAK,EAAE,EAAe,EAAE,UAAkB,EAAE,EAAE;gBAC7D,OAAO,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAA;YAC7D,CAAC;SACD,CAAA;QACD,OAAO,MAAM,CAAA;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,gBAAgB,CACtB,MAAuB,EACvB,UAA0B,EAC1B,KAAa,EACb,YAAY,GAAG,MAAM,EACrB,cAAyC,KAAK,EAC9C,YAAY,GAAG,KAAK;QAKpB,MAAM,MAAM,GAAG;YACd,IAAI,EAAE,KAAK,EAAE,EAAe,EAAE,UAAkB,EAAE,EAAE;gBACnD,IAAI,cAAc,GAAG,oBAAoB,CAAC,cAAc,CAAA;gBACxD,IAAI,WAAW,KAAK,KAAK,EAAE,CAAC;oBAC3B,cAAc,IAAI,oBAAoB,CAAC,WAAW,CAAA;gBACnD,CAAC;gBACD,IAAI,WAAW,KAAK,MAAM,EAAE,CAAC;oBAC5B,cAAc,IAAI,oBAAoB,CAAC,YAAY,CAAA;gBACpD,CAAC;gBACD,IAAI,WAAW,KAAK,QAAQ,EAAE,CAAC;oBAC9B,cAAc,IAAI,oBAAoB,CAAC,cAAc,CAAA;gBACtD,CAAC;gBACD,IAAI,YAAY,EAAE,CAAC;oBAClB,cAAc,IAAI,oBAAoB,CAAC,oBAAoB,CAAA;gBAC5D,CAAC;gBACD,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;oBAClC,CAAC,CAAC,KAAK,CAAC,UAAU;oBAClB,CAAC,CAAC,KAAK,CAAC,iBAAiB,EAAE,EAAE,CAAC,KAAK,CAAC,CAAA;gBACrC,IAAI,CAAC,UAAU,EAAE,CAAC;oBACjB,MAAM,IAAI,KAAK,CACd,gFAAgF,CAChF,CAAA;gBACF,CAAC;gBACD,MAAM,cAAc,GACnB,KAAK,CAAC,iBAAiB,EAAE,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC,QAAQ,CAAA;gBACnE,IAAI,CAAC,cAAc,EAAE,CAAC;oBACrB,MAAM,IAAI,KAAK,CACd,oFAAoF,CACpF,CAAA;gBACF,CAAC;gBACD,MAAM,aAAa,GAClB,KAAK,CAAC,iBAAiB,EAAE,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC;qBACvD,aAAa,CAAA;gBAChB,IAAI,CAAC,aAAa,EAAE,CAAC;oBACpB,MAAM,IAAI,KAAK,CACd,mFAAmF,CACnF,CAAA;gBACF,CAAC;gBAED,MAAM,QAAQ,GAAG,oBAAoB,CAAC,MAAM,CAAC;oBAC5C,UAAU;oBACV,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;oBAC1C,cAAc;oBACd,kBAAkB,EAAE,EAAE,CAAC,OAAO;oBAC9B,WAAW;oBACX,OAAO,EAAE,EAAE,CAAC,OAAO;oBACnB,UAAU;oBACV,SAAS,EAAE,aAAa;oBACxB,aAAa,EACZ,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ;oBAC3D,QAAQ,EAAE,EAAE,CAAC,QAAQ;oBACrB,KAAK,EAAE,cAAc;iBACrB,CAAC,CAAA;gBAEF,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAA;gBAElD,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,MAAM,CAAC,eAAe,CAAC;oBAClD,UAAU;oBACV,KAAK;oBACL,YAAY;oBACZ,kBAAkB,EAAE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;iBACvC,CAAC,CAAA;gBAEF,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC;oBAC/C,UAAU;oBACV,KAAK;oBACL,YAAY;oBACZ,OAAO,EAAE,IAAI;iBACb,CAAC,CAAA;gBAEF,OAAO,IAAI,MAAM,EAAE;qBACjB,QAAQ,CAAC,SAAS,CAAC;qBACnB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;qBACzC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAA;YACjC,CAAC;YACD,cAAc,EAAE,KAAK,EAAE,EAAe,EAAE,UAAkB,EAAE,EAAE;gBAC7D,OAAO,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAA;YAC7D,CAAC;SACD,CAAA;QACD,OAAO,MAAM,CAAA;IACd,CAAC;CACD"}

package/dist/ordlock/ordlock.d.ts

@@ -0,0 +1,126 @@
+import { type PrivateKey, Script, type Transaction, UnlockingScript, type WalletInterface, type WalletProtocol } from '@bsv/sdk';
+/**
+ * OrdLock PREFIX as number array - sCrypt contract prefix shared with Lock template
+ */
+export declare const ORDLOCK_PREFIX: any[];
+/**
+ * OrdLock SUFFIX as number array - contract validation script
+ */
+export declare const ORDLOCK_SUFFIX: any[];
+/**
+ * OrdLock decoded data structure
+ */
+export interface OrdLockData {
+    /** Seller's address (base58check encoded) */
+    seller: string;
+    /** Listing price in satoshis */
+    price: bigint;
+    /** Raw payout output data */
+    payout: number[];
+}
+/**
+ * OrdLock - Ordinal Lock template for marketplace listings
+ *
+ * OrdLock enables trustless ordinal/NFT sales by locking an output with a
+ * contract that can only be unlocked by providing payment to a specified address.
+ *
+ * @example
+ * ```typescript
+ * // Decode an OrdLock from a script
+ * const ordlock = OrdLock.decode(script);
+ * if (ordlock) {
+ *   console.log(`Seller: ${ordlock.seller}`);
+ *   console.log(`Price: ${ordlock.price} satoshis`);
+ * }
+ * ```
+ */
+export default class OrdLock {
+    /**
+     * Decodes an OrdLock from a script
+     *
+     * @param script - The script to decode
+     * @param mainnet - Whether to use mainnet address prefix (default: true)
+     * @returns Decoded OrdLock data or null if not found/invalid
+     */
+    static decode(script: Script, mainnet?: boolean): OrdLockData | null;
+    /**
+     * Checks if a script contains an OrdLock pattern
+     *
+     * @param script - The script to check
+     * @returns true if the script contains OrdLock pattern
+     */
+    static isOrdLock(script: Script): boolean;
+    /**
+     * Checks if an unlocking script indicates a purchase (vs cancellation)
+     *
+     * @param unlockingScript - The unlocking script to check
+     * @returns true if the unlock represents a purchase
+     */
+    static isPurchase(unlockingScript: Script): boolean;
+    /**
+     * Creates an OrdLock locking script for listing an ordinal
+     *
+     * @param cancelAddress - Address that can cancel the listing
+     * @param payAddress - Address that receives payment on purchase
+     * @param price - Listing price in satoshis
+     * @returns The OrdLock locking script
+     */
+    static lock(cancelAddress: string, payAddress: string, price: number): Script;
+    /**
+     * Builds a serialized transaction output (satoshis + script)
+     *
+     * @param satoshis - Output value
+     * @param script - Locking script as binary
+     * @returns Serialized output bytes
+     */
+    static buildOutput(satoshis: number, script: number[]): number[];
+    /**
+     * Creates an unlocking script for cancelling a listing
+     *
+     * @param privateKey - Private key for the cancel address
+     * @param signOutputs - Signature scope for outputs
+     * @param anyoneCanPay - Whether to use ANYONECANPAY
+     * @param sourceSatoshis - Input satoshis (optional if sourceTransaction provided)
+     * @param lockingScript - Input locking script (optional if sourceTransaction provided)
+     * @returns Unlock template with sign and estimateLength methods
+     */
+    static cancelListing(privateKey: PrivateKey, signOutputs?: 'all' | 'none' | 'single', anyoneCanPay?: boolean, sourceSatoshis?: number, lockingScript?: Script): {
+        sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
+        estimateLength: () => Promise<number>;
+    };
+    /**
+     * Creates an unlocking script for cancelling a listing using a BRC-100 wallet.
+     *
+     * Uses wallet.createSignature and wallet.getPublicKey instead of a raw PrivateKey,
+     * enabling key derivation via protocolID/keyID.
+     *
+     * @param wallet - A BRC-100 WalletInterface
+     * @param protocolID - The protocol ID for key derivation
+     * @param keyID - The key ID for key derivation
+     * @param counterparty - The counterparty for key derivation (default: 'self')
+     * @returns Unlock template with sign and estimateLength methods
+     */
+    static cancelWithWallet(wallet: WalletInterface, protocolID: WalletProtocol, keyID: string, counterparty?: string): {
+        sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
+        estimateLength: () => Promise<number>;
+    };
+    /**
+     * Creates an unlocking script for purchasing a listing
+     *
+     * The purchase path requires:
+     * - Output 0: The ordinal going to buyer
+     * - Output 1: Payment to seller (must match payout in OrdLock)
+     * - Output 2+: Additional outputs (marketplace fees, etc.)
+     *
+     * No signature is required - the contract validates the outputs match.
+     *
+     * @param sourceSatoshis - Input satoshis (optional if sourceTransaction provided)
+     * @param lockingScript - Input locking script (optional if sourceTransaction provided)
+     * @returns Unlock template with sign and estimateLength methods
+     */
+    static purchaseListing(sourceSatoshis?: number, lockingScript?: Script): {
+        sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
+        estimateLength: (tx: Transaction, inputIndex: number) => Promise<number>;
+    };
+}
+//# sourceMappingURL=ordlock.d.ts.map

package/dist/ordlock/ordlock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ordlock.d.ts","sourceRoot":"","sources":["../../src/ordlock/ordlock.ts"],"names":[],"mappings":"AACA,OAAO,EAMN,KAAK,UAAU,EACf,MAAM,EACN,KAAK,WAAW,EAEhB,eAAe,EAEf,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,MAAM,UAAU,CAAA;AAEjB;;GAEG;AACH,eAAO,MAAM,cAAc,OAAwC,CAAA;AAEnE;;GAEG;AACH,eAAO,MAAM,cAAc,OAAwC,CAAA;AAEnE;;GAEG;AACH,MAAM,WAAW,WAAW;IAC3B,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,6BAA6B;IAC7B,MAAM,EAAE,MAAM,EAAE,CAAA;CAChB;AAmBD;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,OAAO,OAAO,OAAO;IAC3B;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,UAAO,GAAG,WAAW,GAAG,IAAI;IA6DjE;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAYzC;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO;IAKnD;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACV,aAAa,EAAE,MAAM,EACrB,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GACX,MAAM;IAWT;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,EAAE;IAQhE;;;;;;;;;OASG;IACH,MAAM,CAAC,aAAa,CACnB,UAAU,EAAE,UAAU,EACtB,WAAW,GAAE,KAAK,GAAG,MAAM,GAAG,QAAgB,EAC9C,YAAY,UAAQ,EACpB,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,GACpB;QACF,IAAI,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;QACvE,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;KACrC;IAkBD;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,gBAAgB,CACtB,MAAM,EAAE,eAAe,EACvB,UAAU,EAAE,cAAc,EAC1B,KAAK,EAAE,MAAM,EACb,YAAY,SAAS,GACnB;QACF,IAAI,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;QACvE,cAAc,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;KACrC;IA4ED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,eAAe,CACrB,cAAc,CAAC,EAAE,MAAM,EACvB,aAAa,CAAC,EAAE,MAAM,GACpB;QACF,IAAI,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;QACvE,cAAc,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;KACxE;CAoED"}