@bsv/sdk 1.3.16 → 1.3.19

package/docs/auth.md

@@ -129,10 +129,6 @@ export class AuthFetch {
 
 See also: [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [SessionManager](./auth.md#class-sessionmanager), [VerifiableCertificate](./auth.md#class-verifiablecertificate), [WalletInterface](./wallet.md#interface-walletinterface)
 
-<details>
-
-<summary>Class AuthFetch Details</summary>
-
 #### Constructor
 
 Constructs a new AuthFetch instance.
@@ -194,8 +190,6 @@ async sendCertificateRequest(baseUrl: string, certificatesToRequest: RequestedCe
 ```
 See also: [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [VerifiableCertificate](./auth.md#class-verifiablecertificate)
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -228,10 +222,6 @@ export default class Certificate {
 
 See also: [Base64String](./wallet.md#type-base64string), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [HexString](./wallet.md#type-hexstring), [OutpointString](./wallet.md#type-outpointstring), [ProtoWallet](./wallet.md#class-protowallet), [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletProtocol](./wallet.md#type-walletprotocol), [sign](./compat.md#variable-sign), [verify](./compat.md#variable-verify)
 
-<details>
-
-<summary>Class Certificate Details</summary>
-
 #### Constructor
 
 Constructs a new Certificate.
@@ -407,8 +397,6 @@ Returns
 
 - A promise that resolves to true if the signature is valid.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -483,10 +471,6 @@ export class MasterCertificate extends Certificate {
 
 See also: [Base64String](./wallet.md#type-base64string), [Certificate](./auth.md#class-certificate), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [HexString](./wallet.md#type-hexstring), [OutpointString](./wallet.md#type-outpointstring), [ProtoWallet](./wallet.md#class-protowallet), [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletCounterparty](./wallet.md#type-walletcounterparty)
 
-<details>
-
-<summary>Class MasterCertificate Details</summary>
-
 #### Method createCertificateFields
 
 Encrypts certificate fields for a subject and generates a master keyring.
@@ -624,8 +608,6 @@ Throws
 
 Throws an error if any operation (e.g., encryption, signing) fails during certificate issuance.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -656,10 +638,6 @@ export class Peer {
 
 See also: [AuthMessage](./auth.md#interface-authmessage), [PeerSession](./auth.md#interface-peersession), [RequestedCertificateSet](./auth.md#interface-requestedcertificateset), [SessionManager](./auth.md#class-sessionmanager), [Transport](./auth.md#interface-transport), [VerifiableCertificate](./auth.md#class-verifiablecertificate), [WalletInterface](./wallet.md#interface-walletinterface)
 
-<details>
-
-<summary>Class Peer Details</summary>
-
 #### Constructor
 
 Creates a new Peer instance
@@ -886,8 +864,6 @@ Throws
 
 Will throw an error if the message fails to send.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -909,10 +885,6 @@ export class SessionManager {
 
 See also: [PeerSession](./auth.md#interface-peersession)
 
-<details>
-
-<summary>Class SessionManager Details</summary>
-
 #### Method addSession
 
 Adds a session to the manager, associating it with relevant identifiers for retrieval.
@@ -990,8 +962,6 @@ Argument Details
 + **session**
   + The peer session to update.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -1019,10 +989,6 @@ export class SimplifiedFetchTransport implements Transport {
 
 See also: [AuthMessage](./auth.md#interface-authmessage), [Transport](./auth.md#interface-transport)
 
-<details>
-
-<summary>Class SimplifiedFetchTransport Details</summary>
-
 #### Constructor
 
 Constructs a new instance of SimplifiedFetchTransport.
@@ -1106,8 +1072,6 @@ Throws
 
 Will throw an error if no listener has been registered via `onData`.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -1134,10 +1098,6 @@ export class VerifiableCertificate extends Certificate {
 
 See also: [Base64String](./wallet.md#type-base64string), [Certificate](./auth.md#class-certificate), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [HexString](./wallet.md#type-hexstring), [OutpointString](./wallet.md#type-outpointstring), [ProtoWallet](./wallet.md#class-protowallet), [PubKeyHex](./wallet.md#type-pubkeyhex)
 
-<details>
-
-<summary>Class VerifiableCertificate Details</summary>
-
 #### Method decryptFields
 
 Decrypts selectively revealed certificate fields using the provided keyring and verifier wallet
@@ -1160,8 +1120,6 @@ Throws
 
 Throws an error if any of the decryption operations fail, with a message indicating the failure context.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -1186,10 +1144,6 @@ export async function createNonce(wallet: WalletInterface, counterparty: WalletC
 
 See also: [WalletCounterparty](./wallet.md#type-walletcounterparty), [WalletInterface](./wallet.md#interface-walletinterface)
 
-<details>
-
-<summary>Function createNonce Details</summary>
-
 Returns
 
 A random nonce derived with a wallet
@@ -1199,8 +1153,6 @@ Argument Details
 + **counterparty**
   + The counterparty to the nonce creation. Defaults to 'self'.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -1214,10 +1166,6 @@ export async function verifyNonce(nonce: string, wallet: WalletInterface, counte
 
 See also: [WalletCounterparty](./wallet.md#type-walletcounterparty), [WalletInterface](./wallet.md#interface-walletinterface)
 
-<details>
-
-<summary>Function verifyNonce Details</summary>
-
 Returns
 
 The status of the validation
@@ -1229,8 +1177,6 @@ Argument Details
 + **counterparty**
   + The counterparty to the nonce creation. Defaults to 'self'.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---

package/docs/compat.md

@@ -34,10 +34,6 @@ export default class ECIES {
 
 See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
-<details>
-
-<summary>Class ECIES Details</summary>
-
 #### Method bitcoreDecrypt
 
 Decrypts a message encrypted using the Bitcore variant of ECIES.
@@ -153,8 +149,6 @@ Argument Details
 + **pubKey**
   + The receiver's public key.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -193,10 +187,6 @@ export default class HD {
 
 See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
-<details>
-
-<summary>Class HD Details</summary>
-
 #### Constructor
 
 Constructor for the BIP32 HD wallet.
@@ -455,8 +445,6 @@ Returns
 
 A base58 encoded string of the HD wallet.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -491,10 +479,6 @@ export default class Mnemonic {
 
 See also: [wordList](./compat.md#variable-wordlist)
 
-<details>
-
-<summary>Class Mnemonic Details</summary>
-
 #### Constructor
 
 Constructs a Mnemonic object.
@@ -794,8 +778,6 @@ Returns
 
 The mnemonic phrase as a string.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -825,10 +807,6 @@ export default function fromUtxo(utxo: jsonUtxo, unlockingScriptTemplate: {
 
 See also: [Transaction](./transaction.md#class-transaction), [TransactionInput](./transaction.md#interface-transactioninput), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign)
 
-<details>
-
-<summary>Function fromUtxo Details</summary>
-
 Argument Details
 
 + **utxo**
@@ -836,8 +814,6 @@ Argument Details
 + **unlockingScriptTemplate**
   + : { sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>, estimateLength: (tx: Transaction, inputIndex: number) => Promise<number> }
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---

package/docs/overlay-tools.md

@@ -30,10 +30,6 @@ 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,
@@ -59,8 +55,6 @@ 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)
 
 ---
@@ -75,10 +69,6 @@ export interface LookupQuestion {
 }
 ```
 
-<details>
-
-<summary>Interface LookupQuestion Details</summary>
-
 #### Property query
 
 The query which will be forwarded to the Lookup Service.
@@ -96,8 +86,6 @@ 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)
 
 ---
@@ -116,10 +104,6 @@ export interface LookupResolverConfig {
 
 See also: [OverlayLookupFacilitator](./overlay-tools.md#interface-overlaylookupfacilitator)
 
-<details>
-
-<summary>Interface LookupResolverConfig Details</summary>
-
 #### Property additionalHosts
 
 Map of lookup service names to arrays of hosts to use in addition to resolving via SLAP.
@@ -153,8 +137,6 @@ 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)
 
 ---
@@ -185,10 +167,6 @@ export interface OverlayLookupFacilitator {
 
 See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion)
 
-<details>
-
-<summary>Interface OverlayLookupFacilitator Details</summary>
-
 #### Property lookup
 
 Returns a lookup answer for a lookup question
@@ -198,8 +176,6 @@ lookup: (url: string, question: LookupQuestion, timeout?: number) => Promise<Loo
 ```
 See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion)
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -219,10 +195,6 @@ export interface SHIPBroadcasterConfig {
 
 See also: [LookupResolver](./overlay-tools.md#class-lookupresolver), [OverlayBroadcastFacilitator](./overlay-tools.md#interface-overlaybroadcastfacilitator)
 
-<details>
-
-<summary>Interface SHIPBroadcasterConfig Details</summary>
-
 #### Property facilitator
 
 The facilitator used to make requests to Overlay Services hosts.
@@ -265,8 +237,6 @@ resolver: LookupResolver
 ```
 See also: [LookupResolver](./overlay-tools.md#class-lookupresolver)
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -341,10 +311,6 @@ export default class LookupResolver {
 
 See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion), [LookupResolverConfig](./overlay-tools.md#interface-lookupresolverconfig)
 
-<details>
-
-<summary>Class LookupResolver Details</summary>
-
 #### Method query
 
 Given a LookupQuestion, returns a LookupAnswer. Aggregates across multiple services and supports resiliency.
@@ -354,8 +320,6 @@ async query(question: LookupQuestion, timeout?: number): Promise<LookupAnswer>
 ```
 See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion)
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -383,10 +347,6 @@ 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)
 
-<details>
-
-<summary>Class OverlayAdminTokenTemplate Details</summary>
-
 #### Constructor
 
 Constructs a new Overlay Admin template instance
@@ -467,8 +427,6 @@ 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)
 
 ---
@@ -485,10 +443,6 @@ export default class SHIPCast 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)
 
-<details>
-
-<summary>Class SHIPCast Details</summary>
-
 #### Constructor
 
 Constructs an instance of the SHIP broadcaster.
@@ -523,8 +477,6 @@ Argument Details
 + **tx**
   + The transaction to be sent.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---