@bsv/sdk 1.1.25 → 1.1.27

package/src/transaction/Beef.ts

@@ -8,6 +8,8 @@ export const BEEF_MAGIC = 4022206465    // 0100BEEF in LE order
 export const BEEF_MAGIC_V2 = 4022206466 // 0200BEEF in LE order
 export const BEEF_MAGIC_TXID_ONLY_EXTENSION = 4022206465 // 0100BEEF in LE order
 
+export type BeefVersion = undefined | 'V1' | 'V2'
+
 /*
  * BEEF standard: BRC-62: Background Evaluation Extended Format (BEEF) Transactions
  * https://github.com/bitcoin-sv/BRCs/blob/master/transactions/0062.md
@@ -50,21 +52,29 @@ export const BEEF_MAGIC_TXID_ONLY_EXTENSION = 4022206465 // 0100BEEF in LE order
 export class Beef {
     bumps: MerklePath[] = []
     txs: BeefTx[] = []
+    version: BeefVersion = undefined
 
-    constructor() {
+    constructor(version?: BeefVersion) {
+        this.version = version
     }
 
     /**
      * BEEF_MAGIC is the original V1 version.
      * BEEF_MAGIC_V2 includes support for txidOnly transactions in serialized beefs.
-     * @returns version based on current contents.
+     * @returns version magic value based on current contents and constructor version parameter.
      */
-    get version(): number {
-        const hasTxidOnly = !this.txs.every(tx => !tx.isTxidOnly)
+    get magic(): number {
+        if (this.version === 'V1')
+            return BEEF_MAGIC
+
+        if (this.version === 'V2')
+            return BEEF_MAGIC_V2
+
+        const hasTxidOnly = -1 < this.txs.findIndex(tx => tx.isTxidOnly)
         if (hasTxidOnly)
             return BEEF_MAGIC_V2
-        else
-            return BEEF_MAGIC
+
+        return BEEF_MAGIC
     }
 
     /**
@@ -184,6 +194,9 @@ export class Beef {
     }
 
     mergeTxidOnly(txid: string): BeefTx {
+        if (this.version === 'V1')
+            throw new Error(`BEEF V1 format does not support txid only transactions.`)
+
         let tx = this.txs.find(t => t.txid === txid)
         if (!tx) {
             tx = new BeefTx(txid)
@@ -317,7 +330,7 @@ export class Beef {
     toBinary(): number[] {
 
         const writer = new Writer()
-        writer.writeUInt32LE(this.version)
+        writer.writeUInt32LE(this.magic)
 
         writer.writeVarIntNum(this.bumps.length)
         for (const b of this.bumps) {
@@ -326,7 +339,7 @@ export class Beef {
 
         writer.writeVarIntNum(this.txs.length)
         for (const tx of this.txs) {
-            tx.toWriter(writer)
+            tx.toWriter(writer, this.magic)
         }
 
         return writer.toArray()
@@ -344,7 +357,7 @@ export class Beef {
         const version = br.readUInt32LE()
         if (version !== BEEF_MAGIC && version !== BEEF_MAGIC_V2)
             throw new Error(`Serialized BEEF must start with ${BEEF_MAGIC} or ${BEEF_MAGIC_V2} but starts with ${version}`)
-        const beef = new Beef()
+        const beef = new Beef(version === BEEF_MAGIC_V2 ? 'V2' : undefined)
         const bumpsLength = br.readVarIntNum()
         for (let i = 0; i < bumpsLength; i++) {
             const bump = MerklePath.fromReader(br)
@@ -352,7 +365,7 @@ export class Beef {
         }
         const txsLength = br.readVarIntNum()
         for (let i = 0; i < txsLength; i++) {
-            const beefTx = BeefTx.fromReader(br)
+            const beefTx = BeefTx.fromReader(br, version)
             beef.txs.push(beefTx)
         }
         return beef

package/src/transaction/BeefTx.ts

@@ -1,7 +1,7 @@
 import { hash256 } from "../primitives/Hash.js"
 import { Reader, Writer, toHex, toArray } from "../primitives/utils.js"
 import Transaction from "./Transaction.js"
-import { BEEF_MAGIC_TXID_ONLY_EXTENSION } from "./Beef.js"
+import { BEEF_MAGIC, BEEF_MAGIC_TXID_ONLY_EXTENSION } from "./Beef.js"
 
 /**
  * A single bitcoin transaction associated with a `Beef` validity proof set.
@@ -84,36 +84,77 @@ export default class BeefTx {
         }
     }
 
-    toWriter(writer: Writer) : void {
-        if (this.isTxidOnly) {
-            // Encode just the txid of a known transaction using the txid
-            writer.writeUInt32LE(BEEF_MAGIC_TXID_ONLY_EXTENSION)
-            writer.writeReverse(toArray(this._txid, 'hex'))
-        } else if (this._rawTx)
-            writer.write(this._rawTx)
-        else if (this._tx)
-            writer.write(this._tx.toBinary())
-        else
-            throw new Error('a valid serialized Transaction is expected')
-        if (this.bumpIndex === undefined) {
-            writer.writeUInt8(0)
+    toWriter(writer: Writer, magic: number) : void {
+        if (magic === BEEF_MAGIC) {
+            // V1
+            if (this.isTxidOnly) {
+                // Encode just the txid of a known transaction using the txid
+                writer.writeUInt32LE(BEEF_MAGIC_TXID_ONLY_EXTENSION)
+                writer.writeReverse(toArray(this._txid, 'hex'))
+            } else if (this._rawTx)
+                writer.write(this._rawTx)
+            else if (this._tx)
+                writer.write(this._tx.toBinary())
+            else
+                throw new Error('a valid serialized Transaction is expected')
+            if (this.bumpIndex === undefined) {
+                writer.writeUInt8(0)
+            } else {
+                writer.writeUInt8(1)
+                writer.writeVarIntNum(this.bumpIndex)
+            }
         } else {
-            writer.writeUInt8(1)
-            writer.writeVarIntNum(this.bumpIndex)
+            // V2
+            if (this.isTxidOnly) {
+                // Encode just the txid of a known transaction using the txid
+                writer.writeUInt8(2)
+                writer.writeReverse(toArray(this._txid, 'hex'))
+            } else {
+                if (this.bumpIndex === undefined) {
+                    writer.writeUInt8(0)
+                } else {
+                    writer.writeUInt8(1)
+                    writer.writeVarIntNum(this.bumpIndex)
+                }
+                if (this._rawTx)
+                    writer.write(this._rawTx)
+                else if (this._tx)
+                    writer.write(this._tx.toBinary())
+                else
+                    throw new Error('a valid serialized Transaction is expected')
+            }
         }
     }
 
-    static fromReader (br: Reader): BeefTx {
+    static fromReader (br: Reader, magic: number): BeefTx {
+
         let tx: Transaction | number[] | string | undefined = undefined
-        const version = br.readUInt32LE()
-        if (version === BEEF_MAGIC_TXID_ONLY_EXTENSION) {
-            // This is the extension to support known transactions
-            tx = toHex(br.readReverse(32))
+        let bumpIndex: number | undefined = undefined
+
+        if (magic === BEEF_MAGIC) {
+            // V1
+            const version = br.readUInt32LE()
+            if (version === BEEF_MAGIC_TXID_ONLY_EXTENSION) {
+                // This is the extension to support known transactions
+                tx = toHex(br.readReverse(32))
+            } else {
+                br.pos -= 4 // Unread the version...
+                tx = Transaction.fromReader(br)
+            }
+            bumpIndex = br.readUInt8() ? br.readVarIntNum() : undefined
         } else {
-            br.pos -= 4 // Unread the version...
-            tx = Transaction.fromReader(br)
+            // V2
+            const format = br.readUInt8()
+            if (format === 2) {
+                // txid only
+                tx = toHex(br.readReverse(32))
+            } else {
+                if (format === 1)
+                    bumpIndex =  br.readVarIntNum()
+                tx = Transaction.fromReader(br)
+            }
         }
-        const bumpIndex = br.readUInt8() ? br.readVarIntNum() : undefined
+
         const beefTx = new BeefTx(tx, bumpIndex)
         return beefTx
     }

package/src/transaction/MerklePath.ts

@@ -46,11 +46,11 @@ export default class MerklePath {
    * @param {string} hex - The hexadecimal string representation of the Merkle Path.
    * @returns {MerklePath} - A new MerklePath instance.
    */
-  static fromHex (hex: string): MerklePath {
+  static fromHex(hex: string): MerklePath {
     return MerklePath.fromBinary(toArray(hex, 'hex'))
   }
 
-  static fromReader (reader: Reader): MerklePath {
+  static fromReader(reader: Reader): MerklePath {
     const blockHeight = reader.readVarIntNum()
     const treeHeight = reader.readUInt8()
     const path = Array(treeHeight).fill(0).map(() => ([]))
@@ -89,12 +89,12 @@ 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 {
+  static fromBinary(bump: number[]): MerklePath {
     const reader = new Reader(bump)
     return MerklePath.fromReader(reader)
   }
 
-  constructor (blockHeight: number, path: Array<Array<{
+  constructor(blockHeight: number, path: Array<Array<{
     offset: number
     hash?: string
     txid?: boolean
@@ -142,7 +142,7 @@ export default class MerklePath {
    *
    * @returns {number[]} - The binary array representation of the Merkle Path.
    */
-  toBinary (): number[] {
+  toBinary(): number[] {
     const writer = new Writer()
     writer.writeVarIntNum(this.blockHeight)
     const treeHeight = this.path.length
@@ -173,7 +173,7 @@ export default class MerklePath {
    *
    * @returns {string} - The hexadecimal string representation of the Merkle Path.
    */
-  toHex (): string {
+  toHex(): string {
     return toHex(this.toBinary())
   }
 
@@ -184,7 +184,7 @@ export default class MerklePath {
    * @returns {string} - The computed Merkle root as a hexadecimal string.
    * @throws {Error} - If the transaction ID is not part of the Merkle Path.
    */
-  computeRoot (txid?: string): string {
+  computeRoot(txid?: string): string {
     if (typeof txid !== 'string') {
       txid = this.path[0].find(leaf => Boolean(leaf?.hash)).hash
     }
@@ -224,7 +224,7 @@ export default class MerklePath {
    * @param height
    * @param offset
    */
-  findOrComputeLeaf (height: number, offset: number): MerklePathLeaf | undefined {
+  findOrComputeLeaf(height: number, offset: number): MerklePathLeaf | undefined {
     const hash = (m: string): string => toHex((
       hash256(toArray(m, 'hex').reverse())
     ).reverse())
@@ -261,7 +261,7 @@ export default class MerklePath {
    * @param {ChainTracker} chainTracker - The ChainTracker instance used to verify the Merkle root.
    * @returns {boolean} - True if the transaction ID is valid within the Merkle Path at the specified block height.
    */
-  async verify (txid: string, chainTracker: ChainTracker): Promise<boolean> {
+  async verify(txid: string, chainTracker: ChainTracker): Promise<boolean> {
     const root = this.computeRoot(txid)
     // Use the chain tracker to determine whether this is a valid merkle root at the given block height
     return await chainTracker.isValidRootForHeight(root, this.blockHeight)
@@ -273,7 +273,7 @@ export default class MerklePath {
    * @param {MerklePath} other - Another MerklePath to combine with this path.
    * @throws {Error} - If the paths have different block heights or roots.
    */
-  combine (other: MerklePath): void {
+  combine(other: MerklePath): void {
     if (this.blockHeight !== other.blockHeight) {
       throw new Error('You cannot combine paths which do not have the same block height.')
     }
@@ -309,7 +309,7 @@ export default class MerklePath {
    * Assumes that at least all required nodes are present.
    * Leaves all levels sorted by increasing offset.
    */
-  trim () {
+  trim() {
     const pushIfNew = (v: number, a: number[]) => {
       if (a.length === 0 || a.slice(-1)[0] !== v) { a.push(v) }
     }