@bsv/sdk 1.1.26 → 1.1.28

package/docs/transaction.md

@@ -866,8 +866,8 @@ export default class BeefTx {
     get tx() 
     get rawTx() 
     constructor(tx: Transaction | number[] | string, bumpIndex?: number) 
-    toWriter(writer: Writer): void 
-    static fromReader(br: Reader): BeefTx 
+    toWriter(writer: Writer, magic: number): void 
+    static fromReader(br: Reader, magic: number): BeefTx 
 }
 ```
 
@@ -899,8 +899,9 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 export class Beef {
     bumps: MerklePath[] = [];
     txs: BeefTx[] = [];
-    constructor() 
-    get version(): number 
+    version: BeefVersion = undefined;
+    constructor(version?: BeefVersion) 
+    get magic(): number 
     findTxid(txid: string): BeefTx | undefined 
     mergeBump(bump: MerklePath): number 
     mergeRawTx(rawTx: number[], bumpIndex?: number): BeefTx 
@@ -1869,6 +1870,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 | |
 | --- |
+| [BeefVersion](#type-beefversion) |
 | [Fetch](#type-fetch) |
 | [HttpClientResponse](#type-httpclientresponse) |
 
@@ -1909,6 +1911,15 @@ export type Fetch = (url: string, options: FetchOptions) => Promise<Response>
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
 
+---
+### Type: BeefVersion
+
+```ts
+export type BeefVersion = undefined | "V1" | "V2"
+```
+
+Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Variables](#variables)
+
 ---
 ## Variables
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bsv/sdk",
-  "version": "1.1.26",
+  "version": "1.1.28",
   "type": "module",
   "description": "BSV Blockchain Software Development Kit",
   "main": "dist/cjs/mod.js",
@@ -133,6 +133,9 @@
       "import": "./dist/esm/src/totp/*.js",
       "require": "./dist/cjs/src/totp/*.js",
       "types": "./dist/types/src/totp/*.d.ts"
+    },
+    "./umd": {
+      "import": "./dist/umd/bundle.js"
     }
   },
   "scripts": {
@@ -140,7 +143,9 @@
     "test:watch": "npm run build && jest --watch",
     "test:coverage": "npm run build && jest --coverage",
     "lint": "ts-standard --fix src/**/*.ts",
-    "build": "tsc -b && tsconfig-to-dual-package tsconfig.cjs.json",
+    "build": "npm run build:ts && npm run build:umd",
+    "build:ts": "tsc -b && tsconfig-to-dual-package tsconfig.cjs.json",
+    "build:umd": "webpack --config webpack.config.js",
     "dev": "tsc -b -w",
     "prepublish": "npm run build",
     "doc": "ts2md --inputFilename=src/script/index.ts --outputFilename=docs/script.md --filenameSubString=script --firstHeadingLevel=1 && ts2md --inputFilename=src/primitives/index.ts --outputFilename=docs/primitives.md --filenameSubString=primitives --firstHeadingLevel=1 && ts2md --inputFilename=src/transaction/index.ts --outputFilename=docs/transaction.md --filenameSubString=transaction --firstHeadingLevel=1 && ts2md --inputFilename=src/messages/index.ts --outputFilename=docs/messages.md --filenameSubString=messages --firstHeadingLevel=1 && ts2md --inputFilename=src/compat/index.ts --outputFilename=docs/compat.md --filenameSubString=compat --firstHeadingLevel=1"
@@ -166,9 +171,12 @@
     "@types/jest": "^29.5.5",
     "jest": "^29.7.0",
     "ts-jest": "^29.1.1",
+    "ts-loader": "^9.5.1",
     "ts-standard": "^12.0.2",
     "ts2md": "^0.2.0",
     "tsconfig-to-dual-package": "^1.2.0",
-    "typescript": "^5.2.2"
+    "typescript": "^5.2.2",
+    "webpack": "^5.95.0",
+    "webpack-cli": "^5.1.4"
   }
 }

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
     }