@bsv/sdk 1.3.12 → 1.3.14

package/src/script/templates/P2PKH.ts

@@ -9,6 +9,11 @@ import TransactionSignature from '../../primitives/TransactionSignature.js'
 import { sha256 } from '../../primitives/Hash.js'
 import Script from '../Script.js'
 
+function verifyTruthy<T>(v: T | undefined): T {
+  if (v == null) throw new Error('must have value')
+  return v
+}
+
 /**
  * P2PKH (Pay To Public Key Hash) class implementing ScriptTemplate.
  *
@@ -25,12 +30,16 @@ export default class P2PKH implements ScriptTemplate {
     let data: number[]
     if (typeof pubkeyhash === 'string') {
       const hash = fromBase58Check(pubkeyhash)
-      if (hash.prefix[0] !== 0x00 && hash.prefix[0] !== 0x6f) throw new Error('only P2PKH is supported')
+      if (hash.prefix[0] !== 0x00 && hash.prefix[0] !== 0x6f) {
+        throw new Error('only P2PKH is supported')
+      }
       data = hash.data as number[]
     } else {
       data = pubkeyhash
     }
-    if (data.length !== 20) throw new Error('P2PKH hash length must be 20 bytes')
+    if (data.length !== 20) {
+      throw new Error('P2PKH hash length must be 20 bytes')
+    }
     return new LockingScript([
       { op: OP.OP_DUP },
       { op: OP.OP_HASH160 },
@@ -83,22 +92,32 @@ export default class P2PKH implements ScriptTemplate {
 
         const input = tx.inputs[inputIndex]
 
-        const otherInputs = tx.inputs.filter((_, index) => index !== inputIndex)
+        const otherInputs = tx.inputs.filter(
+          (_, index) => index !== inputIndex
+        )
 
-        const sourceTXID = input.sourceTXID ? input.sourceTXID : input.sourceTransaction?.id('hex')
-        if (!sourceTXID) {
+        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) {
+        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) {
+        lockingScript ||=
+          input.sourceTransaction?.outputs[input.sourceOutputIndex]
+            .lockingScript
+        if (lockingScript == null) {
           throw new Error(
             'The lockingScript or input sourceTransaction is required for transaction signing.'
           )
@@ -106,17 +125,18 @@ export default class P2PKH implements ScriptTemplate {
 
         const preimage = TransactionSignature.format({
           sourceTXID,
-          sourceOutputIndex: input.sourceOutputIndex,
+          sourceOutputIndex: verifyTruthy(input.sourceOutputIndex),
           sourceSatoshis,
           transactionVersion: tx.version,
           otherInputs,
           inputIndex,
           outputs: tx.outputs,
-          inputSequence: input.sequence,
+          inputSequence: verifyTruthy(input.sequence),
           subscript: lockingScript,
           lockTime: tx.lockTime,
           scope: signatureScope
         })
+
         const rawSignature = privateKey.sign(sha256(preimage))
         const sig = new TransactionSignature(
           rawSignature.r,
@@ -124,7 +144,9 @@ export default class P2PKH implements ScriptTemplate {
           signatureScope
         )
         const sigForScript = sig.toChecksigFormat()
-        const pubkeyForScript = privateKey.toPublicKey().encode(true) as number[]
+        const pubkeyForScript = privateKey
+          .toPublicKey()
+          .encode(true) as number[]
         return new UnlockingScript([
           { op: sigForScript.length, data: sigForScript },
           { op: pubkeyForScript.length, data: pubkeyForScript }

package/src/script/templates/PushDrop.ts

@@ -1,8 +1,18 @@
 import { ScriptTemplate, LockingScript, UnlockingScript, OP } from '../index.js'
-import { Utils, Hash, TransactionSignature, Signature, PublicKey } from '../../primitives/index.js'
-import { WalletInterface } from '../../wallet/Wallet.interfaces.js'
+import {
+  Utils,
+  Hash,
+  TransactionSignature,
+  Signature,
+  PublicKey
+} from '../../primitives/index.js'
+import { WalletInterface, SecurityLevel } from '../../wallet/Wallet.interfaces.js'
 import { Transaction } from '../../transaction/index.js'
-import { SecurityLevel } from '../../wallet/Wallet.interfaces.js'
+
+function verifyTruthy<T>(v: T | undefined): T {
+  if (v == null) throw new Error('must have value')
+  return v
+}
 
 /**
  * For a given piece of data to push onto the stack in script, creates the correct minimally-encoded script chunk,
@@ -10,7 +20,9 @@ import { SecurityLevel } from '../../wallet/Wallet.interfaces.js'
  *
  * TODO: This should be made into a TS-SDK util (distinct from the `minimallyEncode` util)
  */
-const createMinimallyEncodedScriptChunk = (data: number[]): { op: number, data?: number[] } => {
+const createMinimallyEncodedScriptChunk = (
+  data: number[]
+): { op: number, data?: number[] } => {
   if (data.length === 0) {
     // Could have used OP_0.
     return { op: 0 }
@@ -52,13 +64,21 @@ export default class PushDrop implements ScriptTemplate {
    * @param script PushDrop script to decode back into token fields
    * @returns An object containing PushDrop token fields and the locking public key. If a signature was included, it will be the last field.
    */
-  static decode(script: LockingScript): { lockingPublicKey: PublicKey, fields: number[][] } {
-    const lockingPublicKey = PublicKey.fromString(Utils.toHex(script.chunks[0].data))
-    const fields = []
+  static decode(script: LockingScript): {
+    lockingPublicKey: PublicKey
+    fields: number[][]
+  } {
+    const lockingPublicKey = PublicKey.fromString(
+      Utils.toHex(verifyTruthy(script.chunks[0].data)) // ✅ Ensure not undefined
+    )
+
+    const fields: number[][] = []
     for (let i = 2; i < script.chunks.length; i++) {
-      const nextOpcode = script.chunks[i + 1].op
-      let chunk = script.chunks[i].data
-      if (!chunk) {
+      const nextOpcode = script.chunks[i + 1]?.op // ✅ Prevent accessing `op` from `undefined`
+      let chunk: number[] = script.chunks[i].data ?? [] // ✅ Ensure `chunk` is always `number[]`
+
+      if (chunk.length === 0) {
+        // ✅ Only modify `chunk` if it was empty
         if (script.chunks[i].op >= 80 && script.chunks[i].op <= 95) {
           chunk = [script.chunks[i].op - 80]
         } else if (script.chunks[i].op === 0) {
@@ -101,7 +121,15 @@ export default class PushDrop implements ScriptTemplate {
    * @param {boolean} [includeSignature=true] - Flag indicating if a signature should be included in the script (default yes).
    * @returns {Promise<LockingScript>} The generated PushDrop locking script.
    */
-  async lock(fields: number[][], protocolID: [SecurityLevel, string], keyID: string, counterparty: string, forSelf = false, includeSignature = true, lockPosition: 'before' | 'after' = 'before'): Promise<LockingScript> {
+  async lock(
+    fields: number[][],
+    protocolID: [SecurityLevel, string],
+    keyID: string,
+    counterparty: string,
+    forSelf = false,
+    includeSignature = true,
+    lockPosition: 'before' | 'after' = 'before'
+  ): Promise<LockingScript> {
     const { publicKey } = await this.wallet.getPublicKey({
       protocolID,
       keyID,
@@ -110,7 +138,10 @@ export default class PushDrop implements ScriptTemplate {
     })
     const lockChunks: Array<{ op: number, data?: number[] }> = []
     const pushDropChunks: Array<{ op: number, data?: number[] }> = []
-    lockChunks.push({ op: publicKey.length / 2, data: Utils.toArray(publicKey, 'hex') })
+    lockChunks.push({
+      op: publicKey.length / 2,
+      data: Utils.toArray(publicKey, 'hex')
+    })
     lockChunks.push({ op: OP.OP_CHECKSIG })
     if (includeSignature) {
       const dataToSign = fields.reduce((a, e) => [...a, ...e], [])
@@ -130,19 +161,13 @@ export default class PushDrop implements ScriptTemplate {
       pushDropChunks.push({ op: OP.OP_2DROP })
       notYetDropped -= 2
     }
-    if (notYetDropped) {
+    if (notYetDropped !== 0) {
       pushDropChunks.push({ op: OP.OP_DROP })
     }
     if (lockPosition === 'before') {
-      return new LockingScript([
-        ...lockChunks,
-        ...pushDropChunks
-      ])
+      return new LockingScript([...lockChunks, ...pushDropChunks])
     } else {
-      return new LockingScript([
-        ...pushDropChunks,
-        ...lockChunks
-      ])
+      return new LockingScript([...pushDropChunks, ...lockChunks])
     }
   }
 
@@ -172,7 +197,10 @@ export default class PushDrop implements ScriptTemplate {
     estimateLength: () => Promise<73>
   } {
     return {
-      sign: async (tx: Transaction, inputIndex: number): Promise<UnlockingScript> => {
+      sign: async (
+        tx: Transaction,
+        inputIndex: number
+      ): Promise<UnlockingScript> => {
         let signatureScope = TransactionSignature.SIGHASH_FORKID
         if (signOutputs === 'all') {
           signatureScope |= TransactionSignature.SIGHASH_ALL
@@ -189,22 +217,27 @@ export default class PushDrop implements ScriptTemplate {
 
         const input = tx.inputs[inputIndex]
 
-        const otherInputs = tx.inputs.filter((_, index) => index !== inputIndex)
+        const otherInputs = tx.inputs.filter(
+          (_, index) => index !== inputIndex
+        )
 
-        const sourceTXID = input.sourceTXID ? input.sourceTXID : input.sourceTransaction?.id('hex')
-        if (!sourceTXID) {
+        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) {
+        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) {
+        lockingScript ||=
+          input.sourceTransaction?.outputs[input.sourceOutputIndex]
+            .lockingScript
+        if (lockingScript == null) {
           throw new Error(
             'The lockingScript or input sourceTransaction is required for transaction signing.'
           )
@@ -212,17 +245,18 @@ export default class PushDrop implements ScriptTemplate {
 
         const preimage = TransactionSignature.format({
           sourceTXID,
-          sourceOutputIndex: input.sourceOutputIndex,
+          sourceOutputIndex: verifyTruthy(input.sourceOutputIndex),
           sourceSatoshis,
           transactionVersion: tx.version,
           otherInputs,
           inputIndex,
           outputs: tx.outputs,
-          inputSequence: input.sequence,
+          inputSequence: input.sequence ?? 0xffffffff,
           subscript: lockingScript,
           lockTime: tx.lockTime,
           scope: signatureScope
         })
+
         const preimageHash = Hash.sha256(preimage)
         const { signature: bareSignature } = await this.wallet.createSignature({
           data: preimageHash,

package/src/script/templates/RPuzzle.ts

@@ -8,6 +8,7 @@ import TransactionSignature from '../../primitives/TransactionSignature.js'
 import { sha256 } from '../../primitives/Hash.js'
 import ScriptChunk from '../ScriptChunk.js'
 import BigNumber from '../../primitives/BigNumber.js'
+import Script from '../Script.js'
 
 /**
  * RPuzzle class implementing ScriptTemplate.
@@ -23,7 +24,15 @@ export default class RPuzzle implements ScriptTemplate {
    *
    * @param {'raw'|'SHA1'|'SHA256'|'HASH256'|'RIPEMD160'|'HASH160'} type Denotes the type of puzzle to create
    */
-  constructor(type: 'raw' | 'SHA1' | 'SHA256' | 'HASH256' | 'RIPEMD160' | 'HASH160' = 'raw') {
+  constructor(
+    type:
+      | 'raw'
+      | 'SHA1'
+      | 'SHA256'
+      | 'HASH256'
+      | 'RIPEMD160'
+      | 'HASH160' = 'raw'
+  ) {
     this.type = type
   }
 
@@ -105,26 +114,38 @@ export default class RPuzzle implements ScriptTemplate {
           )
         }
         const preimage = TransactionSignature.format({
-          sourceTXID: input.sourceTransaction.id('hex'),
-          sourceOutputIndex: input.sourceOutputIndex,
-          sourceSatoshis: input.sourceTransaction.outputs[input.sourceOutputIndex].satoshis,
+          sourceTXID: input.sourceTransaction?.id('hex') ?? '',
+          sourceOutputIndex: input.sourceOutputIndex ?? 0,
+          sourceSatoshis:
+            input.sourceTransaction?.outputs[input.sourceOutputIndex]
+              ?.satoshis ?? 0,
           transactionVersion: tx.version,
           otherInputs,
           inputIndex,
           outputs: tx.outputs,
-          inputSequence: input.sequence,
-          subscript: input.sourceTransaction.outputs[input.sourceOutputIndex].lockingScript,
+          inputSequence: input.sequence ?? 0xffffffff,
+          subscript:
+            input.sourceTransaction?.outputs[input.sourceOutputIndex]
+              ?.lockingScript ?? new Script(),
           lockTime: tx.lockTime,
           scope: signatureScope
         })
-        const rawSignature = privateKey.sign(sha256(preimage), undefined, true, k)
+
+        const rawSignature = privateKey.sign(
+          sha256(preimage),
+          undefined,
+          true,
+          k
+        )
         const sig = new TransactionSignature(
           rawSignature.r,
           rawSignature.s,
           signatureScope
         )
         const sigForScript = sig.toChecksigFormat()
-        const pubkeyForScript = privateKey.toPublicKey().encode(true) as number[]
+        const pubkeyForScript = privateKey
+          .toPublicKey()
+          .encode(true) as number[]
         return new UnlockingScript([
           { op: sigForScript.length, data: sigForScript },
           { op: pubkeyForScript.length, data: pubkeyForScript }

package/src/script/templates/__tests/PushDrop.test.ts

@@ -1,33 +1,66 @@
 /* eslint-env jest */
-import PushDrop from '../../../../dist/cjs/src/script/templates/PushDrop.js'
-import ProtoWallet from '../../../../dist/cjs/src/wallet/ProtoWallet.js'
-import { PrivateKey, Utils } from '../../../../dist/cjs/src/primitives/index.js'
-import { Script, Spend } from '../../../../dist/cjs/src/script/index.js'
-import { Transaction } from '../../../../dist/cjs/src/transaction/index.js'
+import PushDrop from '../../../script/templates/PushDrop'
+import { CompletedProtoWallet } from '../../../auth/certificates/__tests/CompletedProtoWallet'
+import { PrivateKey, Utils } from '../../../primitives/index'
+import { Script, Spend } from '../../../script/index'
+import { Transaction } from '../../../transaction/index'
 
 describe('PushDrop', () => {
-  let privateKey: typeof PrivateKey
   let wallet
   let pushDrop: PushDrop
 
-  const createDecodeRedeem = async (fields: number[][] = [], protocolID: [0 | 1 | 2, string] = [0, 'tests'], keyID: string = 'test-key', counterparty: string = 'self', signOutputs: 'all' | 'none' | 'single' = 'all', anyoneCanPay: boolean = false) => {
-    const lockingScript = await pushDrop.lock(fields, protocolID, keyID, counterparty)
+  const createDecodeRedeem = async (
+    fields: number[][] = [],
+    protocolID: [0 | 1 | 2, string] = [0, 'tests'],
+    keyID: string = 'test-key',
+    counterparty: string = 'self',
+    signOutputs: 'all' | 'none' | 'single' = 'all',
+    anyoneCanPay: boolean = false
+  ): Promise<void> => {
+    const lockingScript = await pushDrop.lock(
+      fields,
+      protocolID,
+      keyID,
+      counterparty
+    )
     expect(lockingScript).toBeInstanceOf(Script)
     const decoded = await PushDrop.decode(lockingScript)
     expect(decoded.fields).toEqual(fields)
-    const expectedPublicKey = (await wallet.getPublicKey({ protocolID, keyID, counterparty })).publicKey
+    const expectedPublicKey = (
+      await wallet.getPublicKey({ protocolID, keyID, counterparty })
+    ).publicKey
     expect(decoded.lockingPublicKey.toString()).toEqual(expectedPublicKey)
     const satoshis = 1
-    const unlockingTemplate = await pushDrop.unlock(protocolID, keyID, counterparty, signOutputs, anyoneCanPay)
-    const sourceTx = new Transaction(1, [], [{
-      lockingScript,
-      satoshis
-    }], 0)
-    const spendTx = new Transaction(1, [{
-      sourceTransaction: sourceTx,
-      sourceOutputIndex: 0,
-      sequence: 0xffffffff
-    }], [], 0)
+    const unlockingTemplate = await pushDrop.unlock(
+      protocolID,
+      keyID,
+      counterparty,
+      signOutputs,
+      anyoneCanPay
+    )
+    const sourceTx = new Transaction(
+      1,
+      [],
+      [
+        {
+          lockingScript,
+          satoshis
+        }
+      ],
+      0
+    )
+    const spendTx = new Transaction(
+      1,
+      [
+        {
+          sourceTransaction: sourceTx,
+          sourceOutputIndex: 0,
+          sequence: 0xffffffff
+        }
+      ],
+      [],
+      0
+    )
     const unlockingScript = await unlockingTemplate.sign(spendTx, 0)
     expect(await unlockingTemplate.estimateLength()).toEqual(73)
     const spend = new Spend({
@@ -48,8 +81,8 @@ describe('PushDrop', () => {
   }
 
   beforeEach(() => {
-    privateKey = PrivateKey.fromRandom()
-    wallet = new ProtoWallet(privateKey)
+    const privateKey = PrivateKey.fromRandom()
+    wallet = new CompletedProtoWallet(privateKey)
     pushDrop = new PushDrop(wallet)
   })
 
@@ -64,11 +97,46 @@ describe('PushDrop', () => {
     await createDecodeRedeem([new Array(70000).fill(0xff)])
     await createDecodeRedeem([[0], [1], [2]])
     await createDecodeRedeem([[0], [1], [2], [3]])
-    await createDecodeRedeem([[3, 1, 4, 1, 5, 9]], undefined, undefined, undefined, 'none', false)
-    await createDecodeRedeem([[3, 1, 4, 1, 5, 9]], undefined, undefined, undefined, 'single', false)
-    await createDecodeRedeem([[3, 1, 4, 1, 5, 9]], undefined, undefined, undefined, 'all', true)
-    await createDecodeRedeem([[3, 1, 4, 1, 5, 9]], undefined, undefined, undefined, 'none', true)
-    await createDecodeRedeem([[3, 1, 4, 1, 5, 9]], undefined, undefined, undefined, 'single', true)
+    await createDecodeRedeem(
+      [[3, 1, 4, 1, 5, 9]],
+      undefined,
+      undefined,
+      undefined,
+      'none',
+      false
+    )
+    await createDecodeRedeem(
+      [[3, 1, 4, 1, 5, 9]],
+      undefined,
+      undefined,
+      undefined,
+      'single',
+      false
+    )
+    await createDecodeRedeem(
+      [[3, 1, 4, 1, 5, 9]],
+      undefined,
+      undefined,
+      undefined,
+      'all',
+      true
+    )
+    await createDecodeRedeem(
+      [[3, 1, 4, 1, 5, 9]],
+      undefined,
+      undefined,
+      undefined,
+      'none',
+      true
+    )
+    await createDecodeRedeem(
+      [[3, 1, 4, 1, 5, 9]],
+      undefined,
+      undefined,
+      undefined,
+      'single',
+      true
+    )
   })
 
   describe('lock', () => {
@@ -81,7 +149,12 @@ describe('PushDrop', () => {
       const protocolID: [0 | 1 | 2, string] = [0, 'tests']
       const keyID = 'test-key'
       const counterparty = 'self'
-      const lockingScript = await pushDrop.lock(fields, protocolID, keyID, counterparty)
+      const lockingScript = await pushDrop.lock(
+        fields,
+        protocolID,
+        keyID,
+        counterparty
+      )
 
       // Check that the locking script is not null
       expect(lockingScript).toBeInstanceOf(Script)
@@ -89,7 +162,9 @@ describe('PushDrop', () => {
       // Decode the locking script and check the fields and locking public key
       const decoded = await PushDrop.decode(lockingScript)
       expect(decoded.fields).toEqual(fields)
-      const expectedPublicKey = (await wallet.getPublicKey({ protocolID, keyID, counterparty })).publicKey
+      const expectedPublicKey = (
+        await wallet.getPublicKey({ protocolID, keyID, counterparty })
+      ).publicKey
       expect(decoded.lockingPublicKey.toString()).toEqual(expectedPublicKey)
     })
   })
@@ -104,18 +179,41 @@ describe('PushDrop', () => {
       const protocolID: [0 | 1 | 2, string] = [0, 'tests']
       const keyID = 'test-key'
       const counterparty = 'self'
-      const lockingScript = await pushDrop.lock(fields, protocolID, keyID, counterparty)
+      const lockingScript = await pushDrop.lock(
+        fields,
+        protocolID,
+        keyID,
+        counterparty
+      )
       const satoshis = 1
-      const unlockingTemplate = await pushDrop.unlock(protocolID, keyID, counterparty)
-      const sourceTx = new Transaction(1, [], [{
-        lockingScript,
-        satoshis
-      }], 0)
-      const spendTx = new Transaction(1, [{
-        sourceTransaction: sourceTx,
-        sourceOutputIndex: 0,
-        sequence: 0xffffffff
-      }], [], 0)
+      const unlockingTemplate = await pushDrop.unlock(
+        protocolID,
+        keyID,
+        counterparty
+      )
+      const sourceTx = new Transaction(
+        1,
+        [],
+        [
+          {
+            lockingScript,
+            satoshis
+          }
+        ],
+        0
+      )
+      const spendTx = new Transaction(
+        1,
+        [
+          {
+            sourceTransaction: sourceTx,
+            sourceOutputIndex: 0,
+            sequence: 0xffffffff
+          }
+        ],
+        [],
+        0
+      )
       const unlockingScript = await unlockingTemplate.sign(spendTx, 0)
       expect(await unlockingTemplate.estimateLength()).toEqual(73)
       const spend = new Spend({
@@ -147,11 +245,18 @@ describe('PushDrop', () => {
       const keyID = 'test-key'
       const counterparty = 'self'
 
-      const lockingScript = await pushDrop.lock(fields, protocolID, keyID, counterparty)
+      const lockingScript = await pushDrop.lock(
+        fields,
+        protocolID,
+        keyID,
+        counterparty
+      )
 
       const decoded = await PushDrop.decode(lockingScript)
       expect(decoded.fields).toEqual(fields)
-      const expectedPublicKey = (await wallet.getPublicKey({ protocolID, keyID, counterparty })).publicKey
+      const expectedPublicKey = (
+        await wallet.getPublicKey({ protocolID, keyID, counterparty })
+      ).publicKey
       expect(decoded.lockingPublicKey.toString()).toEqual(expectedPublicKey)
     })
   })