@bsv/sdk 1.6.18 → 1.6.20

package/src/script/ScriptEvaluationError.ts

@@ -0,0 +1,44 @@
+import { toHex } from '../primitives/utils.js'
+export default class ScriptEvaluationError extends Error {
+  txid: string
+  outputIndex: number
+  context: 'UnlockingScript' | 'LockingScript'
+  programCounter: number
+  stackState: number[][]
+  altStackState: number[][]
+  ifStackState: boolean[]
+  stackMem: number
+  altStackMem: number
+
+  constructor (params: {
+    message: string
+    txid: string
+    outputIndex: number
+    context: 'UnlockingScript' | 'LockingScript'
+    programCounter: number
+    stackState: number[][]
+    altStackState: number[][]
+    ifStackState: boolean[]
+    stackMem: number
+    altStackMem: number
+  }) {
+    const stackHex = params.stackState.map(s => s != null && typeof s.length !== 'undefined' ? toHex(s) : (s === null || s === undefined ? 'null/undef' : 'INVALID_STACK_ITEM')).join(', ')
+    const altStackHex = params.altStackState.map(s => s != null && typeof s.length !== 'undefined' ? toHex(s) : (s === null || s === undefined ? 'null/undef' : 'INVALID_STACK_ITEM')).join(', ')
+    const pcInfo = `Context: ${params.context}, PC: ${params.programCounter}`
+    const stackInfo = `Stack: [${stackHex}] (len: ${params.stackState.length}, mem: ${params.stackMem})`
+    const altStackInfo = `AltStack: [${altStackHex}] (len: ${params.altStackState.length}, mem: ${params.altStackMem})`
+    const ifStackInfo = `IfStack: [${params.ifStackState.join(', ')}]`
+    const fullMessage = `Script evaluation error: ${params.message}\nTXID: ${params.txid}, OutputIdx: ${params.outputIndex}\n${pcInfo}\n${stackInfo}\n${altStackInfo}\n${ifStackInfo}`
+    super(fullMessage)
+    this.name = this.constructor.name
+    this.txid = params.txid
+    this.outputIndex = params.outputIndex
+    this.context = params.context
+    this.programCounter = params.programCounter
+    this.stackState = params.stackState.map(s => s.slice())
+    this.altStackState = params.altStackState.map(s => s.slice())
+    this.ifStackState = params.ifStackState.slice()
+    this.stackMem = params.stackMem
+    this.altStackMem = params.altStackMem
+  }
+}

package/src/script/Spend.ts

@@ -4,7 +4,8 @@ import Script from './Script.js'
 import BigNumber from '../primitives/BigNumber.js'
 import OP from './OP.js'
 import ScriptChunk from './ScriptChunk.js'
-import { toHex, minimallyEncode } from '../primitives/utils.js'
+import { minimallyEncode } from '../primitives/utils.js'
+import ScriptEvaluationError from './ScriptEvaluationError.js'
 import * as Hash from '../primitives/Hash.js'
 import TransactionSignature from '../primitives/TransactionSignature.js'
 import PublicKey from '../primitives/PublicKey.js'
@@ -1054,16 +1055,17 @@ export default class Spend {
   }
 
   private scriptEvaluationError (str: string): void {
-    const pcInfo = `Context: ${this.context}, PC: ${this.programCounter}`
-    const stackHex = this.stack.map(s => (s != null && typeof s.length !== 'undefined') ? toHex(s) : (s === null || s === undefined ? 'null/undef' : 'INVALID_STACK_ITEM')).join(', ')
-    const altStackHex = this.altStack.map(s => (s != null && typeof s.length !== 'undefined') ? toHex(s) : (s === null || s === undefined ? 'null/undef' : 'INVALID_STACK_ITEM')).join(', ')
-
-    const stackInfo = `Stack: [${stackHex}] (len: ${this.stack.length}, mem: ${this.stackMem})`
-    const altStackInfo = `AltStack: [${altStackHex}] (len: ${this.altStack.length}, mem: ${this.altStackMem})`
-    const ifStackInfo = `IfStack: [${this.ifStack.join(', ')}]`
-
-    throw new Error(
-      `Script evaluation error: ${str}\nTXID: ${this.sourceTXID}, OutputIdx: ${this.sourceOutputIndex}\n${pcInfo}\n${stackInfo}\n${altStackInfo}\n${ifStackInfo}`
-    )
+    throw new ScriptEvaluationError({
+      message: str,
+      txid: this.sourceTXID,
+      outputIndex: this.sourceOutputIndex,
+      context: this.context,
+      programCounter: this.programCounter,
+      stackState: this.stack,
+      altStackState: this.altStack,
+      ifStackState: this.ifStack,
+      stackMem: this.stackMem,
+      altStackMem: this.altStackMem
+    })
   }
 }

package/src/script/index.ts

@@ -4,6 +4,7 @@ export { default as LockingScript } from './LockingScript.js'
 export { default as UnlockingScript } from './UnlockingScript.js'
 export { default as Spend } from './Spend.js'
 export type { default as ScriptTemplateUnlock } from './ScriptTemplateUnlock.js'
+export { default as ScriptEvaluationError } from './ScriptEvaluationError.js'
 export type { default as ScriptTemplate } from './ScriptTemplate.js'
 export * from './templates/index.js'
 export type { default as ScriptChunk } from './ScriptChunk.js'

package/src/transaction/Beef.ts

@@ -21,18 +21,18 @@ export enum TX_DATA_FORMAT {
 
 /*
  * BEEF standard: BRC-62: Background Evaluation Extended Format (BEEF) Transactions
- * https://github.com/bitcoin-sv/BRCs/blob/master/transactions/0062.md
+ * https://github.com/bsv-blockchain/BRCs/blob/master/transactions/0062.md
  *
  * BUMP standard: BRC-74: BSV Unified Merkle Path (BUMP) Format
- * https://github.com/bitcoin-sv/BRCs/blob/master/transactions/0074.md
+ * https://github.com/bsv-blockchain/BRCs/blob/master/transactions/0074.md
  *
  * BRC-95: Atomic BEEF Transactions
- * https://github.com/bitcoin-sv/BRCs/blob/master/transactions/0095.md
+ * https://github.com/bsv-blockchain/BRCs/blob/master/transactions/0095.md
  *
  * The Atomic BEEF format is supported by the binary deserialization static method `fromBinary`.
  *
  * BRC-96: BEEF V2, Txid Only Extension
- * https://github.com/bitcoin-sv/BRCs/blob/master/transactions/0096.md
+ * https://github.com/bsv-blockchain/BRCs/blob/master/transactions/0096.md
  *
  * A valid serialized BEEF is the cornerstone of Simplified Payment Validation (SPV)
  * where they are exchanged between two non-trusting parties to establish the

package/src/transaction/Transaction.ts

@@ -119,7 +119,11 @@ export default class Transaction {
   static fromAtomicBEEF (beef: number[]): Transaction {
     const { tx, txid, beef: b } = Transaction.fromAnyBeef(beef)
     if (txid !== b.atomicTxid) {
-      if (b.atomicTxid) { throw new Error(`Transaction with TXID ${b.atomicTxid} not found in BEEF data.`) } else { throw new Error('beef must conform to BRC-95 and must contain the subject txid.') }
+      if (b.atomicTxid != null) {
+        throw new Error(`Transaction with TXID ${b.atomicTxid} not found in BEEF data.`)
+      } else {
+        throw new Error('beef must conform to BRC-95 and must contain the subject txid.')
+      }
     }
     return tx
   }
@@ -129,10 +133,14 @@ export default class Transaction {
     if (b.txs.length < 1) {
       throw new Error('beef must include at least one transaction.')
     }
-    const target = txid || b.atomicTxid || b.txs.slice(-1)[0].txid
+    const target = txid ?? b.atomicTxid ?? b.txs.slice(-1)[0].txid
     const tx = b.findAtomicTransaction(target)
     if (tx == null) {
-      if (txid) { throw new Error(`Transaction with TXID ${target} not found in BEEF data.`) } else { throw new Error('beef does not contain transaction for atomic txid.') }
+      if (txid != null) {
+        throw new Error(`Transaction with TXID ${target} not found in BEEF data.`)
+      } else {
+        throw new Error('beef does not contain transaction for atomic txid.')
+      }
     }
     return { tx, beef: b, txid: target }
   }