@bsv/sdk 1.0.12 → 1.0.14

package/src/transaction/Transaction.ts

@@ -4,7 +4,6 @@ import UnlockingScript from '../script/UnlockingScript.js'
 import LockingScript from '../script/LockingScript.js'
 import { Reader, Writer, toHex, toArray } from '../primitives/utils.js'
 import { hash256 } from '../primitives/Hash.js'
-import BigNumber from '../primitives/BigNumber.js'
 import FeeModel from './FeeModel.js'
 import SatoshisPerKilobyte from './fee-models/SatoshisPerKilobyte.js'
 import { Broadcaster, BroadcastResponse, BroadcastFailure } from './Broadcaster.js'
@@ -54,13 +53,14 @@ export default class Transaction {
   lockTime: number
   metadata: Record<string, any>
   merklePath?: MerklePath
+  private cachedHash?: number[]
 
   /**
    * Creates a new transaction, linked to its inputs and their associated merkle paths, from a BEEF (BRC-62) structure.
    * @param beef A binary representation of a transaction in BEEF format.
    * @returns An anchored transaction, linked to its associated inputs populated with merkle paths.
    */
-  static fromBEEF(beef: number[]): Transaction {
+  static fromBEEF (beef: number[]): Transaction {
     const reader = new Reader(beef)
     // Read the version
     const version = reader.readUInt32LE()
@@ -120,7 +120,7 @@ export default class Transaction {
     return transactions[lastTXID].tx
   }
 
-  private static fromReader(br: Reader): Transaction {
+  private static fromReader (br: Reader): Transaction {
     const version = br.readUInt32LE()
     const inputsLength = br.readVarIntNum()
     const inputs: TransactionInput[] = []
@@ -161,7 +161,7 @@ export default class Transaction {
    * @param {number[]} bin - The binary array representation of the transaction.
    * @returns {Transaction} - A new Transaction instance.
    */
-  static fromBinary(bin: number[]): Transaction {
+  static fromBinary (bin: number[]): Transaction {
     const br = new Reader(bin)
     return Transaction.fromReader(br)
   }
@@ -173,7 +173,7 @@ export default class Transaction {
    * @param {string} hex - The hexadecimal string representation of the transaction.
    * @returns {Transaction} - A new Transaction instance.
    */
-  static fromHex(hex: string): Transaction {
+  static fromHex (hex: string): Transaction {
     return Transaction.fromBinary(toArray(hex, 'hex'))
   }
 
@@ -184,11 +184,11 @@ export default class Transaction {
    * @param {string} hex - The hexadecimal string representation of the transaction BEEF.
    * @returns {Transaction} - A new Transaction instance.
    */
-  static fromHexBEEF(hex: string): Transaction {
+  static fromHexBEEF (hex: string): Transaction {
     return Transaction.fromBEEF(toArray(hex, 'hex'))
   }
 
-  constructor(
+  constructor (
     version: number = 1,
     inputs: TransactionInput[] = [],
     outputs: TransactionOutput[] = [],
@@ -210,7 +210,7 @@ export default class Transaction {
    * @param {TransactionInput} input - The TransactionInput object to add to the transaction.
    * @throws {Error} - If the input does not have a sourceTXID or sourceTransaction defined.
    */
-  addInput(input: TransactionInput): void {
+  addInput (input: TransactionInput): void {
     if (
       typeof input.sourceTXID === 'undefined' &&
       typeof input.sourceTransaction === 'undefined'
@@ -221,6 +221,7 @@ export default class Transaction {
     if (typeof input.sequence === 'undefined') {
       input.sequence = 0xFFFFFFFF
     }
+    this.cachedHash = undefined
     this.inputs.push(input)
   }
 
@@ -229,7 +230,8 @@ export default class Transaction {
    *
    * @param {TransactionOutput} output - The TransactionOutput object to add to the transaction.
    */
-  addOutput(output: TransactionOutput): void {
+  addOutput (output: TransactionOutput): void {
+    this.cachedHash = undefined
     this.outputs.push(output)
   }
 
@@ -238,7 +240,7 @@ export default class Transaction {
    *
    * @param {Record<string, any>} metadata - The metadata object to merge into the existing metadata.
    */
-  updateMetadata(metadata: Record<string, any>): void {
+  updateMetadata (metadata: Record<string, any>): void {
     this.metadata = {
       ...this.metadata,
       ...metadata
@@ -255,7 +257,8 @@ export default class Transaction {
    *
    * TODO: Benford's law change distribution.
    */
-  async fee(model?: FeeModel, changeDistribution: 'equal' | 'random' = 'equal'): Promise<void> {
+  async fee (model?: FeeModel, changeDistribution: 'equal' | 'random' = 'equal'): Promise<void> {
+    this.cachedHash = undefined
     if (typeof model === 'undefined') {
       model = new SatoshisPerKilobyte(10)
     }
@@ -307,7 +310,8 @@ export default class Transaction {
   /**
    * Signs a transaction, hydrating all its unlocking scripts based on the provided script templates where they are available.
    */
-  async sign(): Promise<void> {
+  async sign (): Promise<void> {
+    this.cachedHash = undefined
     for (const out of this.outputs) {
       if (typeof out.satoshis === 'undefined') {
         if (out.change) {
@@ -319,9 +323,9 @@ export default class Transaction {
     }
     const unlockingScripts = await Promise.all(this.inputs.map(async (x, i): Promise<UnlockingScript | undefined> => {
       if (typeof this.inputs[i].unlockingScriptTemplate === 'object') {
-        return this.inputs[i].unlockingScriptTemplate.sign(this, i)
+        return await this.inputs[i].unlockingScriptTemplate.sign(this, i)
       } else {
-        return Promise.resolve(undefined)
+        return await Promise.resolve(undefined)
       }
     }))
     for (let i = 0, l = this.inputs.length; i < l; i++) {
@@ -337,7 +341,7 @@ export default class Transaction {
    * @param broadcaster The Broadcaster instance wwhere the transaction will be sent
    * @returns A BroadcastResponse or BroadcastFailure from the Broadcaster
    */
-  async broadcast(broadcaster: Broadcaster): Promise<BroadcastResponse | BroadcastFailure> {
+  async broadcast (broadcaster: Broadcaster): Promise<BroadcastResponse | BroadcastFailure> {
     return await broadcaster.broadcast(this)
   }
 
@@ -346,7 +350,7 @@ export default class Transaction {
    *
    * @returns {number[]} - The binary array representation of the transaction.
    */
-  toBinary(): number[] {
+  toBinary (): number[] {
     const writer = new Writer()
     writer.writeUInt32LE(this.version)
     writer.writeVarIntNum(this.inputs.length)
@@ -378,7 +382,7 @@ export default class Transaction {
    *
    * @returns {number[]} - The BRC-30 EF representation of the transaction.
    */
-  toEF(): number[] {
+  toEF (): number[] {
     const writer = new Writer()
     writer.writeUInt32LE(this.version)
     writer.write([0, 0, 0, 0, 0, 0xef])
@@ -414,7 +418,7 @@ export default class Transaction {
    *
    * @returns {string} - The hexadecimal string representation of the transaction EF.
    */
-  toHexEF(): string {
+  toHexEF (): string {
     return toHex(this.toEF())
   }
 
@@ -423,7 +427,7 @@ export default class Transaction {
    *
    * @returns {string} - The hexadecimal string representation of the transaction.
    */
-  toHex(): string {
+  toHex (): string {
     return toHex(this.toBinary())
   }
 
@@ -432,7 +436,7 @@ export default class Transaction {
    *
    * @returns {string} - The hexadecimal string representation of the transaction BEEF.
    */
-  toHexBEEF(): string {
+  toHexBEEF (): string {
     return toHex(this.toBEEF())
   }
 
@@ -442,8 +446,14 @@ export default class Transaction {
    * @param {'hex' | undefined} enc - The encoding to use for the hash. If 'hex', returns a hexadecimal string; otherwise returns a binary array.
    * @returns {string | number[]} - The hash of the transaction in the specified format.
    */
-  hash(enc?: 'hex'): number[] | string {
-    let hash = hash256(this.toBinary())
+  hash (enc?: 'hex'): number[] | string {
+    let hash
+    if (this.cachedHash) {
+      hash = this.cachedHash
+    } else {
+      hash = hash256(this.toBinary())
+      this.cachedHash = hash
+    }
     if (enc === 'hex') {
       return toHex(hash)
     } else {
@@ -457,8 +467,8 @@ export default class Transaction {
    * @param {'hex' | undefined} enc - The encoding to use for the ID. If 'hex', returns a hexadecimal string; otherwise returns a binary array.
    * @returns {string | number[]} - The ID of the transaction in the specified format.
    */
-  id(enc?: 'hex'): number[] | string {
-    const id = hash256(this.toBinary()) as number[]
+  id (enc?: 'hex'): number[] | string {
+    const id = [...this.hash() as number[]]
     id.reverse()
     if (enc === 'hex') {
       return toHex(id)
@@ -473,7 +483,7 @@ export default class Transaction {
    *
    * @returns Whether the transaction is valid according to the rules of SPV.
    */
-  async verify(chainTracker: ChainTracker | 'scripts only'): Promise<boolean> {
+  async verify (chainTracker: ChainTracker | 'scripts only'): Promise<boolean> {
     // If the transaction has a valid merkle path, verification is complete.
     if (typeof this.merklePath === 'object' && chainTracker !== 'scripts only') {
       const proofValid = await this.merklePath.verify(
@@ -541,7 +551,7 @@ export default class Transaction {
    *
    * @returns The serialized BEEF structure
    */
-  toBEEF(): number[] {
+  toBEEF (): number[] {
     const writer = new Writer()
     writer.writeUInt32LE(4022206465)
     const BUMPs: MerklePath[] = []

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

@@ -128,7 +128,7 @@ describe('Transaction', () => {
     it('should add an output', () => {
       const txOut = {
         lockingScript: new LockingScript(),
-        satoshis: new BigNumber(0)
+        satoshis: 1
       }
       const tx = new Transaction()
       expect(tx.outputs.length).toEqual(0)
@@ -153,7 +153,7 @@ describe('Transaction', () => {
         unlockingScriptTemplate: p2pkh.unlock(privateKey),
         sequence: 0xffffffff
       }], [{
-        satoshis: new BigNumber(1000),
+        satoshis: 1000,
         lockingScript: p2pkh.lock(publicKeyHash)
       }, {
         lockingScript: p2pkh.lock(publicKeyHash),
@@ -200,7 +200,7 @@ describe('Transaction', () => {
         }
       }
       const spendTx = new Transaction(1, manyInputs, [{
-        satoshis: new BigNumber(1000),
+        satoshis: 1000,
         lockingScript: p2pkh.lock(publicKeyHash)
       }, {
         lockingScript: p2pkh.lock(publicKeyHash),
@@ -228,7 +228,7 @@ describe('Transaction', () => {
         unlockingScriptTemplate: p2pkh.unlock(privateKey),
         sequence: 0xffffffff
       }], [{
-        satoshis: new BigNumber(1000),
+        satoshis: 1000,
         lockingScript: p2pkh.lock(publicKeyHash)
       }, {
         lockingScript: p2pkh.lock(publicKeyHash),
@@ -254,7 +254,7 @@ describe('Transaction', () => {
         unlockingScriptTemplate: p2pkh.unlock(privateKey),
         sequence: 0xffffffff
       }], [{
-        satoshis: new BigNumber(1000),
+        satoshis: 1000,
         lockingScript: p2pkh.lock(publicKeyHash)
       }, {
         lockingScript: p2pkh.lock(publicKeyHash),