@bsv/sdk 1.6.14 → 1.6.15

package/docs/reference/kvstore.md

@@ -31,19 +31,18 @@ Creates an instance of the localKVStore.
 ```ts
 constructor(wallet: WalletInterface = new WalletClient(), context = "kvstore default", encrypt = true, originator?: string, acceptDelayedBroadcast = false) 
 ```
-
 See also: [WalletClient](./wallet.md#class-walletclient), [WalletInterface](./wallet.md#interface-walletinterface), [encrypt](./messages.md#variable-encrypt)
 
 Argument Details
 
-- **wallet**
-    - The wallet interface to use. Defaults to a new WalletClient instance.
-- **context**
-    - The context (basket) for namespacing keys. Defaults to 'kvstore default'.
-- **encrypt**
-    - Whether to encrypt values. Defaults to true.
-- **originator**
-    - — An originator to use with PushDrop and the wallet, if provided.
++ **wallet**
+  + The wallet interface to use. Defaults to a new WalletClient instance.
++ **context**
+  + The context (basket) for namespacing keys. Defaults to 'kvstore default'.
++ **encrypt**
+  + Whether to encrypt values. Defaults to true.
++ **originator**
+  + — An originator to use with PushDrop and the wallet, if provided.
 
 Throws
 
@@ -64,10 +63,10 @@ the defaultValue if the key is not found, or undefined if no defaultValue is pro
 
 Argument Details
 
-- **key**
-    - The key to retrieve the value for.
-- **defaultValue**
-    - The value to return if the key is not found.
++ **key**
+  + The key to retrieve the value for.
++ **defaultValue**
+  + The value to return if the key is not found.
 
 Throws
 
@@ -93,8 +92,8 @@ A promise that resolves to the txids of the removal transactions if successful.
 
 Argument Details
 
-- **key**
-    - The key to remove.
++ **key**
+  + The key to remove.
 
 #### Method set
 
@@ -111,7 +110,6 @@ to the same key from missing earlier changes.
 ```ts
 async set(key: string, value: string): Promise<OutpointString> 
 ```
-
 See also: [OutpointString](./wallet.md#type-outpointstring)
 
 Returns
@@ -120,15 +118,14 @@ A promise that resolves to the outpoint string (txid.vout) of the new or updated
 
 Argument Details
 
-- **key**
-    - The key to set or update.
-- **value**
-    - The value to associate with the key.
++ **key**
+  + The key to set or update.
++ **value**
+  + The value to associate with the key.
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ## Functions
 
 ## Types
@@ -136,3 +133,4 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 ## Enums
 
 ## Variables
+

package/docs/reference/messages.md

@@ -52,7 +52,6 @@ See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitiv
 Links: [API](#api), [Classes](#classes), [Functions](#functions), [Variables](#variables)
 
 ---
-
 ### Variable: encrypt
 
 ```ts
@@ -82,7 +81,6 @@ See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitiv
 Links: [API](#api), [Classes](#classes), [Functions](#functions), [Variables](#variables)
 
 ---
-
 ### Variable: sign
 
 ```ts
@@ -116,7 +114,6 @@ See also: [Curve](./primitives.md#class-curve), [PrivateKey](./primitives.md#cla
 Links: [API](#api), [Classes](#classes), [Functions](#functions), [Variables](#variables)
 
 ---
-
 ### Variable: verify
 
 ```ts

package/docs/reference/overlay-tools.md

@@ -58,7 +58,6 @@ outputsToAdmit: number[]
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Interface: LookupQuestion
 
 The question asked to the Overlay Services Engine when a consumer of state wishes to look up information.
@@ -90,7 +89,6 @@ service: string
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Interface: LookupResolverConfig
 
 Configuration options for the Lookup resolver.
@@ -122,7 +120,6 @@ The facilitator used to make requests to Overlay Services hosts.
 ```ts
 facilitator?: OverlayLookupFacilitator
 ```
-
 See also: [OverlayLookupFacilitator](./overlay-tools.md#interface-overlaylookupfacilitator)
 
 #### Property hostOverrides
@@ -136,7 +133,6 @@ hostOverrides?: Record<string, string[]>
 #### Property networkPreset
 
 The network preset to use, unless other options override it.
-
 - mainnet: use mainnet SLAP trackers and HTTPS facilitator
 - testnet: use testnet SLAP trackers and HTTPS facilitator
 - local: directly query from localhost:8080 and a facilitator that permits plain HTTP
@@ -156,7 +152,6 @@ slapTrackers?: string[]
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Interface: OverlayBroadcastFacilitator
 
 Facilitates transaction broadcasts that return STEAK.
@@ -172,7 +167,6 @@ See also: [STEAK](./overlay-tools.md#type-steak), [TaggedBEEF](./overlay-tools.m
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Interface: OverlayLookupFacilitator
 
 Facilitates lookups to URLs that return answers.
@@ -192,13 +186,11 @@ 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)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Interface: SHIPBroadcasterConfig
 
 Configuration options for the SHIP broadcaster.
@@ -223,13 +215,11 @@ The facilitator used to make requests to Overlay Services hosts.
 ```ts
 facilitator?: OverlayBroadcastFacilitator
 ```
-
 See also: [OverlayBroadcastFacilitator](./overlay-tools.md#interface-overlaybroadcastfacilitator)
 
 #### Property networkPreset
 
 The network preset to use, unless other options override it.
-
 - mainnet: use mainnet resolver and HTTPS facilitator
 - testnet: use testnet resolver and HTTPS facilitator
 - local: directly send to localhost:8080 and a facilitator that permits plain HTTP
@@ -269,13 +259,11 @@ The resolver used to locate suitable hosts with SHIP
 ```ts
 resolver?: LookupResolver
 ```
-
 See also: [LookupResolver](./overlay-tools.md#class-lookupresolver)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Interface: TaggedBEEF
 
 Tagged BEEF
@@ -291,7 +279,6 @@ export interface TaggedBEEF {
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ## Classes
 
 | |
@@ -322,7 +309,6 @@ See also: [OverlayBroadcastFacilitator](./overlay-tools.md#interface-overlaybroa
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Class: HTTPSOverlayLookupFacilitator
 
 ```ts
@@ -339,7 +325,6 @@ See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion]
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Class: LookupResolver
 
 Represents an SHIP transaction broadcaster.
@@ -360,13 +345,11 @@ 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)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Class: OverlayAdminTokenTemplate
 
 Script template enabling the creation, unlocking, and decoding of SHIP and SLAP advertisements.
@@ -398,13 +381,12 @@ Constructs a new Overlay Admin template instance
 ```ts
 constructor(wallet: WalletInterface) 
 ```
-
 See also: [WalletInterface](./wallet.md#interface-walletinterface)
 
 Argument Details
 
-- **wallet**
-    - Wallet to use for locking and unlocking
++ **wallet**
+  + Wallet to use for locking and unlocking
 
 #### Method decode
 
@@ -418,7 +400,6 @@ static decode(script: LockingScript): {
     topicOrService: string;
 } 
 ```
-
 See also: [LockingScript](./script.md#class-lockingscript)
 
 Returns
@@ -427,8 +408,8 @@ Decoded SHIP or SLAP advertisement
 
 Argument Details
 
-- **script**
-    - Locking script comprising a SHIP or SLAP token to decode
++ **script**
+  + Locking script comprising a SHIP or SLAP token to decode
 
 #### Method lock
 
@@ -437,7 +418,6 @@ 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)
 
 Returns
@@ -446,12 +426,12 @@ Locking script comprising the advertisement token
 
 Argument Details
 
-- **protocol**
-    - SHIP or SLAP
-- **domain**
-    - Domain where the topic or service is available
-- **topicOrService**
-    - Topic or service to advertise
++ **protocol**
+  + SHIP or SLAP
++ **domain**
+  + Domain where the topic or service is available
++ **topicOrService**
+  + Topic or service to advertise
 
 #### Method unlock
 
@@ -463,7 +443,6 @@ 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)
 
 Returns
@@ -472,13 +451,12 @@ Script unlocker capable of unlocking the advertisement token
 
 Argument Details
 
-- **protocol**
-    - SHIP or SLAP, depending on the token to unlock
++ **protocol**
+  + SHIP or SLAP, depending on the token to unlock
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Class: TopicBroadcaster
 
 Broadcasts transactions to one or more overlay topics.
@@ -499,15 +477,14 @@ Constructs an instance of the SHIP broadcaster.
 ```ts
 constructor(topics: string[], config: SHIPBroadcasterConfig = {}) 
 ```
-
 See also: [SHIPBroadcasterConfig](./overlay-tools.md#interface-shipbroadcasterconfig)
 
 Argument Details
 
-- **topics**
-    - The list of SHIP topic names where transactions are to be sent.
-- **config**
-    - Configuration options for the SHIP broadcaster.
++ **topics**
+  + The list of SHIP topic names where transactions are to be sent.
++ **config**
+  + Configuration options for the SHIP broadcaster.
 
 #### Method broadcast
 
@@ -516,7 +493,6 @@ 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)
 
 Returns
@@ -525,13 +501,12 @@ A promise that resolves to either a success or failure response.
 
 Argument Details
 
-- **tx**
-    - The transaction to be sent.
++ **tx**
+  + The transaction to be sent.
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ## Functions
 
 ## Types
@@ -564,7 +539,6 @@ export type LookupAnswer = {
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Type: STEAK
 
 Submitted Transaction Execution AcKnowledgment
@@ -578,7 +552,6 @@ See also: [AdmittanceInstructions](./overlay-tools.md#interface-admittanceinstru
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ## Enums
 
 ## Variables
@@ -603,7 +576,6 @@ DEFAULT_SLAP_TRACKERS: string[] = [
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
-
 ### Variable: DEFAULT_TESTNET_SLAP_TRACKERS
 
 ```ts