@bsv/sdk 2.0.7 → 2.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/sdk",
-  "version": "2.0.7",
+  "version": "2.0.8",
   "type": "module",
   "description": "BSV Blockchain Software Development Kit",
   "main": "dist/cjs/mod.js",

package/src/script/templates/P2PKH.ts

@@ -1,6 +1,6 @@
 import OP from '../OP.js'
 import ScriptTemplate from '../ScriptTemplate.js'
-import { fromBase58Check, verifyNotNull } from '../../primitives/utils.js'
+import { fromBase58Check } from '../../primitives/utils.js'
 import LockingScript from '../LockingScript.js'
 import UnlockingScript from '../UnlockingScript.js'
 import Transaction from '../../transaction/Transaction.js'
@@ -8,6 +8,7 @@ import PrivateKey from '../../primitives/PrivateKey.js'
 import TransactionSignature from '../../primitives/TransactionSignature.js'
 import { sha256 } from '../../primitives/Hash.js'
 import Script from '../Script.js'
+import { computeSignatureScope, resolveSourceDetails, formatPreimage } from './SignatureUtils.js'
 
 /**
  * P2PKH (Pay To Public Key Hash) class implementing ScriptTemplate.
@@ -71,65 +72,15 @@ export default class P2PKH implements ScriptTemplate {
   } {
     return {
       sign: async (tx: Transaction, inputIndex: number) => {
-        let signatureScope = TransactionSignature.SIGHASH_FORKID
-        if (signOutputs === 'all') {
-          signatureScope |= TransactionSignature.SIGHASH_ALL
-        }
-        if (signOutputs === 'none') {
-          signatureScope |= TransactionSignature.SIGHASH_NONE
-        }
-        if (signOutputs === 'single') {
-          signatureScope |= TransactionSignature.SIGHASH_SINGLE
-        }
-        if (anyoneCanPay) {
-          signatureScope |= TransactionSignature.SIGHASH_ANYONECANPAY
-        }
+        const signatureScope = computeSignatureScope(signOutputs, anyoneCanPay)
+        const resolved = resolveSourceDetails(tx, inputIndex, sourceSatoshis, lockingScript)
+        sourceSatoshis = resolved.sourceSatoshis
+        lockingScript = resolved.lockingScript
 
-        const input = tx.inputs[inputIndex]
-
-        const otherInputs = tx.inputs.filter(
-          (_, index) => index !== inputIndex
-        )
-
-        const sourceTXID = input.sourceTXID ?? input.sourceTransaction?.id('hex')
-        if (sourceTXID == null || sourceTXID === undefined) {
-          throw new Error(
-            'The input sourceTXID or sourceTransaction is required for transaction signing.'
-          )
-        }
-        if (sourceTXID === '') {
-          throw new Error(
-            'The input sourceTXID or sourceTransaction is required for transaction signing.'
-          )
-        }
-        sourceSatoshis ||=
-          input.sourceTransaction?.outputs[input.sourceOutputIndex].satoshis
-        if (sourceSatoshis == null || sourceSatoshis === undefined) {
-          throw new Error(
-            'The sourceSatoshis or input sourceTransaction is required for transaction signing.'
-          )
-        }
-        lockingScript ||=
-          input.sourceTransaction?.outputs[input.sourceOutputIndex]
-            .lockingScript
-        if (lockingScript == null) {
-          throw new Error(
-            'The lockingScript or input sourceTransaction is required for transaction signing.'
-          )
-        }
-
-        const preimage = TransactionSignature.format({
-          sourceTXID,
-          sourceOutputIndex: verifyNotNull(input.sourceOutputIndex, 'input.sourceOutputIndex must have value'),
-          sourceSatoshis,
-          transactionVersion: tx.version,
-          otherInputs,
-          inputIndex,
-          outputs: tx.outputs,
-          inputSequence: verifyNotNull(input.sequence, 'input.sequence must have value'),
-          subscript: lockingScript,
-          lockTime: tx.lockTime,
-          scope: signatureScope
+        const preimage = formatPreimage({
+          tx, inputIndex, signatureScope,
+          sourceTXID: resolved.sourceTXID, sourceSatoshis: resolved.sourceSatoshis,
+          lockingScript: resolved.lockingScript, otherInputs: resolved.otherInputs
         })
 
         const rawSignature = privateKey.sign(sha256(preimage))

package/src/script/templates/PushDrop.ts

@@ -9,6 +9,7 @@ import {
 import { WalletInterface, WalletProtocol } from '../../wallet/Wallet.interfaces.js'
 import { Transaction } from '../../transaction/index.js'
 import { verifyNotNull } from '../../primitives/utils.js'
+import { computeSignatureScope, resolveSourceDetails, formatPreimage } from './SignatureUtils.js'
 
 /**
  * For a given piece of data to push onto the stack in script, creates the correct minimally-encoded script chunk,
@@ -216,60 +217,16 @@ export default class PushDrop implements ScriptTemplate {
         tx: Transaction,
         inputIndex: number
       ): Promise<UnlockingScript> => {
-        let signatureScope = TransactionSignature.SIGHASH_FORKID
-        if (signOutputs === 'all') {
-          signatureScope |= TransactionSignature.SIGHASH_ALL
-        }
-        if (signOutputs === 'none') {
-          signatureScope |= TransactionSignature.SIGHASH_NONE
-        }
-        if (signOutputs === 'single') {
-          signatureScope |= TransactionSignature.SIGHASH_SINGLE
-        }
-        if (anyoneCanPay) {
-          signatureScope |= TransactionSignature.SIGHASH_ANYONECANPAY
-        }
-
-        const input = tx.inputs[inputIndex]
-
-        const otherInputs = tx.inputs.filter(
-          (_, index) => index !== inputIndex
-        )
-
-        const sourceTXID = input.sourceTXID ?? input.sourceTransaction?.id('hex')
-        if (sourceTXID == null || sourceTXID === undefined) {
-          throw new Error(
-            'The input sourceTXID or sourceTransaction is required for transaction signing.'
-          )
-        }
-        sourceSatoshis ||=
-          input.sourceTransaction?.outputs[input.sourceOutputIndex].satoshis
-        if (sourceSatoshis == null || sourceSatoshis === undefined) {
-          throw new Error(
-            'The sourceSatoshis or input sourceTransaction is required for transaction signing.'
-          )
-        }
-        lockingScript ||=
-          input.sourceTransaction?.outputs[input.sourceOutputIndex]
-            .lockingScript
-        if (lockingScript == null) {
-          throw new Error(
-            'The lockingScript or input sourceTransaction is required for transaction signing.'
-          )
-        }
-
-        const preimage = TransactionSignature.format({
-          sourceTXID,
-          sourceOutputIndex: verifyNotNull(input.sourceOutputIndex, 'input.sourceOutputIndex must have value'),
-          sourceSatoshis,
-          transactionVersion: tx.version,
-          otherInputs,
-          inputIndex,
-          outputs: tx.outputs,
-          inputSequence: input.sequence ?? 0xffffffff,
-          subscript: lockingScript,
-          lockTime: tx.lockTime,
-          scope: signatureScope
+        const signatureScope = computeSignatureScope(signOutputs, anyoneCanPay)
+        const resolved = resolveSourceDetails(tx, inputIndex, sourceSatoshis, lockingScript)
+        sourceSatoshis = resolved.sourceSatoshis
+        lockingScript = resolved.lockingScript as LockingScript
+
+        const preimage = formatPreimage({
+          tx, inputIndex, signatureScope,
+          sourceTXID: resolved.sourceTXID, sourceSatoshis: resolved.sourceSatoshis,
+          lockingScript: resolved.lockingScript, otherInputs: resolved.otherInputs,
+          inputSequence: tx.inputs[inputIndex].sequence ?? 0xffffffff
         })
 
         const preimageHash = Hash.sha256(preimage)

package/src/script/templates/SignatureUtils.ts

@@ -0,0 +1,111 @@
+import TransactionSignature from '../../primitives/TransactionSignature.js'
+import Transaction from '../../transaction/Transaction.js'
+import Script from '../Script.js'
+import { verifyNotNull } from '../../primitives/utils.js'
+
+/**
+ * Computes the signature scope flags from the given signing parameters.
+ */
+export function computeSignatureScope(
+  signOutputs: 'all' | 'none' | 'single',
+  anyoneCanPay: boolean
+): number {
+  let signatureScope = TransactionSignature.SIGHASH_FORKID
+  if (signOutputs === 'all') {
+    signatureScope |= TransactionSignature.SIGHASH_ALL
+  }
+  if (signOutputs === 'none') {
+    signatureScope |= TransactionSignature.SIGHASH_NONE
+  }
+  if (signOutputs === 'single') {
+    signatureScope |= TransactionSignature.SIGHASH_SINGLE
+  }
+  if (anyoneCanPay) {
+    signatureScope |= TransactionSignature.SIGHASH_ANYONECANPAY
+  }
+  return signatureScope
+}
+
+/**
+ * Resolves and validates the source transaction details needed for signing.
+ * Returns the resolved sourceTXID, sourceSatoshis, lockingScript, and otherInputs.
+ */
+export function resolveSourceDetails(
+  tx: Transaction,
+  inputIndex: number,
+  providedSourceSatoshis?: number,
+  providedLockingScript?: Script
+): {
+  sourceTXID: string
+  sourceSatoshis: number
+  lockingScript: Script
+  otherInputs: typeof tx.inputs
+} {
+  const input = tx.inputs[inputIndex]
+
+  const otherInputs = tx.inputs.filter(
+    (_, index) => index !== inputIndex
+  )
+
+  const sourceTXID = input.sourceTXID ?? input.sourceTransaction?.id('hex')
+  if (sourceTXID == null || sourceTXID === undefined) {
+    throw new Error(
+      'The input sourceTXID or sourceTransaction is required for transaction signing.'
+    )
+  }
+  if (sourceTXID === '') {
+    throw new Error(
+      'The input sourceTXID or sourceTransaction is required for transaction signing.'
+    )
+  }
+  const sourceSatoshis = providedSourceSatoshis ??
+    input.sourceTransaction?.outputs[input.sourceOutputIndex].satoshis
+  if (sourceSatoshis == null || sourceSatoshis === undefined) {
+    throw new Error(
+      'The sourceSatoshis or input sourceTransaction is required for transaction signing.'
+    )
+  }
+  const lockingScript = providedLockingScript ??
+    input.sourceTransaction?.outputs[input.sourceOutputIndex]
+      .lockingScript
+  if (lockingScript == null) {
+    throw new Error(
+      'The lockingScript or input sourceTransaction is required for transaction signing.'
+    )
+  }
+
+  return { sourceTXID, sourceSatoshis, lockingScript, otherInputs }
+}
+
+/** Parameters for formatting the transaction preimage */
+export interface FormatPreimageParams {
+  tx: Transaction
+  inputIndex: number
+  signatureScope: number
+  sourceTXID: string
+  sourceSatoshis: number
+  lockingScript: Script
+  otherInputs: Transaction['inputs']
+  inputSequence?: number
+}
+
+/**
+ * Formats the transaction preimage for signing.
+ */
+export function formatPreimage(params: FormatPreimageParams): number[] {
+  const { tx, inputIndex, signatureScope, sourceTXID, sourceSatoshis, lockingScript, otherInputs, inputSequence } = params
+  const input = tx.inputs[inputIndex]
+  return TransactionSignature.format({
+    sourceTXID,
+    sourceOutputIndex: verifyNotNull(input.sourceOutputIndex, 'input.sourceOutputIndex must have value'),
+    sourceSatoshis,
+    transactionVersion: tx.version,
+    otherInputs,
+    inputIndex,
+    outputs: tx.outputs,
+    inputSequence: inputSequence ?? verifyNotNull(input.sequence, 'input.sequence must have value'),
+    subscript: lockingScript,
+    lockTime: tx.lockTime,
+    scope: signatureScope
+  })
+}

package/src/transaction/Transaction.ts

@@ -15,6 +15,7 @@ import { defaultBroadcaster } from './broadcasters/DefaultBroadcaster.js'
 import { defaultChainTracker } from './chaintrackers/DefaultChainTracker.js'
 import { Beef, BEEF_V1 } from './Beef.js'
 import P2PKH from '../script/templates/P2PKH.js'
+import type { WalletInterface, DescriptionString5to50Bytes, CreateActionOptions } from '../wallet/Wallet.interfaces.js'
 
 /**
  * Represents a complete Bitcoin transaction. This class encapsulates all the details

package/src/transaction/__tests/Transaction.test.ts

@@ -1462,7 +1462,7 @@ describe('Transaction', () => {
 
   describe('completeWithWallet', () => {
     // Mock implementation of WalletInterface for testing
-    class MockWallet implements Partial<WalletInterface> {
+    class MockWallet {
       public lastCreateActionArgs: CreateActionArgs | null = null
       public lastSignActionArgs: any = null
       public signActionCalled: boolean = false
@@ -1624,7 +1624,7 @@ describe('Transaction', () => {
       const mockWallet = new MockWallet()
 
       // Complete the transaction with the wallet
-      await tx.completeWithWallet(mockWallet, 'Test transaction completion')
+      await tx.completeWithWallet(mockWallet as unknown as WalletInterface,'Test transaction completion')
 
       // Verify that the wallet's createAction was called with correct arguments
       expect(mockWallet.lastCreateActionArgs).not.toBeNull()
@@ -1665,7 +1665,7 @@ describe('Transaction', () => {
       const mockWallet = new MockWallet()
 
       // Expect completeWithWallet to throw an error
-      await expect(tx.completeWithWallet(mockWallet))
+      await expect(tx.completeWithWallet(mockWallet as unknown as WalletInterface))
         .rejects
         .toThrow('All inputs must have a sourceTransaction when using completeWithWallet')
     })
@@ -1710,7 +1710,7 @@ describe('Transaction', () => {
       const mockWallet = new MockWallet()
 
       // Expect completeWithWallet to throw an error
-      await expect(tx.completeWithWallet(mockWallet))
+      await expect(tx.completeWithWallet(mockWallet as unknown as WalletInterface))
         .rejects
         .toThrow('All inputs must have an unlockingScript when using completeWithWallet')
     })
@@ -1766,7 +1766,7 @@ describe('Transaction', () => {
       const mockWallet = new MockWallet()
 
       // Complete the transaction with the wallet
-      await tx.completeWithWallet(mockWallet, 'Test with template')
+      await tx.completeWithWallet(mockWallet as unknown as WalletInterface,'Test with template')
 
       // Verify that signAction was called
       expect(mockWallet.signActionCalled).toBe(true)
@@ -1850,7 +1850,7 @@ describe('Transaction', () => {
       const mockWallet = new MockWallet()
 
       // Complete the transaction with the wallet
-      await tx.completeWithWallet(mockWallet, 'Test with mixed inputs')
+      await tx.completeWithWallet(mockWallet as unknown as WalletInterface,'Test with mixed inputs')
 
       // Verify that signAction was called (because at least one template exists)
       expect(mockWallet.signActionCalled).toBe(true)
@@ -1937,7 +1937,7 @@ describe('Transaction', () => {
       const mockWallet = new MockWallet()
 
       // Should throw error about missing script/template on input 1
-      await expect(tx.completeWithWallet(mockWallet))
+      await expect(tx.completeWithWallet(mockWallet as unknown as WalletInterface))
         .rejects
         .toThrow('Input 1 must have either an unlockingScript or unlockingScriptTemplate')
     })
@@ -1964,7 +1964,7 @@ describe('Transaction', () => {
         returnTXIDOnly: true
       }
 
-      await tx.completeWithWallet(mockWallet, 'Test with options', undefined, options)
+      await tx.completeWithWallet(mockWallet as unknown as WalletInterface,'Test with options', undefined, options)
 
       // Verify options were passed to createAction
       expect(mockWallet.lastCreateActionArgs?.options).toEqual(options)
@@ -1997,7 +1997,7 @@ describe('Transaction', () => {
         randomizeOutputs: false
       }
 
-      await tx.completeWithWallet(mockWallet, 'Test template with options', undefined, options)
+      await tx.completeWithWallet(mockWallet as unknown as WalletInterface,'Test template with options', undefined, options)
 
       // Verify signAndProcess: false was set for createAction (required for template flow)
       expect(mockWallet.lastCreateActionArgs?.options?.signAndProcess).toBe(false)

package/src/transaction/http/BinaryFetchClient.ts

@@ -3,6 +3,7 @@ import {
   HttpClientRequestOptions,
   HttpClientResponse
 } from './HttpClient.js'
+import { HttpsModuleLike, executeNodejsRequest } from './NodejsHttpRequestUtils.js'
 
 /** Node Https module interface limited to options needed by ts-sdk */
 export interface BinaryHttpsNodejs {
@@ -19,7 +20,7 @@ export interface BinaryNodejsHttpClientRequest {
 
   on: (event: string, callback: (data: any) => void) => void
 
-  end: (() => void) & (() => void)
+  end: () => void
 }
 
 /**
@@ -32,37 +33,12 @@ export class BinaryNodejsHttpClient implements HttpClient {
     url: string,
     requestOptions: HttpClientRequestOptions
   ): Promise<HttpClientResponse> {
-    return await new Promise((resolve, reject) => {
-      const req = this.https.request(url, requestOptions, (res) => {
-        let body = ''
-        res.on('data', (chunk: string) => {
-          body += chunk
-        })
-        res.on('end', () => {
-          const ok = res.statusCode >= 200 && res.statusCode <= 299
-          const mediaType = res.headers['content-type']
-          const data =
-            body !== '' && typeof mediaType === 'string' && mediaType.startsWith('application/json')
-              ? JSON.parse(body)
-              : body
-          resolve({
-            status: res.statusCode,
-            statusText: res.statusMessage,
-            ok,
-            data
-          })
-        })
-      })
-
-      req.on('error', (error: Error) => {
-        reject(error)
-      })
-
-      if (requestOptions.data !== null && requestOptions.data !== undefined) {
-        req.write(Buffer.from(requestOptions.data))
-      }
-      req.end()
-    })
+    return await executeNodejsRequest(
+      this.https as unknown as HttpsModuleLike,
+      url,
+      requestOptions,
+      (data) => Buffer.from(data)
+    )
   }
 }
 

package/src/transaction/http/NodejsHttpClient.ts

@@ -3,6 +3,7 @@ import {
   HttpClientRequestOptions,
   HttpClientResponse
 } from './HttpClient.js'
+import { HttpsModuleLike, executeNodejsRequest } from './NodejsHttpRequestUtils.js'
 
 /** Node Https module interface limited to options needed by ts-sdk */
 export interface HttpsNodejs {
@@ -19,7 +20,7 @@ export interface NodejsHttpClientRequest {
 
   on: (event: string, callback: (data: any) => void) => void
 
-  end: (() => void) & (() => void)
+  end: () => void
 }
 
 /**
@@ -32,36 +33,11 @@ export class NodejsHttpClient implements HttpClient {
     url: string,
     requestOptions: HttpClientRequestOptions
   ): Promise<HttpClientResponse> {
-    return await new Promise((resolve, reject) => {
-      const req = this.https.request(url, requestOptions, (res) => {
-        let body = ''
-        res.on('data', (chunk: string) => {
-          body += chunk
-        })
-        res.on('end', () => {
-          const ok = res.statusCode >= 200 && res.statusCode <= 299
-          const mediaType = res.headers['content-type']
-          const data =
-            body !== '' && typeof mediaType === 'string' && mediaType.startsWith('application/json')
-              ? JSON.parse(body)
-              : body
-          resolve({
-            status: res.statusCode,
-            statusText: res.statusMessage,
-            ok,
-            data
-          })
-        })
-      })
-
-      req.on('error', (error: Error) => {
-        reject(error)
-      })
-
-      if (requestOptions.data !== null && requestOptions.data !== undefined) {
-        req.write(JSON.stringify(requestOptions.data))
-      }
-      req.end()
-    })
+    return await executeNodejsRequest(
+      this.https as unknown as HttpsModuleLike,
+      url,
+      requestOptions,
+      (data) => JSON.stringify(data)
+    )
   }
 }

package/src/transaction/http/NodejsHttpRequestUtils.ts

@@ -0,0 +1,68 @@
+import {
+  HttpClientRequestOptions,
+  HttpClientResponse
+} from './HttpClient.js'
+
+/** Common interface for Node.js https module request objects */
+export interface NodejsRequestLike {
+  write: (chunk: any) => void
+  on: (event: string, callback: (data: any) => void) => void
+  end: () => void
+}
+
+/** Common interface for Node.js https modules */
+export interface HttpsModuleLike {
+  request: (
+    url: string,
+    options: HttpClientRequestOptions,
+    callback: (res: any) => void
+  ) => NodejsRequestLike
+}
+
+/**
+ * Shared implementation for handling Node.js HTTP requests.
+ * Used by both NodejsHttpClient and BinaryNodejsHttpClient.
+ *
+ * @param https The Node.js https module (or compatible)
+ * @param url The URL to make the request to
+ * @param requestOptions The request configuration
+ * @param serializeData Function to serialize the request data for writing
+ */
+export function executeNodejsRequest(
+  https: HttpsModuleLike,
+  url: string,
+  requestOptions: HttpClientRequestOptions,
+  serializeData: (data: any) => any
+): Promise<HttpClientResponse> {
+  return new Promise((resolve, reject) => {
+    const req = https.request(url, requestOptions, (res) => {
+      let body = ''
+      res.on('data', (chunk: string) => {
+        body += chunk
+      })
+      res.on('end', () => {
+        const ok = res.statusCode >= 200 && res.statusCode <= 299
+        const mediaType = res.headers['content-type']
+        const data =
+          body !== '' && typeof mediaType === 'string' && mediaType.startsWith('application/json')
+            ? JSON.parse(body)
+            : body
+        resolve({
+          status: res.statusCode,
+          statusText: res.statusMessage,
+          ok,
+          data
+        })
+      })
+    })
+
+    req.on('error', (error: Error) => {
+      reject(error)
+    })
+
+    if (requestOptions.data !== null && requestOptions.data !== undefined) {
+      req.write(serializeData(requestOptions.data))
+    }
+    req.end()
+  })
+}