@bsv/sdk 1.8.0 → 1.8.2

package/docs/reference/compat.md

@@ -32,8 +32,6 @@ export default class ECIES {
 }
 ```
 
-See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
-
 #### Method bitcoreDecrypt
 
 Decrypts a message encrypted using the Bitcore variant of ECIES.
@@ -41,7 +39,6 @@ Decrypts a message encrypted using the Bitcore variant of ECIES.
 ```ts
 public static bitcoreDecrypt(encBuf: number[], toPrivateKey: PrivateKey): number[] 
 ```
-See also: [PrivateKey](./primitives.md#class-privatekey)
 
 Returns
 
@@ -61,7 +58,6 @@ 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](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 Returns
 
@@ -85,7 +81,6 @@ Decrypts a message encrypted using the Electrum ECIES method.
 ```ts
 public static electrumDecrypt(encBuf: number[], toPrivateKey: PrivateKey, fromPublicKey?: PublicKey): number[] 
 ```
-See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 Returns
 
@@ -107,7 +102,6 @@ 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](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 Returns
 
@@ -136,7 +130,6 @@ public static ivkEkM(privKey: PrivateKey, pubKey: PublicKey): {
     kM: number[];
 } 
 ```
-See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 Returns
 
@@ -185,8 +178,6 @@ export default class HD {
 }
 ```
 
-See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
-
 #### Constructor
 
 Constructor for the BIP32 HD wallet.
@@ -195,7 +186,6 @@ 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](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 Argument Details
 
@@ -222,7 +212,7 @@ The path specifies the hierarchy of the child key to be derived.
 ```ts
 public derive(path: string): HD 
 ```
-See also: [HD](./compat.md#class-hd)
+See also: [HD](#class-hd)
 
 Returns
 
@@ -241,7 +231,7 @@ This method generates either a private or public child key depending on the curr
 ```ts
 public deriveChild(i: number): HD 
 ```
-See also: [HD](./compat.md#class-hd)
+See also: [HD](#class-hd)
 
 Returns
 
@@ -260,7 +250,7 @@ Parses a binary buffer to set up the wallet's properties.
 ```ts
 public static fromBinary(buf: number[]): HD 
 ```
-See also: [HD](./compat.md#class-hd)
+See also: [HD](#class-hd)
 
 Returns
 
@@ -310,7 +300,7 @@ This method creates a root HD wallet with randomly generated private and public
 ```ts
 public static fromRandom(): HD 
 ```
-See also: [HD](./compat.md#class-hd)
+See also: [HD](#class-hd)
 
 Returns
 
@@ -324,7 +314,7 @@ This method generates keys and other properties from a given seed, conforming to
 ```ts
 public static fromSeed(bytes: number[]): HD 
 ```
-See also: [HD](./compat.md#class-hd)
+See also: [HD](#class-hd)
 
 Returns
 
@@ -361,7 +351,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](./compat.md#class-hd)
+See also: [HD](#class-hd)
 
 Returns
 
@@ -424,7 +414,7 @@ This method strips away the private key information, leaving only the public par
 ```ts
 public toPublic(): HD 
 ```
-See also: [HD](./compat.md#class-hd)
+See also: [HD](#class-hd)
 
 Returns
 
@@ -477,7 +467,7 @@ export default class Mnemonic {
 }
 ```
 
-See also: [wordList](./compat.md#variable-wordlist)
+See also: [wordList](#variable-wordlist)
 
 #### Constructor
 
@@ -486,7 +476,7 @@ Constructs a Mnemonic object.
 ```ts
 constructor(mnemonic?: string, seed?: number[], wordlist = wordList) 
 ```
-See also: [wordList](./compat.md#variable-wordlist)
+See also: [wordList](#variable-wordlist)
 
 Argument Details
 
@@ -584,7 +574,7 @@ Static method to create a Mnemonic instance from a given entropy.
 ```ts
 public static fromEntropy(buf: number[]): Mnemonic 
 ```
-See also: [Mnemonic](./compat.md#class-mnemonic)
+See also: [Mnemonic](#class-mnemonic)
 
 Returns
 
@@ -623,7 +613,7 @@ Static method to generate a Mnemonic instance with a random mnemonic.
 ```ts
 public static fromRandom(bits?: number): Mnemonic 
 ```
-See also: [Mnemonic](./compat.md#class-mnemonic)
+See also: [Mnemonic](#class-mnemonic)
 
 Returns
 
@@ -658,7 +648,7 @@ Static method to create a Mnemonic instance from a mnemonic string.
 ```ts
 public static fromString(str: string): Mnemonic 
 ```
-See also: [Mnemonic](./compat.md#class-mnemonic)
+See also: [Mnemonic](#class-mnemonic)
 
 Returns
 
@@ -805,7 +795,7 @@ export default function fromUtxo(utxo: jsonUtxo, unlockingScriptTemplate: {
 }): TransactionInput 
 ```
 
-See also: [Transaction](./transaction.md#class-transaction), [TransactionInput](./transaction.md#interface-transactioninput), [UnlockingScript](./script.md#class-unlockingscript), [sign](./compat.md#variable-sign)
+See also: [sign](#variable-sign)
 
 Argument Details
 
@@ -849,8 +839,6 @@ magicHash = (messageBuf: number[]): number[] => {
 }
 ```
 
-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)
 
 ---
@@ -869,7 +857,7 @@ sign = (message: number[], privateKey: PrivateKey, mode: "raw" | "base64" = "bas
 }
 ```
 
-See also: [BigNumber](./primitives.md#class-bignumber), [PrivateKey](./primitives.md#class-privatekey), [Signature](./primitives.md#class-signature), [magicHash](./compat.md#variable-magichash)
+See also: [magicHash](#variable-magichash)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -883,7 +871,7 @@ verify = (message: number[], sig: Signature, pubKey: PublicKey): boolean => {
 }
 ```
 
-See also: [BigNumber](./primitives.md#class-bignumber), [PublicKey](./primitives.md#class-publickey), [Signature](./primitives.md#class-signature), [magicHash](./compat.md#variable-magichash)
+See also: [magicHash](#variable-magichash)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 

package/docs/reference/identity.md

@@ -41,8 +41,6 @@ export interface IdentityClientOptions {
 }
 ```
 
-See also: [WalletProtocol](./wallet.md#type-walletprotocol)
-
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
@@ -68,7 +66,7 @@ export class ContactsManager {
 }
 ```
 
-See also: [Contact](./identity.md#type-contact), [DisplayableIdentity](./identity.md#interface-displayableidentity), [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletInterface](./wallet.md#interface-walletinterface)
+See also: [Contact](#type-contact), [DisplayableIdentity](#interface-displayableidentity)
 
 #### Method getContacts
 
@@ -77,7 +75,7 @@ Load all records from the contacts basket
 ```ts
 async getContacts(identityKey?: PubKeyHex, forceRefresh = false, limit = 1000): Promise<Contact[]> 
 ```
-See also: [Contact](./identity.md#type-contact), [PubKeyHex](./wallet.md#type-pubkeyhex)
+See also: [Contact](#type-contact)
 
 Returns
 
@@ -112,7 +110,7 @@ Save or update a Metanet contact
 ```ts
 async saveContact(contact: DisplayableIdentity, metadata?: Record<string, any>): Promise<void> 
 ```
-See also: [DisplayableIdentity](./identity.md#interface-displayableidentity)
+See also: [DisplayableIdentity](#interface-displayableidentity)
 
 Argument Details
 
@@ -141,7 +139,7 @@ export class IdentityClient {
 }
 ```
 
-See also: [BroadcastFailure](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [Contact](./identity.md#type-contact), [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), [PubKeyHex](./wallet.md#type-pubkeyhex), [WalletCertificate](./wallet.md#interface-walletcertificate), [WalletInterface](./wallet.md#interface-walletinterface)
+See also: [Contact](#type-contact), [DEFAULT_IDENTITY_CLIENT_OPTIONS](#variable-default_identity_client_options), [DisplayableIdentity](#interface-displayableidentity)
 
 #### Method getContacts
 
@@ -153,7 +151,7 @@ Load all records from the contacts basket
 ```ts
 public async getContacts(identityKey?: PubKeyHex, forceRefresh = false, limit = 1000): Promise<Contact[]> 
 ```
-See also: [Contact](./identity.md#type-contact), [PubKeyHex](./wallet.md#type-pubkeyhex)
+See also: [Contact](#type-contact)
 
 Returns
 
@@ -177,7 +175,7 @@ Parse out identity and certifier attributes to display from an IdentityCertifica
 ```ts
 static parseIdentity(identityToParse: IdentityCertificate): DisplayableIdentity 
 ```
-See also: [DisplayableIdentity](./identity.md#interface-displayableidentity), [IdentityCertificate](./wallet.md#interface-identitycertificate)
+See also: [DisplayableIdentity](#interface-displayableidentity)
 
 Returns
 
@@ -196,7 +194,6 @@ 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](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [WalletCertificate](./wallet.md#interface-walletcertificate)
 
 Returns
 
@@ -220,7 +217,6 @@ Remove a contact from the contacts basket
 ```ts
 public async removeContact(identityKey: PubKeyHex): Promise<void> 
 ```
-See also: [PubKeyHex](./wallet.md#type-pubkeyhex)
 
 Argument Details
 
@@ -234,7 +230,7 @@ Resolves displayable identity certificates by specific identity attributes, issu
 ```ts
 async resolveByAttributes(args: DiscoverByAttributesArgs, overrideWithContacts = true): Promise<DisplayableIdentity[]> 
 ```
-See also: [DiscoverByAttributesArgs](./wallet.md#interface-discoverbyattributesargs), [DisplayableIdentity](./identity.md#interface-displayableidentity)
+See also: [DisplayableIdentity](#interface-displayableidentity)
 
 Returns
 
@@ -254,7 +250,7 @@ Resolves displayable identity certificates, issued to a given identity key by a
 ```ts
 async resolveByIdentityKey(args: DiscoverByIdentityKeyArgs, overrideWithContacts = true): Promise<DisplayableIdentity[]> 
 ```
-See also: [DiscoverByIdentityKeyArgs](./wallet.md#interface-discoverbyidentitykeyargs), [DisplayableIdentity](./identity.md#interface-displayableidentity)
+See also: [DisplayableIdentity](#interface-displayableidentity)
 
 Returns
 
@@ -274,7 +270,7 @@ Save or update a Metanet contact
 ```ts
 public async saveContact(contact: DisplayableIdentity, metadata?: Record<string, any>): Promise<void> 
 ```
-See also: [DisplayableIdentity](./identity.md#interface-displayableidentity)
+See also: [DisplayableIdentity](#interface-displayableidentity)
 
 Argument Details
 
@@ -298,7 +294,7 @@ export type Contact = DisplayableIdentity & {
 }
 ```
 
-See also: [DisplayableIdentity](./identity.md#interface-displayableidentity)
+See also: [DisplayableIdentity](#interface-displayableidentity)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -328,7 +324,7 @@ DEFAULT_IDENTITY_CLIENT_OPTIONS: IdentityClientOptions = {
 }
 ```
 
-See also: [IdentityClientOptions](./identity.md#interface-identityclientoptions)
+See also: [IdentityClientOptions](#interface-identityclientoptions)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
@@ -366,7 +362,7 @@ defaultIdentity: DisplayableIdentity = {
 }
 ```
 
-See also: [DisplayableIdentity](./identity.md#interface-displayableidentity)
+See also: [DisplayableIdentity](#interface-displayableidentity)
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)