Merge pull request #200 from bitcoin-sv/scriptTemplateFix

Script template fix

docs/script.md

@@ -8,6 +8,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 | --- |
 | [ScriptChunk](#interface-scriptchunk) |
 | [ScriptTemplate](#interface-scripttemplate) |
+| [ScriptTemplateUnlock](#interface-scripttemplateunlock) |
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -31,15 +32,12 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 ```ts
 export default interface ScriptTemplate {
-    lock: (...params: unknown[]) => LockingScript | Promise<LockingScript>;
-    unlock: (...params: unknown[]) => {
-        sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
-        estimateLength: (tx: Transaction, inputIndex: number) => Promise<number>;
-    };
+    lock: (...params: any[]) => LockingScript | Promise<LockingScript>;
+    unlock: (...params: any[]) => ScriptTemplateUnlock;
 }
 ```
 
-See also: [LockingScript](./script.md#class-lockingscript), [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign)
+See also: [LockingScript](./script.md#class-lockingscript), [ScriptTemplateUnlock](./script.md#interface-scripttemplateunlock)
 
 <details>
 
@@ -50,7 +48,7 @@ See also: [LockingScript](./script.md#class-lockingscript), [Transaction](./tran
 Creates a locking script with the given parameters.
 
 ```ts
-lock: (...params: unknown[]) => LockingScript | Promise<LockingScript>
+lock: (...params: any[]) => LockingScript | Promise<LockingScript>
 ```
 See also: [LockingScript](./script.md#class-lockingscript)
 
@@ -63,14 +61,25 @@ This method returns an object containing two functions:
 2. `estimateLength` - A function that returns the estimated length of the unlocking script in bytes.
 
 ```ts
-unlock: (...params: unknown[]) => {
+unlock: (...params: any[]) => ScriptTemplateUnlock
+```
+See also: [ScriptTemplateUnlock](./script.md#interface-scripttemplateunlock)
+
+</details>
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
+### Interface: ScriptTemplateUnlock
+
+```ts
+export default interface ScriptTemplateUnlock {
     sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
     estimateLength: (tx: Transaction, inputIndex: number) => Promise<number>;
 }
 ```
-See also: [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign)
 
-</details>
+See also: [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/sdk",
-  "version": "1.3.15",
+  "version": "1.3.16",
   "type": "module",
   "description": "BSV Blockchain Software Development Kit",
   "main": "dist/cjs/mod.js",
@@ -239,6 +239,7 @@
     "project": "tsconfig.eslint.json",
     "ignore": [
       "dist",
+      "src/script/ScriptTemplate.ts",
       "src/transaction/Transaction.ts",
       "src/auth/transports/SimplifiedFetchTransport.ts"
     ]

src/script/ScriptTemplate.ts

@@ -1,6 +1,5 @@
 import LockingScript from './LockingScript.js'
-import UnlockingScript from './UnlockingScript.js'
-import Transaction from '../transaction/Transaction.js'
+import ScriptTemplateUnlock from './ScriptTemplateUnlock.js'
 
 /**
  * @interface
@@ -12,10 +11,10 @@ export default interface ScriptTemplate {
   /**
    * Creates a locking script with the given parameters.
    *
-   * @param {...any} params - The parameters required to create the locking script.
+   * @param {...any[]} params - The parameters required to create the locking script.
    * @returns {LockingScript} - An instance of LockingScript, or a Promise for one.
    */
-  lock: (...params: unknown[]) => LockingScript | Promise<LockingScript>
+  lock: (...params: any[]) => LockingScript | Promise<LockingScript>
 
   /**
    * Creates a function that generates an unlocking script along with its signature and length estimation.
@@ -24,11 +23,8 @@ export default interface ScriptTemplate {
    * 1. `sign` - A function that, when called with a transaction and an input index, returns an UnlockingScript instance.
    * 2. `estimateLength` - A function that returns the estimated length of the unlocking script in bytes.
    *
-   * @param {...any} params - The parameters required to create the unlocking script.
-   * @returns {Object} - An object containing the `sign` and `estimateLength` functions.
+   * @param {...any[]} params - The parameters required to create the unlocking script.
+   * @returns {ScriptTemplateUnlock} - An object containing the `sign` and `estimateLength` functions.
    */
-  unlock: (...params: unknown[]) => {
-    sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>
-    estimateLength: (tx: Transaction, inputIndex: number) => Promise<number>
-  }
+  unlock: (...params: any[]) => ScriptTemplateUnlock
 }

src/script/ScriptTemplateUnlock.ts

@@ -0,0 +1,7 @@
+import UnlockingScript from './UnlockingScript.js'
+import Transaction from '../transaction/Transaction.js'
+
+export default interface ScriptTemplateUnlock {
+  sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>
+  estimateLength: (tx: Transaction, inputIndex: number) => Promise<number>
+}

src/script/index.ts

@@ -3,5 +3,6 @@ export { default as Script } from './Script.js'
 export { default as LockingScript } from './LockingScript.js'
 export { default as UnlockingScript } from './UnlockingScript.js'
 export { default as Spend } from './Spend.js'
+export type { default as ScriptTemplateUnlock } from './ScriptTemplateUnlock.js'
 export type { default as ScriptTemplate } from './ScriptTemplate.js'
 export * from './templates/index.js'