@1sat/templates 0.0.1

package/dist/inscription/inscription.d.ts

@@ -0,0 +1,165 @@
+import { LockingScript, Script, type ScriptTemplate, type Transaction, type UnlockingScript } from '@bsv/sdk';
+/**
+ * Interface representing an inscription file
+ */
+export interface InscriptionFile {
+    /** SHA256 hash of the content */
+    hash: Uint8Array;
+    /** Size of the content in bytes */
+    size: number;
+    /** MIME type of the content */
+    type: string;
+    /** The actual file content */
+    content: Uint8Array;
+}
+/**
+ * Interface for inscription creation options
+ */
+export interface InscriptionOptions {
+    /** Optional parent inscription reference (36-byte outpoint) */
+    parent?: Uint8Array;
+    /** Optional script prefix to prepend before inscription (e.g., P2PKH locking script) */
+    scriptPrefix?: Script | LockingScript;
+    /** Optional script suffix to append after inscription (e.g., OP_RETURN data) */
+    scriptSuffix?: Script | LockingScript;
+}
+/**
+ * Inscription class implementing ScriptTemplate for Bitcoin ordinals and on-chain data storage.
+ *
+ * Inscriptions enable embedding arbitrary files, data, and content directly into blockchain
+ * transactions using the script pattern: OP_0 OP_IF "ord" OP_1 [MIME_TYPE] OP_0 [CONTENT] OP_ENDIF
+ *
+ * @example
+ * ```typescript
+ * // Create inscription from text
+ * const inscription = Inscription.fromText("Hello, BSV!", "text/plain");
+ * const lockingScript = inscription.lock();
+ *
+ * // Create inscription from binary data
+ * const imageData = new Uint8Array([...]); // PNG image data
+ * const imageInscription = Inscription.create(imageData, "image/png");
+ *
+ * // Parse inscription from script
+ * const parsed = Inscription.decode(someScript);
+ * if (parsed) {
+ *   console.log(`Content type: ${parsed.file.type}`);
+ *   console.log(`Content size: ${parsed.file.size} bytes`);
+ * }
+ * ```
+ */
+export default class Inscription implements ScriptTemplate {
+    /** Inscription file data */
+    readonly file: InscriptionFile;
+    /** Optional parent inscription reference */
+    readonly parent?: Uint8Array;
+    /** Optional script prefix */
+    readonly scriptPrefix?: Script | LockingScript;
+    /** Optional script suffix */
+    readonly scriptSuffix?: Script | LockingScript;
+    /** Unknown/custom fields (field number -> data) */
+    readonly fields?: Map<string, Uint8Array>;
+    /**
+     * Creates a new Inscription instance
+     *
+     * @param file - The inscription file data
+     * @param parent - Optional parent inscription reference (32 or 36-byte outpoint)
+     * @param scriptPrefix - Optional script prefix (Script or LockingScript)
+     * @param scriptSuffix - Optional script suffix (Script or LockingScript)
+     * @param fields - Optional map of unknown/custom fields
+     */
+    constructor(file: InscriptionFile, parent?: Uint8Array, scriptPrefix?: Script | LockingScript, scriptSuffix?: Script | LockingScript, fields?: Map<string, Uint8Array>);
+    /**
+     * Creates an inscription locking script following the ordinals protocol format:
+     * [ScriptPrefix] OP_0 OP_IF "ord" OP_1 [MIME_TYPE] OP_0 [CONTENT] OP_ENDIF [ScriptSuffix]
+     *
+     * @returns A locking script containing the inscription data
+     */
+    lock(): LockingScript;
+    /**
+     * Unlock method is not applicable for inscription scripts.
+     * Inscriptions are typically used in outputs that don't require unlocking.
+     *
+     * @throws Error indicating unlock is not supported
+     */
+    unlock(): {
+        sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
+        estimateLength: () => Promise<number>;
+    };
+    /**
+     * Verifies that the file hash matches the content
+     *
+     * @returns true if the hash is valid, false otherwise
+     */
+    verify(): boolean;
+    /**
+     * Creates a new inscription from content and MIME type
+     *
+     * @param content - The file content as bytes
+     * @param contentType - The MIME type of the content
+     * @param options - Optional inscription parameters
+     * @returns A new Inscription instance
+     */
+    static create(content: Uint8Array, contentType: string, options?: InscriptionOptions): Inscription;
+    /**
+     * Creates an inscription from text content
+     *
+     * @param text - The text content
+     * @param contentType - Optional MIME type (defaults to "text/plain;charset=utf-8")
+     * @param options - Optional inscription parameters
+     * @returns A new Inscription instance
+     */
+    static fromText(text: string, contentType?: string, options?: InscriptionOptions): Inscription;
+    /**
+     * Creates an inscription from a browser File object
+     *
+     * @param file - The File object
+     * @param options - Optional inscription parameters
+     * @returns Promise resolving to a new Inscription instance
+     */
+    static fromFile(file: File, options?: InscriptionOptions): Promise<Inscription>;
+    /**
+     * Checks if a script contains an inscription
+     *
+     * @param script - The script to check
+     * @returns true if the script contains an inscription pattern
+     */
+    static isInscription(script: Script): boolean;
+    /**
+     * Decodes an inscription from a script
+     *
+     * @param script - The script containing inscription data
+     * @returns Decoded inscription or null if not found/invalid
+     */
+    static decode(script: Script): Inscription | null;
+    /**
+     * Extracts text content from the inscription if it's a text type
+     *
+     * @returns The text content or null if not text or invalid UTF-8
+     */
+    getText(): string | null;
+    /**
+     * Parses JSON content from the inscription
+     *
+     * @returns The parsed JSON object or null if not JSON or invalid
+     */
+    getJSON<T = unknown>(): T | null;
+    /**
+     * Gets the raw content as bytes
+     *
+     * @returns The file content
+     */
+    getContent(): Uint8Array;
+    /**
+     * Gets content as base64 string
+     *
+     * @returns Base64 encoded content
+     */
+    getBase64(): string;
+    /**
+     * Gets content as hex string
+     *
+     * @returns Hex encoded content
+     */
+    getHex(): string;
+}
+//# sourceMappingURL=inscription.d.ts.map

package/dist/inscription/inscription.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inscription.d.ts","sourceRoot":"","sources":["../../src/inscription/inscription.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,aAAa,EAEb,MAAM,EACN,KAAK,cAAc,EACnB,KAAK,WAAW,EAChB,KAAK,eAAe,EAEpB,MAAM,UAAU,CAAA;AAEjB;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B,iCAAiC;IACjC,IAAI,EAAE,UAAU,CAAA;IAChB,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,8BAA8B;IAC9B,OAAO,EAAE,UAAU,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,+DAA+D;IAC/D,MAAM,CAAC,EAAE,UAAU,CAAA;IACnB,wFAAwF;IACxF,YAAY,CAAC,EAAE,MAAM,GAAG,aAAa,CAAA;IACrC,gFAAgF;IAChF,YAAY,CAAC,EAAE,MAAM,GAAG,aAAa,CAAA;CACrC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,OAAO,WAAY,YAAW,cAAc;IACzD,4BAA4B;IAC5B,SAAgB,IAAI,EAAE,eAAe,CAAA;IACrC,4CAA4C;IAC5C,SAAgB,MAAM,CAAC,EAAE,UAAU,CAAA;IACnC,6BAA6B;IAC7B,SAAgB,YAAY,CAAC,EAAE,MAAM,GAAG,aAAa,CAAA;IACrD,6BAA6B;IAC7B,SAAgB,YAAY,CAAC,EAAE,MAAM,GAAG,aAAa,CAAA;IACrD,mDAAmD;IACnD,SAAgB,MAAM,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IAEhD;;;;;;;;OAQG;gBAEF,IAAI,EAAE,eAAe,EACrB,MAAM,CAAC,EAAE,UAAU,EACnB,YAAY,CAAC,EAAE,MAAM,GAAG,aAAa,EACrC,YAAY,CAAC,EAAE,MAAM,GAAG,aAAa,EACrC,MAAM,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC;IASjC;;;;;OAKG;IACH,IAAI,IAAI,aAAa;IA4CrB;;;;;OAKG;IACH,MAAM,IAAI;QACT,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;IAID;;;;OAIG;IACH,MAAM,IAAI,OAAO;IAOjB;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,CACZ,OAAO,EAAE,UAAU,EACnB,WAAW,EAAE,MAAM,EACnB,OAAO,GAAE,kBAAuB,GAC9B,WAAW;IAqCd;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CACd,IAAI,EAAE,MAAM,EACZ,WAAW,SAA6B,EACxC,OAAO,GAAE,kBAAuB,GAC9B,WAAW;IAKd;;;;;;OAMG;WACU,QAAQ,CACpB,IAAI,EAAE,IAAI,EACV,OAAO,GAAE,kBAAuB,GAC9B,OAAO,CAAC,WAAW,CAAC;IAQvB;;;;;OAKG;IACH,MAAM,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IA0B7C;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW,GAAG,IAAI;IA+JjD;;;;OAIG;IACH,OAAO,IAAI,MAAM,GAAG,IAAI;IAexB;;;;OAIG;IACH,OAAO,CAAC,CAAC,GAAG,OAAO,KAAK,CAAC,GAAG,IAAI;IAWhC;;;;OAIG;IACH,UAAU,IAAI,UAAU;IAIxB;;;;OAIG;IACH,SAAS,IAAI,MAAM;IAInB;;;;OAIG;IACH,MAAM,IAAI,MAAM;CAGhB"}

package/dist/inscription/inscription.js

@@ -0,0 +1,401 @@
+import { Hash, LockingScript, OP, Script, Utils, } from '@bsv/sdk';
+/**
+ * Inscription class implementing ScriptTemplate for Bitcoin ordinals and on-chain data storage.
+ *
+ * Inscriptions enable embedding arbitrary files, data, and content directly into blockchain
+ * transactions using the script pattern: OP_0 OP_IF "ord" OP_1 [MIME_TYPE] OP_0 [CONTENT] OP_ENDIF
+ *
+ * @example
+ * ```typescript
+ * // Create inscription from text
+ * const inscription = Inscription.fromText("Hello, BSV!", "text/plain");
+ * const lockingScript = inscription.lock();
+ *
+ * // Create inscription from binary data
+ * const imageData = new Uint8Array([...]); // PNG image data
+ * const imageInscription = Inscription.create(imageData, "image/png");
+ *
+ * // Parse inscription from script
+ * const parsed = Inscription.decode(someScript);
+ * if (parsed) {
+ *   console.log(`Content type: ${parsed.file.type}`);
+ *   console.log(`Content size: ${parsed.file.size} bytes`);
+ * }
+ * ```
+ */
+export default class Inscription {
+    /** Inscription file data */
+    file;
+    /** Optional parent inscription reference */
+    parent;
+    /** Optional script prefix */
+    scriptPrefix;
+    /** Optional script suffix */
+    scriptSuffix;
+    /** Unknown/custom fields (field number -> data) */
+    fields;
+    /**
+     * Creates a new Inscription instance
+     *
+     * @param file - The inscription file data
+     * @param parent - Optional parent inscription reference (32 or 36-byte outpoint)
+     * @param scriptPrefix - Optional script prefix (Script or LockingScript)
+     * @param scriptSuffix - Optional script suffix (Script or LockingScript)
+     * @param fields - Optional map of unknown/custom fields
+     */
+    constructor(file, parent, scriptPrefix, scriptSuffix, fields) {
+        this.file = file;
+        this.parent = parent;
+        this.scriptPrefix = scriptPrefix;
+        this.scriptSuffix = scriptSuffix;
+        this.fields = fields;
+    }
+    /**
+     * Creates an inscription locking script following the ordinals protocol format:
+     * [ScriptPrefix] OP_0 OP_IF "ord" OP_1 [MIME_TYPE] OP_0 [CONTENT] OP_ENDIF [ScriptSuffix]
+     *
+     * @returns A locking script containing the inscription data
+     */
+    lock() {
+        const script = new Script();
+        // Add script prefix if present - iterate over chunks to preserve data pushes
+        if (this.scriptPrefix != null) {
+            for (const chunk of this.scriptPrefix.chunks) {
+                script.chunks.push(chunk);
+            }
+        }
+        // Start inscription envelope: OP_0 OP_IF
+        script.writeOpCode(OP.OP_0);
+        script.writeOpCode(OP.OP_IF);
+        // Protocol identifier: "ord"
+        script.writeBin(Utils.toArray('ord', 'utf8'));
+        // Add MIME type (field 1)
+        script.writeOpCode(OP.OP_1);
+        script.writeBin(Utils.toArray(this.file.type, 'utf8'));
+        // Add parent if present (field 3)
+        if (this.parent != null && this.parent.length === 36) {
+            script.writeOpCode(OP.OP_3);
+            script.writeBin(Array.from(this.parent));
+        }
+        // Add content (field 0)
+        script.writeOpCode(OP.OP_0);
+        script.writeBin(Array.from(this.file.content));
+        // End inscription envelope: OP_ENDIF
+        script.writeOpCode(OP.OP_ENDIF);
+        // Add script suffix if present - iterate over chunks to preserve data pushes
+        if (this.scriptSuffix != null) {
+            for (const chunk of this.scriptSuffix.chunks) {
+                script.chunks.push(chunk);
+            }
+        }
+        return new LockingScript(script.chunks);
+    }
+    /**
+     * Unlock method is not applicable for inscription scripts.
+     * Inscriptions are typically used in outputs that don't require unlocking.
+     *
+     * @throws Error indicating unlock is not supported
+     */
+    unlock() {
+        throw new Error('Unlock is not supported for inscription scripts');
+    }
+    /**
+     * Verifies that the file hash matches the content
+     *
+     * @returns true if the hash is valid, false otherwise
+     */
+    verify() {
+        const calculatedHash = Hash.sha256(Array.from(this.file.content));
+        return (Utils.toHex(calculatedHash) === Utils.toHex(Array.from(this.file.hash)));
+    }
+    /**
+     * Creates a new inscription from content and MIME type
+     *
+     * @param content - The file content as bytes
+     * @param contentType - The MIME type of the content
+     * @param options - Optional inscription parameters
+     * @returns A new Inscription instance
+     */
+    static create(content, contentType, options = {}) {
+        // Validate MIME type
+        if (contentType === '' || contentType.length > 255) {
+            throw new Error('Content type must be a non-empty string with max 255 characters');
+        }
+        // Validate UTF-8 encoding for content type
+        try {
+            Utils.toArray(contentType, 'utf8');
+        }
+        catch {
+            throw new Error('Content type must be valid UTF-8');
+        }
+        // Validate parent if provided
+        if (options.parent != null && options.parent.length !== 36) {
+            throw new Error('Parent must be exactly 36 bytes (transaction outpoint)');
+        }
+        // Calculate hash and create file structure
+        const hash = new Uint8Array(Hash.sha256(Array.from(content)));
+        const file = {
+            hash,
+            size: content.length,
+            type: contentType,
+            content,
+        };
+        return new Inscription(file, options.parent, options.scriptPrefix, options.scriptSuffix);
+    }
+    /**
+     * Creates an inscription from text content
+     *
+     * @param text - The text content
+     * @param contentType - Optional MIME type (defaults to "text/plain;charset=utf-8")
+     * @param options - Optional inscription parameters
+     * @returns A new Inscription instance
+     */
+    static fromText(text, contentType = 'text/plain;charset=utf-8', options = {}) {
+        const content = new Uint8Array(Utils.toArray(text, 'utf8'));
+        return Inscription.create(content, contentType, options);
+    }
+    /**
+     * Creates an inscription from a browser File object
+     *
+     * @param file - The File object
+     * @param options - Optional inscription parameters
+     * @returns Promise resolving to a new Inscription instance
+     */
+    static async fromFile(file, options = {}) {
+        const arrayBuffer = await file.arrayBuffer();
+        const content = new Uint8Array(arrayBuffer);
+        const contentType = file.type !== '' ? file.type : 'application/octet-stream';
+        return Inscription.create(content, contentType, options);
+    }
+    /**
+     * Checks if a script contains an inscription
+     *
+     * @param script - The script to check
+     * @returns true if the script contains an inscription pattern
+     */
+    static isInscription(script) {
+        try {
+            const chunks = script.chunks;
+            // Look for the pattern: OP_0 OP_IF "ord"
+            for (let i = 0; i < chunks.length - 2; i++) {
+                const chunk0 = chunks[i];
+                const chunk1 = chunks[i + 1];
+                const chunk2 = chunks[i + 2];
+                if (chunk0?.op === OP.OP_0 &&
+                    chunk1?.op === OP.OP_IF &&
+                    chunk2?.data != null &&
+                    chunk2.data.length === 3 &&
+                    Utils.toUTF8(chunk2.data) === 'ord') {
+                    return true;
+                }
+            }
+            return false;
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * Decodes an inscription from a script
+     *
+     * @param script - The script containing inscription data
+     * @returns Decoded inscription or null if not found/invalid
+     */
+    static decode(script) {
+        try {
+            const chunks = script.chunks;
+            // Find inscription pattern: OP_0 OP_IF "ord"
+            let inscriptionStart = -1;
+            for (let i = 0; i < chunks.length - 2; i++) {
+                const chunk0 = chunks[i];
+                const chunk1 = chunks[i + 1];
+                const chunk2 = chunks[i + 2];
+                if (chunk0?.op === OP.OP_0 &&
+                    chunk1?.op === OP.OP_IF &&
+                    chunk2?.data != null &&
+                    chunk2.data.length === 3 &&
+                    Utils.toUTF8(chunk2.data) === 'ord') {
+                    inscriptionStart = i;
+                    break;
+                }
+            }
+            if (inscriptionStart === -1) {
+                return null;
+            }
+            // Extract prefix (everything before inscription) - preserve as Script with proper chunks
+            let scriptPrefix;
+            if (inscriptionStart > 0) {
+                scriptPrefix = new Script();
+                for (let i = 0; i < inscriptionStart; i++) {
+                    scriptPrefix.chunks.push(chunks[i]);
+                }
+            }
+            // Parse inscription fields
+            let pos = inscriptionStart + 3; // Skip OP_0 OP_IF "ord"
+            let contentType = '';
+            let content = new Uint8Array(0);
+            let parent;
+            const fields = new Map();
+            while (pos < chunks.length) {
+                if (chunks[pos].op === OP.OP_ENDIF) {
+                    pos++;
+                    break;
+                }
+                // Read field number/key
+                const fieldChunk = chunks[pos];
+                let fieldNum;
+                let fieldKey;
+                // Handle OP codes for field numbers
+                if (fieldChunk.op === OP.OP_0) {
+                    fieldNum = 0;
+                }
+                else if (fieldChunk.op !== undefined &&
+                    fieldChunk.op > OP.OP_PUSHDATA4 &&
+                    fieldChunk.op <= OP.OP_16) {
+                    fieldNum = fieldChunk.op - 80; // OP_1 = 81, so OP_1 - 80 = 1
+                }
+                else if (fieldChunk.data != null && fieldChunk.data.length === 1) {
+                    // Single byte data as field number
+                    fieldNum = fieldChunk.data[0];
+                }
+                else if (fieldChunk.data != null && fieldChunk.data.length > 1) {
+                    // Multi-byte data as string key (like Go implementation)
+                    fieldKey = String.fromCharCode(...fieldChunk.data);
+                }
+                else {
+                    // Unknown field format, skip
+                    pos++;
+                    continue;
+                }
+                pos++;
+                // Read data
+                const dataChunk = chunks[pos];
+                if (pos >= chunks.length) {
+                    break;
+                }
+                // Data chunk may be empty or have data
+                const data = dataChunk?.data != null
+                    ? new Uint8Array(dataChunk.data)
+                    : new Uint8Array(0);
+                pos++;
+                // Process field based on number or key
+                if (fieldKey != null) {
+                    // String key field - store in fields map
+                    fields.set(fieldKey, data);
+                }
+                else if (fieldNum !== undefined) {
+                    switch (fieldNum) {
+                        case 0: // Content
+                            content = data;
+                            break;
+                        case 1: // MIME type
+                            try {
+                                contentType = Utils.toUTF8(Array.from(data));
+                            }
+                            catch {
+                                // Invalid UTF-8, use empty string
+                                contentType = '';
+                            }
+                            break;
+                        case 3: // Parent - accept both 32 and 36 bytes (like Go)
+                            if (data.length === 36) {
+                                parent = data;
+                            }
+                            else if (data.length === 32) {
+                                // 32-byte txid only - create 36-byte outpoint with vout=0
+                                parent = new Uint8Array(36);
+                                parent.set(data, 0);
+                                // Last 4 bytes are already 0 (vout = 0)
+                            }
+                            break;
+                        default:
+                            // Store unknown numeric fields in fields map
+                            fields.set(fieldNum.toString(), data);
+                    }
+                }
+            }
+            // Extract suffix (everything after OP_ENDIF) - preserve as Script with proper chunks
+            let scriptSuffix;
+            if (pos < chunks.length) {
+                scriptSuffix = new Script();
+                for (let i = pos; i < chunks.length; i++) {
+                    scriptSuffix.chunks.push(chunks[i]);
+                }
+            }
+            // Must have content to be valid
+            if (content.length === 0) {
+                return null;
+            }
+            // Calculate hash
+            const hash = new Uint8Array(Hash.sha256(Array.from(content)));
+            const file = {
+                hash,
+                size: content.length,
+                type: contentType,
+                content,
+            };
+            return new Inscription(file, parent, scriptPrefix, scriptSuffix, fields.size > 0 ? fields : undefined);
+        }
+        catch {
+            return null;
+        }
+    }
+    /**
+     * Extracts text content from the inscription if it's a text type
+     *
+     * @returns The text content or null if not text or invalid UTF-8
+     */
+    getText() {
+        if (!this.file.type.startsWith('text/') &&
+            this.file.type !== 'application/json') {
+            return null;
+        }
+        try {
+            return Utils.toUTF8(Array.from(this.file.content));
+        }
+        catch {
+            return null;
+        }
+    }
+    /**
+     * Parses JSON content from the inscription
+     *
+     * @returns The parsed JSON object or null if not JSON or invalid
+     */
+    getJSON() {
+        const text = this.getText();
+        if (text == null)
+            return null;
+        try {
+            return JSON.parse(text);
+        }
+        catch {
+            return null;
+        }
+    }
+    /**
+     * Gets the raw content as bytes
+     *
+     * @returns The file content
+     */
+    getContent() {
+        return this.file.content;
+    }
+    /**
+     * Gets content as base64 string
+     *
+     * @returns Base64 encoded content
+     */
+    getBase64() {
+        return Utils.toBase64(Array.from(this.file.content));
+    }
+    /**
+     * Gets content as hex string
+     *
+     * @returns Hex encoded content
+     */
+    getHex() {
+        return Utils.toHex(Array.from(this.file.content));
+    }
+}
+//# sourceMappingURL=inscription.js.map

package/dist/inscription/inscription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"inscription.js","sourceRoot":"","sources":["../../src/inscription/inscription.ts"],"names":[],"mappings":"AAAA,OAAO,EACN,IAAI,EACJ,aAAa,EACb,EAAE,EACF,MAAM,EAIN,KAAK,GACL,MAAM,UAAU,CAAA;AA4BjB;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IAC/B,4BAA4B;IACZ,IAAI,CAAiB;IACrC,4CAA4C;IAC5B,MAAM,CAAa;IACnC,6BAA6B;IACb,YAAY,CAAyB;IACrD,6BAA6B;IACb,YAAY,CAAyB;IACrD,mDAAmD;IACnC,MAAM,CAA0B;IAEhD;;;;;;;;OAQG;IACH,YACC,IAAqB,EACrB,MAAmB,EACnB,YAAqC,EACrC,YAAqC,EACrC,MAAgC;QAEhC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;QAChC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;QAChC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACrB,CAAC;IAED;;;;;OAKG;IACH,IAAI;QACH,MAAM,MAAM,GAAG,IAAI,MAAM,EAAE,CAAA;QAE3B,6EAA6E;QAC7E,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,EAAE,CAAC;YAC/B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;gBAC9C,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAC1B,CAAC;QACF,CAAC;QAED,yCAAyC;QACzC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;QAC3B,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,CAAC,CAAA;QAE5B,6BAA6B;QAC7B,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA;QAE7C,0BAA0B;QAC1B,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;QAC3B,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;QAEtD,kCAAkC;QAClC,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YACtD,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;YAC3B,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;QACzC,CAAC;QAED,wBAAwB;QACxB,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,IAAI,CAAC,CAAA;QAC3B,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;QAE9C,qCAAqC;QACrC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAA;QAE/B,6EAA6E;QAC7E,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,EAAE,CAAC;YAC/B,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;gBAC9C,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAC1B,CAAC;QACF,CAAC;QAED,OAAO,IAAI,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;IACxC,CAAC;IAED;;;;;OAKG;IACH,MAAM;QAIL,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;IACnE,CAAC;IAED;;;;OAIG;IACH,MAAM;QACL,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;QACjE,OAAO,CACN,KAAK,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CACvE,CAAA;IACF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,MAAM,CACZ,OAAmB,EACnB,WAAmB,EACnB,UAA8B,EAAE;QAEhC,qBAAqB;QACrB,IAAI,WAAW,KAAK,EAAE,IAAI,WAAW,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CACd,iEAAiE,CACjE,CAAA;QACF,CAAC;QAED,2CAA2C;QAC3C,IAAI,CAAC;YACJ,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,CAAA;QACnC,CAAC;QAAC,MAAM,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;QACpD,CAAC;QAED,8BAA8B;QAC9B,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAA;QAC1E,CAAC;QAED,2CAA2C;QAC3C,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;QAC7D,MAAM,IAAI,GAAoB;YAC7B,IAAI;YACJ,IAAI,EAAE,OAAO,CAAC,MAAM;YACpB,IAAI,EAAE,WAAW;YACjB,OAAO;SACP,CAAA;QAED,OAAO,IAAI,WAAW,CACrB,IAAI,EACJ,OAAO,CAAC,MAAM,EACd,OAAO,CAAC,YAAY,EACpB,OAAO,CAAC,YAAY,CACpB,CAAA;IACF,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CACd,IAAY,EACZ,WAAW,GAAG,0BAA0B,EACxC,UAA8B,EAAE;QAEhC,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;QAC3D,OAAO,WAAW,CAAC,MAAM,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,CAAA;IACzD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,QAAQ,CACpB,IAAU,EACV,UAA8B,EAAE;QAEhC,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAA;QAC5C,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,WAAW,CAAC,CAAA;QAC3C,MAAM,WAAW,GAChB,IAAI,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,0BAA0B,CAAA;QAC1D,OAAO,WAAW,CAAC,MAAM,CAAC,OAAO,EAAE,WAAW,EAAE,OAAO,CAAC,CAAA;IACzD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,aAAa,CAAC,MAAc;QAClC,IAAI,CAAC;YACJ,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;YAE5B,yCAAyC;YACzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC5C,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;gBACxB,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;gBAC5B,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;gBAC5B,IACC,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI;oBACtB,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,KAAK;oBACvB,MAAM,EAAE,IAAI,IAAI,IAAI;oBACpB,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC;oBACxB,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,EAClC,CAAC;oBACF,OAAO,IAAI,CAAA;gBACZ,CAAC;YACF,CAAC;YAED,OAAO,KAAK,CAAA;QACb,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,KAAK,CAAA;QACb,CAAC;IACF,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,MAAM,CAAC,MAAc;QAC3B,IAAI,CAAC;YACJ,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;YAE5B,6CAA6C;YAC7C,IAAI,gBAAgB,GAAG,CAAC,CAAC,CAAA;YACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC5C,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,CAAA;gBACxB,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;gBAC5B,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;gBAC5B,IACC,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI;oBACtB,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,KAAK;oBACvB,MAAM,EAAE,IAAI,IAAI,IAAI;oBACpB,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC;oBACxB,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,KAAK,EAClC,CAAC;oBACF,gBAAgB,GAAG,CAAC,CAAA;oBACpB,MAAK;gBACN,CAAC;YACF,CAAC;YAED,IAAI,gBAAgB,KAAK,CAAC,CAAC,EAAE,CAAC;gBAC7B,OAAO,IAAI,CAAA;YACZ,CAAC;YAED,yFAAyF;YACzF,IAAI,YAAgC,CAAA;YACpC,IAAI,gBAAgB,GAAG,CAAC,EAAE,CAAC;gBAC1B,YAAY,GAAG,IAAI,MAAM,EAAE,CAAA;gBAC3B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC3C,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;gBACpC,CAAC;YACF,CAAC;YAED,2BAA2B;YAC3B,IAAI,GAAG,GAAG,gBAAgB,GAAG,CAAC,CAAA,CAAC,wBAAwB;YACvD,IAAI,WAAW,GAAG,EAAE,CAAA;YACpB,IAAI,OAAO,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;YAC/B,IAAI,MAA8B,CAAA;YAClC,MAAM,MAAM,GAAG,IAAI,GAAG,EAAsB,CAAA;YAE5C,OAAO,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;gBAC5B,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,QAAQ,EAAE,CAAC;oBACpC,GAAG,EAAE,CAAA;oBACL,MAAK;gBACN,CAAC;gBAED,wBAAwB;gBACxB,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;gBAC9B,IAAI,QAA4B,CAAA;gBAChC,IAAI,QAA4B,CAAA;gBAEhC,oCAAoC;gBACpC,IAAI,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,CAAC;oBAC/B,QAAQ,GAAG,CAAC,CAAA;gBACb,CAAC;qBAAM,IACN,UAAU,CAAC,EAAE,KAAK,SAAS;oBAC3B,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC,YAAY;oBAC/B,UAAU,CAAC,EAAE,IAAI,EAAE,CAAC,KAAK,EACxB,CAAC;oBACF,QAAQ,GAAG,UAAU,CAAC,EAAE,GAAG,EAAE,CAAA,CAAC,8BAA8B;gBAC7D,CAAC;qBAAM,IAAI,UAAU,CAAC,IAAI,IAAI,IAAI,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACpE,mCAAmC;oBACnC,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;gBAC9B,CAAC;qBAAM,IAAI,UAAU,CAAC,IAAI,IAAI,IAAI,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAClE,yDAAyD;oBACzD,QAAQ,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,CAAA;gBACnD,CAAC;qBAAM,CAAC;oBACP,6BAA6B;oBAC7B,GAAG,EAAE,CAAA;oBACL,SAAQ;gBACT,CAAC;gBAED,GAAG,EAAE,CAAA;gBAEL,YAAY;gBACZ,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;gBAC7B,IAAI,GAAG,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;oBAC1B,MAAK;gBACN,CAAC;gBAED,uCAAuC;gBACvC,MAAM,IAAI,GACT,SAAS,EAAE,IAAI,IAAI,IAAI;oBACtB,CAAC,CAAC,IAAI,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC;oBAChC,CAAC,CAAC,IAAI,UAAU,CAAC,CAAC,CAAC,CAAA;gBACrB,GAAG,EAAE,CAAA;gBAEL,uCAAuC;gBACvC,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;oBACtB,yCAAyC;oBACzC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAA;gBAC3B,CAAC;qBAAM,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;oBACnC,QAAQ,QAAQ,EAAE,CAAC;wBAClB,KAAK,CAAC,EAAE,UAAU;4BACjB,OAAO,GAAG,IAAI,CAAA;4BACd,MAAK;wBACN,KAAK,CAAC,EAAE,YAAY;4BACnB,IAAI,CAAC;gCACJ,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAA;4BAC7C,CAAC;4BAAC,MAAM,CAAC;gCACR,kCAAkC;gCAClC,WAAW,GAAG,EAAE,CAAA;4BACjB,CAAC;4BACD,MAAK;wBACN,KAAK,CAAC,EAAE,iDAAiD;4BACxD,IAAI,IAAI,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;gCACxB,MAAM,GAAG,IAAI,CAAA;4BACd,CAAC;iCAAM,IAAI,IAAI,CAAC,MAAM,KAAK,EAAE,EAAE,CAAC;gCAC/B,0DAA0D;gCAC1D,MAAM,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC,CAAA;gCAC3B,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAA;gCACnB,wCAAwC;4BACzC,CAAC;4BACD,MAAK;wBACN;4BACC,6CAA6C;4BAC7C,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,CAAA;oBACvC,CAAC;gBACF,CAAC;YACF,CAAC;YAED,qFAAqF;YACrF,IAAI,YAAgC,CAAA;YACpC,IAAI,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;gBACzB,YAAY,GAAG,IAAI,MAAM,EAAE,CAAA;gBAC3B,KAAK,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC1C,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;gBACpC,CAAC;YACF,CAAC;YAED,gCAAgC;YAChC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAC1B,OAAO,IAAI,CAAA;YACZ,CAAC;YAED,iBAAiB;YACjB,MAAM,IAAI,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;YAE7D,MAAM,IAAI,GAAoB;gBAC7B,IAAI;gBACJ,IAAI,EAAE,OAAO,CAAC,MAAM;gBACpB,IAAI,EAAE,WAAW;gBACjB,OAAO;aACP,CAAA;YAED,OAAO,IAAI,WAAW,CACrB,IAAI,EACJ,MAAM,EACN,YAAY,EACZ,YAAY,EACZ,MAAM,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CACpC,CAAA;QACF,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,IAAI,CAAA;QACZ,CAAC;IACF,CAAC;IAED;;;;OAIG;IACH,OAAO;QACN,IACC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;YACnC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,kBAAkB,EACpC,CAAC;YACF,OAAO,IAAI,CAAA;QACZ,CAAC;QAED,IAAI,CAAC;YACJ,OAAO,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;QACnD,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,IAAI,CAAA;QACZ,CAAC;IACF,CAAC;IAED;;;;OAIG;IACH,OAAO;QACN,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,EAAE,CAAA;QAC3B,IAAI,IAAI,IAAI,IAAI;YAAE,OAAO,IAAI,CAAA;QAE7B,IAAI,CAAC;YACJ,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAM,CAAA;QAC7B,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,IAAI,CAAA;QACZ,CAAC;IACF,CAAC;IAED;;;;OAIG;IACH,UAAU;QACT,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAA;IACzB,CAAC;IAED;;;;OAIG;IACH,SAAS;QACR,OAAO,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;IACrD,CAAC;IAED;;;;OAIG;IACH,MAAM;QACL,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;IAClD,CAAC;CACD"}

package/dist/lock/lock.d.ts

@@ -0,0 +1,92 @@
+import { type PrivateKey, Script, type Transaction, type UnlockingScript, type WalletInterface, type WalletProtocol } from '@bsv/sdk';
+/**
+ * Lock PREFIX as number array - sCrypt contract prefix shared with OrdLock template
+ */
+export declare const LOCK_PREFIX: any[];
+/**
+ * Lock SUFFIX as number array - time-lock contract validation script
+ */
+export declare const LOCK_SUFFIX: any[];
+/**
+ * Lock decoded data structure
+ */
+export interface LockData {
+    /** Owner's address (base58check encoded) */
+    address: string;
+    /** Block height or timestamp until which the output is locked */
+    until: number;
+}
+/**
+ * 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: Script, mainnet?: boolean): LockData | 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: Script): boolean;
+    /**
+     * 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: string, until: number): Script;
+    /**
+     * 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: PrivateKey, sighashType?: 'all' | 'none' | 'single', anyoneCanPay?: boolean, sourceSatoshis?: number, lockingScript?: Script): {
+        sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
+        estimateLength: (tx: Transaction, inputIndex: number) => Promise<number>;
+    };
+    /**
+     * 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: WalletInterface, protocolID: WalletProtocol, keyID: string, counterparty?: string, sighashType?: 'all' | 'none' | 'single', anyoneCanPay?: boolean): {
+        sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
+        estimateLength: (tx: Transaction, inputIndex: number) => Promise<number>;
+    };
+}
+//# sourceMappingURL=lock.d.ts.map