@bsv/sdk 1.10.1 → 1.10.3

package/src/transaction/MerklePath.ts

@@ -1,7 +1,8 @@
 
-import { Reader, Writer, toHex, toArray } from '../primitives/utils.js'
+import { Reader, Writer, toHex, toArray, WriterUint8Array } from '../primitives/utils.js'
 import { hash256 } from '../primitives/Hash.js'
 import ChainTracker from './ChainTracker.js'
+import { ReaderUint8Array } from '../primitives/ReaderUint8Array.js'
 
 export interface MerklePathLeaf {
   offset: number
@@ -54,7 +55,7 @@ export default class MerklePath {
   }
 
   static fromReader (
-    reader: Reader,
+    reader: Reader | ReaderUint8Array,
     legalOffsetsOnly: boolean = true
   ): MerklePath {
     const blockHeight = reader.readVarIntNum()
@@ -103,8 +104,8 @@ export default class MerklePath {
    * @param {number[]} bump - The binary array representation of the Merkle Path.
    * @returns {MerklePath} - A new MerklePath instance.
    */
-  static fromBinary (bump: number[]): MerklePath {
-    const reader = new Reader(bump)
+  static fromBinary (bump: number[] | Uint8Array): MerklePath {
+    const reader = new ReaderUint8Array(bump)
     return MerklePath.fromReader(reader)
   }
 
@@ -181,12 +182,11 @@ export default class MerklePath {
   }
 
   /**
-   * Converts the MerklePath to a binary array format.
+   * Serializes the MerklePath to the writer provided.
    *
-   * @returns {number[]} - The binary array representation of the Merkle Path.
+   * @param writer - The writer to which the Merkle Path will be serialized.
    */
-  toBinary (): number[] {
-    const writer = new Writer()
+  toWriter (writer: Writer | WriterUint8Array): void {
     writer.writeVarIntNum(this.blockHeight)
     const treeHeight = this.path.length
     writer.writeUInt8(treeHeight)
@@ -208,16 +208,37 @@ export default class MerklePath {
         }
       }
     }
+  }
+
+  /**
+   * Converts the MerklePath to a binary array format.
+   *
+   * @returns {number[]} - The binary array representation of the Merkle Path.
+   */
+  toBinary (): number[] {
+    const writer = new Writer()
+    this.toWriter(writer)
     return writer.toArray()
   }
 
+  /**
+   * Converts the MerklePath to a binary array format.
+   *
+   * @returns {Uint8Array} - The binary array representation of the Merkle Path.
+   */
+  toBinaryUint8Array (): Uint8Array {
+    const writer = new WriterUint8Array()
+    this.toWriter(writer)
+    return writer.toUint8Array()
+  }
+
   /**
    * Converts the MerklePath to a hexadecimal string format.
    *
    * @returns {string} - The hexadecimal string representation of the Merkle Path.
    */
   toHex (): string {
-    return toHex(this.toBinary())
+    return toHex(this.toBinaryUint8Array())
   }
 
   //

package/src/transaction/Transaction.ts

@@ -3,7 +3,7 @@ import TransactionInput from './TransactionInput.js'
 import TransactionOutput from './TransactionOutput.js'
 import UnlockingScript from '../script/UnlockingScript.js'
 import LockingScript from '../script/LockingScript.js'
-import { Reader, Writer, toHex, toArray } from '../primitives/utils.js'
+import { Reader, Writer, toHex, toArray, ReaderUint8Array, toUint8Array, WriterUint8Array } from '../primitives/utils.js'
 import { hash256 } from '../primitives/Hash.js'
 import FeeModel from './FeeModel.js'
 import LivePolicy from './fee-models/LivePolicy.js'
@@ -16,9 +16,6 @@ import { defaultChainTracker } from './chaintrackers/DefaultChainTracker.js'
 import { Beef, BEEF_V1 } from './Beef.js'
 import P2PKH from '../script/templates/P2PKH.js'
 
-const BufferCtor =
-  typeof globalThis !== 'undefined' ? (globalThis as any).Buffer : undefined
-
 /**
  * Represents a complete Bitcoin transaction. This class encapsulates all the details
  * required for creating, signing, and processing a Bitcoin transaction, including
@@ -109,7 +106,7 @@ export default class Transaction {
    * @param txid Optional TXID of the transaction to retrieve from the BEEF data.
    * @returns An anchored transaction, linked to its associated inputs populated with merkle paths.
    */
-  static fromBEEF (beef: number[], txid?: string): Transaction {
+  static fromBEEF (beef: number[] | Uint8Array, txid?: string): Transaction {
     const { tx } = Transaction.fromAnyBeef(beef, txid)
     return tx
   }
@@ -121,7 +118,7 @@ export default class Transaction {
    * @param beef A binary representation of an Atomic BEEF structure.
    * @returns The subject transaction, linked to its associated inputs populated with merkle paths.
    */
-  static fromAtomicBEEF (beef: number[]): Transaction {
+  static fromAtomicBEEF (beef: number[] | Uint8Array): Transaction {
     const { tx, txid, beef: b } = Transaction.fromAnyBeef(beef)
     if (txid !== b.atomicTxid) {
       if (b.atomicTxid != null) {
@@ -133,7 +130,7 @@ export default class Transaction {
     return tx
   }
 
-  private static fromAnyBeef (beef: number[], txid?: string): { tx: Transaction, beef: Beef, txid: string } {
+  private static fromAnyBeef (beef: number[] | Uint8Array, txid?: string): { tx: Transaction, beef: Beef, txid: string } {
     const b = Beef.fromBinary(beef)
     if (b.txs.length < 1) {
       throw new Error('beef must include at least one transaction.')
@@ -155,8 +152,8 @@ export default class Transaction {
    * @param ef A binary representation of a transaction in EF format.
    * @returns An extended transaction, linked to its associated inputs by locking script and satoshis amounts only.
    */
-  static fromEF (ef: number[]): Transaction {
-    const br = new Reader(ef)
+  static fromEF (ef: number[] | Uint8Array): Transaction {
+    const br = ReaderUint8Array.makeReader(ef)
     const version = br.readUInt32LE()
     if (toHex(br.read(6)) !== '0000000000ef') { throw new Error('Invalid EF marker') }
     const inputsLength = br.readVarIntNum()
@@ -217,11 +214,11 @@ export default class Transaction {
    *   outputs: { vout: number, offset: number, length: number }[]
    * }
    */
-  static parseScriptOffsets (bin: number[]): {
+  static parseScriptOffsets (bin: number[] | Uint8Array): {
     inputs: Array<{ vin: number, offset: number, length: number }>
     outputs: Array<{ vout: number, offset: number, length: number }>
   } {
-    const br = new Reader(bin)
+    const br = ReaderUint8Array.makeReader(bin)
     const inputs: Array<{ vin: number, offset: number, length: number }> = []
     const outputs: Array<{ vout: number, offset: number, length: number }> = []
 
@@ -243,7 +240,7 @@ export default class Transaction {
     return { inputs, outputs }
   }
 
-  static fromReader (br: Reader): Transaction {
+  static fromReader (br: Reader | ReaderUint8Array): Transaction {
     const version = br.readUInt32LE()
     const inputsLength = br.readVarIntNum()
     const inputs: TransactionInput[] = []
@@ -284,10 +281,10 @@ 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[] | Uint8Array): Transaction {
     const copy = bin.slice()
     const rawBytes = Uint8Array.from(copy)
-    const br = new Reader(copy)
+    const br = new ReaderUint8Array(rawBytes)
     const tx = Transaction.fromReader(br)
     tx.rawBytesCache = rawBytes
     return tx
@@ -301,15 +298,11 @@ export default class Transaction {
    * @returns {Transaction} - A new Transaction instance.
    */
   static fromHex (hex: string): Transaction {
-    const bin = toArray(hex, 'hex')
-    const rawBytes = Uint8Array.from(bin)
-    const br = new Reader(bin)
+    const rawBytes = toUint8Array(hex, 'hex')
+    const br = new ReaderUint8Array(rawBytes)
     const tx = Transaction.fromReader(br)
     tx.rawBytesCache = rawBytes
-    tx.hexCache =
-      BufferCtor != null
-        ? BufferCtor.from(rawBytes).toString('hex')
-        : toHex(bin)
+    tx.hexCache = toHex(rawBytes)
     return tx
   }
 
@@ -321,7 +314,7 @@ export default class Transaction {
    * @returns {Transaction} - A new Transaction instance.
    */
   static fromHexEF (hex: string): Transaction {
-    return Transaction.fromEF(toArray(hex, 'hex'))
+    return Transaction.fromEF(toUint8Array(hex, 'hex'))
   }
 
   /**
@@ -616,7 +609,7 @@ export default class Transaction {
     return await broadcaster.broadcast(this)
   }
 
-  private writeTransactionBody (writer: Writer): void {
+  private writeTransactionBody (writer: Writer | WriterUint8Array): void {
     writer.writeUInt32LE(this.version)
     writer.writeVarIntNum(this.inputs.length)
     for (const i of this.inputs) {
@@ -649,7 +642,7 @@ export default class Transaction {
   }
 
   private buildSerializedBytes (): Uint8Array {
-    const writer = new Writer()
+    const writer = new WriterUint8Array()
     this.writeTransactionBody(writer)
     return writer.toUint8Array()
   }
@@ -674,13 +667,7 @@ export default class Transaction {
     return this.getSerializedBytes()
   }
 
-  /**
-   * Converts the transaction to a BRC-30 EF format.
-   *
-   * @returns {number[]} - The BRC-30 EF representation of the transaction.
-   */
-  toEF (): number[] {
-    const writer = new Writer()
+  private writeEF (writer: Writer | WriterUint8Array): void {
     writer.writeUInt32LE(this.version)
     writer.write([0, 0, 0, 0, 0, 0xef])
     writer.writeVarIntNum(this.inputs.length)
@@ -721,16 +708,37 @@ export default class Transaction {
       writer.write(scriptBin)
     }
     writer.writeUInt32LE(this.lockTime)
+  }
+
+  /**
+   * Converts the transaction to a BRC-30 EF format.
+   *
+   * @returns {number[]} - The BRC-30 EF representation of the transaction.
+   */
+  toEF (): number[] {
+    const writer = new Writer()
+    this.writeEF(writer)
     return writer.toArray()
   }
 
+  /**
+   * Converts the transaction to a BRC-30 EF format.
+   *
+   * @returns {Uint8Array} - The BRC-30 EF representation of the transaction.
+   */
+  toEFUint8Array (): Uint8Array {
+    const writer = new WriterUint8Array()
+    this.writeEF(writer)
+    return writer.toUint8Array()
+  }
+
   /**
    * Converts the transaction to a hexadecimal string EF.
    *
    * @returns {string} - The hexadecimal string representation of the transaction EF.
    */
   toHexEF (): string {
-    return toHex(this.toEF())
+    return toHex(this.toEFUint8Array())
   }
 
   /**
@@ -743,10 +751,7 @@ export default class Transaction {
       return this.hexCache
     }
     const bytes = this.getSerializedBytes()
-    const hex =
-      BufferCtor != null
-        ? BufferCtor.from(bytes).toString('hex')
-        : toHex(Array.from(bytes))
+    const hex = toHex(bytes)
     this.hexCache = hex
     return hex
   }
@@ -956,8 +961,7 @@ export default class Transaction {
    * @returns The serialized BEEF structure
    * @throws Error if there are any missing sourceTransactions unless `allowPartial` is true.
    */
-  toBEEF (allowPartial?: boolean): number[] {
-    const writer = new Writer()
+  writeSerializedBEEF (writer: Writer | WriterUint8Array, allowPartial?: boolean): void {
     writer.writeUInt32LE(BEEF_V1)
     const BUMPs: MerklePath[] = []
     const bumpIndexByInstance = new Map<MerklePath, number>()
@@ -1035,6 +1039,34 @@ export default class Transaction {
     return writer.toArray()
   }
 
+  /**
+   * Serializes this transaction, together with its inputs and the respective merkle proofs, into the BEEF (BRC-62) format. This enables efficient verification of its compliance with the rules of SPV.
+   *
+   * @param allowPartial If true, error will not be thrown if there are any missing sourceTransactions.
+   *
+   * @returns {number[]} The serialized BEEF structure
+   * @throws Error if there are any missing sourceTransactions unless `allowPartial` is true.
+   */
+  toBEEF (allowPartial?: boolean): number[] {
+    const writer = new Writer()
+    this.writeSerializedBEEF(writer, allowPartial)
+    return writer.toArray()
+  }
+
+  /**
+   * Serializes this transaction, together with its inputs and the respective merkle proofs, into the BEEF (BRC-62) format. This enables efficient verification of its compliance with the rules of SPV.
+   *
+   * @param allowPartial If true, error will not be thrown if there are any missing sourceTransactions.
+   *
+   * @returns {number[]} The serialized BEEF structure
+   * @throws Error if there are any missing sourceTransactions unless `allowPartial` is true.
+   */
+  toBEEFUint8Array (allowPartial?: boolean): Uint8Array {
+    const writer = new WriterUint8Array()
+    this.writeSerializedBEEF(writer, allowPartial)
+    return writer.toArray()
+  }
+
   /**
    * Serializes this transaction and its inputs into the Atomic BEEF (BRC-95) format.
    * The Atomic BEEF format starts with a 4-byte prefix `0x01010101`, followed by the TXID of the subject transaction,
@@ -1052,4 +1084,25 @@ export default class Transaction {
     const beefData = this.toBEEF(allowPartial)
     return prefix.concat(txHash, beefData)
   }
+
+  /**
+   * Serializes this transaction and its inputs into the Atomic BEEF (BRC-95) format.
+   * The Atomic BEEF format starts with a 4-byte prefix `0x01010101`, followed by the TXID of the subject transaction,
+   * and then the BEEF data containing only the subject transaction and its dependencies.
+   * This format ensures that the BEEF structure is atomic and contains no unrelated transactions.
+   *
+   * @param allowPartial If true, error will not be thrown if there are any missing sourceTransactions.
+   *
+   * @returns {number[]} - The serialized Atomic BEEF structure.
+   * @throws Error if there are any missing sourceTransactions unless `allowPartial` is true.
+   */
+  toAtomicBEEFUint8Array (allowPartial?: boolean): Uint8Array {
+    const writer = new WriterUint8Array()
+    const prefix = [1, 1, 1, 1]
+    writer.write(prefix)
+    const txHash = this.hash() as number[]
+    writer.write(txHash)
+    this.writeSerializedBEEF(writer, allowPartial)
+    return writer.toUint8Array()
+  }
 }

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

@@ -324,6 +324,81 @@ describe('Beef tests', () => {
     }
   })
 
+  test('6b_trimKnownTxids_removes_unreferenced_bumps', async () => {
+    // Create a beef with multiple transactions and bumps
+    const beef = Beef.fromString(beefs[0])
+    
+    // Verify initial state
+    const initialBumpCount = beef.bumps.length
+    const initialTxCount = beef.txs.length
+    expect(initialBumpCount).toBe(1)
+    expect(initialTxCount).toBe(1)
+    
+    // Add some txid-only transactions that don't have bumps
+    beef.mergeTxidOnly('txid1')
+    beef.mergeTxidOnly('txid2')
+    beef.mergeTxidOnly('txid3')
+    
+    expect(beef.txs.length).toBe(4)
+    expect(beef.bumps.length).toBe(1)
+    
+    // Get the txid of the transaction with a bump
+    const txWithBump = beef.txs.find(tx => tx.bumpIndex !== undefined)
+    expect(txWithBump).toBeTruthy()
+    
+    // Trim all txid-only transactions
+    beef.trimKnownTxids(['txid1', 'txid2', 'txid3'])
+    
+    // Verify txids were removed
+    expect(beef.txs.length).toBe(1)
+    expect(beef.bumps.length).toBe(1) // Bump should still be there because it's referenced
+    
+    // Now test removing the transaction that has the bump
+    // First, make it txidOnly
+    const originalTxid = txWithBump!.txid
+    beef.makeTxidOnly(originalTxid)
+    
+    // Now trim it
+    beef.trimKnownTxids([originalTxid])
+    
+    // The bump should be removed since no transactions reference it anymore
+    expect(beef.txs.length).toBe(0)
+    expect(beef.bumps.length).toBe(0)
+  })
+
+  test('6c_trimKnownTxids_updates_bump_indices', async () => {
+    // Use existing beef with bumps
+    const beef = Beef.fromString(beefs[0])
+    
+    const initialBumpCount = beef.bumps.length
+    const initialTxCount = beef.txs.length
+    
+    // Find transaction with bump
+    const txWithBump = beef.txs.find(tx => tx.bumpIndex !== undefined)
+    expect(txWithBump).toBeTruthy()
+    const originalBumpIndex = txWithBump!.bumpIndex
+    
+    // Add some txid-only transactions
+    beef.mergeTxidOnly('known1')
+    beef.mergeTxidOnly('known2')
+    
+    expect(beef.txs.length).toBe(initialTxCount + 2)
+    expect(beef.bumps.length).toBe(initialBumpCount)
+    
+    // Trim the known txids
+    beef.trimKnownTxids(['known1', 'known2'])
+    
+    // Verify bump count didn't change (all bumps are still referenced)
+    expect(beef.bumps.length).toBe(initialBumpCount)
+    
+    // Verify transaction count decreased
+    expect(beef.txs.length).toBe(initialTxCount)
+    
+    // Verify bumpIndex is still correct
+    const txAfterTrim = beef.txs.find(tx => tx.txid === txWithBump!.txid)
+    expect(txAfterTrim?.bumpIndex).toBe(originalBumpIndex)
+  })
+
   test('7_AtomicBeef', async () => {
     {
       const beef = Beef.fromString(beefs[0])