@bsv/sdk 1.3.12 → 1.3.14

package/docs/compat.md

@@ -32,7 +32,7 @@ export default class ECIES {
 }
 ```
 
-See also: [PrivateKey](#class-privatekey), [PublicKey](#class-publickey)
+See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 <details>
 
@@ -45,7 +45,7 @@ Decrypts a message encrypted using the Bitcore variant of ECIES.
 ```ts
 public static bitcoreDecrypt(encBuf: number[], toPrivateKey: PrivateKey): number[] 
 ```
-See also: [PrivateKey](#class-privatekey)
+See also: [PrivateKey](./primitives.md#class-privatekey)
 
 Returns
 
@@ -65,7 +65,7 @@ Encrypts a given message using the Bitcore variant of ECIES.
 ```ts
 public static bitcoreEncrypt(messageBuf: number[], toPublicKey: PublicKey, fromPrivateKey?: PrivateKey, ivBuf?: number[]): number[] 
 ```
-See also: [PrivateKey](#class-privatekey), [PublicKey](#class-publickey)
+See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 Returns
 
@@ -89,7 +89,7 @@ Decrypts a message encrypted using the Electrum ECIES method.
 ```ts
 public static electrumDecrypt(encBuf: number[], toPrivateKey: PrivateKey, fromPublicKey?: PublicKey): number[] 
 ```
-See also: [PrivateKey](#class-privatekey), [PublicKey](#class-publickey)
+See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 Returns
 
@@ -111,7 +111,7 @@ Encrypts a given message using the Electrum ECIES method.
 ```ts
 public static electrumEncrypt(messageBuf: number[], toPublicKey: PublicKey, fromPrivateKey?: PrivateKey, noKey = false): number[] 
 ```
-See also: [PrivateKey](#class-privatekey), [PublicKey](#class-publickey)
+See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 Returns
 
@@ -140,7 +140,7 @@ public static ivkEkM(privKey: PrivateKey, pubKey: PublicKey): {
     kM: number[];
 } 
 ```
-See also: [PrivateKey](#class-privatekey), [PublicKey](#class-publickey)
+See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 Returns
 
@@ -191,7 +191,7 @@ export default class HD {
 }
 ```
 
-See also: [PrivateKey](#class-privatekey), [PublicKey](#class-publickey)
+See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 <details>
 
@@ -205,7 +205,7 @@ Initializes an HD wallet with optional parameters for version bytes, depth, pare
 ```ts
 constructor(versionBytesNum?: number, depth?: number, parentFingerPrint?: number[], childIndex?: number, chainCode?: number[], privKey?: PrivateKey, pubKey?: PublicKey) 
 ```
-See also: [PrivateKey](#class-privatekey), [PublicKey](#class-publickey)
+See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 Argument Details
 
@@ -232,7 +232,7 @@ The path specifies the hierarchy of the child key to be derived.
 ```ts
 public derive(path: string): HD 
 ```
-See also: [HD](#class-hd)
+See also: [HD](./compat.md#class-hd)
 
 Returns
 
@@ -251,7 +251,7 @@ This method generates either a private or public child key depending on the curr
 ```ts
 public deriveChild(i: number): HD 
 ```
-See also: [HD](#class-hd)
+See also: [HD](./compat.md#class-hd)
 
 Returns
 
@@ -270,7 +270,7 @@ Parses a binary buffer to set up the wallet's properties.
 ```ts
 public static fromBinary(buf: number[]): HD 
 ```
-See also: [HD](#class-hd)
+See also: [HD](./compat.md#class-hd)
 
 Returns
 
@@ -320,7 +320,7 @@ This method creates a root HD wallet with randomly generated private and public
 ```ts
 public static fromRandom(): HD 
 ```
-See also: [HD](#class-hd)
+See also: [HD](./compat.md#class-hd)
 
 Returns
 
@@ -334,7 +334,7 @@ This method generates keys and other properties from a given seed, conforming to
 ```ts
 public static fromSeed(bytes: number[]): HD 
 ```
-See also: [HD](#class-hd)
+See also: [HD](./compat.md#class-hd)
 
 Returns
 
@@ -371,7 +371,7 @@ This method decodes a provided string to set up the HD wallet's properties.
 ```ts
 public static fromString(str: string): HD 
 ```
-See also: [HD](#class-hd)
+See also: [HD](./compat.md#class-hd)
 
 Returns
 
@@ -434,7 +434,7 @@ This method strips away the private key information, leaving only the public par
 ```ts
 public toPublic(): HD 
 ```
-See also: [HD](#class-hd)
+See also: [HD](./compat.md#class-hd)
 
 Returns
 
@@ -489,7 +489,7 @@ export default class Mnemonic {
 }
 ```
 
-See also: [wordList](#variable-wordlist)
+See also: [wordList](./compat.md#variable-wordlist)
 
 <details>
 
@@ -502,7 +502,7 @@ Constructs a Mnemonic object.
 ```ts
 constructor(mnemonic?: string, seed?: number[], wordlist = wordList) 
 ```
-See also: [wordList](#variable-wordlist)
+See also: [wordList](./compat.md#variable-wordlist)
 
 Argument Details
 
@@ -600,7 +600,7 @@ Static method to create a Mnemonic instance from a given entropy.
 ```ts
 public static fromEntropy(buf: number[]): Mnemonic 
 ```
-See also: [Mnemonic](#class-mnemonic)
+See also: [Mnemonic](./compat.md#class-mnemonic)
 
 Returns
 
@@ -639,7 +639,7 @@ Static method to generate a Mnemonic instance with a random mnemonic.
 ```ts
 public static fromRandom(bits?: number): Mnemonic 
 ```
-See also: [Mnemonic](#class-mnemonic)
+See also: [Mnemonic](./compat.md#class-mnemonic)
 
 Returns
 
@@ -674,7 +674,7 @@ Static method to create a Mnemonic instance from a mnemonic string.
 ```ts
 public static fromString(str: string): Mnemonic 
 ```
-See also: [Mnemonic](#class-mnemonic)
+See also: [Mnemonic](./compat.md#class-mnemonic)
 
 Returns
 
@@ -823,7 +823,7 @@ export default function fromUtxo(utxo: jsonUtxo, unlockingScriptTemplate: {
 }): TransactionInput 
 ```
 
-See also: [Transaction](#class-transaction), [TransactionInput](#interface-transactioninput), [UnlockingScript](#class-unlockingscript), [sign](#variable-sign)
+See also: [Transaction](./transaction.md#class-transaction), [TransactionInput](./transaction.md#interface-transactioninput), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign)
 
 <details>
 
@@ -873,7 +873,7 @@ magicHash = (messageBuf: number[]): number[] => {
 }
 ```
 
-See also: [Writer](#class-writer), [hash256](#variable-hash256), [toArray](#variable-toarray)
+See also: [Writer](./primitives.md#class-writer), [hash256](./primitives.md#variable-hash256), [toArray](./primitives.md#variable-toarray)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -893,7 +893,7 @@ sign = (message: number[], privateKey: PrivateKey, mode: "raw" | "base64" = "bas
 }
 ```
 
-See also: [BigNumber](#class-bignumber), [PrivateKey](#class-privatekey), [Signature](#class-signature), [magicHash](#variable-magichash)
+See also: [BigNumber](./primitives.md#class-bignumber), [PrivateKey](./primitives.md#class-privatekey), [Signature](./primitives.md#class-signature), [magicHash](./compat.md#variable-magichash)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -907,7 +907,7 @@ verify = (message: number[], sig: Signature, pubKey: PublicKey): boolean => {
 }
 ```
 
-See also: [BigNumber](#class-bignumber), [PublicKey](#class-publickey), [Signature](#class-signature), [magicHash](#variable-magichash)
+See also: [BigNumber](./primitives.md#class-bignumber), [PublicKey](./primitives.md#class-publickey), [Signature](./primitives.md#class-signature), [magicHash](./compat.md#variable-magichash)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 

package/docs/messages.md

@@ -30,7 +30,9 @@ decrypt = (message: number[], recipient: PrivateKey): number[] => {
     }
     const sender = PublicKey.fromString(toHex(reader.read(33)));
     const expectedRecipientDER = toHex(reader.read(33));
-    const actualRecipientDER = recipient.toPublicKey().encode(true, "hex") as string;
+    const actualRecipientDER = recipient
+        .toPublicKey()
+        .encode(true, "hex") as string;
     if (expectedRecipientDER !== actualRecipientDER) {
         throw new Error(`The encrypted message expects a recipient public key of ${expectedRecipientDER}, but the provided key is ${actualRecipientDER}`);
     }
@@ -45,7 +47,7 @@ decrypt = (message: number[], recipient: PrivateKey): number[] => {
 }
 ```
 
-See also: [PrivateKey](#class-privatekey), [PublicKey](#class-publickey), [Reader](#class-reader), [SymmetricKey](#class-symmetrickey), [encode](#variable-encode), [toBase64](#function-tobase64), [toHex](#variable-tohex)
+See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [Reader](./primitives.md#class-reader), [SymmetricKey](./primitives.md#class-symmetrickey), [encode](./primitives.md#variable-encode), [toBase64](./primitives.md#function-tobase64), [toHex](./primitives.md#variable-tohex)
 
 Links: [API](#api), [Classes](#classes), [Functions](#functions), [Variables](#variables)
 
@@ -74,7 +76,7 @@ encrypt = (message: number[], sender: PrivateKey, recipient: PublicKey): number[
 }
 ```
 
-See also: [PrivateKey](#class-privatekey), [PublicKey](#class-publickey), [SymmetricKey](#class-symmetrickey), [encode](#variable-encode), [toArray](#variable-toarray), [toBase64](#function-tobase64)
+See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [SymmetricKey](./primitives.md#class-symmetrickey), [encode](./primitives.md#variable-encode), [toArray](./primitives.md#variable-toarray), [toBase64](./primitives.md#function-tobase64)
 
 Links: [API](#api), [Classes](#classes), [Functions](#functions), [Variables](#variables)
 
@@ -107,7 +109,7 @@ sign = (message: number[], signer: PrivateKey, verifier?: PublicKey): number[] =
 }
 ```
 
-See also: [Curve](#class-curve), [PrivateKey](#class-privatekey), [PublicKey](#class-publickey), [encode](#variable-encode), [toArray](#variable-toarray), [toBase64](#function-tobase64)
+See also: [Curve](./primitives.md#class-curve), [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [encode](./primitives.md#variable-encode), [toArray](./primitives.md#variable-toarray), [toBase64](./primitives.md#function-tobase64)
 
 Links: [API](#api), [Classes](#classes), [Functions](#functions), [Variables](#variables)
 
@@ -147,7 +149,7 @@ verify = (message: number[], sig: number[], recipient?: PrivateKey): boolean =>
 }
 ```
 
-See also: [PrivateKey](#class-privatekey), [PublicKey](#class-publickey), [Reader](#class-reader), [Signature](#class-signature), [encode](#variable-encode), [toBase64](#function-tobase64), [toHex](#variable-tohex)
+See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey), [Reader](./primitives.md#class-reader), [Signature](./primitives.md#class-signature), [encode](./primitives.md#variable-encode), [toBase64](./primitives.md#function-tobase64), [toHex](./primitives.md#variable-tohex)
 
 Links: [API](#api), [Classes](#classes), [Functions](#functions), [Variables](#variables)
 

package/docs/overlay-tools.md

@@ -114,7 +114,7 @@ export interface LookupResolverConfig {
 }
 ```
 
-See also: [OverlayLookupFacilitator](#interface-overlaylookupfacilitator)
+See also: [OverlayLookupFacilitator](./overlay-tools.md#interface-overlaylookupfacilitator)
 
 <details>
 
@@ -135,7 +135,7 @@ The facilitator used to make requests to Overlay Services hosts.
 ```ts
 facilitator?: OverlayLookupFacilitator
 ```
-See also: [OverlayLookupFacilitator](#interface-overlaylookupfacilitator)
+See also: [OverlayLookupFacilitator](./overlay-tools.md#interface-overlaylookupfacilitator)
 
 #### Property hostOverrides
 
@@ -168,7 +168,7 @@ export interface OverlayBroadcastFacilitator {
 }
 ```
 
-See also: [STEAK](#type-steak), [TaggedBEEF](#interface-taggedbeef)
+See also: [STEAK](./overlay-tools.md#type-steak), [TaggedBEEF](./overlay-tools.md#interface-taggedbeef)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -183,7 +183,7 @@ export interface OverlayLookupFacilitator {
 }
 ```
 
-See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion)
+See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion)
 
 <details>
 
@@ -196,7 +196,7 @@ Returns a lookup answer for a lookup question
 ```ts
 lookup: (url: string, question: LookupQuestion, timeout?: number) => Promise<LookupAnswer>
 ```
-See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion)
+See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion)
 
 </details>
 
@@ -217,7 +217,7 @@ export interface SHIPBroadcasterConfig {
 }
 ```
 
-See also: [LookupResolver](#class-lookupresolver), [OverlayBroadcastFacilitator](#interface-overlaybroadcastfacilitator)
+See also: [LookupResolver](./overlay-tools.md#class-lookupresolver), [OverlayBroadcastFacilitator](./overlay-tools.md#interface-overlaybroadcastfacilitator)
 
 <details>
 
@@ -230,7 +230,7 @@ The facilitator used to make requests to Overlay Services hosts.
 ```ts
 facilitator?: OverlayBroadcastFacilitator
 ```
-See also: [OverlayBroadcastFacilitator](#interface-overlaybroadcastfacilitator)
+See also: [OverlayBroadcastFacilitator](./overlay-tools.md#interface-overlaybroadcastfacilitator)
 
 #### Property requireAcknowledgmentFromAllHostsForTopics
 
@@ -263,7 +263,7 @@ The resolver used to locate suitable hosts with SHIP
 ```ts
 resolver: LookupResolver
 ```
-See also: [LookupResolver](#class-lookupresolver)
+See also: [LookupResolver](./overlay-tools.md#class-lookupresolver)
 
 </details>
 
@@ -308,7 +308,7 @@ export class HTTPSOverlayBroadcastFacilitator implements OverlayBroadcastFacilit
 }
 ```
 
-See also: [OverlayBroadcastFacilitator](#interface-overlaybroadcastfacilitator), [STEAK](#type-steak), [TaggedBEEF](#interface-taggedbeef)
+See also: [OverlayBroadcastFacilitator](./overlay-tools.md#interface-overlaybroadcastfacilitator), [STEAK](./overlay-tools.md#type-steak), [TaggedBEEF](./overlay-tools.md#interface-taggedbeef)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -323,7 +323,7 @@ export class HTTPSOverlayLookupFacilitator implements OverlayLookupFacilitator {
 }
 ```
 
-See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion), [OverlayLookupFacilitator](#interface-overlaylookupfacilitator)
+See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion), [OverlayLookupFacilitator](./overlay-tools.md#interface-overlaylookupfacilitator)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -339,7 +339,7 @@ export default class LookupResolver {
 }
 ```
 
-See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion), [LookupResolverConfig](#interface-lookupresolverconfig)
+See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion), [LookupResolverConfig](./overlay-tools.md#interface-lookupresolverconfig)
 
 <details>
 
@@ -352,7 +352,7 @@ Given a LookupQuestion, returns a LookupAnswer. Aggregates across multiple servi
 ```ts
 async query(question: LookupQuestion, timeout?: number): Promise<LookupAnswer> 
 ```
-See also: [LookupAnswer](#type-lookupanswer), [LookupQuestion](#interface-lookupquestion)
+See also: [LookupAnswer](./overlay-tools.md#type-lookupanswer), [LookupQuestion](./overlay-tools.md#interface-lookupquestion)
 
 </details>
 
@@ -381,7 +381,7 @@ export default class OverlayAdminTokenTemplate implements ScriptTemplate {
 }
 ```
 
-See also: [LockingScript](#class-lockingscript), [PushDrop](#class-pushdrop), [ScriptTemplate](#interface-scripttemplate), [Transaction](#class-transaction), [UnlockingScript](#class-unlockingscript), [WalletInterface](#interface-walletinterface), [sign](#variable-sign)
+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>
 
@@ -394,7 +394,7 @@ Constructs a new Overlay Admin template instance
 ```ts
 constructor(wallet: WalletInterface) 
 ```
-See also: [WalletInterface](#interface-walletinterface)
+See also: [WalletInterface](./wallet.md#interface-walletinterface)
 
 Argument Details
 
@@ -413,7 +413,7 @@ static decode(script: LockingScript): {
     topicOrService: string;
 } 
 ```
-See also: [LockingScript](#class-lockingscript)
+See also: [LockingScript](./script.md#class-lockingscript)
 
 Returns
 
@@ -431,7 +431,7 @@ Creates a new advertisement locking script
 ```ts
 async lock(protocol: "SHIP" | "SLAP", domain: string, topicOrService: string): Promise<LockingScript> 
 ```
-See also: [LockingScript](#class-lockingscript)
+See also: [LockingScript](./script.md#class-lockingscript)
 
 Returns
 
@@ -456,7 +456,7 @@ unlock(protocol: "SHIP" | "SLAP"): {
     estimateLength: (tx: Transaction, inputIndex: number) => Promise<number>;
 } 
 ```
-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)
 
 Returns
 
@@ -483,7 +483,7 @@ export default class SHIPCast implements Broadcaster {
 }
 ```
 
-See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [Broadcaster](#interface-broadcaster), [SHIPBroadcasterConfig](#interface-shipbroadcasterconfig), [Transaction](#class-transaction)
+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>
 
@@ -496,7 +496,7 @@ Constructs an instance of the SHIP broadcaster.
 ```ts
 constructor(topics: string[], config?: SHIPBroadcasterConfig) 
 ```
-See also: [SHIPBroadcasterConfig](#interface-shipbroadcasterconfig)
+See also: [SHIPBroadcasterConfig](./overlay-tools.md#interface-shipbroadcasterconfig)
 
 Argument Details
 
@@ -512,7 +512,7 @@ Broadcasts a transaction to Overlay Services via SHIP.
 ```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
 
@@ -570,7 +570,7 @@ Submitted Transaction Execution AcKnowledgment
 export type STEAK = Record<string, AdmittanceInstructions>
 ```
 
-See also: [AdmittanceInstructions](#interface-admittanceinstructions)
+See also: [AdmittanceInstructions](./overlay-tools.md#interface-admittanceinstructions)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)