@bsv/sdk 1.6.14 → 1.6.15

package/docs/reference/script.md

@@ -28,7 +28,6 @@ export default interface ScriptChunk {
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Interface: ScriptTemplate
 
 ```ts
@@ -47,7 +46,6 @@ Creates a locking script with the given parameters.
 ```ts
 lock: (...params: any[]) => LockingScript | Promise<LockingScript>
 ```
-
 See also: [LockingScript](./script.md#class-lockingscript)
 
 #### Property unlock
@@ -55,20 +53,17 @@ See also: [LockingScript](./script.md#class-lockingscript)
 Creates a function that generates an unlocking script along with its signature and length estimation.
 
 This method returns an object containing two functions:
-
 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.
 
 ```ts
 unlock: (...params: any[]) => ScriptTemplateUnlock
 ```
-
 See also: [ScriptTemplateUnlock](./script.md#interface-scripttemplateunlock)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Interface: ScriptTemplateUnlock
 
 ```ts
@@ -83,7 +78,6 @@ See also: [Transaction](./transaction.md#class-transaction), [UnlockingScript](.
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ## Classes
 
 | |
@@ -139,7 +133,6 @@ Always returns false for a LockingScript instance.
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Class: P2PKH
 
 P2PKH (Pay To Public Key Hash) class implementing ScriptTemplate.
@@ -165,7 +158,6 @@ Creates a P2PKH locking script for a given public key hash or address string
 ```ts
 lock(pubkeyhash: string | number[]): LockingScript 
 ```
-
 See also: [LockingScript](./script.md#class-lockingscript)
 
 Returns
@@ -174,15 +166,14 @@ Returns
 
 Argument Details
 
-- **pubkeyhash**
-    - or address - An array or address representing the public key hash.
++ **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.
@@ -193,7 +184,6 @@ unlock(privateKey: PrivateKey, signOutputs: "all" | "none" | "single" = "all", a
     estimateLength: () => Promise<108>;
 } 
 ```
-
 See also: [PrivateKey](./primitives.md#class-privatekey), [Script](./script.md#class-script), [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign)
 
 Returns
@@ -202,21 +192,20 @@ Returns
 
 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.
++ **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.
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Class: PushDrop
 
 ```ts
@@ -251,15 +240,14 @@ Constructs a new instance of the PushDrop class.
 ```ts
 constructor(wallet: WalletInterface, originator?: string) 
 ```
-
 See also: [WalletInterface](./wallet.md#interface-walletinterface)
 
 Argument Details
 
-- **wallet**
-    - The wallet interface used for creating signatures and accessing public keys.
-- **originator**
-    - — The originator to use with Wallet requests
++ **wallet**
+  + The wallet interface used for creating signatures and accessing public keys.
++ **originator**
+  + — The originator to use with Wallet requests
 
 #### Method decode
 
@@ -272,7 +260,6 @@ static decode(script: LockingScript): {
     fields: number[][];
 } 
 ```
-
 See also: [LockingScript](./script.md#class-lockingscript), [PublicKey](./primitives.md#class-publickey)
 
 Returns
@@ -281,8 +268,8 @@ An object containing PushDrop token fields and the locking public key. If a sign
 
 Argument Details
 
-- **script**
-    - PushDrop script to decode back into token fields
++ **script**
+  + PushDrop script to decode back into token fields
 
 #### Method lock
 
@@ -294,7 +281,6 @@ async lock(fields: number[][], protocolID: [
     string
 ], keyID: string, counterparty: string, forSelf = false, includeSignature = true, lockPosition: "before" | "after" = "before"): Promise<LockingScript> 
 ```
-
 See also: [LockingScript](./script.md#class-lockingscript), [SecurityLevel](./wallet.md#type-securitylevel)
 
 Returns
@@ -303,18 +289,18 @@ 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).
++ **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
 
@@ -329,7 +315,6 @@ unlock(protocolID: [
     estimateLength: () => Promise<73>;
 } 
 ```
-
 See also: [LockingScript](./script.md#class-lockingscript), [SecurityLevel](./wallet.md#type-securitylevel), [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign)
 
 Returns
@@ -338,27 +323,26 @@ An object containing functions to sign the transaction and estimate the script l
 
 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.
++ **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.
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Class: RPuzzle
 
 RPuzzle class implementing ScriptTemplate.
@@ -387,8 +371,8 @@ constructor(type: "raw" | "SHA1" | "SHA256" | "HASH256" | "RIPEMD160" | "HASH160
 
 Argument Details
 
-- **type**
-    - Denotes the type of puzzle to create
++ **type**
+  + Denotes the type of puzzle to create
 
 #### Method lock
 
@@ -397,7 +381,6 @@ Creates an R puzzle locking script for a given R value or R value hash.
 ```ts
 lock(value: number[]): LockingScript 
 ```
-
 See also: [LockingScript](./script.md#class-lockingscript)
 
 Returns
@@ -406,15 +389,14 @@ Returns
 
 Argument Details
 
-- **value**
-    - An array representing the R value or its hash.
++ **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.
@@ -425,7 +407,6 @@ unlock(k: BigNumber, privateKey: PrivateKey, signOutputs: "all" | "none" | "sing
     estimateLength: () => Promise<108>;
 } 
 ```
-
 See also: [BigNumber](./primitives.md#class-bignumber), [PrivateKey](./primitives.md#class-privatekey), [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign)
 
 Returns
@@ -434,19 +415,18 @@ Returns
 
 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.
++ **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.
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Class: Script
 
 The Script class represents a script in a Bitcoin SV transaction,
@@ -484,13 +464,12 @@ See also: [BigNumber](./primitives.md#class-bignumber), [ScriptChunk](./script.m
 ```ts
 constructor(chunks: ScriptChunk[] = []) 
 ```
-
 See also: [ScriptChunk](./script.md#interface-scriptchunk)
 
 Argument Details
 
-- **chunks**
-    - =[] - An array of script chunks to directly initialize the script.
++ **chunks**
+  + =[] - An array of script chunks to directly initialize the script.
 
 #### Method findAndDelete
 
@@ -499,7 +478,6 @@ Deletes the given item wherever it appears in the current script.
 ```ts
 findAndDelete(script: Script): Script 
 ```
-
 See also: [Script](./script.md#class-script)
 
 Returns
@@ -508,15 +486,14 @@ This script instance for chaining.
 
 Argument Details
 
-- **script**
-    - The script containing the item to delete from the current script.
++ **script**
+  + The script containing the item to delete from the current script.
 
 #### Method fromASM
 
 ```ts
 static fromASM(asm: string): Script 
 ```
-
 See also: [Script](./script.md#class-script)
 
 Returns
@@ -525,8 +502,8 @@ A new Script instance.
 
 Argument Details
 
-- **asm**
-    - The script in ASM string format.
++ **asm**
+  + The script in ASM string format.
 
 Example
 
@@ -539,7 +516,6 @@ const script = Script.fromASM("OP_DUP OP_HASH160 abcd... OP_EQUALVERIFY OP_CHECK
 ```ts
 static fromBinary(bin: number[]): Script 
 ```
-
 See also: [Script](./script.md#class-script)
 
 Returns
@@ -548,8 +524,8 @@ A new Script instance.
 
 Argument Details
 
-- **bin**
-    - The script in binary array format.
++ **bin**
+  + The script in binary array format.
 
 Example
 
@@ -562,7 +538,6 @@ const script = Script.fromBinary([0x76, 0xa9, ...])
 ```ts
 static fromHex(hex: string): Script 
 ```
-
 See also: [Script](./script.md#class-script)
 
 Returns
@@ -571,8 +546,8 @@ A new Script instance.
 
 Argument Details
 
-- **hex**
-    - The script in hexadecimal format.
++ **hex**
+  + The script in hexadecimal format.
 
 Example
 
@@ -615,7 +590,6 @@ True if the script is an unlocking script, otherwise false.
 ```ts
 removeCodeseparators(): Script 
 ```
-
 See also: [Script](./script.md#class-script)
 
 Returns
@@ -627,7 +601,6 @@ This script instance for chaining.
 ```ts
 setChunkOpCode(i: number, op: number): Script 
 ```
-
 See also: [Script](./script.md#class-script)
 
 Returns
@@ -636,10 +609,10 @@ This script instance for chaining.
 
 Argument Details
 
-- **i**
-    - The index of the chunk.
-- **op**
-    - The opcode to set.
++ **i**
+  + The index of the chunk.
++ **op**
+  + The opcode to set.
 
 #### Method toASM
 
@@ -676,7 +649,6 @@ The script in hexadecimal format.
 ```ts
 writeBin(bin: number[]): Script 
 ```
-
 See also: [Script](./script.md#class-script)
 
 Returns
@@ -685,8 +657,8 @@ This script instance for chaining.
 
 Argument Details
 
-- **bin**
-    - The binary data to append.
++ **bin**
+  + The binary data to append.
 
 Throws
 
@@ -697,7 +669,6 @@ Throws an error if the data is too large to be pushed.
 ```ts
 writeBn(bn: BigNumber): Script 
 ```
-
 See also: [BigNumber](./primitives.md#class-bignumber), [Script](./script.md#class-script)
 
 Returns
@@ -706,15 +677,14 @@ This script instance for chaining.
 
 Argument Details
 
-- **bn**
-    - The BigNumber to append.
++ **bn**
+  + The BigNumber to append.
 
 #### Method writeNumber
 
 ```ts
 writeNumber(num: number): Script 
 ```
-
 See also: [Script](./script.md#class-script)
 
 Returns
@@ -723,15 +693,14 @@ This script instance for chaining.
 
 Argument Details
 
-- **num**
-    - The number to append.
++ **num**
+  + The number to append.
 
 #### Method writeOpCode
 
 ```ts
 writeOpCode(op: number): Script 
 ```
-
 See also: [Script](./script.md#class-script)
 
 Returns
@@ -740,15 +709,14 @@ This script instance for chaining.
 
 Argument Details
 
-- **op**
-    - The opcode to append.
++ **op**
+  + The opcode to append.
 
 #### Method writeScript
 
 ```ts
 writeScript(script: Script): Script 
 ```
-
 See also: [Script](./script.md#class-script)
 
 Returns
@@ -757,13 +725,12 @@ This script instance for chaining.
 
 Argument Details
 
-- **script**
-    - The script to append.
++ **script**
+  + The script to append.
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Class: Spend
 
 The Spend class represents a spend action within a Bitcoin SV transaction.
@@ -832,35 +799,34 @@ constructor(params: {
     memoryLimit?: number;
 }) 
 ```
-
 See also: [LockingScript](./script.md#class-lockingscript), [TransactionInput](./transaction.md#interface-transactioninput), [TransactionOutput](./transaction.md#interface-transactionoutput), [UnlockingScript](./script.md#class-unlockingscript)
 
 Argument Details
 
-- **params.sourceTXID**
-    - The transaction ID of the source UTXO.
-- **params.sourceOutputIndex**
-    - The index of the output in the source transaction.
-- **params.sourceSatoshis**
-    - The amount of satoshis in the source UTXO.
-- **params.lockingScript**
-    - The locking script associated with the UTXO.
-- **params.transactionVersion**
-    - The version of the current transaction.
-- **params.otherInputs**
-        - -
++ **params.sourceTXID**
+  + The transaction ID of the source UTXO.
++ **params.sourceOutputIndex**
+  + The index of the output in the source transaction.
++ **params.sourceSatoshis**
+  + The amount of satoshis in the source UTXO.
++ **params.lockingScript**
+  + The locking script associated with the UTXO.
++ **params.transactionVersion**
+  + The version of the current transaction.
++ **params.otherInputs**
+  + -
 An array of other inputs in the transaction.
-- **params.outputs**
-        - -
++ **params.outputs**
+  + -
 The outputs of the current transaction.
-- **params.inputIndex**
-    - The index of this input in the current transaction.
-- **params.unlockingScript**
-    - The unlocking script for this spend.
-- **params.inputSequence**
-    - The sequence number of this input.
-- **params.lockTime**
-    - The lock time of the transaction.
++ **params.inputIndex**
+  + The index of this input in the current transaction.
++ **params.unlockingScript**
+  + The unlocking script for this spend.
++ **params.inputSequence**
+  + The sequence number of this input.
++ **params.lockTime**
+  + The lock time of the transaction.
 
 Example
 
@@ -903,7 +869,6 @@ if (spend.validate()) {
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Class: UnlockingScript
 
 The UnlockingScript class represents an unlocking script in a Bitcoin SV transaction.
@@ -943,7 +908,6 @@ Always returns true for an UnlockingScript instance.
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ## Functions
 
 ## Types
@@ -951,3 +915,4 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 ## Enums
 
 ## Variables
+