@bsv/sdk 1.6.12 → 1.6.14

package/docs/reference/compat.md

@@ -41,6 +41,7 @@ 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
@@ -49,10 +50,10 @@ The decrypted message as a number array.
 
 Argument Details
 
-+ **encBuf**
-  + The encrypted message buffer.
-+ **toPrivateKey**
-  + The private key of the recipient.
+- **encBuf**
+    - The encrypted message buffer.
+- **toPrivateKey**
+    - The private key of the recipient.
 
 #### Method bitcoreEncrypt
 
@@ -61,6 +62,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](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 Returns
@@ -69,14 +71,14 @@ The encrypted message as a number array.
 
 Argument Details
 
-+ **messageBuf**
-  + The message to be encrypted, in number array format.
-+ **toPublicKey**
-  + The public key of the recipient.
-+ **fromPrivateKey**
-  + The private key of the sender. If not provided, a random private key is used.
-+ **ivBuf**
-  + The initialization vector for encryption. If not provided, a random IV is used.
+- **messageBuf**
+    - The message to be encrypted, in number array format.
+- **toPublicKey**
+    - The public key of the recipient.
+- **fromPrivateKey**
+    - The private key of the sender. If not provided, a random private key is used.
+- **ivBuf**
+    - The initialization vector for encryption. If not provided, a random IV is used.
 
 #### Method electrumDecrypt
 
@@ -85,6 +87,7 @@ 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
@@ -93,12 +96,12 @@ The decrypted message as a number array.
 
 Argument Details
 
-+ **encBuf**
-  + The encrypted message buffer.
-+ **toPrivateKey**
-  + The private key of the recipient.
-+ **fromPublicKey**
-  + The public key of the sender. If not provided, it is extracted from the message.
+- **encBuf**
+    - The encrypted message buffer.
+- **toPrivateKey**
+    - The private key of the recipient.
+- **fromPublicKey**
+    - The public key of the sender. If not provided, it is extracted from the message.
 
 #### Method electrumEncrypt
 
@@ -107,6 +110,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](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 Returns
@@ -115,14 +119,14 @@ The encrypted message as a number array.
 
 Argument Details
 
-+ **messageBuf**
-  + The message to be encrypted, in number array format.
-+ **toPublicKey**
-  + The public key of the recipient.
-+ **fromPrivateKey**
-  + The private key of the sender. If not provided, a random private key is used.
-+ **noKey**
-  + If true, does not include the sender's public key in the encrypted message.
+- **messageBuf**
+    - The message to be encrypted, in number array format.
+- **toPublicKey**
+    - The public key of the recipient.
+- **fromPrivateKey**
+    - The private key of the sender. If not provided, a random private key is used.
+- **noKey**
+    - If true, does not include the sender's public key in the encrypted message.
 
 #### Method ivkEkM
 
@@ -136,6 +140,7 @@ public static ivkEkM(privKey: PrivateKey, pubKey: PublicKey): {
     kM: number[];
 } 
 ```
+
 See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitives.md#class-publickey)
 
 Returns
@@ -144,14 +149,15 @@ An object containing the iv, kE, and kM as number arrays.
 
 Argument Details
 
-+ **privKey**
-  + The sender's private key.
-+ **pubKey**
-  + The receiver's public key.
+- **privKey**
+    - The sender's private key.
+- **pubKey**
+    - The receiver's public key.
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
+
 ### Class: HD
 
 ```ts
@@ -195,24 +201,25 @@ 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
 
-+ **versionBytesNum**
-  + Version bytes number for the wallet.
-+ **depth**
-  + Depth of the key in the hierarchy.
-+ **parentFingerPrint**
-  + Fingerprint of the parent key.
-+ **childIndex**
-  + Index of the child key.
-+ **chainCode**
-  + Chain code for key derivation.
-+ **privKey**
-  + Private key of the wallet.
-+ **pubKey**
-  + Public key of the wallet.
+- **versionBytesNum**
+    - Version bytes number for the wallet.
+- **depth**
+    - Depth of the key in the hierarchy.
+- **parentFingerPrint**
+    - Fingerprint of the parent key.
+- **childIndex**
+    - Index of the child key.
+- **chainCode**
+    - Chain code for key derivation.
+- **privKey**
+    - Private key of the wallet.
+- **pubKey**
+    - Public key of the wallet.
 
 #### Method derive
 
@@ -222,6 +229,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)
 
 Returns
@@ -230,8 +238,8 @@ A new HD instance representing the derived child wallet.
 
 Argument Details
 
-+ **path**
-  + A string representing the derivation path (e.g., 'm/0'/1).
+- **path**
+    - A string representing the derivation path (e.g., 'm/0'/1).
 
 #### Method deriveChild
 
@@ -241,6 +249,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)
 
 Returns
@@ -249,8 +258,8 @@ A new HD instance representing the derived child wallet.
 
 Argument Details
 
-+ **i**
-  + The index of the child key to derive.
+- **i**
+    - The index of the child key to derive.
 
 #### Method fromBinary
 
@@ -260,6 +269,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)
 
 Returns
@@ -268,8 +278,8 @@ The new instance with properties set from the buffer.
 
 Argument Details
 
-+ **buf**
-  + A buffer containing the wallet data.
+- **buf**
+    - A buffer containing the wallet data.
 
 #### Method fromBinary
 
@@ -286,8 +296,8 @@ The current instance with properties set from the buffer.
 
 Argument Details
 
-+ **buf**
-  + A buffer containing the wallet data.
+- **buf**
+    - A buffer containing the wallet data.
 
 #### Method fromRandom
 
@@ -310,6 +320,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)
 
 Returns
@@ -324,6 +335,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)
 
 Returns
@@ -332,8 +344,8 @@ The current instance with properties set from the seed.
 
 Argument Details
 
-+ **bytes**
-  + An array of bytes representing the seed.
+- **bytes**
+    - An array of bytes representing the seed.
 
 #### Method fromSeed
 
@@ -350,8 +362,8 @@ The current instance with properties set from the seed.
 
 Argument Details
 
-+ **bytes**
-  + An array of bytes representing the seed.
+- **bytes**
+    - An array of bytes representing the seed.
 
 #### Method fromString
 
@@ -361,6 +373,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)
 
 Returns
@@ -369,8 +382,8 @@ The new instance with properties set from the string.
 
 Argument Details
 
-+ **str**
-  + A base58 encoded string representing the wallet.
+- **str**
+    - A base58 encoded string representing the wallet.
 
 #### Method fromString
 
@@ -387,8 +400,8 @@ The current instance with properties set from the string.
 
 Argument Details
 
-+ **str**
-  + A base58 encoded string representing the wallet.
+- **str**
+    - A base58 encoded string representing the wallet.
 
 #### Method isPrivate
 
@@ -424,6 +437,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)
 
 Returns
@@ -448,6 +462,7 @@ A base58 encoded string of the HD wallet.
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
+
 ### Class: Mnemonic
 
 ```ts
@@ -486,16 +501,17 @@ Constructs a Mnemonic object.
 ```ts
 constructor(mnemonic?: string, seed?: number[], wordlist = wordList) 
 ```
+
 See also: [wordList](./compat.md#variable-wordlist)
 
 Argument Details
 
-+ **mnemonic**
-  + An optional mnemonic phrase.
-+ **seed**
-  + An optional seed derived from the mnemonic.
-+ **wordlist**
-  + An object containing a list of words and space character used in the mnemonic.
+- **mnemonic**
+    - An optional mnemonic phrase.
+- **seed**
+    - An optional seed derived from the mnemonic.
+- **wordlist**
+    - An object containing a list of words and space character used in the mnemonic.
 
 #### Method check
 
@@ -531,8 +547,8 @@ The Mnemonic instance with the mnemonic set from the entropy.
 
 Argument Details
 
-+ **buf**
-  + The entropy buffer to convert. Must be at least 128 bits.
+- **buf**
+    - The entropy buffer to convert. Must be at least 128 bits.
 
 Throws
 
@@ -552,8 +568,8 @@ The Mnemonic instance with loaded mnemonic and seed.
 
 Argument Details
 
-+ **bin**
-  + The binary representation of a mnemonic and seed.
+- **bin**
+    - The binary representation of a mnemonic and seed.
 
 #### Method fromEntropy
 
@@ -570,8 +586,8 @@ The Mnemonic instance with the mnemonic set from the given entropy.
 
 Argument Details
 
-+ **buf**
-  + The entropy buffer, must be at least 128 bits.
+- **buf**
+    - The entropy buffer, must be at least 128 bits.
 
 Throws
 
@@ -584,6 +600,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)
 
 Returns
@@ -592,8 +609,8 @@ A new Mnemonic instance.
 
 Argument Details
 
-+ **buf**
-  + The entropy buffer.
+- **buf**
+    - The entropy buffer.
 
 #### Method fromRandom
 
@@ -609,8 +626,8 @@ The Mnemonic instance with the new random mnemonic.
 
 Argument Details
 
-+ **bits**
-  + The bit length for the random mnemonic (must be a multiple of 32 and at least 128).
+- **bits**
+    - The bit length for the random mnemonic (must be a multiple of 32 and at least 128).
 
 Throws
 
@@ -623,6 +640,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)
 
 Returns
@@ -631,8 +649,8 @@ A new Mnemonic instance.
 
 Argument Details
 
-+ **bits**
-  + The bit length for the random mnemonic.
+- **bits**
+    - The bit length for the random mnemonic.
 
 #### Method fromString
 
@@ -648,8 +666,8 @@ The Mnemonic instance with the set mnemonic.
 
 Argument Details
 
-+ **mnemonic**
-  + The mnemonic phrase as a string.
+- **mnemonic**
+    - The mnemonic phrase as a string.
 
 #### Method fromString
 
@@ -658,6 +676,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)
 
 Returns
@@ -666,8 +685,8 @@ A new Mnemonic instance.
 
 Argument Details
 
-+ **str**
-  + The mnemonic phrase.
+- **str**
+    - The mnemonic phrase.
 
 #### Method isValid
 
@@ -684,8 +703,8 @@ True if the mnemonic and passphrase combination is valid, false otherwise.
 
 Argument Details
 
-+ **passphrase**
-  + The passphrase to validate.
+- **passphrase**
+    - The passphrase to validate.
 
 #### Method isValid
 
@@ -701,10 +720,10 @@ True if the combination is valid, false otherwise.
 
 Argument Details
 
-+ **mnemonic**
-  + The mnemonic phrase.
-+ **passphrase**
-  + The passphrase to validate.
+- **mnemonic**
+    - The mnemonic phrase.
+- **passphrase**
+    - The passphrase to validate.
 
 #### Method mnemonic2Seed
 
@@ -723,8 +742,8 @@ The Mnemonic instance with the seed generated from the mnemonic.
 
 Argument Details
 
-+ **passphrase**
-  + An optional passphrase for added security.
+- **passphrase**
+    - An optional passphrase for added security.
 
 Throws
 
@@ -757,8 +776,8 @@ The generated seed.
 
 Argument Details
 
-+ **passphrase**
-  + An optional passphrase for additional security.
+- **passphrase**
+    - An optional passphrase for additional security.
 
 Throws
 
@@ -781,6 +800,7 @@ The mnemonic phrase as a string.
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
+
 ## Functions
 
 ### Function: fromUtxo
@@ -809,14 +829,15 @@ See also: [Transaction](./transaction.md#class-transaction), [TransactionInput](
 
 Argument Details
 
-+ **utxo**
-  + : jsonUtxo
-+ **unlockingScriptTemplate**
-  + : { sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>, estimateLength: (tx: Transaction, inputIndex: number) => Promise<number> }
+- **utxo**
+    - : jsonUtxo
+- **unlockingScriptTemplate**
+    - : { sign: (tx: Transaction, inputIndex: number) => Promise<UnlockingScript>, estimateLength: (tx: Transaction, inputIndex: number) => Promise<number> }
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
+
 ## Types
 
 ## Enums
@@ -854,6 +875,7 @@ See also: [Writer](./primitives.md#class-writer), [hash256](./primitives.md#vari
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
+
 ### Variable: sign
 
 ```ts
@@ -874,6 +896,7 @@ See also: [BigNumber](./primitives.md#class-bignumber), [PrivateKey](./primitive
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
+
 ### Variable: verify
 
 ```ts
@@ -888,6 +911,7 @@ See also: [BigNumber](./primitives.md#class-bignumber), [PublicKey](./primitives
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
+
 ### Variable: wordList
 
 ```ts

package/docs/reference/configuration.md

@@ -50,6 +50,7 @@ interface NetworkConfig {
 ### Predefined Networks
 
 #### Mainnet Configuration
+
 ```typescript
 const MAINNET_CONFIG: NetworkConfig = {
   name: 'mainnet',
@@ -76,6 +77,7 @@ const MAINNET_CONFIG: NetworkConfig = {
 ```
 
 #### Testnet Configuration
+
 ```typescript
 const TESTNET_CONFIG: NetworkConfig = {
   name: 'testnet',
@@ -101,6 +103,7 @@ const TESTNET_CONFIG: NetworkConfig = {
 ```
 
 #### Regtest Configuration
+
 ```typescript
 const REGTEST_CONFIG: NetworkConfig = {
   name: 'regtest',
@@ -808,18 +811,21 @@ function validateConfig(config: SDKConfig): string[] {
 ### Environment-Specific Settings
 
 #### Development
+
 - Use testnet or regtest networks
 - Enable debug logging
 - Shorter timeouts for faster feedback
 - Disable strict validation for testing
 
 #### Staging
+
 - Mirror production configuration
 - Enable comprehensive logging
 - Use production-like endpoints
 - Enable all validation checks
 
 #### Production
+
 - Use mainnet network
 - Minimal logging (warn/error only)
 - Longer timeouts for reliability

package/docs/reference/debugging.md

@@ -667,23 +667,27 @@ const testDebugConfig = {
 ### Debug Checklist
 
 1. **Enable appropriate logging level**
+
    ```typescript
    // Set debug level based on issue severity
    const config = { logging: { level: 'debug' } }
    ```
 
 2. **Check network connectivity**
+
    ```typescript
    NetworkInspector.startRequest('health-check', 'https://api.whatsonchain.com/v1/bsv/main/chain/info', 'GET')
    ```
 
 3. **Validate transaction structure**
+
    ```typescript
    const analysis = TransactionAnalyzer.analyze(transaction)
    console.log('Transaction Analysis:', analysis)
    ```
 
 4. **Monitor performance**
+
    ```typescript
    PerformanceMonitor.startTimer('wallet-operation')
    // ... perform operation
@@ -691,6 +695,7 @@ const testDebugConfig = {
    ```
 
 5. **Check memory usage**
+
    ```typescript
    MemoryMonitor.logMemoryUsage('before-operation')
    // ... perform operation