@bsv/sdk 1.4.24 → 1.5.0

package/docs/compat.md

@@ -32,11 +32,7 @@ export default class ECIES {
 }
 ```
 
-See also: [PrivateKey](#class-privatekey), [PublicKey](#class-publickey)
-
-<details>
-
-<summary>Class ECIES Details</summary>
+See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 #### Method bitcoreDecrypt
 
@@ -45,7 +41,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 +61,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 +85,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 +107,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 +136,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
 
@@ -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)
 
 ---
@@ -191,11 +185,7 @@ export default class HD {
 }
 ```
 
-See also: [PrivateKey](#class-privatekey), [PublicKey](#class-publickey)
-
-<details>
-
-<summary>Class HD Details</summary>
+See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 #### Constructor
 
@@ -205,7 +195,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 +222,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 +241,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 +260,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 +310,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 +324,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 +361,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 +424,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
 
@@ -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)
 
 ---
@@ -489,11 +477,7 @@ export default class Mnemonic {
 }
 ```
 
-See also: [wordList](#variable-wordlist)
-
-<details>
-
-<summary>Class Mnemonic Details</summary>
+See also: [wordList](./compat.md#variable-wordlist)
 
 #### Constructor
 
@@ -502,7 +486,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 +584,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 +623,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 +658,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
 
@@ -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)
 
 ---
@@ -823,11 +805,7 @@ export default function fromUtxo(utxo: jsonUtxo, unlockingScriptTemplate: {
 }): TransactionInput 
 ```
 
-See also: [Transaction](#class-transaction), [TransactionInput](#interface-transactioninput), [UnlockingScript](#class-unlockingscript), [sign](#variable-sign)
-
-<details>
-
-<summary>Function fromUtxo Details</summary>
+See also: [Transaction](./transaction.md#class-transaction), [TransactionInput](./transaction.md#interface-transactioninput), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign)
 
 Argument Details
 
@@ -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)
 
 ---
@@ -873,7 +849,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 +869,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 +883,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/identity.md

@@ -41,7 +41,7 @@ export interface IdentityClientOptions {
 }
 ```
 
-See also: [WalletProtocol](#type-walletprotocol)
+See also: [WalletProtocol](./wallet.md#type-walletprotocol)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -62,11 +62,7 @@ export class IdentityClient {
 }
 ```
 
-See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [DEFAULT_IDENTITY_CLIENT_OPTIONS](#variable-default_identity_client_options), [DiscoverByAttributesArgs](#interface-discoverbyattributesargs), [DiscoverByIdentityKeyArgs](#interface-discoverbyidentitykeyargs), [DisplayableIdentity](#interface-displayableidentity), [IdentityCertificate](#interface-identitycertificate), [OriginatorDomainNameStringUnder250Bytes](#type-originatordomainnamestringunder250bytes), [WalletCertificate](#interface-walletcertificate), [WalletInterface](#interface-walletinterface)
-
-<details>
-
-<summary>Class IdentityClient Details</summary>
+See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [DEFAULT_IDENTITY_CLIENT_OPTIONS](./identity.md#variable-default_identity_client_options), [DiscoverByAttributesArgs](./wallet.md#interface-discoverbyattributesargs), [DiscoverByIdentityKeyArgs](./wallet.md#interface-discoverbyidentitykeyargs), [DisplayableIdentity](./identity.md#interface-displayableidentity), [IdentityCertificate](./wallet.md#interface-identitycertificate), [OriginatorDomainNameStringUnder250Bytes](./wallet.md#type-originatordomainnamestringunder250bytes), [WalletCertificate](./wallet.md#interface-walletcertificate), [WalletInterface](./wallet.md#interface-walletinterface)
 
 #### Method parseIdentity
 
@@ -78,7 +74,7 @@ Parse out identity and certifier attributes to display from an IdentityCertifica
 ```ts
 static parseIdentity(identityToParse: IdentityCertificate): DisplayableIdentity 
 ```
-See also: [DisplayableIdentity](#interface-displayableidentity), [IdentityCertificate](#interface-identitycertificate)
+See also: [DisplayableIdentity](./identity.md#interface-displayableidentity), [IdentityCertificate](./wallet.md#interface-identitycertificate)
 
 Returns
 
@@ -99,7 +95,7 @@ The publicly revealed certificate is included in a blockchain transaction and br
 ```ts
 async publiclyRevealAttributes(certificate: WalletCertificate, fieldsToReveal: CertificateFieldNameUnder50Bytes[]): Promise<BroadcastResponse | BroadcastFailure> 
 ```
-See also: [BroadcastFailure](#interface-broadcastfailure), [BroadcastResponse](#interface-broadcastresponse), [CertificateFieldNameUnder50Bytes](#type-certificatefieldnameunder50bytes), [WalletCertificate](#interface-walletcertificate)
+See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [WalletCertificate](./wallet.md#interface-walletcertificate)
 
 Returns
 
@@ -123,7 +119,7 @@ Resolves displayable identity certificates by specific identity attributes, issu
 ```ts
 async resolveByAttributes(args: DiscoverByAttributesArgs): Promise<DisplayableIdentity[]> 
 ```
-See also: [DiscoverByAttributesArgs](#interface-discoverbyattributesargs), [DisplayableIdentity](#interface-displayableidentity)
+See also: [DiscoverByAttributesArgs](./wallet.md#interface-discoverbyattributesargs), [DisplayableIdentity](./identity.md#interface-displayableidentity)
 
 Returns
 
@@ -141,7 +137,7 @@ Resolves displayable identity certificates, issued to a given identity key by a
 ```ts
 async resolveByIdentityKey(args: DiscoverByIdentityKeyArgs): Promise<DisplayableIdentity[]> 
 ```
-See also: [DiscoverByIdentityKeyArgs](#interface-discoverbyidentitykeyargs), [DisplayableIdentity](#interface-displayableidentity)
+See also: [DiscoverByIdentityKeyArgs](./wallet.md#interface-discoverbyidentitykeyargs), [DisplayableIdentity](./identity.md#interface-displayableidentity)
 
 Returns
 
@@ -152,8 +148,6 @@ Argument Details
 + **args**
   + Arguments for requesting the discovery based on the identity key.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -186,7 +180,7 @@ DEFAULT_IDENTITY_CLIENT_OPTIONS: IdentityClientOptions = {
 }
 ```
 
-See also: [IdentityClientOptions](#interface-identityclientoptions)
+See also: [IdentityClientOptions](./identity.md#interface-identityclientoptions)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -224,7 +218,7 @@ defaultIdentity: DisplayableIdentity = {
 }
 ```
 
-See also: [DisplayableIdentity](#interface-displayableidentity)
+See also: [DisplayableIdentity](./identity.md#interface-displayableidentity)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 

package/docs/kvstore.md

@@ -21,11 +21,7 @@ export default class LocalKVStore {
 }
 ```
 
-See also: [OutpointString](#type-outpointstring), [WalletClient](#class-walletclient), [WalletInterface](#interface-walletinterface)
-
-<details>
-
-<summary>Class LocalKVStore Details</summary>
+See also: [OutpointString](./wallet.md#type-outpointstring), [WalletClient](./wallet.md#class-walletclient), [WalletInterface](./wallet.md#interface-walletinterface), [encrypt](./messages.md#variable-encrypt)
 
 #### Constructor
 
@@ -34,7 +30,7 @@ Creates an instance of the localKVStore.
 ```ts
 constructor(wallet: WalletInterface = new WalletClient(), context = "kvstore default", encrypt = true, originator?: string) 
 ```
-See also: [WalletClient](#class-walletclient), [WalletInterface](#interface-walletinterface)
+See also: [WalletClient](./wallet.md#class-walletclient), [WalletInterface](./wallet.md#interface-walletinterface), [encrypt](./messages.md#variable-encrypt)
 
 Argument Details
 
@@ -111,7 +107,7 @@ If signing the update/collapse transaction fails, it relinquishes the original o
 ```ts
 async set(key: string, value: string): Promise<OutpointString> 
 ```
-See also: [OutpointString](#type-outpointstring)
+See also: [OutpointString](./wallet.md#type-outpointstring)
 
 Returns
 
@@ -124,8 +120,6 @@ Argument Details
 + **value**
   + The value to associate with the key.
 
-</details>
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---

package/docs/messages.md

@@ -47,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)
 
@@ -76,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)
 
@@ -109,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)
 
@@ -149,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)