@bsv/sdk 1.1.32 → 1.1.33

package/docs/transaction.md

@@ -926,7 +926,9 @@ export class Beef {
     mergeBeef(beef: number[] | Beef) 
     isValid(allowTxidOnly?: boolean): boolean 
     async verify(chainTracker: ChainTracker, allowTxidOnly?: boolean): Promise<boolean> 
+    toWriter(writer: Writer) 
     toBinary(): number[] 
+    toBinaryAtomic(txid: string) 
     toHex(): string 
     static fromReader(br: Reader): Beef 
     static fromBinary(bin: number[]): Beef 
@@ -1187,6 +1189,21 @@ Returns
 
 A binary array representing the BEEF
 
+#### Method toBinaryAtomic
+
+Serialize this Beef as AtomicBEEF.
+
+`txid` must exist and be the last transaction
+in sorted (dependency) order.
+
+```ts
+toBinaryAtomic(txid: string) 
+```
+
+Returns
+
+serialized contents of this Beef with AtomicBEEF prefix.
+
 #### Method toHex
 
 Returns a hex string representing the serialized BEEF
@@ -1209,6 +1226,14 @@ Returns
 
 Summary of `Beef` contents as multi-line string.
 
+#### Method toWriter
+
+Serializes this data to `writer`
+
+```ts
+toWriter(writer: Writer) 
+```
+
 #### Method trimKnownTxids
 
 Ensure that all the txids in `knownTxids` are txidOnly

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/sdk",
-  "version": "1.1.32",
+  "version": "1.1.33",
   "type": "module",
   "description": "BSV Blockchain Software Development Kit",
   "main": "dist/cjs/mod.js",

package/src/transaction/Beef.ts

@@ -396,11 +396,10 @@ export class Beef {
   }
 
   /**
-     * Returns a binary array representing the serialized BEEF
-     * @returns A binary array representing the BEEF
-     */
-  toBinary (): number[] {
-    const writer = new Writer()
+   * Serializes this data to `writer`
+   * @param writer 
+   */
+  toWriter (writer: Writer) {
     writer.writeUInt32LE(this.magic)
 
     writer.writeVarIntNum(this.bumps.length)
@@ -412,7 +411,38 @@ export class Beef {
     for (const tx of this.txs) {
       tx.toWriter(writer, this.magic)
     }
+  }
+
+  /**
+     * Returns a binary array representing the serialized BEEF
+     * @returns A binary array representing the BEEF
+     */
+  toBinary (): number[] {
+    const writer = new Writer()
+    this.toWriter(writer)
+    return writer.toArray()
+  }
 
+  /**
+   * Serialize this Beef as AtomicBEEF.
+   * 
+   * `txid` must exist and be the last transaction
+   * in sorted (dependency) order.
+   * 
+   * @param txid 
+   * @returns serialized contents of this Beef with AtomicBEEF prefix.
+   */
+  toBinaryAtomic(txid: string) {
+    this.sortTxs()
+    const tx = this.findTxid(txid)
+    if (!tx)
+      throw new Error(`${txid} does not exist in this Beef`)
+    if (this.txs[this.txs.length - 1] !== tx)
+      throw new Error(`${txid} is not the last transaction in this Beef`)
+    const writer = new Writer()
+    writer.writeUInt32LE(ATOMIC_BEEF)
+    writer.write(toArray(txid, 'hex'))
+    this.toWriter(writer)
     return writer.toArray()
   }
 
@@ -429,7 +459,7 @@ export class Beef {
     let atomicTxid: string | undefined = undefined
     if (version === ATOMIC_BEEF) {
       // Skip the txid and re-read the BEEF version
-      atomicTxid = toHex(br.readReverse(32))
+      atomicTxid = toHex(br.read(32))
       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}`) }

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

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

@@ -101,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)
@@ -115,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)
@@ -125,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)
@@ -165,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])
@@ -201,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)
@@ -254,7 +254,7 @@ describe('Beef tests', () => {
       }
     })
 
-    test('5_AtomicBeef', async () => {
+    test('7_AtomicBeef', async () => {
       {
         const beef = Beef.fromString(beefs[0])
         expect(beef.toHex()).toBe(beefs[0])
@@ -291,6 +291,20 @@ describe('Beef tests', () => {
         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[] = [