@bsv/sdk 1.4.22 → 1.4.24

package/docs/overlay-tools.md

@@ -30,6 +30,10 @@ export interface AdmittanceInstructions {
 }
 ```
 
+<details>
+
+<summary>Interface AdmittanceInstructions Details</summary>
+
 #### Property coinsRemoved
 
 The indices of all inputs from the provided transaction which reference previously-admitted outputs,
@@ -55,6 +59,8 @@ The indices of all admissible outputs into the managed topic from the provided t
 outputsToAdmit: number[]
 ```
 
+</details>
+
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -69,6 +75,10 @@ export interface LookupQuestion {
 }
 ```
 
+<details>
+
+<summary>Interface LookupQuestion Details</summary>
+
 #### Property query
 
 The query which will be forwarded to the Lookup Service.
@@ -86,6 +96,8 @@ The identifier for a Lookup Service which the person asking the question wishes
 service: string
 ```
 
+</details>
+
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -103,7 +115,11 @@ export interface LookupResolverConfig {
 }
 ```
 
-See also: [OverlayLookupFacilitator](./overlay-tools.md#interface-overlaylookupfacilitator)
+See also: [OverlayLookupFacilitator](#interface-overlaylookupfacilitator)
+
+<details>
+
+<summary>Interface LookupResolverConfig Details</summary>
 
 #### Property additionalHosts
 
@@ -120,7 +136,7 @@ The facilitator used to make requests to Overlay Services hosts.
 ```ts
 facilitator?: OverlayLookupFacilitator
 ```
-See also: [OverlayLookupFacilitator](./overlay-tools.md#interface-overlaylookupfacilitator)
+See also: [OverlayLookupFacilitator](#interface-overlaylookupfacilitator)
 
 #### Property hostOverrides
 
@@ -149,6 +165,8 @@ The list of SLAP trackers queried to resolve Overlay Services hosts for a given
 slapTrackers?: string[]
 ```
 
+</details>
+
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -162,7 +180,7 @@ export interface OverlayBroadcastFacilitator {
 }
 ```
 
-See also: [STEAK](./overlay-tools.md#type-steak), [TaggedBEEF](./overlay-tools.md#interface-taggedbeef)
+See also: [STEAK](#type-steak), [TaggedBEEF](#interface-taggedbeef)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -177,7 +195,11 @@ export interface OverlayLookupFacilitator {
 }
 ```
 
-See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion)
+See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion)
+
+<details>
+
+<summary>Interface OverlayLookupFacilitator Details</summary>
 
 #### Property lookup
 
@@ -186,7 +208,9 @@ Returns a lookup answer for a lookup question
 ```ts
 lookup: (url: string, question: LookupQuestion, timeout?: number) => Promise<LookupAnswer>
 ```
-See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion)
+See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion)
+
+</details>
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -206,7 +230,11 @@ export interface SHIPBroadcasterConfig {
 }
 ```
 
-See also: [LookupResolver](./overlay-tools.md#class-lookupresolver), [OverlayBroadcastFacilitator](./overlay-tools.md#interface-overlaybroadcastfacilitator)
+See also: [LookupResolver](#class-lookupresolver), [OverlayBroadcastFacilitator](#interface-overlaybroadcastfacilitator)
+
+<details>
+
+<summary>Interface SHIPBroadcasterConfig Details</summary>
 
 #### Property facilitator
 
@@ -215,7 +243,7 @@ The facilitator used to make requests to Overlay Services hosts.
 ```ts
 facilitator?: OverlayBroadcastFacilitator
 ```
-See also: [OverlayBroadcastFacilitator](./overlay-tools.md#interface-overlaybroadcastfacilitator)
+See also: [OverlayBroadcastFacilitator](#interface-overlaybroadcastfacilitator)
 
 #### Property networkPreset
 
@@ -259,7 +287,9 @@ The resolver used to locate suitable hosts with SHIP
 ```ts
 resolver?: LookupResolver
 ```
-See also: [LookupResolver](./overlay-tools.md#class-lookupresolver)
+See also: [LookupResolver](#class-lookupresolver)
+
+</details>
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -303,7 +333,7 @@ export class HTTPSOverlayBroadcastFacilitator implements OverlayBroadcastFacilit
 }
 ```
 
-See also: [OverlayBroadcastFacilitator](./overlay-tools.md#interface-overlaybroadcastfacilitator), [STEAK](./overlay-tools.md#type-steak), [TaggedBEEF](./overlay-tools.md#interface-taggedbeef)
+See also: [OverlayBroadcastFacilitator](#interface-overlaybroadcastfacilitator), [STEAK](#type-steak), [TaggedBEEF](#interface-taggedbeef)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -319,7 +349,7 @@ export class HTTPSOverlayLookupFacilitator implements OverlayLookupFacilitator {
 }
 ```
 
-See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion), [OverlayLookupFacilitator](./overlay-tools.md#interface-overlaylookupfacilitator)
+See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion), [OverlayLookupFacilitator](#interface-overlaylookupfacilitator)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -335,7 +365,11 @@ export default class LookupResolver {
 }
 ```
 
-See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion), [LookupResolverConfig](./overlay-tools.md#interface-lookupresolverconfig)
+See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion), [LookupResolverConfig](#interface-lookupresolverconfig)
+
+<details>
+
+<summary>Class LookupResolver Details</summary>
 
 #### Method query
 
@@ -344,7 +378,9 @@ Given a LookupQuestion, returns a LookupAnswer. Aggregates across multiple servi
 ```ts
 async query(question: LookupQuestion, timeout?: number): Promise<LookupAnswer> 
 ```
-See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion)
+See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion)
+
+</details>
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -371,7 +407,11 @@ export default class OverlayAdminTokenTemplate implements ScriptTemplate {
 }
 ```
 
-See also: [LockingScript](./script.md#class-lockingscript), [PushDrop](./script.md#class-pushdrop), [ScriptTemplate](./script.md#interface-scripttemplate), [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [WalletInterface](./wallet.md#interface-walletinterface), [sign](./compat.md#variable-sign)
+See also: [LockingScript](#class-lockingscript), [PushDrop](#class-pushdrop), [ScriptTemplate](#interface-scripttemplate), [Transaction](#class-transaction), [UnlockingScript](#class-unlockingscript), [WalletInterface](#interface-walletinterface), [sign](#variable-sign)
+
+<details>
+
+<summary>Class OverlayAdminTokenTemplate Details</summary>
 
 #### Constructor
 
@@ -380,7 +420,7 @@ Constructs a new Overlay Admin template instance
 ```ts
 constructor(wallet: WalletInterface) 
 ```
-See also: [WalletInterface](./wallet.md#interface-walletinterface)
+See also: [WalletInterface](#interface-walletinterface)
 
 Argument Details
 
@@ -399,7 +439,7 @@ static decode(script: LockingScript): {
     topicOrService: string;
 } 
 ```
-See also: [LockingScript](./script.md#class-lockingscript)
+See also: [LockingScript](#class-lockingscript)
 
 Returns
 
@@ -417,7 +457,7 @@ Creates a new advertisement locking script
 ```ts
 async lock(protocol: "SHIP" | "SLAP", domain: string, topicOrService: string): Promise<LockingScript> 
 ```
-See also: [LockingScript](./script.md#class-lockingscript)
+See also: [LockingScript](#class-lockingscript)
 
 Returns
 
@@ -442,7 +482,7 @@ unlock(protocol: "SHIP" | "SLAP"): {
     estimateLength: (tx: Transaction, inputIndex: number) => Promise<number>;
 } 
 ```
-See also: [Transaction](./transaction.md#class-transaction), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign)
+See also: [Transaction](#class-transaction), [UnlockingScript](#class-unlockingscript), [sign](#variable-sign)
 
 Returns
 
@@ -453,6 +493,8 @@ Argument Details
 + **protocol**
   + SHIP or SLAP, depending on the token to unlock
 
+</details>
+
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -467,7 +509,11 @@ export default class TopicBroadcaster implements Broadcaster {
 }
 ```
 
-See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Broadcaster](./transaction.md#interface-broadcaster), [SHIPBroadcasterConfig](./overlay-tools.md#interface-shipbroadcasterconfig), [Transaction](./transaction.md#class-transaction)
+See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Broadcaster](#interface-broadcaster), [SHIPBroadcasterConfig](#interface-shipbroadcasterconfig), [Transaction](#class-transaction)
+
+<details>
+
+<summary>Class TopicBroadcaster Details</summary>
 
 #### Constructor
 
@@ -476,7 +522,7 @@ Constructs an instance of the SHIP broadcaster.
 ```ts
 constructor(topics: string[], config: SHIPBroadcasterConfig = {}) 
 ```
-See also: [SHIPBroadcasterConfig](./overlay-tools.md#interface-shipbroadcasterconfig)
+See also: [SHIPBroadcasterConfig](#interface-shipbroadcasterconfig)
 
 Argument Details
 
@@ -492,7 +538,7 @@ Broadcasts a transaction to Overlay Services via SHIP.
 ```ts
 async broadcast(tx: Transaction): Promise<BroadcastResponse | BroadcastFailure> 
 ```
-See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [Transaction](./transaction.md#class-transaction)
+See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Transaction](#class-transaction)
 
 Returns
 
@@ -503,6 +549,8 @@ Argument Details
 + **tx**
   + The transaction to be sent.
 
+</details>
+
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -548,7 +596,7 @@ Submitted Transaction Execution AcKnowledgment
 export type STEAK = Record<string, AdmittanceInstructions>
 ```
 
-See also: [AdmittanceInstructions](./overlay-tools.md#interface-admittanceinstructions)
+See also: [AdmittanceInstructions](#interface-admittanceinstructions)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)