@1sat/templates 0.0.1

package/dist/ordlock/ordlock.js

@@ -0,0 +1,316 @@
+import { ORD_LOCK_PREFIX, ORD_LOCK_SUFFIX } from '@1sat/types';
+import { BigNumber, Hash, OP, P2PKH, Script, TransactionSignature, UnlockingScript, Utils, } from '@bsv/sdk';
+/**
+ * OrdLock PREFIX as number array - sCrypt contract prefix shared with Lock template
+ */
+export const ORDLOCK_PREFIX = Utils.toArray(ORD_LOCK_PREFIX, 'hex');
+/**
+ * OrdLock SUFFIX as number array - contract validation script
+ */
+export const ORDLOCK_SUFFIX = Utils.toArray(ORD_LOCK_SUFFIX, '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;
+}
+/**
+ * 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, mainnet = true) {
+        try {
+            const scriptBinary = script.toBinary();
+            // Find PREFIX
+            const prefixIndex = indexOf(scriptBinary, ORDLOCK_PREFIX);
+            if (prefixIndex === -1)
+                return null;
+            // Find SUFFIX after PREFIX
+            const suffixIndex = indexOf(scriptBinary, ORDLOCK_SUFFIX, prefixIndex + ORDLOCK_PREFIX.length);
+            if (suffixIndex === -1)
+                return null;
+            // Extract data between PREFIX and SUFFIX
+            const dataBytes = scriptBinary.slice(prefixIndex + ORDLOCK_PREFIX.length, suffixIndex);
+            if (dataBytes.length === 0)
+                return null;
+            // Parse the data as script chunks
+            const dataScript = Script.fromBinary(dataBytes);
+            const chunks = dataScript.chunks;
+            if (chunks.length < 2)
+                return null;
+            // Chunk 0: seller PKHash (20 bytes)
+            const sellerChunk = chunks[0];
+            if (sellerChunk?.data == null || sellerChunk.data.length !== 20)
+                return null;
+            // Chunk 1: payout TransactionOutput (satoshis + locking script)
+            const payoutChunk = chunks[1];
+            if (payoutChunk?.data == null || payoutChunk.data.length < 9)
+                return null;
+            const payoutData = payoutChunk.data;
+            // Parse TransactionOutput: 8-byte LE satoshis + varint script length + script
+            // Read 8-byte little-endian satoshis
+            let price = BigInt(0);
+            for (let i = 0; i < 8; i++) {
+                price |= BigInt(payoutData[i]) << BigInt(i * 8);
+            }
+            // Convert PKHash to address
+            const addressPrefix = mainnet ? [0x00] : [0x6f];
+            const seller = Utils.toBase58Check(sellerChunk.data, addressPrefix);
+            return {
+                seller,
+                price,
+                payout: Array.from(payoutData),
+            };
+        }
+        catch {
+            return 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) {
+        const scriptBinary = script.toBinary();
+        const prefixIndex = indexOf(scriptBinary, ORDLOCK_PREFIX);
+        if (prefixIndex === -1)
+            return false;
+        const suffixIndex = indexOf(scriptBinary, ORDLOCK_SUFFIX, prefixIndex + ORDLOCK_PREFIX.length);
+        return suffixIndex !== -1;
+    }
+    /**
+     * 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) {
+        const scriptBinary = unlockingScript.toBinary();
+        return indexOf(scriptBinary, ORDLOCK_SUFFIX) !== -1;
+    }
+    /**
+     * 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, payAddress, price) {
+        const cancelPkh = Utils.fromBase58Check(cancelAddress).data;
+        const payPkh = Utils.fromBase58Check(payAddress).data;
+        return new Script()
+            .writeScript(Script.fromBinary(ORDLOCK_PREFIX))
+            .writeBin(cancelPkh)
+            .writeBin(OrdLock.buildOutput(price, new P2PKH().lock(payPkh).toBinary()))
+            .writeScript(Script.fromBinary(ORDLOCK_SUFFIX));
+    }
+    /**
+     * Builds a serialized transaction output (satoshis + script)
+     *
+     * @param satoshis - Output value
+     * @param script - Locking script as binary
+     * @returns Serialized output bytes
+     */
+    static buildOutput(satoshis, script) {
+        const writer = new Utils.Writer();
+        writer.writeUInt64LEBn(new BigNumber(satoshis));
+        writer.writeVarIntNum(script.length);
+        writer.write(script);
+        return writer.toArray();
+    }
+    /**
+     * 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, signOutputs = 'all', anyoneCanPay = false, sourceSatoshis, lockingScript) {
+        const p2pkh = new P2PKH().unlock(privateKey, signOutputs, anyoneCanPay, sourceSatoshis, lockingScript);
+        return {
+            sign: async (tx, inputIndex) => {
+                return (await p2pkh.sign(tx, inputIndex)).writeOpCode(OP.OP_1);
+            },
+            estimateLength: async () => {
+                return 107;
+            },
+        };
+    }
+    /**
+     * 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, protocolID, keyID, counterparty = 'self') {
+        return {
+            sign: async (tx, inputIndex) => {
+                const signatureScope = TransactionSignature.SIGHASH_ALL |
+                    TransactionSignature.SIGHASH_ANYONECANPAY |
+                    TransactionSignature.SIGHASH_FORKID;
+                const input = tx.inputs[inputIndex];
+                const sourceTXID = input.sourceTXID ?? input.sourceTransaction?.id('hex');
+                if (!sourceTXID) {
+                    throw new Error('The input sourceTXID or sourceTransaction is required for signing.');
+                }
+                const sourceSatoshis = input.sourceTransaction?.outputs[input.sourceOutputIndex].satoshis;
+                if (!sourceSatoshis) {
+                    throw new Error('The sourceSatoshis or input sourceTransaction is required for signing.');
+                }
+                const lockingScript = input.sourceTransaction?.outputs[input.sourceOutputIndex]
+                    .lockingScript;
+                if (!lockingScript) {
+                    throw new Error('The lockingScript or input sourceTransaction is required for signing.');
+                }
+                const preimage = TransactionSignature.format({
+                    sourceTXID,
+                    sourceOutputIndex: input.sourceOutputIndex,
+                    sourceSatoshis,
+                    transactionVersion: tx.version,
+                    otherInputs: [],
+                    inputIndex,
+                    outputs: tx.outputs,
+                    inputSequence: input.sequence ?? 0xffffffff,
+                    subscript: lockingScript,
+                    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,
+                });
+                const sigWithHashtype = [...signature, signatureScope];
+                return new UnlockingScript()
+                    .writeBin(sigWithHashtype)
+                    .writeBin(Utils.toArray(publicKey, 'hex'))
+                    .writeOpCode(OP.OP_1);
+            },
+            estimateLength: async () => {
+                return 108;
+            },
+        };
+    }
+    /**
+     * 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, lockingScript) {
+        const purchase = {
+            sign: async (tx, inputIndex) => {
+                if (tx.outputs.length < 2) {
+                    throw new Error('Malformed transaction: requires at least 2 outputs');
+                }
+                const script = new UnlockingScript().writeBin(OrdLock.buildOutput(tx.outputs[0].satoshis ?? 0, tx.outputs[0].lockingScript.toBinary()));
+                if (tx.outputs.length > 2) {
+                    const writer = new Utils.Writer();
+                    for (const output of tx.outputs.slice(2)) {
+                        writer.write(OrdLock.buildOutput(output.satoshis ?? 0, output.lockingScript.toBinary()));
+                    }
+                    script.writeBin(writer.toArray());
+                }
+                else {
+                    script.writeOpCode(OP.OP_0);
+                }
+                const input = tx.inputs[inputIndex];
+                let sourceSats = sourceSatoshis;
+                if (!sourceSats && input.sourceTransaction != null) {
+                    sourceSats = input.sourceTransaction.outputs[input.sourceOutputIndex]
+                        .satoshis;
+                }
+                else if (!sourceSatoshis) {
+                    throw new Error('sourceTransaction or sourceSatoshis is required');
+                }
+                const sourceTXID = (input.sourceTXID ??
+                    input.sourceTransaction?.id('hex'));
+                let subscript = lockingScript;
+                if (!subscript) {
+                    subscript = input.sourceTransaction?.outputs[input.sourceOutputIndex]
+                        .lockingScript;
+                }
+                const preimage = TransactionSignature.format({
+                    sourceTXID,
+                    sourceOutputIndex: input.sourceOutputIndex,
+                    sourceSatoshis: sourceSats,
+                    transactionVersion: tx.version,
+                    otherInputs: [],
+                    inputIndex,
+                    outputs: tx.outputs,
+                    inputSequence: input.sequence ?? 0xffffffff,
+                    subscript,
+                    lockTime: tx.lockTime,
+                    scope: TransactionSignature.SIGHASH_ALL |
+                        TransactionSignature.SIGHASH_ANYONECANPAY |
+                        TransactionSignature.SIGHASH_FORKID,
+                });
+                return script.writeBin(preimage).writeOpCode(OP.OP_0);
+            },
+            estimateLength: async (tx, inputIndex) => {
+                return (await purchase.sign(tx, inputIndex)).toBinary().length;
+            },
+        };
+        return purchase;
+    }
+}
+//# sourceMappingURL=ordlock.js.map

package/dist/ordlock/ordlock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ordlock.js","sourceRoot":"","sources":["../../src/ordlock/ordlock.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AAC9D,OAAO,EACN,SAAS,EACT,IAAI,EAEJ,EAAE,EACF,KAAK,EAEL,MAAM,EAEN,oBAAoB,EACpB,eAAe,EACf,KAAK,GAGL,MAAM,UAAU,CAAA;AAEjB;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,KAAK,CAAC,CAAA;AAEnE;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,KAAK,CAAC,CAAA;AAcnE;;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,MAAM,CAAC,OAAO,OAAO,OAAO;IAC3B;;;;;;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,cAAc,CAAC,CAAA;YACzD,IAAI,WAAW,KAAK,CAAC,CAAC;gBAAE,OAAO,IAAI,CAAA;YAEnC,2BAA2B;YAC3B,MAAM,WAAW,GAAG,OAAO,CAC1B,YAAY,EACZ,cAAc,EACd,WAAW,GAAG,cAAc,CAAC,MAAM,CACnC,CAAA;YACD,IAAI,WAAW,KAAK,CAAC,CAAC;gBAAE,OAAO,IAAI,CAAA;YAEnC,yCAAyC;YACzC,MAAM,SAAS,GAAG,YAAY,CAAC,KAAK,CACnC,WAAW,GAAG,cAAc,CAAC,MAAM,EACnC,WAAW,CACX,CAAA;YACD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO,IAAI,CAAA;YAEvC,kCAAkC;YAClC,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,SAAS,CAAC,CAAA;YAC/C,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAA;YAEhC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;gBAAE,OAAO,IAAI,CAAA;YAElC,oCAAoC;YACpC,MAAM,WAAW,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;YAC7B,IAAI,WAAW,EAAE,IAAI,IAAI,IAAI,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,KAAK,EAAE;gBAC9D,OAAO,IAAI,CAAA;YAEZ,gEAAgE;YAChE,MAAM,WAAW,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;YAC7B,IAAI,WAAW,EAAE,IAAI,IAAI,IAAI,IAAI,WAAW,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC;gBAAE,OAAO,IAAI,CAAA;YAEzE,MAAM,UAAU,GAAG,WAAW,CAAC,IAAI,CAAA;YAEnC,8EAA8E;YAC9E,qCAAqC;YACrC,IAAI,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;YACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC5B,KAAK,IAAI,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;YAChD,CAAC;YAED,4BAA4B;YAC5B,MAAM,aAAa,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;YAC/C,MAAM,MAAM,GAAG,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC,IAAI,EAAE,aAAa,CAAC,CAAA;YAEnE,OAAO;gBACN,MAAM;gBACN,KAAK;gBACL,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC;aAC9B,CAAA;QACF,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,IAAI,CAAA;QACZ,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,SAAS,CAAC,MAAc;QAC9B,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAA;QACtC,MAAM,WAAW,GAAG,OAAO,CAAC,YAAY,EAAE,cAAc,CAAC,CAAA;QACzD,IAAI,WAAW,KAAK,CAAC,CAAC;YAAE,OAAO,KAAK,CAAA;QACpC,MAAM,WAAW,GAAG,OAAO,CAC1B,YAAY,EACZ,cAAc,EACd,WAAW,GAAG,cAAc,CAAC,MAAM,CACnC,CAAA;QACD,OAAO,WAAW,KAAK,CAAC,CAAC,CAAA;IAC1B,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,eAAuB;QACxC,MAAM,YAAY,GAAG,eAAe,CAAC,QAAQ,EAAE,CAAA;QAC/C,OAAO,OAAO,CAAC,YAAY,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC,CAAA;IACpD,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,CACV,aAAqB,EACrB,UAAkB,EAClB,KAAa;QAEb,MAAM,SAAS,GAAG,KAAK,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC,IAAgB,CAAA;QACvE,MAAM,MAAM,GAAG,KAAK,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,IAAgB,CAAA;QAEjE,OAAO,IAAI,MAAM,EAAE;aACjB,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;aAC9C,QAAQ,CAAC,SAAS,CAAC;aACnB,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,KAAK,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;aACzE,WAAW,CAAC,MAAM,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAA;IACjD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,QAAgB,EAAE,MAAgB;QACpD,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,MAAM,EAAE,CAAA;QACjC,MAAM,CAAC,eAAe,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC/C,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QACpC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;QACpB,OAAO,MAAM,CAAC,OAAO,EAAE,CAAA;IACxB,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,aAAa,CACnB,UAAsB,EACtB,cAAyC,KAAK,EAC9C,YAAY,GAAG,KAAK,EACpB,cAAuB,EACvB,aAAsB;QAKtB,MAAM,KAAK,GAAG,IAAI,KAAK,EAAE,CAAC,MAAM,CAC/B,UAAU,EACV,WAAW,EACX,YAAY,EACZ,cAAc,EACd,aAAa,CACb,CAAA;QACD,OAAO;YACN,IAAI,EAAE,KAAK,EAAE,EAAe,EAAE,UAAkB,EAAE,EAAE;gBACnD,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;YAC/D,CAAC;YACD,cAAc,EAAE,KAAK,IAAI,EAAE;gBAC1B,OAAO,GAAG,CAAA;YACX,CAAC;SACD,CAAA;IACF,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,gBAAgB,CACtB,MAAuB,EACvB,UAA0B,EAC1B,KAAa,EACb,YAAY,GAAG,MAAM;QAKrB,OAAO;YACN,IAAI,EAAE,KAAK,EAAE,EAAe,EAAE,UAAkB,EAAE,EAAE;gBACnD,MAAM,cAAc,GACnB,oBAAoB,CAAC,WAAW;oBAChC,oBAAoB,CAAC,oBAAoB;oBACzC,oBAAoB,CAAC,cAAc,CAAA;gBAEpC,MAAM,KAAK,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;gBAEnC,MAAM,UAAU,GACf,KAAK,CAAC,UAAU,IAAI,KAAK,CAAC,iBAAiB,EAAE,EAAE,CAAC,KAAK,CAAC,CAAA;gBACvD,IAAI,CAAC,UAAU,EAAE,CAAC;oBACjB,MAAM,IAAI,KAAK,CACd,oEAAoE,CACpE,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,wEAAwE,CACxE,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,uEAAuE,CACvE,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,EAAE,EAAE;oBACf,UAAU;oBACV,OAAO,EAAE,EAAE,CAAC,OAAO;oBACnB,aAAa,EAAE,KAAK,CAAC,QAAQ,IAAI,UAAU;oBAC3C,SAAS,EAAE,aAAa;oBACxB,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,MAAM,eAAe,GAAG,CAAC,GAAG,SAAS,EAAE,cAAc,CAAC,CAAA;gBAEtD,OAAO,IAAI,eAAe,EAAE;qBAC1B,QAAQ,CAAC,eAAe,CAAC;qBACzB,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;qBACzC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;YACvB,CAAC;YACD,cAAc,EAAE,KAAK,IAAI,EAAE;gBAC1B,OAAO,GAAG,CAAA;YACX,CAAC;SACD,CAAA;IACF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,eAAe,CACrB,cAAuB,EACvB,aAAsB;QAKtB,MAAM,QAAQ,GAAG;YAChB,IAAI,EAAE,KAAK,EAAE,EAAe,EAAE,UAAkB,EAAE,EAAE;gBACnD,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC3B,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAA;gBACtE,CAAC;gBACD,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC,QAAQ,CAC5C,OAAO,CAAC,WAAW,CAClB,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,CAAC,EAC3B,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE,CACtC,CACD,CAAA;gBACD,IAAI,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC3B,MAAM,MAAM,GAAG,IAAI,KAAK,CAAC,MAAM,EAAE,CAAA;oBACjC,KAAK,MAAM,MAAM,IAAI,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;wBAC1C,MAAM,CAAC,KAAK,CACX,OAAO,CAAC,WAAW,CAClB,MAAM,CAAC,QAAQ,IAAI,CAAC,EACpB,MAAM,CAAC,aAAa,CAAC,QAAQ,EAAE,CAC/B,CACD,CAAA;oBACF,CAAC;oBACD,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAA;gBAClC,CAAC;qBAAM,CAAC;oBACP,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;gBAC5B,CAAC;gBAED,MAAM,KAAK,GAAG,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;gBACnC,IAAI,UAAU,GAAG,cAAwB,CAAA;gBACzC,IAAI,CAAC,UAAU,IAAI,KAAK,CAAC,iBAAiB,IAAI,IAAI,EAAE,CAAC;oBACpD,UAAU,GAAG,KAAK,CAAC,iBAAiB,CAAC,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC;yBACnE,QAAkB,CAAA;gBACrB,CAAC;qBAAM,IAAI,CAAC,cAAc,EAAE,CAAC;oBAC5B,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;gBACnE,CAAC;gBAED,MAAM,UAAU,GAAG,CAAC,KAAK,CAAC,UAAU;oBACnC,KAAK,CAAC,iBAAiB,EAAE,EAAE,CAAC,KAAK,CAAC,CAAW,CAAA;gBAC9C,IAAI,SAAS,GAAG,aAA8B,CAAA;gBAC9C,IAAI,CAAC,SAAS,EAAE,CAAC;oBAChB,SAAS,GAAG,KAAK,CAAC,iBAAiB,EAAE,OAAO,CAAC,KAAK,CAAC,iBAAiB,CAAC;yBACnE,aAA8B,CAAA;gBACjC,CAAC;gBACD,MAAM,QAAQ,GAAG,oBAAoB,CAAC,MAAM,CAAC;oBAC5C,UAAU;oBACV,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;oBAC1C,cAAc,EAAE,UAAU;oBAC1B,kBAAkB,EAAE,EAAE,CAAC,OAAO;oBAC9B,WAAW,EAAE,EAAE;oBACf,UAAU;oBACV,OAAO,EAAE,EAAE,CAAC,OAAO;oBACnB,aAAa,EAAE,KAAK,CAAC,QAAQ,IAAI,UAAU;oBAC3C,SAAS;oBACT,QAAQ,EAAE,EAAE,CAAC,QAAQ;oBACrB,KAAK,EACJ,oBAAoB,CAAC,WAAW;wBAChC,oBAAoB,CAAC,oBAAoB;wBACzC,oBAAoB,CAAC,cAAc;iBACpC,CAAC,CAAA;gBAEF,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;YACtD,CAAC;YACD,cAAc,EAAE,KAAK,EAAE,EAAe,EAAE,UAAkB,EAAE,EAAE;gBAC7D,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAA;YAC/D,CAAC;SACD,CAAA;QACD,OAAO,QAAQ,CAAA;IAChB,CAAC;CACD"}

package/dist/signer.d.ts

@@ -0,0 +1,39 @@
+import { type PrivateKey, type WalletInterface, type WalletProtocol } from '@bsv/sdk';
+/**
+ * Unified signing interface for message signing operations.
+ *
+ * Abstracts the difference between raw PrivateKey and BRC-100
+ * WalletInterface so templates don't need to know which signing
+ * backend is in use.
+ */
+export interface Signer {
+    /** Sign a pre-computed hash. Returns DER-encoded signature bytes. */
+    signHash: (hash: number[]) => Promise<number[]>;
+    /** Returns the compressed public key as a hex string. */
+    getPublicKey: () => Promise<string>;
+}
+/**
+ * Signer adapter for a raw PrivateKey.
+ */
+export declare class PrivateKeySigner implements Signer {
+    private readonly privateKey;
+    constructor(privateKey: PrivateKey);
+    signHash(hash: number[]): Promise<number[]>;
+    getPublicKey(): Promise<string>;
+}
+/**
+ * Signer adapter for a BRC-100 WalletInterface.
+ *
+ * Uses wallet.createSignature with hashToDirectlySign and
+ * wallet.getPublicKey for key derivation via protocolID/keyID.
+ */
+export declare class WalletSigner implements Signer {
+    private readonly wallet;
+    private readonly protocolID;
+    private readonly keyID;
+    private readonly counterparty;
+    constructor(wallet: WalletInterface, protocolID: WalletProtocol, keyID: string, counterparty?: string);
+    signHash(hash: number[]): Promise<number[]>;
+    getPublicKey(): Promise<string>;
+}
+//# sourceMappingURL=signer.d.ts.map

package/dist/signer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../src/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,KAAK,UAAU,EAEf,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,MAAM,UAAU,CAAA;AAEjB;;;;;;GAMG;AACH,MAAM,WAAW,MAAM;IACtB,qEAAqE;IACrE,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC,CAAA;IAC/C,yDAAyD;IACzD,YAAY,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,qBAAa,gBAAiB,YAAW,MAAM;IAClC,OAAO,CAAC,QAAQ,CAAC,UAAU;gBAAV,UAAU,EAAE,UAAU;IAE7C,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAK3C,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;CAGrC;AAED;;;;;GAKG;AACH,qBAAa,YAAa,YAAW,MAAM;IAEzC,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,UAAU;IAC3B,OAAO,CAAC,QAAQ,CAAC,KAAK;IACtB,OAAO,CAAC,QAAQ,CAAC,YAAY;gBAHZ,MAAM,EAAE,eAAe,EACvB,UAAU,EAAE,cAAc,EAC1B,KAAK,EAAE,MAAM,EACb,YAAY,GAAE,MAAe;IAGzC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAU3C,YAAY,IAAI,OAAO,CAAC,MAAM,CAAC;CASrC"}

package/dist/signer.js

@@ -0,0 +1,54 @@
+import { BSM, } from '@bsv/sdk';
+/**
+ * Signer adapter for a raw PrivateKey.
+ */
+export class PrivateKeySigner {
+    privateKey;
+    constructor(privateKey) {
+        this.privateKey = privateKey;
+    }
+    async signHash(hash) {
+        const sig = BSM.sign(hash, this.privateKey, 'raw');
+        return sig.toDER();
+    }
+    async getPublicKey() {
+        return this.privateKey.toPublicKey().toString();
+    }
+}
+/**
+ * Signer adapter for a BRC-100 WalletInterface.
+ *
+ * Uses wallet.createSignature with hashToDirectlySign and
+ * wallet.getPublicKey for key derivation via protocolID/keyID.
+ */
+export class WalletSigner {
+    wallet;
+    protocolID;
+    keyID;
+    counterparty;
+    constructor(wallet, protocolID, keyID, counterparty = 'self') {
+        this.wallet = wallet;
+        this.protocolID = protocolID;
+        this.keyID = keyID;
+        this.counterparty = counterparty;
+    }
+    async signHash(hash) {
+        const { signature } = await this.wallet.createSignature({
+            protocolID: this.protocolID,
+            keyID: this.keyID,
+            counterparty: this.counterparty,
+            hashToDirectlySign: hash,
+        });
+        return Array.from(signature);
+    }
+    async getPublicKey() {
+        const { publicKey } = await this.wallet.getPublicKey({
+            protocolID: this.protocolID,
+            keyID: this.keyID,
+            counterparty: this.counterparty,
+            forSelf: true,
+        });
+        return publicKey;
+    }
+}
+//# sourceMappingURL=signer.js.map

package/dist/signer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"signer.js","sourceRoot":"","sources":["../src/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,GAAG,GAKH,MAAM,UAAU,CAAA;AAgBjB;;GAEG;AACH,MAAM,OAAO,gBAAgB;IACC;IAA7B,YAA6B,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;IAAG,CAAC;IAEvD,KAAK,CAAC,QAAQ,CAAC,IAAc;QAC5B,MAAM,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,KAAK,CAAc,CAAA;QAC/D,OAAO,GAAG,CAAC,KAAK,EAAc,CAAA;IAC/B,CAAC;IAED,KAAK,CAAC,YAAY;QACjB,OAAO,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAA;IAChD,CAAC;CACD;AAED;;;;;GAKG;AACH,MAAM,OAAO,YAAY;IAEN;IACA;IACA;IACA;IAJlB,YACkB,MAAuB,EACvB,UAA0B,EAC1B,KAAa,EACb,eAAuB,MAAM;QAH7B,WAAM,GAAN,MAAM,CAAiB;QACvB,eAAU,GAAV,UAAU,CAAgB;QAC1B,UAAK,GAAL,KAAK,CAAQ;QACb,iBAAY,GAAZ,YAAY,CAAiB;IAC5C,CAAC;IAEJ,KAAK,CAAC,QAAQ,CAAC,IAAc;QAC5B,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC;YACvD,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,kBAAkB,EAAE,IAAI;SACxB,CAAC,CAAA;QACF,OAAO,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IAC7B,CAAC;IAED,KAAK,CAAC,YAAY;QACjB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC;YACpD,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,OAAO,EAAE,IAAI;SACb,CAAC,CAAA;QACF,OAAO,SAAS,CAAA;IACjB,CAAC;CACD"}

package/package.json

@@ -0,0 +1,43 @@
+{
+	"name": "@1sat/templates",
+	"version": "0.0.1",
+	"description": "Bitcoin script templates for 1Sat Ordinals SDK",
+	"type": "module",
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.ts",
+			"import": "./dist/index.js"
+		},
+		"./sigma": {
+			"types": "./dist/bitcom/sigma.d.ts",
+			"import": "./dist/bitcom/sigma.js"
+		}
+	},
+	"files": ["dist"],
+	"scripts": {
+		"build": "tsc",
+		"dev": "tsc --watch",
+		"clean": "rm -rf dist"
+	},
+	"keywords": ["1sat", "bsv", "ordinals", "templates", "typescript"],
+	"license": "MIT",
+	"dependencies": {
+		"@1sat/types": "0.0.13"
+	},
+	"peerDependencies": {
+		"@bsv/sdk": "^2.0.4",
+		"sigma-protocol": "^0.1.9"
+	},
+	"peerDependenciesMeta": {
+		"sigma-protocol": {
+		"optional": true
+	}
+},
+"devDependencies": {
+	"@bsv/sdk": "^2.0.4",
+	"sigma-protocol": "^0.1.9",
+	"typescript": "^5.9.3"
+}
+}