@bsv/sdk 1.1.30 → 1.1.33

package/src/transaction/BeefTx.ts

@@ -18,7 +18,12 @@ export default class BeefTx {
   _rawTx?: number[]
   _txid?: string
   inputTxids: string[] = []
-  degree: number = 0
+  /**
+   * true if `hasProof` or all inputs chain to `hasProof`.
+   * 
+   * Typically set by sorting transactions by proven dependency chains.
+   */
+  isValid?: boolean = undefined
 
   get bumpIndex (): number | undefined { return this._bumpIndex }
 

package/src/transaction/Transaction.ts

@@ -138,7 +138,18 @@ export default class Transaction {
 
     // Ensure that all transactions are part of the dependency graph of the subject transaction
     const validTxids = new Set<string>()
+    // All BUMP level 0 hashes are valid.
+    for (const bump of BUMPs) {
+      for (const n of bump.path[0])
+        if (n.hash)
+          validTxids.add(n.hash)
+    }
+    // To keep track of which transactions were used.
+    const unusedTxTxids = new Set<string>()
+    for (const txid of Object.keys(transactions)) unusedTxTxids.add(txid)
+
     const traverseDependencies = (txid: string) => {
+      unusedTxTxids.delete(txid)
       if (validTxids.has(txid)) {
         return
       }
@@ -156,10 +167,8 @@ export default class Transaction {
     traverseDependencies(subjectTXID)
 
     // Check for any unrelated transactions
-    for (const txid in transactions) {
-      if (!validTxids.has(txid)) {
-        throw new Error(`Unrelated transaction with TXID ${txid} found in Atomic BEEF data.`)
-      }
+    for (const txid of unusedTxTxids) {
+      throw new Error(`Unrelated transaction with TXID ${txid} found in Atomic BEEF data.`)
     }
 
     // Build the transaction by linking inputs and merkle paths
@@ -859,10 +868,13 @@ export default class Transaction {
 
   /**
    * 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 The serialized BEEF structure
+   * @throws Error if there are any missing sourceTransactions unless `allowPartial` is true.
    */
-  toBEEF (): number[] {
+  toBEEF (allowPartial?: boolean): number[] {
     const writer = new Writer()
     writer.writeUInt32LE(4022206465)
     const BUMPs: MerklePath[] = []
@@ -907,10 +919,10 @@ export default class Transaction {
       if (!hasProof) {
         for (let i = 0; i < tx.inputs.length; i++) {
           const input = tx.inputs[i]
-          if (typeof input.sourceTransaction !== 'object') {
+          if (typeof input.sourceTransaction === 'object')
+            addPathsAndInputs(input.sourceTransaction)
+          else if (!allowPartial)
             throw new Error('A required source transaction is missing!')
-          }
-          addPathsAndInputs(input.sourceTransaction)
         }
       }
     }
@@ -940,16 +952,19 @@ export default class 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.
    */
-  toAtomicBEEF (): number[] {
+  toAtomicBEEF (allowPartial?: boolean): number[] {
     const writer = new Writer()
     // Write the Atomic BEEF prefix
     writer.writeUInt32LE(0x01010101)
     // Write the subject TXID (big-endian)
     writer.write(this.id())
     // Append the BEEF data
-    const beefData = this.toBEEF()
+    const beefData = this.toBEEF(allowPartial)
     writer.write(beefData)
     return writer.toArray()
   }

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

@@ -1,9 +1,17 @@
+// The following imports allow flag a large number type checking errors by the VsCode editor due to missing type information:
 import BeefTx from "../../../dist/cjs/src/transaction/BeefTx"
 import Beef from "../../../dist/cjs/src/transaction/Beef"
 import BeefParty from "../../../dist/cjs/src/transaction/BeefParty"
 import { BEEF_MAGIC, BEEF_MAGIC_V2 } from "../../../dist/cjs/src/transaction/Beef"
 import Transaction from "../../../dist/cjs/src/transaction/Transaction"
 
+// The following imports allow full type checking by the VsCode editor, but tests will fail to run:
+//import BeefTx from '../BeefTx'
+//import Beef from '../Beef'
+//import BeefParty from "../BeefParty"
+//import { BEEF_MAGIC, BEEF_MAGIC_V2 } from "../Beef"
+//import Transaction from "../Transaction"
+
 describe('Beef tests', () => {
     jest.setTimeout(99999999)
 
@@ -56,8 +64,8 @@ describe('Beef tests', () => {
           expect(btx.rawTx).toBe(undefined)
         }
 
-        const missing = beef.sortTxs()
-        expect(missing.length).toBe(0)
+        const r = beef.sortTxs()
+        expect(r.missingInputs.length).toBe(0)
         expect(beef.toLogString()).toBe(log2)
 
         {
@@ -72,8 +80,8 @@ describe('Beef tests', () => {
         {
           const beef = new Beef()
           beef.mergeTransaction(Transaction.fromHex(txs[0]))
-          const missing = beef.sortTxs()
-          expect(missing).toEqual(['bd4a39c6dce3bdd982be3c67eb04b83934fd431f8bcb64f9da4413c91c634d07'])
+          const { missingInputs } = beef.sortTxs()
+          expect(missingInputs).toEqual(['bd4a39c6dce3bdd982be3c67eb04b83934fd431f8bcb64f9da4413c91c634d07'])
           const beef0 = Beef.fromString(beefs[0])
           beef.mergeBump(beef0.bumps[0])
           beef.mergeRawTx(beef0.txs[0].rawTx!, undefined)
@@ -93,7 +101,7 @@ describe('Beef tests', () => {
         }
     })
 
-    test('4_all merkleRoots equal', async () => {
+    test('1_all merkleRoots equal', async () => {
         {
           const beef = Beef.fromString(beefs[0])
           expect(beef.isValid(undefined)).toBe(true)
@@ -107,7 +115,7 @@ describe('Beef tests', () => {
         }
     })
 
-    test('4_allowTxidOnly', async () => {
+    test('2_allowTxidOnly', async () => {
         {
           const beef = Beef.fromString(beefs[0])
           expect(beef.isValid(undefined)).toBe(true)
@@ -117,7 +125,7 @@ describe('Beef tests', () => {
         }
     })
 
-    test('4_removeExistingTxid', async () => {
+    test('3_removeExistingTxid', async () => {
         {
           const beef = Beef.fromString(beefs[0])
           expect(beef.isValid(undefined)).toBe(true)
@@ -157,7 +165,7 @@ describe('Beef tests', () => {
         }
     })
 
-    test('4_mergeBeef', async () => {
+    test('5_mergeBeef', async () => {
         {
           const beef = Beef.fromString(beefs[0])
           const beefB = Beef.fromString(beefs[0])
@@ -193,7 +201,7 @@ describe('Beef tests', () => {
         }
     })
 
-    test('4_BeefParty', async () => {
+    test('6_BeefParty', async () => {
 
       const bp = new BeefParty(['b', 'c'])
       expect(bp.isParty('a')).toBe(false)
@@ -215,10 +223,10 @@ describe('Beef tests', () => {
         const v = bp.getTrimmedBeefForParty('a').toLogString()
         expect(v).toBe(`BEEF with 0 BUMPS and 2 Transactions, isValid false
   TX 0
-    txid: 4
+    txid: 3
     txidOnly
   TX 1
-    txid: 3
+    txid: 4
     txidOnly
 `)
       }
@@ -226,10 +234,10 @@ describe('Beef tests', () => {
         const v = bp.getTrimmedBeefForParty('b').toLogString()
         expect(v).toBe(`BEEF with 0 BUMPS and 2 Transactions, isValid false
   TX 0
-    txid: 2
+    txid: 1
     txidOnly
   TX 1
-    txid: 1
+    txid: 2
     txidOnly
 `)
       }
@@ -237,15 +245,66 @@ describe('Beef tests', () => {
         const v = bp.getTrimmedBeefForParty('c').toLogString()
         expect(v).toBe(`BEEF with 0 BUMPS and 2 Transactions, isValid false
   TX 0
-    txid: 4
+    txid: 1
     txidOnly
   TX 1
-    txid: 1
+    txid: 4
     txidOnly
 `)
       }
     })
 
+    test('7_AtomicBeef', async () => {
+      {
+        const beef = Beef.fromString(beefs[0])
+        expect(beef.toHex()).toBe(beefs[0])
+        const sr = beef.sortTxs()
+        const beefHex = beef.toHex()
+        const tx = beef.txs[beef.txs.length - 1].tx!
+        expect(tx).toBeTruthy()
+        const atomic = tx.toAtomicBEEF(true)
+        // Verify that atomic BEEF can be deserialized.
+        const beef2 = Beef.fromBinary(atomic)
+        // The merkle path isn't linked to tx by default.
+        expect(beef2.toHex()).not.toBe(beefHex)
+        {
+          const atx = beef.findAtomicTransaction(tx.id('hex'))
+          const atomic = atx.toAtomicBEEF(true)
+          // Verify that atomic BEEF can be deserialized.
+          const beef2 = Beef.fromBinary(atomic)
+          // The merkle path now is linked to tx by default.
+          expect(beef2.toHex()).toBe(beefHex)
+        }
+      }
+      {
+        const beef = Beef.fromString(beefs[0])
+        expect(beef.toHex()).toBe(beefs[0])
+        beef.mergeTransaction(Transaction.fromHex(txs[0]))
+        const sr = beef.sortTxs()
+        const beefHex = beef.toHex()
+        const tx = beef.txs[beef.txs.length - 1].tx!
+        expect(tx).toBeTruthy()
+        const atx = beef.findAtomicTransaction(tx.id('hex'))
+        const atomic = atx.toAtomicBEEF()
+        // Verify that atomic BEEF can be deserialized.
+        const beef2 = Beef.fromBinary(atomic)
+        expect(beef2.toHex()).toBe(beefHex)
+      }
+    })
+
+    test('8_toBinaryAtomic', async () => {
+      {
+        const beef = Beef.fromString(beefs[0])
+        const tx = Transaction.fromHex(txs[0])
+        beef.mergeTransaction(tx)
+        const sr = beef.sortTxs()
+        const log = beef.toLogString()
+        const atomic = beef.toBinaryAtomic(tx.id('hex'))
+        const t2 = Transaction.fromAtomicBEEF(atomic)
+        const beef2 = t2.toAtomicBEEF()
+        expect(atomic).toEqual(beef2)
+      }
+    })
 })
 
 const txs: string[] = [