@bsv/sdk 2.0.8 → 2.0.10

package/docs/reference/script.md

@@ -6,6 +6,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 | |
 | --- |
+| [FormatPreimageParams](#interface-formatpreimageparams) |
 | [ScriptChunk](#interface-scriptchunk) |
 | [ScriptTemplate](#interface-scripttemplate) |
 | [ScriptTemplateUnlock](#interface-scripttemplateunlock) |
@@ -14,6 +15,28 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 ---
 
+### Interface: FormatPreimageParams
+
+Parameters for formatting the transaction preimage
+
+```ts
+export interface FormatPreimageParams {
+    tx: Transaction;
+    inputIndex: number;
+    signatureScope: number;
+    sourceTXID: string;
+    sourceSatoshis: number;
+    lockingScript: Script;
+    otherInputs: Transaction["inputs"];
+    inputSequence?: number;
+}
+```
+
+See also: [Script](./script.md#class-script), [Transaction](./transaction.md#class-transaction)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
 ### Interface: ScriptChunk
 
 A representation of a chunk of a script, which includes an opcode. For push operations, the associated data to push onto the stack is also included.
@@ -942,6 +965,59 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 ---
 ## Functions
 
+| |
+| --- |
+| [computeSignatureScope](#function-computesignaturescope) |
+| [formatPreimage](#function-formatpreimage) |
+| [resolveSourceDetails](#function-resolvesourcedetails) |
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
+
+### Function: computeSignatureScope
+
+Computes the signature scope flags from the given signing parameters.
+
+```ts
+export function computeSignatureScope(signOutputs: "all" | "none" | "single", anyoneCanPay: boolean): number 
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
+### Function: formatPreimage
+
+Formats the transaction preimage for signing.
+
+```ts
+export function formatPreimage(params: FormatPreimageParams): number[] 
+```
+
+See also: [FormatPreimageParams](./script.md#interface-formatpreimageparams)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
+### Function: resolveSourceDetails
+
+Resolves and validates the source transaction details needed for signing.
+Returns the resolved sourceTXID, sourceSatoshis, lockingScript, and otherInputs.
+
+```ts
+export function resolveSourceDetails(tx: Transaction, inputIndex: number, providedSourceSatoshis?: number, providedLockingScript?: Script): {
+    sourceTXID: string;
+    sourceSatoshis: number;
+    lockingScript: Script;
+    otherInputs: typeof tx.inputs;
+} 
+```
+
+See also: [Script](./script.md#class-script), [Transaction](./transaction.md#class-transaction)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
 ## Types
 
 ## Enums

package/docs/reference/transaction.md

@@ -6,14 +6,15 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 | | |
 | --- | --- |
-| [ArcConfig](#interface-arcconfig) | [HttpClientRequestOptions](#interface-httpclientrequestoptions) |
+| [ArcConfig](#interface-arcconfig) | [HttpsModuleLike](#interface-httpsmodulelike) |
 | [BroadcastFailure](#interface-broadcastfailure) | [HttpsNodejs](#interface-httpsnodejs) |
 | [BroadcastResponse](#interface-broadcastresponse) | [MerklePathLeaf](#interface-merklepathleaf) |
 | [Broadcaster](#interface-broadcaster) | [NodejsHttpClientRequest](#interface-nodejshttpclientrequest) |
-| [ChainTracker](#interface-chaintracker) | [TransactionInput](#interface-transactioninput) |
-| [FeeModel](#interface-feemodel) | [TransactionOutput](#interface-transactionoutput) |
-| [FetchOptions](#interface-fetchoptions) | [WhatsOnChainConfig](#interface-whatsonchainconfig) |
-| [HttpClient](#interface-httpclient) |  |
+| [ChainTracker](#interface-chaintracker) | [NodejsRequestLike](#interface-nodejsrequestlike) |
+| [FeeModel](#interface-feemodel) | [TransactionInput](#interface-transactioninput) |
+| [FetchOptions](#interface-fetchoptions) | [TransactionOutput](#interface-transactionoutput) |
+| [HttpClient](#interface-httpclient) | [WhatsOnChainConfig](#interface-whatsonchainconfig) |
+| [HttpClientRequestOptions](#interface-httpclientrequestoptions) |  |
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -297,6 +298,21 @@ signal?: AbortSignal
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
+---
+### Interface: HttpsModuleLike
+
+Common interface for Node.js https modules
+
+```ts
+export interface HttpsModuleLike {
+    request: (url: string, options: HttpClientRequestOptions, callback: (res: any) => void) => NodejsRequestLike;
+}
+```
+
+See also: [HttpClientRequestOptions](./transaction.md#interface-httpclientrequestoptions), [NodejsRequestLike](./transaction.md#interface-nodejsrequestlike)
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
 ---
 ### Interface: HttpsNodejs
 
@@ -335,7 +351,22 @@ Nodejs result of the Node https.request call limited to options needed by ts-sdk
 export interface NodejsHttpClientRequest {
     write: (chunk: string) => void;
     on: (event: string, callback: (data: any) => void) => void;
-    end: (() => void) & (() => void);
+    end: () => void;
+}
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
+---
+### Interface: NodejsRequestLike
+
+Common interface for Node.js https module request objects
+
+```ts
+export interface NodejsRequestLike {
+    write: (chunk: any) => void;
+    on: (event: string, callback: (data: any) => void) => void;
+    end: () => void;
 }
 ```
 
@@ -1673,10 +1704,11 @@ export default class Transaction {
     toAtomicBEEF(allowPartial?: boolean): number[] 
     toAtomicBEEFUint8Array(allowPartial?: boolean): Uint8Array 
     async completeWithWallet(wallet: WalletInterface, actionDescription?: DescriptionString5to50Bytes, originator?: string, options?: CreateActionOptions): Promise<void> 
+    preimage(inputIndex?: number, signatureScope?: number, subscript?: LockingScript): number[] 
 }
 ```
 
-See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Broadcaster](./transaction.md#interface-broadcaster), [ChainTracker](./transaction.md#interface-chaintracker), [CreateActionOptions](./wallet.md#interface-createactionoptions), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [FeeModel](./transaction.md#interface-feemodel), [LivePolicy](./transaction.md#class-livepolicy), [MerklePath](./transaction.md#class-merklepath), [Reader](./primitives.md#class-reader), [ReaderUint8Array](./primitives.md#class-readeruint8array), [TransactionInput](./transaction.md#interface-transactioninput), [TransactionOutput](./transaction.md#interface-transactionoutput), [WalletInterface](./wallet.md#interface-walletinterface), [Writer](./primitives.md#class-writer), [WriterUint8Array](./primitives.md#class-writeruint8array), [defaultBroadcaster](./transaction.md#function-defaultbroadcaster), [defaultChainTracker](./transaction.md#function-defaultchaintracker), [sign](./compat.md#variable-sign), [toHex](./primitives.md#variable-tohex), [toUint8Array](./primitives.md#variable-touint8array), [verify](./compat.md#variable-verify)
+See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Broadcaster](./transaction.md#interface-broadcaster), [ChainTracker](./transaction.md#interface-chaintracker), [CreateActionOptions](./wallet.md#interface-createactionoptions), [DescriptionString5to50Bytes](./wallet.md#type-descriptionstring5to50bytes), [FeeModel](./transaction.md#interface-feemodel), [LivePolicy](./transaction.md#class-livepolicy), [LockingScript](./script.md#class-lockingscript), [MerklePath](./transaction.md#class-merklepath), [Reader](./primitives.md#class-reader), [ReaderUint8Array](./primitives.md#class-readeruint8array), [TransactionInput](./transaction.md#interface-transactioninput), [TransactionOutput](./transaction.md#interface-transactionoutput), [WalletInterface](./wallet.md#interface-walletinterface), [Writer](./primitives.md#class-writer), [WriterUint8Array](./primitives.md#class-writeruint8array), [defaultBroadcaster](./transaction.md#function-defaultbroadcaster), [defaultChainTracker](./transaction.md#function-defaultchaintracker), [sign](./compat.md#variable-sign), [toHex](./primitives.md#variable-tohex), [toUint8Array](./primitives.md#variable-touint8array), [verify](./compat.md#variable-verify)
 
 #### Method addInput
 
@@ -2033,6 +2065,28 @@ Argument Details
 + **bin**
   + binary transaction data
 
+#### Method preimage
+
+Returns the formatted preimage of a transaction for the requested input index, signature scope (default SIGHASH_FORKID | SIGHASH_ALL), and optional subscript.
+
+```ts
+preimage(inputIndex?: number, signatureScope?: number, subscript?: LockingScript): number[] 
+```
+See also: [LockingScript](./script.md#class-lockingscript)
+
+Returns
+
+The formatted preimage
+
+Argument Details
+
++ **inputIndex**
+  + The index of the input to generate the preimage for
++ **signatureScope**
+  + The signature scope to use for the preimage
++ **subscript**
+  + The subscript to use for the preimage (optional)
+
 #### Method sign
 
 Signs a transaction, hydrating all its unlocking scripts based on the provided script templates where they are available.
@@ -2328,6 +2382,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 | [defaultBroadcaster](#function-defaultbroadcaster) |
 | [defaultChainTracker](#function-defaultchaintracker) |
 | [defaultHttpClient](#function-defaulthttpclient) |
+| [executeNodejsRequest](#function-executenodejsrequest) |
 | [isBroadcastFailure](#function-isbroadcastfailure) |
 | [isBroadcastResponse](#function-isbroadcastresponse) |
 
@@ -2371,6 +2426,31 @@ See also: [HttpClient](./transaction.md#interface-httpclient)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
+---
+### Function: executeNodejsRequest
+
+Shared implementation for handling Node.js HTTP requests.
+Used by both NodejsHttpClient and BinaryNodejsHttpClient.
+
+```ts
+export function executeNodejsRequest(https: HttpsModuleLike, url: string, requestOptions: HttpClientRequestOptions, serializeData: (data: any) => any): Promise<HttpClientResponse> 
+```
+
+See also: [HttpClientRequestOptions](./transaction.md#interface-httpclientrequestoptions), [HttpClientResponse](./transaction.md#type-httpclientresponse), [HttpsModuleLike](./transaction.md#interface-httpsmodulelike)
+
+Argument Details
+
++ **https**
+  + The Node.js https module (or compatible)
++ **url**
+  + The URL to make the request to
++ **requestOptions**
+  + The request configuration
++ **serializeData**
+  + Function to serialize the request data for writing
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
+
 ---
 ### Function: isBroadcastFailure