@bsv/sdk 1.2.1 → 1.2.2

package/docs/script.md

@@ -39,6 +39,8 @@ export default interface ScriptTemplate {
 }
 ```
 
+See also: [LockingScript](#class-lockingscript), [Transaction](#class-transaction), [UnlockingScript](#class-unlockingscript), [sign](#variable-sign)
+
 <details>
 
 <summary>Interface ScriptTemplate Details</summary>
@@ -50,6 +52,7 @@ Creates a locking script with the given parameters.
 ```ts
 lock: (...params: any) => LockingScript | Promise<LockingScript>
 ```
+See also: [LockingScript](#class-lockingscript)
 
 #### Property unlock
 
@@ -65,6 +68,7 @@ unlock: (...params: any) => {
     estimateLength: (tx: Transaction, inputIndex: number) => Promise<number>;
 }
 ```
+See also: [Transaction](#class-transaction), [UnlockingScript](#class-unlockingscript), [sign](#variable-sign)
 
 </details>
 
@@ -87,362 +91,491 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 ---
 
-### Class: Script
+### Class: LockingScript
 
-The Script class represents a script in a Bitcoin SV transaction,
-encapsulating the functionality to construct, parse, and serialize
-scripts used in both locking (output) and unlocking (input) scripts.
+The LockingScript class represents a locking script in a Bitcoin SV transaction.
+It extends the Script class and is used specifically for output scripts that lock funds.
+
+Inherits all properties and methods from the Script class.
 
 ```ts
-export default class Script {
-    chunks: ScriptChunk[];
-    static fromASM(asm: string): Script 
-    static fromHex(hex: string): Script 
-    static fromBinary(bin: number[]): Script 
-    constructor(chunks: ScriptChunk[] = []) 
-    toASM(): string 
-    toHex(): string 
-    toBinary(): number[] 
-    writeScript(script: Script): Script 
-    writeOpCode(op: number): Script 
-    setChunkOpCode(i: number, op: number): Script 
-    writeBn(bn: BigNumber): Script 
-    writeBin(bin: number[]): Script 
-    writeNumber(num: number): Script 
-    removeCodeseparators(): Script 
-    findAndDelete(script: Script): Script 
-    isPushOnly(): boolean 
+export default class LockingScript extends Script {
     isLockingScript(): boolean 
     isUnlockingScript(): boolean 
 }
 ```
 
+See also: [Script](#class-script)
+
 <details>
 
-<summary>Class Script Details</summary>
+<summary>Class LockingScript Details</summary>
 
-#### Constructor
+#### Method isLockingScript
 
 ```ts
-constructor(chunks: ScriptChunk[] = []) 
+isLockingScript(): boolean 
 ```
 
-Argument Details
-
-+ **chunks**
-  + =[] - An array of script chunks to directly initialize the script.
+Returns
 
-#### Method findAndDelete
+Always returns true for a LockingScript instance.
 
-Deletes the given item wherever it appears in the current script.
+#### Method isUnlockingScript
 
 ```ts
-findAndDelete(script: Script): Script 
+isUnlockingScript(): boolean 
 ```
 
 Returns
 
-This script instance for chaining.
+Always returns false for a LockingScript instance.
 
-Argument Details
+</details>
 
-+ **script**
-  + The script containing the item to delete from the current script.
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
-#### Method fromASM
+---
+### Class: P2PKH
 
-```ts
-static fromASM(asm: string): Script 
-```
+P2PKH (Pay To Public Key Hash) class implementing ScriptTemplate.
 
-Returns
+This class provides methods to create Pay To Public Key Hash locking and unlocking scripts, including the unlocking of P2PKH UTXOs with the private key.
 
-A new Script instance.
+```ts
+export default class P2PKH implements ScriptTemplate {
+    lock(pubkeyhash: string | number[]): LockingScript 
+    unlock(privateKey: PrivateKey, signOutputs: "all" | "none" | "single" = "all", anyoneCanPay: boolean = false, sourceSatoshis?: number, lockingScript?: Script): {
+        sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
+        estimateLength: () => Promise<108>;
+    } 
+}
+```
 
-Argument Details
+See also: [LockingScript](#class-lockingscript), [PrivateKey](#class-privatekey), [Script](#class-script), [ScriptTemplate](#interface-scripttemplate), [Transaction](#class-transaction), [UnlockingScript](#class-unlockingscript), [sign](#variable-sign)
 
-+ **asm**
-  + The script in ASM string format.
+<details>
 
-Example
+<summary>Class P2PKH Details</summary>
 
-```ts
-const script = Script.fromASM("OP_DUP OP_HASH160 abcd... OP_EQUALVERIFY OP_CHECKSIG")
-```
+#### Method lock
 
-#### Method fromBinary
+Creates a P2PKH locking script for a given public key hash or address string
 
 ```ts
-static fromBinary(bin: number[]): Script 
+lock(pubkeyhash: string | number[]): LockingScript 
 ```
+See also: [LockingScript](#class-lockingscript)
 
 Returns
 
-A new Script instance.
+- A P2PKH locking script.
 
 Argument Details
 
-+ **bin**
-  + The script in binary array format.
++ **pubkeyhash**
+  + or address - An array or address representing the public key hash.
 
-Example
+#### Method unlock
 
-```ts
-const script = Script.fromBinary([0x76, 0xa9, ...])
-```
+Creates a function that generates a P2PKH unlocking script along with its signature and length estimation.
 
-#### Method fromHex
+The returned object contains:
+1. `sign` - A function that, when invoked with a transaction and an input index,
+   produces an unlocking script suitable for a P2PKH locked output.
+2. `estimateLength` - A function that returns the estimated length of the unlocking script in bytes.
 
 ```ts
-static fromHex(hex: string): Script 
+unlock(privateKey: PrivateKey, signOutputs: "all" | "none" | "single" = "all", anyoneCanPay: boolean = false, sourceSatoshis?: number, lockingScript?: Script): {
+    sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
+    estimateLength: () => Promise<108>;
+} 
 ```
+See also: [PrivateKey](#class-privatekey), [Script](#class-script), [Transaction](#class-transaction), [UnlockingScript](#class-unlockingscript), [sign](#variable-sign)
 
 Returns
 
-A new Script instance.
+- An object containing the `sign` and `estimateLength` functions.
 
 Argument Details
 
-+ **hex**
-  + The script in hexadecimal format.
++ **privateKey**
+  + The private key used for signing the transaction.
++ **signOutputs**
+  + The signature scope for outputs.
++ **anyoneCanPay**
+  + Flag indicating if the signature allows for other inputs to be added later.
++ **sourceSatoshis**
+  + Optional. The amount being unlocked. Otherwise the input.sourceTransaction is required.
++ **lockingScript**
+  + Optional. The lockinScript. Otherwise the input.sourceTransaction is required.
 
-Example
+</details>
 
-```ts
-const script = Script.fromHex("76a9...");
-```
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
-#### Method isLockingScript
+---
+### Class: PushDrop
 
 ```ts
-isLockingScript(): boolean 
+export default class PushDrop implements ScriptTemplate {
+    wallet: Wallet;
+    static decode(script: LockingScript): {
+        lockingPublicKey: PublicKey;
+        fields: number[][];
+    } 
+    constructor(wallet: Wallet) 
+    async lock(fields: number[][], protocolID: [
+        0 | 1 | 2,
+        string
+    ], keyID: string, counterparty: string, forSelf = false, includeSignature = true, lockPosition: "before" | "after" = "before"): Promise<LockingScript> 
+    unlock(protocolID: [
+        0 | 1 | 2,
+        string
+    ], keyID: string, counterparty: string, signOutputs: "all" | "none" | "single" = "all", anyoneCanPay = false, sourceSatoshis?: number, lockingScript?: LockingScript): {
+        sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
+        estimateLength: () => Promise<73>;
+    } 
+}
 ```
 
-Returns
-
-True if the script is a locking script, otherwise false.
-
-#### Method isPushOnly
+See also: [LockingScript](#class-lockingscript), [PublicKey](#class-publickey), [ScriptTemplate](#interface-scripttemplate), [Transaction](#class-transaction), [UnlockingScript](#class-unlockingscript), [Wallet](#interface-wallet), [sign](#variable-sign)
 
-```ts
-isPushOnly(): boolean 
-```
+<details>
 
-Returns
+<summary>Class PushDrop Details</summary>
 
-True if the script is push-only, otherwise false.
+#### Constructor
 
-#### Method isUnlockingScript
+Constructs a new instance of the PushDrop class.
 
 ```ts
-isUnlockingScript(): boolean 
+constructor(wallet: Wallet) 
 ```
+See also: [Wallet](#interface-wallet)
 
-Returns
-
-True if the script is an unlocking script, otherwise false.
-
-#### Method removeCodeseparators
-
-```ts
-removeCodeseparators(): Script 
-```
+Argument Details
 
-Returns
++ **wallet**
+  + The wallet interface used for creating signatures and accessing public keys.
 
-This script instance for chaining.
+#### Method decode
 
-#### Method setChunkOpCode
+Decodes a PushDrop script back into its token fields and the locking public key. If a signature was present, it will be the last field returned.
+Warning: Only works with a P2PK lock at the beginning of the script.
 
 ```ts
-setChunkOpCode(i: number, op: number): Script 
+static decode(script: LockingScript): {
+    lockingPublicKey: PublicKey;
+    fields: number[][];
+} 
 ```
+See also: [LockingScript](#class-lockingscript), [PublicKey](#class-publickey)
 
 Returns
 
-This script instance for chaining.
+An object containing PushDrop token fields and the locking public key. If a signature was included, it will be the last field.
 
 Argument Details
 
-+ **i**
-  + The index of the chunk.
-+ **op**
-  + The opcode to set.
-
-#### Method toASM
-
-```ts
-toASM(): string 
-```
-
-Returns
++ **script**
+  + PushDrop script to decode back into token fields
 
-The script in ASM string format.
+#### Method lock
 
-#### Method toBinary
+Creates a PushDrop locking script with arbitrary data fields and a public key lock.
 
 ```ts
-toBinary(): number[] 
+async lock(fields: number[][], protocolID: [
+    0 | 1 | 2,
+    string
+], keyID: string, counterparty: string, forSelf = false, includeSignature = true, lockPosition: "before" | "after" = "before"): Promise<LockingScript> 
 ```
+See also: [LockingScript](#class-lockingscript)
 
 Returns
 
-The script in binary array format.
-
-#### Method toHex
+The generated PushDrop locking script.
 
-```ts
-toHex(): string 
-```
+Argument Details
 
-Returns
++ **fields**
+  + The token fields to include in the locking script.
++ **protocolID**
+  + The protocol ID to use.
++ **keyID**
+  + The key ID to use.
++ **counterparty**
+  + The counterparty involved in the transaction, "self" or "anyone".
++ **forSelf**
+  + Flag indicating if the lock is for the creator (default no).
++ **includeSignature**
+  + Flag indicating if a signature should be included in the script (default yes).
 
-The script in hexadecimal format.
+#### Method unlock
 
-#### Method writeBin
+Creates an unlocking script for spending a PushDrop token output.
 
 ```ts
-writeBin(bin: number[]): Script 
+unlock(protocolID: [
+    0 | 1 | 2,
+    string
+], keyID: string, counterparty: string, signOutputs: "all" | "none" | "single" = "all", anyoneCanPay = false, sourceSatoshis?: number, lockingScript?: LockingScript): {
+    sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
+    estimateLength: () => Promise<73>;
+} 
 ```
+See also: [LockingScript](#class-lockingscript), [Transaction](#class-transaction), [UnlockingScript](#class-unlockingscript), [sign](#variable-sign)
 
 Returns
 
-This script instance for chaining.
+An object containing functions to sign the transaction and estimate the script length.
 
 Argument Details
 
-+ **bin**
-  + The binary data to append.
-
-Throws
++ **protocolID**
+  + The protocol ID to use.
++ **keyID**
+  + The key ID to use.
++ **counterparty**
+  + The counterparty involved in the transaction, "self" or "anyone".
++ **sourceTXID**
+  + The TXID of the source transaction.
++ **sourceSatoshis**
+  + The number of satoshis in the source output.
++ **lockingScript**
+  + The locking script of the source output.
++ **signOutputs**
+  + Specifies which outputs to sign.
++ **anyoneCanPay**
+  + Specifies if the anyone-can-pay flag is set.
 
-Throws an error if the data is too large to be pushed.
+</details>
 
-#### Method writeBn
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
+---
+### Class: RPuzzle
+
+RPuzzle class implementing ScriptTemplate.
+
+This class provides methods to create R Puzzle and R Puzzle Hash locking and unlocking scripts, including the unlocking of UTXOs with the correct K value.
 
 ```ts
-writeBn(bn: BigNumber): Script 
+export default class RPuzzle implements ScriptTemplate {
+    type: "raw" | "SHA1" | "SHA256" | "HASH256" | "RIPEMD160" | "HASH160" = "raw";
+    constructor(type: "raw" | "SHA1" | "SHA256" | "HASH256" | "RIPEMD160" | "HASH160" = "raw") 
+    lock(value: number[]): LockingScript 
+    unlock(k: BigNumber, privateKey: PrivateKey, signOutputs: "all" | "none" | "single" = "all", anyoneCanPay: boolean = false): {
+        sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
+        estimateLength: () => Promise<108>;
+    } 
+}
 ```
 
-Returns
-
-This script instance for chaining.
+See also: [BigNumber](#class-bignumber), [LockingScript](#class-lockingscript), [PrivateKey](#class-privatekey), [ScriptTemplate](#interface-scripttemplate), [Transaction](#class-transaction), [UnlockingScript](#class-unlockingscript), [sign](#variable-sign)
 
-Argument Details
+<details>
 
-+ **bn**
-  + The BigNumber to append.
+<summary>Class RPuzzle Details</summary>
 
-#### Method writeNumber
+#### Constructor
 
 ```ts
-writeNumber(num: number): Script 
+constructor(type: "raw" | "SHA1" | "SHA256" | "HASH256" | "RIPEMD160" | "HASH160" = "raw") 
 ```
 
-Returns
-
-This script instance for chaining.
-
 Argument Details
 
-+ **num**
-  + The number to append.
++ **type**
+  + Denotes the type of puzzle to create
 
-#### Method writeOpCode
+#### Method lock
+
+Creates an R puzzle locking script for a given R value or R value hash.
 
 ```ts
-writeOpCode(op: number): Script 
+lock(value: number[]): LockingScript 
 ```
+See also: [LockingScript](#class-lockingscript)
 
 Returns
 
-This script instance for chaining.
+- An R puzzle locking script.
 
 Argument Details
 
-+ **op**
-  + The opcode to append.
++ **value**
+  + An array representing the R value or its hash.
 
-#### Method writeScript
+#### Method unlock
+
+Creates a function that generates an R puzzle unlocking script along with its signature and length estimation.
+
+The returned object contains:
+1. `sign` - A function that, when invoked with a transaction and an input index,
+   produces an unlocking script suitable for an R puzzle locked output.
+2. `estimateLength` - A function that returns the estimated length of the unlocking script in bytes.
 
 ```ts
-writeScript(script: Script): Script 
+unlock(k: BigNumber, privateKey: PrivateKey, signOutputs: "all" | "none" | "single" = "all", anyoneCanPay: boolean = false): {
+    sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
+    estimateLength: () => Promise<108>;
+} 
 ```
+See also: [BigNumber](#class-bignumber), [PrivateKey](#class-privatekey), [Transaction](#class-transaction), [UnlockingScript](#class-unlockingscript), [sign](#variable-sign)
 
 Returns
 
-This script instance for chaining.
+- An object containing the `sign` and `estimateLength` functions.
 
 Argument Details
 
-+ **script**
-  + The script to append.
++ **k**
+  + — The K-value used to unlock the R-puzzle.
++ **privateKey**
+  + The private key used for signing the transaction. If not provided, a random key will be generated.
++ **signOutputs**
+  + The signature scope for outputs.
++ **anyoneCanPay**
+  + Flag indicating if the signature allows for other inputs to be added later.
 
 </details>
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
 ---
-### Class: LockingScript
-
-The LockingScript class represents a locking script in a Bitcoin SV transaction.
-It extends the Script class and is used specifically for output scripts that lock funds.
+### Class: Script
 
-Inherits all properties and methods from the Script class.
+The Script class represents a script in a Bitcoin SV transaction,
+encapsulating the functionality to construct, parse, and serialize
+scripts used in both locking (output) and unlocking (input) scripts.
 
 ```ts
-export default class LockingScript extends Script {
+export default class Script {
+    chunks: ScriptChunk[];
+    static fromASM(asm: string): Script 
+    static fromHex(hex: string): Script 
+    static fromBinary(bin: number[]): Script 
+    constructor(chunks: ScriptChunk[] = []) 
+    toASM(): string 
+    toHex(): string 
+    toBinary(): number[] 
+    writeScript(script: Script): Script 
+    writeOpCode(op: number): Script 
+    setChunkOpCode(i: number, op: number): Script 
+    writeBn(bn: BigNumber): Script 
+    writeBin(bin: number[]): Script 
+    writeNumber(num: number): Script 
+    removeCodeseparators(): Script 
+    findAndDelete(script: Script): Script 
+    isPushOnly(): boolean 
     isLockingScript(): boolean 
     isUnlockingScript(): boolean 
 }
 ```
 
+See also: [BigNumber](#class-bignumber), [ScriptChunk](#interface-scriptchunk), [toHex](#variable-tohex)
+
 <details>
 
-<summary>Class LockingScript Details</summary>
+<summary>Class Script Details</summary>
 
-#### Method isLockingScript
+#### Constructor
 
 ```ts
-isLockingScript(): boolean 
+constructor(chunks: ScriptChunk[] = []) 
+```
+See also: [ScriptChunk](#interface-scriptchunk)
+
+Argument Details
+
++ **chunks**
+  + =[] - An array of script chunks to directly initialize the script.
+
+#### Method findAndDelete
+
+Deletes the given item wherever it appears in the current script.
+
+```ts
+findAndDelete(script: Script): Script 
 ```
+See also: [Script](#class-script)
 
 Returns
 
-Always returns true for a LockingScript instance.
+This script instance for chaining.
 
-#### Method isUnlockingScript
+Argument Details
+
++ **script**
+  + The script containing the item to delete from the current script.
+
+#### Method fromASM
 
 ```ts
-isUnlockingScript(): boolean 
+static fromASM(asm: string): Script 
 ```
+See also: [Script](#class-script)
 
 Returns
 
-Always returns false for a LockingScript instance.
+A new Script instance.
 
-</details>
+Argument Details
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
++ **asm**
+  + The script in ASM string format.
 
----
-### Class: UnlockingScript
+Example
 
-The UnlockingScript class represents an unlocking script in a Bitcoin SV transaction.
-It extends the Script class and is used specifically for input scripts that unlock funds.
+```ts
+const script = Script.fromASM("OP_DUP OP_HASH160 abcd... OP_EQUALVERIFY OP_CHECKSIG")
+```
 
-Inherits all properties and methods from the Script class.
+#### Method fromBinary
 
 ```ts
-export default class UnlockingScript extends Script {
-    isLockingScript(): boolean 
-    isUnlockingScript(): boolean 
-}
+static fromBinary(bin: number[]): Script 
 ```
+See also: [Script](#class-script)
 
-<details>
+Returns
 
-<summary>Class UnlockingScript Details</summary>
+A new Script instance.
+
+Argument Details
+
++ **bin**
+  + The script in binary array format.
+
+Example
+
+```ts
+const script = Script.fromBinary([0x76, 0xa9, ...])
+```
+
+#### Method fromHex
+
+```ts
+static fromHex(hex: string): Script 
+```
+See also: [Script](#class-script)
+
+Returns
+
+A new Script instance.
+
+Argument Details
+
++ **hex**
+  + The script in hexadecimal format.
+
+Example
+
+```ts
+const script = Script.fromHex("76a9...");
+```
 
 #### Method isLockingScript
 
@@ -452,7 +585,17 @@ isLockingScript(): boolean
 
 Returns
 
-Always returns false for an UnlockingScript instance.
+True if the script is a locking script, otherwise false.
+
+#### Method isPushOnly
+
+```ts
+isPushOnly(): boolean 
+```
+
+Returns
+
+True if the script is push-only, otherwise false.
 
 #### Method isUnlockingScript
 
@@ -462,35 +605,178 @@ isUnlockingScript(): boolean
 
 Returns
 
-Always returns true for an UnlockingScript instance.
+True if the script is an unlocking script, otherwise false.
 
-</details>
+#### Method removeCodeseparators
 
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+```ts
+removeCodeseparators(): Script 
+```
+See also: [Script](#class-script)
 
----
-### Class: Spend
+Returns
 
-The Spend class represents a spend action within a Bitcoin SV transaction.
-It encapsulates all the necessary data required for spending a UTXO (Unspent Transaction Output)
-and includes details about the source transaction, output, and the spending transaction itself.
+This script instance for chaining.
+
+#### Method setChunkOpCode
 
 ```ts
-export default class Spend {
-    sourceTXID: string;
-    sourceOutputIndex: number;
-    sourceSatoshis: number;
-    lockingScript: LockingScript;
-    transactionVersion: number;
-    otherInputs: TransactionInput[];
-    outputs: TransactionOutput[];
-    inputIndex: number;
-    unlockingScript: UnlockingScript;
-    inputSequence: number;
-    lockTime: number;
-    context: "UnlockingScript" | "LockingScript";
-    programCounter: number;
-    lastCodeSeparator: number | null;
+setChunkOpCode(i: number, op: number): Script 
+```
+See also: [Script](#class-script)
+
+Returns
+
+This script instance for chaining.
+
+Argument Details
+
++ **i**
+  + The index of the chunk.
++ **op**
+  + The opcode to set.
+
+#### Method toASM
+
+```ts
+toASM(): string 
+```
+
+Returns
+
+The script in ASM string format.
+
+#### Method toBinary
+
+```ts
+toBinary(): number[] 
+```
+
+Returns
+
+The script in binary array format.
+
+#### Method toHex
+
+```ts
+toHex(): string 
+```
+
+Returns
+
+The script in hexadecimal format.
+
+#### Method writeBin
+
+```ts
+writeBin(bin: number[]): Script 
+```
+See also: [Script](#class-script)
+
+Returns
+
+This script instance for chaining.
+
+Argument Details
+
++ **bin**
+  + The binary data to append.
+
+Throws
+
+Throws an error if the data is too large to be pushed.
+
+#### Method writeBn
+
+```ts
+writeBn(bn: BigNumber): Script 
+```
+See also: [BigNumber](#class-bignumber), [Script](#class-script)
+
+Returns
+
+This script instance for chaining.
+
+Argument Details
+
++ **bn**
+  + The BigNumber to append.
+
+#### Method writeNumber
+
+```ts
+writeNumber(num: number): Script 
+```
+See also: [Script](#class-script)
+
+Returns
+
+This script instance for chaining.
+
+Argument Details
+
++ **num**
+  + The number to append.
+
+#### Method writeOpCode
+
+```ts
+writeOpCode(op: number): Script 
+```
+See also: [Script](#class-script)
+
+Returns
+
+This script instance for chaining.
+
+Argument Details
+
++ **op**
+  + The opcode to append.
+
+#### Method writeScript
+
+```ts
+writeScript(script: Script): Script 
+```
+See also: [Script](#class-script)
+
+Returns
+
+This script instance for chaining.
+
+Argument Details
+
++ **script**
+  + The script to append.
+
+</details>
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
+---
+### Class: Spend
+
+The Spend class represents a spend action within a Bitcoin SV transaction.
+It encapsulates all the necessary data required for spending a UTXO (Unspent Transaction Output)
+and includes details about the source transaction, output, and the spending transaction itself.
+
+```ts
+export default class Spend {
+    sourceTXID: string;
+    sourceOutputIndex: number;
+    sourceSatoshis: number;
+    lockingScript: LockingScript;
+    transactionVersion: number;
+    otherInputs: TransactionInput[];
+    outputs: TransactionOutput[];
+    inputIndex: number;
+    unlockingScript: UnlockingScript;
+    inputSequence: number;
+    lockTime: number;
+    context: "UnlockingScript" | "LockingScript";
+    programCounter: number;
+    lastCodeSeparator: number | null;
     stack: number[][];
     altStack: number[][];
     ifStack: boolean[];
@@ -513,6 +799,8 @@ export default class Spend {
 }
 ```
 
+See also: [LockingScript](#class-lockingscript), [TransactionInput](#interface-transactioninput), [TransactionOutput](#interface-transactionoutput), [UnlockingScript](#class-unlockingscript)
+
 <details>
 
 <summary>Class Spend Details</summary>
@@ -534,6 +822,7 @@ constructor(params: {
     lockTime: number;
 }) 
 ```
+See also: [LockingScript](#class-lockingscript), [TransactionInput](#interface-transactioninput), [TransactionOutput](#interface-transactionoutput), [UnlockingScript](#class-unlockingscript)
 
 Argument Details
 
@@ -604,295 +893,45 @@ if (spend.validate()) {
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
 ---
-### Class: P2PKH
-
-P2PKH (Pay To Public Key Hash) class implementing ScriptTemplate.
-
-This class provides methods to create Pay To Public Key Hash locking and unlocking scripts, including the unlocking of P2PKH UTXOs with the private key.
-
-```ts
-export default class P2PKH implements ScriptTemplate {
-    lock(pubkeyhash: string | number[]): LockingScript 
-    unlock(privateKey: PrivateKey, signOutputs: "all" | "none" | "single" = "all", anyoneCanPay: boolean = false, sourceSatoshis?: number, lockingScript?: Script): {
-        sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
-        estimateLength: () => Promise<108>;
-    } 
-}
-```
-
-<details>
-
-<summary>Class P2PKH Details</summary>
-
-#### Method lock
-
-Creates a P2PKH locking script for a given public key hash or address string
-
-```ts
-lock(pubkeyhash: string | number[]): LockingScript 
-```
-
-Returns
-
-- A P2PKH locking script.
-
-Argument Details
-
-+ **pubkeyhash**
-  + or address - An array or address representing the public key hash.
-
-#### Method unlock
-
-Creates a function that generates a P2PKH unlocking script along with its signature and length estimation.
-
-The returned object contains:
-1. `sign` - A function that, when invoked with a transaction and an input index,
-   produces an unlocking script suitable for a P2PKH locked output.
-2. `estimateLength` - A function that returns the estimated length of the unlocking script in bytes.
-
-```ts
-unlock(privateKey: PrivateKey, signOutputs: "all" | "none" | "single" = "all", anyoneCanPay: boolean = false, sourceSatoshis?: number, lockingScript?: Script): {
-    sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
-    estimateLength: () => Promise<108>;
-} 
-```
-
-Returns
-
-- An object containing the `sign` and `estimateLength` functions.
-
-Argument Details
-
-+ **privateKey**
-  + The private key used for signing the transaction.
-+ **signOutputs**
-  + The signature scope for outputs.
-+ **anyoneCanPay**
-  + Flag indicating if the signature allows for other inputs to be added later.
-+ **sourceSatoshis**
-  + Optional. The amount being unlocked. Otherwise the input.sourceTransaction is required.
-+ **lockingScript**
-  + Optional. The lockinScript. Otherwise the input.sourceTransaction is required.
-
-</details>
-
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
-
----
-### Class: RPuzzle
+### Class: UnlockingScript
 
-RPuzzle class implementing ScriptTemplate.
+The UnlockingScript class represents an unlocking script in a Bitcoin SV transaction.
+It extends the Script class and is used specifically for input scripts that unlock funds.
 
-This class provides methods to create R Puzzle and R Puzzle Hash locking and unlocking scripts, including the unlocking of UTXOs with the correct K value.
+Inherits all properties and methods from the Script class.
 
 ```ts
-export default class RPuzzle implements ScriptTemplate {
-    type: "raw" | "SHA1" | "SHA256" | "HASH256" | "RIPEMD160" | "HASH160" = "raw";
-    constructor(type: "raw" | "SHA1" | "SHA256" | "HASH256" | "RIPEMD160" | "HASH160" = "raw") 
-    lock(value: number[]): LockingScript 
-    unlock(k: BigNumber, privateKey: PrivateKey, signOutputs: "all" | "none" | "single" = "all", anyoneCanPay: boolean = false): {
-        sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
-        estimateLength: () => Promise<108>;
-    } 
+export default class UnlockingScript extends Script {
+    isLockingScript(): boolean 
+    isUnlockingScript(): boolean 
 }
 ```
 
-<details>
-
-<summary>Class RPuzzle Details</summary>
-
-#### Constructor
-
-```ts
-constructor(type: "raw" | "SHA1" | "SHA256" | "HASH256" | "RIPEMD160" | "HASH160" = "raw") 
-```
-
-Argument Details
-
-+ **type**
-  + Denotes the type of puzzle to create
-
-#### Method lock
-
-Creates an R puzzle locking script for a given R value or R value hash.
-
-```ts
-lock(value: number[]): LockingScript 
-```
-
-Returns
-
-- An R puzzle locking script.
-
-Argument Details
-
-+ **value**
-  + An array representing the R value or its hash.
-
-#### Method unlock
-
-Creates a function that generates an R puzzle unlocking script along with its signature and length estimation.
-
-The returned object contains:
-1. `sign` - A function that, when invoked with a transaction and an input index,
-   produces an unlocking script suitable for an R puzzle locked output.
-2. `estimateLength` - A function that returns the estimated length of the unlocking script in bytes.
-
-```ts
-unlock(k: BigNumber, privateKey: PrivateKey, signOutputs: "all" | "none" | "single" = "all", anyoneCanPay: boolean = false): {
-    sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
-    estimateLength: () => Promise<108>;
-} 
-```
-
-Returns
-
-- An object containing the `sign` and `estimateLength` functions.
-
-Argument Details
-
-+ **k**
-  + — The K-value used to unlock the R-puzzle.
-+ **privateKey**
-  + The private key used for signing the transaction. If not provided, a random key will be generated.
-+ **signOutputs**
-  + The signature scope for outputs.
-+ **anyoneCanPay**
-  + Flag indicating if the signature allows for other inputs to be added later.
-
-</details>
-
-Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
-
----
-### Class: PushDrop
-
-```ts
-export default class PushDrop implements ScriptTemplate {
-    wallet: Wallet;
-    static decode(script: LockingScript): {
-        lockingPublicKey: PublicKey;
-        fields: number[][];
-    } 
-    constructor(wallet: Wallet) 
-    async lock(fields: number[][], protocolID: [
-        0 | 1 | 2,
-        string
-    ], keyID: string, counterparty: string, forSelf = false, includeSignature = true, lockPosition: "before" | "after" = "before"): Promise<LockingScript> 
-    unlock(protocolID: [
-        0 | 1 | 2,
-        string
-    ], keyID: string, counterparty: string, signOutputs: "all" | "none" | "single" = "all", anyoneCanPay = false, sourceSatoshis?: number, lockingScript?: LockingScript): {
-        sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
-        estimateLength: () => Promise<73>;
-    } 
-}
-```
+See also: [Script](#class-script)
 
 <details>
 
-<summary>Class PushDrop Details</summary>
-
-#### Constructor
-
-Constructs a new instance of the PushDrop class.
-
-```ts
-constructor(wallet: Wallet) 
-```
-
-Argument Details
-
-+ **wallet**
-  + The wallet interface used for creating signatures and accessing public keys.
-
-#### Method decode
-
-Decodes a PushDrop script back into its token fields and the locking public key. If a signature was present, it will be the last field returned.
-Warning: Only works with a P2PK lock at the beginning of the script.
-
-```ts
-static decode(script: LockingScript): {
-    lockingPublicKey: PublicKey;
-    fields: number[][];
-} 
-```
-
-Returns
-
-An object containing PushDrop token fields and the locking public key. If a signature was included, it will be the last field.
-
-Argument Details
-
-+ **script**
-  + PushDrop script to decode back into token fields
-
-#### Method lock
+<summary>Class UnlockingScript Details</summary>
 
-Creates a PushDrop locking script with arbitrary data fields and a public key lock.
+#### Method isLockingScript
 
 ```ts
-async lock(fields: number[][], protocolID: [
-    0 | 1 | 2,
-    string
-], keyID: string, counterparty: string, forSelf = false, includeSignature = true, lockPosition: "before" | "after" = "before"): Promise<LockingScript> 
+isLockingScript(): boolean 
 ```
 
 Returns
 
-The generated PushDrop locking script.
-
-Argument Details
-
-+ **fields**
-  + The token fields to include in the locking script.
-+ **protocolID**
-  + The protocol ID to use.
-+ **keyID**
-  + The key ID to use.
-+ **counterparty**
-  + The counterparty involved in the transaction, "self" or "anyone".
-+ **forSelf**
-  + Flag indicating if the lock is for the creator (default no).
-+ **includeSignature**
-  + Flag indicating if a signature should be included in the script (default yes).
-
-#### Method unlock
+Always returns false for an UnlockingScript instance.
 
-Creates an unlocking script for spending a PushDrop token output.
+#### Method isUnlockingScript
 
 ```ts
-unlock(protocolID: [
-    0 | 1 | 2,
-    string
-], keyID: string, counterparty: string, signOutputs: "all" | "none" | "single" = "all", anyoneCanPay = false, sourceSatoshis?: number, lockingScript?: LockingScript): {
-    sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>;
-    estimateLength: () => Promise<73>;
-} 
+isUnlockingScript(): boolean 
 ```
 
 Returns
 
-An object containing functions to sign the transaction and estimate the script length.
-
-Argument Details
-
-+ **protocolID**
-  + The protocol ID to use.
-+ **keyID**
-  + The key ID to use.
-+ **counterparty**
-  + The counterparty involved in the transaction, "self" or "anyone".
-+ **sourceTXID**
-  + The TXID of the source transaction.
-+ **sourceSatoshis**
-  + The number of satoshis in the source output.
-+ **lockingScript**
-  + The locking script of the source output.
-+ **signOutputs**
-  + Specifies which outputs to sign.
-+ **anyoneCanPay**
-  + Specifies if the anyone-can-pay flag is set.
+Always returns true for an UnlockingScript instance.
 
 </details>