@bsv/sdk 1.3.12 → 1.3.14

package/docs/transaction.md

@@ -34,7 +34,7 @@ export interface ArcConfig {
 }
 ```
 
-See also: [HttpClient](#interface-httpclient)
+See also: [HttpClient](./transaction.md#interface-httpclient)
 
 <details>
 
@@ -87,7 +87,7 @@ The HTTP client used to make requests to the ARC API.
 ```ts
 httpClient?: HttpClient
 ```
-See also: [HttpClient](#interface-httpclient)
+See also: [HttpClient](./transaction.md#interface-httpclient)
 
 </details>
 
@@ -139,7 +139,7 @@ export interface Broadcaster {
 }
 ```
 
-See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Transaction](#class-transaction)
+See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Transaction](./transaction.md#class-transaction)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -161,8 +161,8 @@ const chainTracker = {
     // Implementation to check if the Merkle root is valid for the specified block height.
   }
  currentHeight: async () => {
-   // Implementation to get the current block height.
- }
+    // Implementation to get the current block height.
+  }
 };
 ```
 
@@ -187,7 +187,7 @@ export default interface FeeModel {
 }
 ```
 
-See also: [Transaction](#class-transaction)
+See also: [Transaction](./transaction.md#class-transaction)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -248,7 +248,7 @@ export interface HttpClient {
 }
 ```
 
-See also: [HttpClientRequestOptions](#interface-httpclientrequestoptions), [HttpClientResponse](#type-httpclientresponse)
+See also: [HttpClientRequestOptions](./transaction.md#interface-httpclientrequestoptions), [HttpClientResponse](./transaction.md#type-httpclientresponse)
 
 <details>
 
@@ -261,7 +261,7 @@ Makes a request to the server.
 ```ts
 request: <T = any, D = any>(url: string, options: HttpClientRequestOptions<D>) => Promise<HttpClientResponse<T>>
 ```
-See also: [HttpClientRequestOptions](#interface-httpclientrequestoptions), [HttpClientResponse](#type-httpclientresponse)
+See also: [HttpClientRequestOptions](./transaction.md#interface-httpclientrequestoptions), [HttpClientResponse](./transaction.md#type-httpclientresponse)
 
 </details>
 
@@ -315,7 +315,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 ---
 ### Interface: HttpsNodejs
 
-Node.js Https module interface limited to options needed by ts-sdk
+Node Https module interface limited to options needed by ts-sdk
 
 ```ts
 export interface HttpsNodejs {
@@ -323,7 +323,7 @@ export interface HttpsNodejs {
 }
 ```
 
-See also: [HttpClientRequestOptions](#interface-httpclientrequestoptions), [NodejsHttpClientRequest](#interface-nodejshttpclientrequest)
+See also: [HttpClientRequestOptions](./transaction.md#interface-httpclientrequestoptions), [NodejsHttpClientRequest](./transaction.md#interface-nodejshttpclientrequest)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -344,7 +344,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 ---
 ### Interface: NodejsHttpClientRequest
 
-Nodejs result of the Node.js https.request call limited to options needed by ts-sdk
+Nodejs result of the Node https.request call limited to options needed by ts-sdk
 
 ```ts
 export interface NodejsHttpClientRequest {
@@ -394,7 +394,7 @@ export default interface TransactionInput {
 }
 ```
 
-See also: [Transaction](#class-transaction), [UnlockingScript](#class-unlockingscript), [sign](#variable-sign)
+See also: [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -424,7 +424,7 @@ export default interface TransactionOutput {
 }
 ```
 
-See also: [LockingScript](#class-lockingscript)
+See also: [LockingScript](./script.md#class-lockingscript)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -440,7 +440,7 @@ export interface WhatsOnChainConfig {
 }
 ```
 
-See also: [HttpClient](#interface-httpclient)
+See also: [HttpClient](./transaction.md#interface-httpclient)
 
 <details>
 
@@ -461,7 +461,7 @@ The HTTP client used to make requests to the API.
 ```ts
 httpClient?: HttpClient
 ```
-See also: [HttpClient](#interface-httpclient)
+See also: [HttpClient](./transaction.md#interface-httpclient)
 
 </details>
 
@@ -503,11 +503,11 @@ export default class ARC implements Broadcaster {
     constructor(URL: string, apiKey?: string);
     constructor(URL: string, config?: string | ArcConfig) 
     async broadcast(tx: Transaction): Promise<BroadcastResponse | BroadcastFailure> 
-    async broadcastMany(txs: Transaction[]): Promise<Array<object>> 
+    async broadcastMany(txs: Transaction[]): Promise<object[]> 
 }
 ```
 
-See also: [ArcConfig](#interface-arcconfig), [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Broadcaster](#interface-broadcaster), [Transaction](#class-transaction)
+See also: [ArcConfig](./transaction.md#interface-arcconfig), [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Broadcaster](./transaction.md#interface-broadcaster), [Transaction](./transaction.md#class-transaction)
 
 <details>
 
@@ -520,7 +520,7 @@ Constructs an instance of the ARC broadcaster.
 ```ts
 constructor(URL: string, config?: ArcConfig)
 ```
-See also: [ArcConfig](#interface-arcconfig)
+See also: [ArcConfig](./transaction.md#interface-arcconfig)
 
 Argument Details
 
@@ -551,7 +551,7 @@ Broadcasts a transaction via ARC.
 ```ts
 async broadcast(tx: Transaction): Promise<BroadcastResponse | BroadcastFailure> 
 ```
-See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Transaction](#class-transaction)
+See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Transaction](./transaction.md#class-transaction)
 
 Returns
 
@@ -568,9 +568,9 @@ Broadcasts multiple transactions via ARC.
 Handles mixed responses where some transactions succeed and others fail.
 
 ```ts
-async broadcastMany(txs: Transaction[]): Promise<Array<object>> 
+async broadcastMany(txs: Transaction[]): Promise<object[]> 
 ```
-See also: [Transaction](#class-transaction)
+See also: [Transaction](./transaction.md#class-transaction)
 
 Returns
 
@@ -603,15 +603,15 @@ export class Beef {
     mergeBump(bump: MerklePath): number 
     mergeRawTx(rawTx: number[], bumpIndex?: number): BeefTx 
     mergeTransaction(tx: Transaction): BeefTx 
-    removeExistingTxid(txid: string) 
+    removeExistingTxid(txid: string): void 
     mergeTxidOnly(txid: string): BeefTx 
     mergeBeefTx(btx: BeefTx): BeefTx 
-    mergeBeef(beef: number[] | Beef) 
+    mergeBeef(beef: number[] | Beef): void 
     isValid(allowTxidOnly?: boolean): boolean 
     async verify(chainTracker: ChainTracker, allowTxidOnly?: boolean): Promise<boolean> 
-    toWriter(writer: Writer) 
+    toWriter(writer: Writer): void 
     toBinary(): number[] 
-    toBinaryAtomic(txid: string) 
+    toBinaryAtomic(txid: string): number[] 
     toHex(): string 
     static fromReader(br: Reader): Beef 
     static fromBinary(bin: number[]): Beef 
@@ -624,14 +624,14 @@ export class Beef {
         txidOnly: string[];
     } 
     clone(): Beef 
-    trimKnownTxids(knownTxids: string[]) 
+    trimKnownTxids(knownTxids: string[]): void 
     getValidTxids(): string[] 
     toLogString(): string 
-    addComputedLeaves() 
+    addComputedLeaves(): void 
 }
 ```
 
-See also: [BEEF_V2](#variable-beef_v2), [BeefTx](#class-beeftx), [ChainTracker](#interface-chaintracker), [MerklePath](#class-merklepath), [Reader](#class-reader), [Transaction](#class-transaction), [Writer](#class-writer), [toHex](#variable-tohex), [verify](#variable-verify)
+See also: [BEEF_V2](./transaction.md#variable-beef_v2), [BeefTx](./transaction.md#class-beeftx), [ChainTracker](./transaction.md#interface-chaintracker), [MerklePath](./transaction.md#class-merklepath), [Reader](./primitives.md#class-reader), [Transaction](./transaction.md#class-transaction), [Writer](./primitives.md#class-writer), [toHex](./primitives.md#variable-tohex), [verify](./compat.md#variable-verify)
 
 <details>
 
@@ -639,11 +639,11 @@ See also: [BEEF_V2](#variable-beef_v2), [BeefTx](#class-beeftx), [ChainTracker](
 
 #### Method addComputedLeaves
 
-In some circumstances it may be helpful for the BUMP MerkePaths to include
+In some circumstances it may be helpful for the BUMP MerklePaths to include
 leaves that can be computed from row zero.
 
 ```ts
-addComputedLeaves() 
+addComputedLeaves(): void 
 ```
 
 #### Method clone
@@ -651,7 +651,7 @@ addComputedLeaves()
 ```ts
 clone(): Beef 
 ```
-See also: [Beef](#class-beef)
+See also: [Beef](./transaction.md#class-beef)
 
 Returns
 
@@ -666,7 +666,7 @@ To succeed, the Beef must contain all the required transaction and merkle path d
 ```ts
 findAtomicTransaction(txid: string): Transaction | undefined 
 ```
-See also: [Transaction](#class-transaction)
+See also: [Transaction](./transaction.md#class-transaction)
 
 Returns
 
@@ -682,7 +682,7 @@ Argument Details
 ```ts
 findBump(txid: string): MerklePath | undefined 
 ```
-See also: [MerklePath](#class-merklepath)
+See also: [MerklePath](./transaction.md#class-merklepath)
 
 Returns
 
@@ -698,7 +698,7 @@ The result is suitable for signing.
 ```ts
 findTransactionForSigning(txid: string): Transaction | undefined 
 ```
-See also: [Transaction](#class-transaction)
+See also: [Transaction](./transaction.md#class-transaction)
 
 Returns
 
@@ -714,7 +714,7 @@ Argument Details
 ```ts
 findTxid(txid: string): BeefTx | undefined 
 ```
-See also: [BeefTx](#class-beeftx)
+See also: [BeefTx](./transaction.md#class-beeftx)
 
 Returns
 
@@ -732,7 +732,7 @@ Constructs an instance of the Beef class based on the provided binary array
 ```ts
 static fromBinary(bin: number[]): Beef 
 ```
-See also: [Beef](#class-beef)
+See also: [Beef](./transaction.md#class-beef)
 
 Returns
 
@@ -750,7 +750,7 @@ Constructs an instance of the Beef class based on the provided string
 ```ts
 static fromString(s: string, enc: "hex" | "utf8" | "base64" = "hex"): Beef 
 ```
-See also: [Beef](#class-beef)
+See also: [Beef](./transaction.md#class-beef)
 
 Returns
 
@@ -805,7 +805,7 @@ original.
 ```ts
 makeTxidOnly(txid: string): BeefTx | undefined 
 ```
-See also: [BeefTx](#class-beeftx)
+See also: [BeefTx](./transaction.md#class-beeftx)
 
 Returns
 
@@ -818,7 +818,7 @@ Merge a MerklePath that is assumed to be fully valid.
 ```ts
 mergeBump(bump: MerklePath): number 
 ```
-See also: [MerklePath](#class-merklepath)
+See also: [MerklePath](./transaction.md#class-merklepath)
 
 Returns
 
@@ -835,7 +835,7 @@ Replaces existing transaction with same txid.
 ```ts
 mergeRawTx(rawTx: number[], bumpIndex?: number): BeefTx 
 ```
-See also: [BeefTx](#class-beeftx)
+See also: [BeefTx](./transaction.md#class-beeftx)
 
 Returns
 
@@ -857,7 +857,7 @@ Attempts to match an existing bump to the new transaction.
 ```ts
 mergeTransaction(tx: Transaction): BeefTx 
 ```
-See also: [BeefTx](#class-beeftx), [Transaction](#class-transaction)
+See also: [BeefTx](./transaction.md#class-beeftx), [Transaction](./transaction.md#class-transaction)
 
 Returns
 
@@ -868,7 +868,7 @@ txid of tx
 Removes an existing transaction from the BEEF, given its TXID
 
 ```ts
-removeExistingTxid(txid: string) 
+removeExistingTxid(txid: string): void 
 ```
 
 Argument Details
@@ -920,7 +920,7 @@ Serialize this Beef as AtomicBEEF.
 after sorting, if txid is not last txid, creates a clone and removes newer txs
 
 ```ts
-toBinaryAtomic(txid: string) 
+toBinaryAtomic(txid: string): number[] 
 ```
 
 Returns
@@ -954,16 +954,16 @@ Summary of `Beef` contents as multi-line string.
 Serializes this data to `writer`
 
 ```ts
-toWriter(writer: Writer) 
+toWriter(writer: Writer): void 
 ```
-See also: [Writer](#class-writer)
+See also: [Writer](./primitives.md#class-writer)
 
 #### Method trimKnownTxids
 
 Ensure that all the txids in `knownTxids` are txidOnly
 
 ```ts
-trimKnownTxids(knownTxids: string[]) 
+trimKnownTxids(knownTxids: string[]): void 
 ```
 
 #### Method verify
@@ -981,7 +981,7 @@ Validity requirements:
 ```ts
 async verify(chainTracker: ChainTracker, allowTxidOnly?: boolean): Promise<boolean> 
 ```
-See also: [ChainTracker](#interface-chaintracker)
+See also: [ChainTracker](./transaction.md#interface-chaintracker)
 
 Argument Details
 
@@ -1020,16 +1020,16 @@ The size and redundancy of these Beefs becomes a problem when chained transactio
 export class BeefParty extends Beef {
     knownTo: Record<string, Record<string, boolean>> = {};
     constructor(parties?: string[]) 
-    isParty(party: string) 
-    addParty(party: string) 
+    isParty(party: string): boolean 
+    addParty(party: string): void 
     getKnownTxidsForParty(party: string): string[] 
     getTrimmedBeefForParty(party: string): Beef 
-    addKnownTxidsForParty(party: string, knownTxids: string[]) 
-    mergeBeefFromParty(party: string, beef: number[] | Beef) 
+    addKnownTxidsForParty(party: string, knownTxids: string[]): void 
+    mergeBeefFromParty(party: string, beef: number[] | Beef): void 
 }
 ```
 
-See also: [Beef](#class-beef)
+See also: [Beef](./transaction.md#class-beef)
 
 <details>
 
@@ -1060,7 +1060,7 @@ knownTo: Record<string, Record<string, boolean>> = {}
 Make note of additional txids "known" to `party`.
 
 ```ts
-addKnownTxidsForParty(party: string, knownTxids: string[]) 
+addKnownTxidsForParty(party: string, knownTxids: string[]): void 
 ```
 
 Argument Details
@@ -1073,7 +1073,7 @@ Argument Details
 Adds a new unique party identifier to this `BeefParty`.
 
 ```ts
-addParty(party: string) 
+addParty(party: string): void 
 ```
 
 #### Method getKnownTxidsForParty
@@ -1091,7 +1091,7 @@ Array of txids "known" to `party`.
 ```ts
 getTrimmedBeefForParty(party: string): Beef 
 ```
-See also: [Beef](#class-beef)
+See also: [Beef](./transaction.md#class-beef)
 
 Returns
 
@@ -1100,7 +1100,7 @@ trimmed beef of unknown transactions and proofs for `party`
 #### Method isParty
 
 ```ts
-isParty(party: string) 
+isParty(party: string): boolean 
 ```
 
 Returns
@@ -1116,9 +1116,9 @@ corresponding to transactions for which `party`
 has raw transaction and validity proof data.
 
 ```ts
-mergeBeefFromParty(party: string, beef: number[] | Beef) 
+mergeBeefFromParty(party: string, beef: number[] | Beef): void 
 ```
-See also: [Beef](#class-beef)
+See also: [Beef](./transaction.md#class-beef)
 
 </details>
 
@@ -1147,9 +1147,9 @@ export default class BeefTx {
     set bumpIndex(v: number | undefined) 
     get hasProof(): boolean 
     get isTxidOnly(): boolean 
-    get txid() 
-    get tx() 
-    get rawTx() 
+    get txid(): string 
+    get tx(): Transaction | undefined 
+    get rawTx(): number[] | undefined 
     constructor(tx: Transaction | number[] | string, bumpIndex?: number) 
     static fromTx(tx: Transaction, bumpIndex?: number): BeefTx 
     static fromRawTx(rawTx: number[], bumpIndex?: number): BeefTx 
@@ -1159,7 +1159,7 @@ export default class BeefTx {
 }
 ```
 
-See also: [Reader](#class-reader), [Transaction](#class-transaction), [Writer](#class-writer)
+See also: [Reader](./primitives.md#class-reader), [Transaction](./transaction.md#class-transaction), [Writer](./primitives.md#class-writer)
 
 <details>
 
@@ -1170,7 +1170,7 @@ See also: [Reader](#class-reader), [Transaction](#class-transaction), [Writer](#
 ```ts
 constructor(tx: Transaction | number[] | string, bumpIndex?: number) 
 ```
-See also: [Transaction](#class-transaction)
+See also: [Transaction](./transaction.md#class-transaction)
 
 Argument Details
 
@@ -1196,7 +1196,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 ---
 ### Class: FetchHttpClient
 
-Adapter for Node.js Https module to be used as HttpClient
+Adapter for Node Https module to be used as HttpClient
 
 ```ts
 export class FetchHttpClient implements HttpClient {
@@ -1205,7 +1205,7 @@ export class FetchHttpClient implements HttpClient {
 }
 ```
 
-See also: [Fetch](#type-fetch), [HttpClient](#interface-httpclient), [HttpClientRequestOptions](#interface-httpclientrequestoptions), [HttpClientResponse](#type-httpclientresponse)
+See also: [Fetch](./transaction.md#type-fetch), [HttpClient](./transaction.md#interface-httpclient), [HttpClientRequestOptions](./transaction.md#interface-httpclientrequestoptions), [HttpClientResponse](./transaction.md#type-httpclientresponse)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -1249,11 +1249,11 @@ export default class MerklePath {
     findOrComputeLeaf(height: number, offset: number): MerklePathLeaf | undefined 
     async verify(txid: string, chainTracker: ChainTracker): Promise<boolean> 
     combine(other: MerklePath): void 
-    trim() 
+    trim(): void 
 }
 ```
 
-See also: [ChainTracker](#interface-chaintracker), [MerklePathLeaf](#interface-merklepathleaf), [Reader](#class-reader), [toHex](#variable-tohex), [verify](#variable-verify)
+See also: [ChainTracker](./transaction.md#interface-chaintracker), [MerklePathLeaf](./transaction.md#interface-merklepathleaf), [Reader](./primitives.md#class-reader), [toHex](./primitives.md#variable-tohex), [verify](./compat.md#variable-verify)
 
 <details>
 
@@ -1266,7 +1266,7 @@ Combines this MerklePath with another to create a compound proof.
 ```ts
 combine(other: MerklePath): void 
 ```
-See also: [MerklePath](#class-merklepath)
+See also: [MerklePath](./transaction.md#class-merklepath)
 
 Argument Details
 
@@ -1307,7 +1307,7 @@ Does not add computed leaves to path.
 ```ts
 findOrComputeLeaf(height: number, offset: number): MerklePathLeaf | undefined 
 ```
-See also: [MerklePathLeaf](#interface-merklepathleaf)
+See also: [MerklePathLeaf](./transaction.md#interface-merklepathleaf)
 
 #### Method fromBinary
 
@@ -1316,7 +1316,7 @@ Creates a MerklePath instance from a binary array.
 ```ts
 static fromBinary(bump: number[]): MerklePath 
 ```
-See also: [MerklePath](#class-merklepath)
+See also: [MerklePath](./transaction.md#class-merklepath)
 
 Returns
 
@@ -1332,7 +1332,7 @@ Argument Details
 ```ts
 static fromCoinbaseTxidAndHeight(txid: string, height: number): MerklePath 
 ```
-See also: [MerklePath](#class-merklepath)
+See also: [MerklePath](./transaction.md#class-merklepath)
 
 Returns
 
@@ -1352,7 +1352,7 @@ Creates a MerklePath instance from a hexadecimal string.
 ```ts
 static fromHex(hex: string): MerklePath 
 ```
-See also: [MerklePath](#class-merklepath)
+See also: [MerklePath](./transaction.md#class-merklepath)
 
 Returns
 
@@ -1394,7 +1394,7 @@ Assumes that at least all required nodes are present.
 Leaves all levels sorted by increasing offset.
 
 ```ts
-trim() 
+trim(): void 
 ```
 
 #### Method verify
@@ -1404,7 +1404,7 @@ Verifies if the given transaction ID is part of the Merkle tree at the specified
 ```ts
 async verify(txid: string, chainTracker: ChainTracker): Promise<boolean> 
 ```
-See also: [ChainTracker](#interface-chaintracker)
+See also: [ChainTracker](./transaction.md#interface-chaintracker)
 
 Returns
 
@@ -1424,7 +1424,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 ---
 ### Class: NodejsHttpClient
 
-Adapter for Node.js Https module to be used as HttpClient
+Adapter for Node Https module to be used as HttpClient
 
 ```ts
 export class NodejsHttpClient implements HttpClient {
@@ -1433,7 +1433,7 @@ export class NodejsHttpClient implements HttpClient {
 }
 ```
 
-See also: [HttpClient](#interface-httpclient), [HttpClientRequestOptions](#interface-httpclientrequestoptions), [HttpClientResponse](#type-httpclientresponse), [HttpsNodejs](#interface-httpsnodejs)
+See also: [HttpClient](./transaction.md#interface-httpclient), [HttpClientRequestOptions](./transaction.md#interface-httpclientrequestoptions), [HttpClientResponse](./transaction.md#type-httpclientresponse), [HttpsNodejs](./transaction.md#interface-httpsnodejs)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -1450,7 +1450,7 @@ export default class SatoshisPerKilobyte implements FeeModel {
 }
 ```
 
-See also: [FeeModel](#interface-feemodel), [Transaction](#class-transaction)
+See also: [FeeModel](./transaction.md#interface-feemodel), [Transaction](./transaction.md#class-transaction)
 
 <details>
 
@@ -1476,7 +1476,7 @@ Computes the fee for a given transaction.
 ```ts
 async computeFee(tx: Transaction): Promise<number> 
 ```
-See also: [Transaction](#class-transaction)
+See also: [Transaction](./transaction.md#class-transaction)
 
 Returns
 
@@ -1563,7 +1563,7 @@ export default class Transaction {
 }
 ```
 
-See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Broadcaster](#interface-broadcaster), [ChainTracker](#interface-chaintracker), [FeeModel](#interface-feemodel), [MerklePath](#class-merklepath), [Reader](#class-reader), [SatoshisPerKilobyte](#class-satoshisperkilobyte), [TransactionInput](#interface-transactioninput), [TransactionOutput](#interface-transactionoutput), [defaultBroadcaster](#function-defaultbroadcaster), [defaultChainTracker](#function-defaultchaintracker), [sign](#variable-sign), [toHex](#variable-tohex), [verify](#variable-verify)
+See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Broadcaster](./transaction.md#interface-broadcaster), [ChainTracker](./transaction.md#interface-chaintracker), [FeeModel](./transaction.md#interface-feemodel), [MerklePath](./transaction.md#class-merklepath), [Reader](./primitives.md#class-reader), [SatoshisPerKilobyte](./transaction.md#class-satoshisperkilobyte), [TransactionInput](./transaction.md#interface-transactioninput), [TransactionOutput](./transaction.md#interface-transactionoutput), [defaultBroadcaster](./transaction.md#function-defaultbroadcaster), [defaultChainTracker](./transaction.md#function-defaultchaintracker), [sign](./compat.md#variable-sign), [toHex](./primitives.md#variable-tohex), [verify](./compat.md#variable-verify)
 
 <details>
 
@@ -1576,7 +1576,7 @@ Adds a new input to the transaction.
 ```ts
 addInput(input: TransactionInput): void 
 ```
-See also: [TransactionInput](#interface-transactioninput)
+See also: [TransactionInput](./transaction.md#interface-transactioninput)
 
 Argument Details
 
@@ -1594,7 +1594,7 @@ Adds a new output to the transaction.
 ```ts
 addOutput(output: TransactionOutput): void 
 ```
-See also: [TransactionOutput](#interface-transactionoutput)
+See also: [TransactionOutput](./transaction.md#interface-transactionoutput)
 
 Argument Details
 
@@ -1623,7 +1623,7 @@ Broadcasts a transaction.
 ```ts
 async broadcast(broadcaster: Broadcaster = defaultBroadcaster()): Promise<BroadcastResponse | BroadcastFailure> 
 ```
-See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Broadcaster](#interface-broadcaster), [defaultBroadcaster](#function-defaultbroadcaster)
+See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Broadcaster](./transaction.md#interface-broadcaster), [defaultBroadcaster](./transaction.md#function-defaultbroadcaster)
 
 Returns
 
@@ -1643,7 +1643,7 @@ If fee is a number, the transaction uses that value as fee.
 ```ts
 async fee(modelOrFee: FeeModel | number = new SatoshisPerKilobyte(10), changeDistribution: "equal" | "random" = "equal"): Promise<void> 
 ```
-See also: [FeeModel](#interface-feemodel), [SatoshisPerKilobyte](#class-satoshisperkilobyte)
+See also: [FeeModel](./transaction.md#interface-feemodel), [SatoshisPerKilobyte](./transaction.md#class-satoshisperkilobyte)
 
 Argument Details
 
@@ -1656,14 +1656,12 @@ amongst the change outputs
 #### Method fromAtomicBEEF
 
 Creates a new transaction from an Atomic BEEF (BRC-95) structure.
-Extracts the subject transaction and ensures that all transactions within the BEEF data
-are part of the dependency graph of the subject transaction.
-Throws errors if the Atomic BEEF data does not strictly adhere to the BRC-95 specification.
+Extracts the subject transaction and supporting merkle path and source transactions contained in the BEEF data
 
 ```ts
 static fromAtomicBEEF(beef: number[]): Transaction 
 ```
-See also: [Transaction](#class-transaction)
+See also: [Transaction](./transaction.md#class-transaction)
 
 Returns
 
@@ -1676,15 +1674,15 @@ Argument Details
 
 #### Method fromBEEF
 
-Creates a new transaction, linked to its inputs and their associated merkle paths, from a BEEF (BRC-62) structure.
+Creates a new transaction, linked to its inputs and their associated merkle paths, from a BEEF V1, V2 or Atomic.
 Optionally, you can provide a specific TXID to retrieve a particular transaction from the BEEF data.
 If the TXID is provided but not found in the BEEF data, an error will be thrown.
-If no TXID is provided, the last transaction in the BEEF data is returned.
+If no TXID is provided, the last transaction in the BEEF data is returned, or the atomic txid.
 
 ```ts
 static fromBEEF(beef: number[], txid?: string): Transaction 
 ```
-See also: [Transaction](#class-transaction)
+See also: [Transaction](./transaction.md#class-transaction)
 
 Returns
 
@@ -1704,7 +1702,7 @@ Creates a Transaction instance from a binary array.
 ```ts
 static fromBinary(bin: number[]): Transaction 
 ```
-See also: [Transaction](#class-transaction)
+See also: [Transaction](./transaction.md#class-transaction)
 
 Returns
 
@@ -1722,7 +1720,7 @@ Creates a new transaction, linked to its inputs and their associated merkle path
 ```ts
 static fromEF(ef: number[]): Transaction 
 ```
-See also: [Transaction](#class-transaction)
+See also: [Transaction](./transaction.md#class-transaction)
 
 Returns
 
@@ -1740,7 +1738,7 @@ Creates a Transaction instance from a hexadecimal string.
 ```ts
 static fromHex(hex: string): Transaction 
 ```
-See also: [Transaction](#class-transaction)
+See also: [Transaction](./transaction.md#class-transaction)
 
 Returns
 
@@ -1761,7 +1759,7 @@ If no TXID is provided, the last transaction in the BEEF data is returned.
 ```ts
 static fromHexBEEF(hex: string, txid?: string): Transaction 
 ```
-See also: [Transaction](#class-transaction)
+See also: [Transaction](./transaction.md#class-transaction)
 
 Returns
 
@@ -1781,7 +1779,7 @@ Creates a Transaction instance from a hexadecimal string encoded EF.
 ```ts
 static fromHexEF(hex: string): Transaction 
 ```
-See also: [Transaction](#class-transaction)
+See also: [Transaction](./transaction.md#class-transaction)
 
 Returns
 
@@ -2048,7 +2046,7 @@ Verifies the legitimacy of the Bitcoin transaction according to the rules of SPV
 ```ts
 async verify(chainTracker: ChainTracker | "scripts only" = defaultChainTracker(), feeModel?: FeeModel): Promise<boolean> 
 ```
-See also: [ChainTracker](#interface-chaintracker), [FeeModel](#interface-feemodel), [defaultChainTracker](#function-defaultchaintracker)
+See also: [ChainTracker](./transaction.md#interface-chaintracker), [FeeModel](./transaction.md#interface-feemodel), [defaultChainTracker](./transaction.md#function-defaultchaintracker)
 
 Returns
 
@@ -2084,7 +2082,7 @@ export default class WhatsOnChain implements ChainTracker {
 }
 ```
 
-See also: [ChainTracker](#interface-chaintracker), [WhatsOnChainConfig](#interface-whatsonchainconfig)
+See also: [ChainTracker](./transaction.md#interface-chaintracker), [WhatsOnChainConfig](./transaction.md#interface-whatsonchainconfig)
 
 <details>
 
@@ -2097,7 +2095,7 @@ Constructs an instance of the WhatsOnChain ChainTracker.
 ```ts
 constructor(network: "main" | "test" | "stn" = "main", config: WhatsOnChainConfig = {}) 
 ```
-See also: [WhatsOnChainConfig](#interface-whatsonchainconfig)
+See also: [WhatsOnChainConfig](./transaction.md#interface-whatsonchainconfig)
 
 Argument Details
 
@@ -2131,7 +2129,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 export function defaultBroadcaster(isTestnet: boolean = false, config: ArcConfig = {}): Broadcaster 
 ```
 
-See also: [ArcConfig](#interface-arcconfig), [Broadcaster](#interface-broadcaster)
+See also: [ArcConfig](./transaction.md#interface-arcconfig), [Broadcaster](./transaction.md#interface-broadcaster)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -2142,7 +2140,7 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 export function defaultChainTracker(): ChainTracker 
 ```
 
-See also: [ChainTracker](#interface-chaintracker)
+See also: [ChainTracker](./transaction.md#interface-chaintracker)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -2151,13 +2149,13 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 
 Returns a default HttpClient implementation based on the environment that it is run on.
 This method will attempt to use `window.fetch` if available (in browser environments).
-If running in a Node.js environment, it falls back to using the Node.js `https` module
+If running in a Node environment, it falls back to using the Node `https` module
 
 ```ts
 export function defaultHttpClient(): HttpClient 
 ```
 
-See also: [HttpClient](#interface-httpclient)
+See also: [HttpClient](./transaction.md#interface-httpclient)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -2170,7 +2168,7 @@ Convenience type guard for response from `Broadcaster.broadcast`
 export function isBroadcastFailure(r: BroadcastResponse | BroadcastFailure): r is BroadcastFailure 
 ```
 
-See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse)
+See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -2183,7 +2181,7 @@ Convenience type guard for response from `Broadcaster.broadcast`
 export function isBroadcastResponse(r: BroadcastResponse | BroadcastFailure): r is BroadcastResponse 
 ```
 
-See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse)
+See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -2209,7 +2207,7 @@ Makes a request to the server.
 export type Fetch = (url: string, options: FetchOptions) => Promise<Response>
 ```
 
-See also: [FetchOptions](#interface-fetchoptions)
+See also: [FetchOptions](./transaction.md#interface-fetchoptions)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)