@bsv/sdk 1.6.12 → 1.6.14

package/docs/reference/errors.md

@@ -7,40 +7,48 @@ Complete reference for error codes, messages, and troubleshooting in the BSV Typ
 ### Transaction Errors
 
 #### INSUFFICIENT_FUNDS
+
 **Code**: `INSUFFICIENT_FUNDS`  
 **Message**: "Insufficient funds to create transaction"  
 **Cause**: Wallet doesn't have enough UTXOs to cover transaction outputs and fees  
 **Solutions**:
+
 - Check wallet balance with `listOutputs()`
 - Reduce transaction amount
 - Wait for pending transactions to confirm
 - Use smaller fee rates
 
 #### INVALID_TRANSACTION
+
 **Code**: `INVALID_TRANSACTION`  
 **Message**: "Transaction validation failed"  
 **Cause**: Transaction structure or signatures are invalid  
 **Solutions**:
+
 - Verify all inputs are properly signed
 - Check script templates are correct
 - Ensure transaction format is valid
 - Validate all output amounts are positive
 
 #### TRANSACTION_TOO_LARGE
+
 **Code**: `TRANSACTION_TOO_LARGE`  
 **Message**: "Transaction exceeds maximum size limit"  
 **Cause**: Transaction size exceeds network limits  
 **Solutions**:
+
 - Reduce number of inputs/outputs
 - Use more efficient script templates
 - Split into multiple transactions
 - Optimize data storage methods
 
 #### INVALID_SCRIPT
+
 **Code**: `INVALID_SCRIPT`  
 **Message**: "Script execution failed"  
 **Cause**: Locking or unlocking script contains errors  
 **Solutions**:
+
 - Validate script syntax with `Script.fromASM()`
 - Check opcode usage and limits
 - Verify script template implementation
@@ -49,40 +57,48 @@ Complete reference for error codes, messages, and troubleshooting in the BSV Typ
 ### Wallet Errors
 
 #### WALLET_NOT_CONNECTED
+
 **Code**: `WALLET_NOT_CONNECTED`  
 **Message**: "Wallet connection not established"  
 **Cause**: WalletClient not connected to substrate  
 **Solutions**:
+
 - Call `await wallet.connectToSubstrate()`
 - Check wallet application is running
 - Verify network connectivity
 - Restart wallet application if needed
 
 #### AUTHENTICATION_FAILED
+
 **Code**: `AUTHENTICATION_FAILED`  
 **Message**: "Wallet authentication failed"  
 **Cause**: User denied access or authentication expired  
 **Solutions**:
+
 - Re-authenticate with wallet
 - Check originator domain permissions
 - Verify wallet trust settings
 - Clear cached authentication state
 
 #### WALLET_LOCKED
+
 **Code**: `WALLET_LOCKED`  
 **Message**: "Wallet is locked or requires password"  
 **Cause**: Wallet requires user authentication  
 **Solutions**:
+
 - Unlock wallet application
 - Enter wallet password
 - Check wallet auto-lock settings
 - Verify user session is active
 
 #### ACTION_REJECTED
+
 **Code**: `ACTION_REJECTED`  
 **Message**: "User rejected the transaction"  
 **Cause**: User declined transaction in wallet UI  
 **Solutions**:
+
 - Retry transaction with user consent
 - Adjust transaction parameters
 - Provide clearer transaction description
@@ -91,40 +107,48 @@ Complete reference for error codes, messages, and troubleshooting in the BSV Typ
 ### Network Errors
 
 #### NETWORK_ERROR
+
 **Code**: `NETWORK_ERROR`  
 **Message**: "Network request failed"  
 **Cause**: Connection issues with blockchain nodes  
 **Solutions**:
+
 - Check internet connectivity
 - Verify node endpoints are accessible
 - Try alternative chain trackers
 - Implement retry logic with exponential backoff
 
 #### NODE_UNAVAILABLE
+
 **Code**: `NODE_UNAVAILABLE`  
 **Message**: "Blockchain node is unavailable"  
 **Cause**: Target node is down or unreachable  
 **Solutions**:
+
 - Switch to backup node endpoints
 - Check node status and health
 - Use multiple chain tracker instances
 - Implement failover mechanisms
 
 #### BROADCAST_FAILED
+
 **Code**: `BROADCAST_FAILED`  
 **Message**: "Transaction broadcast failed"  
 **Cause**: Network rejected transaction or broadcast error  
 **Solutions**:
+
 - Verify transaction is valid
 - Check network fees are adequate
 - Retry broadcast after delay
 - Use alternative broadcast endpoints
 
 #### TIMEOUT_ERROR
+
 **Code**: `TIMEOUT_ERROR`  
 **Message**: "Request timeout exceeded"  
 **Cause**: Network request took too long  
 **Solutions**:
+
 - Increase timeout values
 - Check network latency
 - Use faster endpoints
@@ -133,40 +157,48 @@ Complete reference for error codes, messages, and troubleshooting in the BSV Typ
 ### Cryptographic Errors
 
 #### INVALID_PRIVATE_KEY
+
 **Code**: `INVALID_PRIVATE_KEY`  
 **Message**: "Private key is invalid or out of range"  
 **Cause**: Private key doesn't meet secp256k1 requirements  
 **Solutions**:
+
 - Generate new key with `PrivateKey.fromRandom()`
 - Validate key is within curve order
 - Check key format and encoding
 - Use proper key derivation methods
 
 #### INVALID_PUBLIC_KEY
+
 **Code**: `INVALID_PUBLIC_KEY`  
 **Message**: "Public key is invalid or not on curve"  
 **Cause**: Public key point is invalid  
 **Solutions**:
+
 - Verify key derivation from private key
 - Check point coordinates are valid
 - Validate key format (compressed/uncompressed)
 - Use `PublicKey.fromPrivateKey()` for generation
 
 #### SIGNATURE_VERIFICATION_FAILED
+
 **Code**: `SIGNATURE_VERIFICATION_FAILED`  
 **Message**: "Digital signature verification failed"  
 **Cause**: Signature doesn't match message and public key  
 **Solutions**:
+
 - Verify message hash is correct
 - Check signature format (DER encoding)
 - Ensure correct public key is used
 - Validate signature components (r, s values)
 
 #### ENCRYPTION_FAILED
+
 **Code**: `ENCRYPTION_FAILED`  
 **Message**: "Symmetric encryption operation failed"  
 **Cause**: AES encryption/decryption error  
 **Solutions**:
+
 - Verify encryption key is valid
 - Check data format and encoding
 - Ensure proper IV/nonce usage
@@ -175,30 +207,36 @@ Complete reference for error codes, messages, and troubleshooting in the BSV Typ
 ### SPV Verification Errors
 
 #### INVALID_MERKLE_PROOF
+
 **Code**: `INVALID_MERKLE_PROOF`  
 **Message**: "Merkle proof verification failed"  
 **Cause**: Merkle path doesn't lead to valid root  
 **Solutions**:
+
 - Verify merkle path structure
 - Check transaction hash calculation
 - Validate block header merkle root
 - Ensure proof completeness
 
 #### BLOCK_HEADER_INVALID
+
 **Code**: `BLOCK_HEADER_INVALID`  
 **Message**: "Block header validation failed"  
 **Cause**: Block header doesn't meet consensus rules  
 **Solutions**:
+
 - Verify header hash and difficulty
 - Check timestamp validity
 - Validate previous block hash
 - Ensure proper header format
 
 #### CHAIN_VALIDATION_FAILED
+
 **Code**: `CHAIN_VALIDATION_FAILED`  
 **Message**: "Blockchain validation failed"  
 **Cause**: Chain doesn't follow consensus rules  
 **Solutions**:
+
 - Verify chain continuity
 - Check difficulty adjustments
 - Validate block timestamps
@@ -207,20 +245,24 @@ Complete reference for error codes, messages, and troubleshooting in the BSV Typ
 ### Configuration Errors
 
 #### INVALID_CONFIG
+
 **Code**: `INVALID_CONFIG`  
 **Message**: "SDK configuration is invalid"  
 **Cause**: Configuration parameters are incorrect  
 **Solutions**:
+
 - Validate configuration schema
 - Check required parameters are present
 - Verify network settings
 - Use default configuration as baseline
 
 #### UNSUPPORTED_NETWORK
+
 **Code**: `UNSUPPORTED_NETWORK`  
 **Message**: "Network type is not supported"  
 **Cause**: Invalid network specification  
 **Solutions**:
+
 - Use supported networks: mainnet, testnet, regtest
 - Check network configuration
 - Verify chain parameters
@@ -315,9 +357,11 @@ function categorizeError(error: WalletErrorObject): 'user' | 'network' | 'system
 ### Common Issues and Solutions
 
 #### "RPC Error: no header should have returned false"
+
 **Symptoms**: Error during `createAction` calls  
 **Cause**: Wallet input selection issues  
 **Solutions**:
+
 1. Restart wallet application
 2. Ensure wallet is fully synced
 3. Use slightly larger amounts (200-500 satoshis)
@@ -325,27 +369,33 @@ function categorizeError(error: WalletErrorObject): 'user' | 'network' | 'system
 5. Check for sufficient confirmed UTXOs
 
 #### "Insufficient funds" with Available Balance
+
 **Symptoms**: Error despite wallet showing balance  
 **Cause**: UTXOs not properly selected by wallet  
 **Solutions**:
+
 1. Check UTXO status with `listOutputs()`
 2. Verify UTXOs are confirmed
 3. Restart wallet to refresh UTXO cache
 4. Use manual input selection if supported
 
 #### Transaction Broadcast Failures
+
 **Symptoms**: Valid transactions rejected by network  
 **Cause**: Various network or validation issues  
 **Solutions**:
+
 1. Verify transaction format and signatures
 2. Check fee rates are adequate
 3. Ensure inputs are unspent
 4. Try alternative broadcast endpoints
 
 #### Wallet Connection Issues
+
 **Symptoms**: Cannot connect to wallet substrate  
 **Cause**: Wallet not running or permission issues  
 **Solutions**:
+
 1. Ensure wallet application is running
 2. Check originator domain permissions
 3. Clear browser cache and cookies

package/docs/reference/identity.md

@@ -30,6 +30,7 @@ export interface DisplayableIdentity {
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
+
 ### Interface: IdentityClientOptions
 
 ```ts
@@ -46,6 +47,7 @@ See also: [WalletProtocol](./wallet.md#type-walletprotocol)
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
+
 ## Classes
 
 ### Class: IdentityClient
@@ -74,6 +76,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)
 
 Returns
@@ -82,10 +85,10 @@ Returns
 
 Argument Details
 
-+ **serialNumber**
-  + Unique serial number of the certificate to revoke revelation
-+ **identityToParse**
-  + The Identity Certificate to parse
+- **serialNumber**
+    - Unique serial number of the certificate to revoke revelation
+- **identityToParse**
+    - The Identity Certificate to parse
 
 #### Method publiclyRevealAttributes
 
@@ -95,6 +98,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](./transaction.md#interface-broadcastfailure), [BroadcastResponse](./transaction.md#interface-broadcastresponse), [CertificateFieldNameUnder50Bytes](./wallet.md#type-certificatefieldnameunder50bytes), [WalletCertificate](./wallet.md#interface-walletcertificate)
 
 Returns
@@ -103,10 +107,10 @@ A promise that resolves with the broadcast result from the overlay network.
 
 Argument Details
 
-+ **certificate**
-  + The master certificate to selectively reveal.
-+ **fieldsToReveal**
-  + An array of certificate field names to reveal. Only these fields will be included in the public certificate.
+- **certificate**
+    - The master certificate to selectively reveal.
+- **fieldsToReveal**
+    - An array of certificate field names to reveal. Only these fields will be included in the public certificate.
 
 Throws
 
@@ -119,6 +123,7 @@ Resolves displayable identity certificates by specific identity attributes, issu
 ```ts
 async resolveByAttributes(args: DiscoverByAttributesArgs): Promise<DisplayableIdentity[]> 
 ```
+
 See also: [DiscoverByAttributesArgs](./wallet.md#interface-discoverbyattributesargs), [DisplayableIdentity](./identity.md#interface-displayableidentity)
 
 Returns
@@ -127,8 +132,8 @@ The promise resolves to displayable identities.
 
 Argument Details
 
-+ **args**
-  + Attributes and optional parameters used to discover certificates.
+- **args**
+    - Attributes and optional parameters used to discover certificates.
 
 #### Method resolveByIdentityKey
 
@@ -137,6 +142,7 @@ Resolves displayable identity certificates, issued to a given identity key by a
 ```ts
 async resolveByIdentityKey(args: DiscoverByIdentityKeyArgs): Promise<DisplayableIdentity[]> 
 ```
+
 See also: [DiscoverByIdentityKeyArgs](./wallet.md#interface-discoverbyidentitykeyargs), [DisplayableIdentity](./identity.md#interface-displayableidentity)
 
 Returns
@@ -145,12 +151,13 @@ The promise resolves to displayable identities.
 
 Argument Details
 
-+ **args**
-  + Arguments for requesting the discovery based on the identity key.
+- **args**
+    - Arguments for requesting the discovery based on the identity key.
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
+
 ## Functions
 
 ## Types
@@ -185,6 +192,7 @@ See also: [IdentityClientOptions](./identity.md#interface-identityclientoptions)
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
+
 ### Variable: KNOWN_IDENTITY_TYPES
 
 ```ts
@@ -204,6 +212,7 @@ KNOWN_IDENTITY_TYPES = {
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
+
 ### Variable: defaultIdentity
 
 ```ts

package/docs/reference/index.md

@@ -5,6 +5,7 @@ Complete technical specifications and API documentation for the BSV TypeScript S
 ## Standards and Interfaces
 
 ### [BRC-100 Wallet Interface](./brc-100.md)
+
 - Unified wallet-to-application interface standard
 - WalletClient implementation details
 - JSON API specifications
@@ -12,26 +13,31 @@ Complete technical specifications and API documentation for the BSV TypeScript S
 ## Core Classes
 
 ### [Transaction Class](./transaction.md)
+
 - Constructor options and methods
 - Input/output management
 - Serialization formats
 
 ### [PrivateKey/PublicKey Classes](./primitives.md)
+
 - Key generation methods
 - Import/export formats
 - Cryptographic operations
 
 ### [Transaction Signatures Reference](./transaction-signatures.md)
+
 - ECDSA signature components
 - DER encoding format
 - Signature hash types (SIGHASH flags)
 
 ### [Script Classes](./script.md)
+
 - Script construction utilities
 - Standard script templates
 - Custom script patterns
 
 ### [OP Codes Reference](./op-codes.md)
+
 - Complete opcode listing and descriptions
 - Opcode categories and usage patterns
 - Script execution examples
@@ -39,17 +45,20 @@ Complete technical specifications and API documentation for the BSV TypeScript S
 ## Module Reference
 
 ### [Primitives Module](./primitives.md)
+
 - Cryptographic primitives
 - Hash functions
 - Security implementation notes
 
 ### [Transaction Module](./transaction.md)
+
 - Transaction lifecycle
 - Fee calculation details
 - Broadcasting options
 - SPV verification
 
 ### [Wallet Module](./wallet.md)
+
 - Wallet architecture patterns
 - Integration guidelines
 - BRC-100 compliance notes
@@ -57,6 +66,7 @@ Complete technical specifications and API documentation for the BSV TypeScript S
 ## Configuration Reference
 
 ### [SDK Configuration Options](./configuration.md)
+
 ```typescript
 interface SDKConfig {
   network: 'mainnet' | 'testnet' | 'regtest'
@@ -67,12 +77,14 @@ interface SDKConfig {
 ```
 
 ### [ARC Configuration](./arc-config.md)
+
 - Endpoint configuration
 - Authentication methods
 - Rate limiting options
 - Failover settings
 
 ### [Network Configuration](./network-config.md)
+
 - Mainnet vs testnet settings
 - Custom network parameters
 - Node endpoint configurations
@@ -80,17 +92,18 @@ interface SDKConfig {
 ## Error Reference
 
 ### [Error Codes and Messages](./errors.md)
+
 - Transaction validation errors
 - Network connectivity errors
 - Cryptographic operation errors
 - Troubleshooting steps
 
 ### [Debugging Guide](./debugging.md)
+
 - SDK logging configuration
 - Debug mode activation
 - Transaction inspection tools
 
-
 ## Swagger
 
 [BRC-100](https://brc.dev/100) defines a Unified, Vendor-Neutral, Unchanging, and Open BSV Blockchain Standard Wallet-to-Application Interface which is implemented in this library within the WalletClient class. The API is laid out here as a swagger openapi document to offer a fast-track to understanding the interface which is implemented across multiple substrates. The JSON api is generally considered a developer friendly introduction to the WalletClient, where an binary equivalent ABI may be preferred for production use cases.

package/docs/reference/kvstore.md

@@ -31,18 +31,19 @@ Creates an instance of the localKVStore.
 ```ts
 constructor(wallet: WalletInterface = new WalletClient(), context = "kvstore default", encrypt = true, originator?: string, acceptDelayedBroadcast = false) 
 ```
+
 See also: [WalletClient](./wallet.md#class-walletclient), [WalletInterface](./wallet.md#interface-walletinterface), [encrypt](./messages.md#variable-encrypt)
 
 Argument Details
 
-+ **wallet**
-  + The wallet interface to use. Defaults to a new WalletClient instance.
-+ **context**
-  + The context (basket) for namespacing keys. Defaults to 'kvstore default'.
-+ **encrypt**
-  + Whether to encrypt values. Defaults to true.
-+ **originator**
-  + — An originator to use with PushDrop and the wallet, if provided.
+- **wallet**
+    - The wallet interface to use. Defaults to a new WalletClient instance.
+- **context**
+    - The context (basket) for namespacing keys. Defaults to 'kvstore default'.
+- **encrypt**
+    - Whether to encrypt values. Defaults to true.
+- **originator**
+    - — An originator to use with PushDrop and the wallet, if provided.
 
 Throws
 
@@ -63,10 +64,10 @@ the defaultValue if the key is not found, or undefined if no defaultValue is pro
 
 Argument Details
 
-+ **key**
-  + The key to retrieve the value for.
-+ **defaultValue**
-  + The value to return if the key is not found.
+- **key**
+    - The key to retrieve the value for.
+- **defaultValue**
+    - The value to return if the key is not found.
 
 Throws
 
@@ -92,8 +93,8 @@ A promise that resolves to the txids of the removal transactions if successful.
 
 Argument Details
 
-+ **key**
-  + The key to remove.
+- **key**
+    - The key to remove.
 
 #### Method set
 
@@ -110,6 +111,7 @@ to the same key from missing earlier changes.
 ```ts
 async set(key: string, value: string): Promise<OutpointString> 
 ```
+
 See also: [OutpointString](./wallet.md#type-outpointstring)
 
 Returns
@@ -118,14 +120,15 @@ A promise that resolves to the outpoint string (txid.vout) of the new or updated
 
 Argument Details
 
-+ **key**
-  + The key to set or update.
-+ **value**
-  + The value to associate with the key.
+- **key**
+    - The key to set or update.
+- **value**
+    - The value to associate with the key.
 
 Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](#functions), [Types](#types), [Enums](#enums), [Variables](#variables)
 
 ---
+
 ## Functions
 
 ## Types
@@ -133,4 +136,3 @@ Links: [API](#api), [Interfaces](#interfaces), [Classes](#classes), [Functions](
 ## Enums
 
 ## Variables
-

package/docs/reference/messages.md

@@ -52,6 +52,7 @@ See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitiv
 Links: [API](#api), [Classes](#classes), [Functions](#functions), [Variables](#variables)
 
 ---
+
 ### Variable: encrypt
 
 ```ts
@@ -81,6 +82,7 @@ See also: [PrivateKey](./primitives.md#class-privatekey), [PublicKey](./primitiv
 Links: [API](#api), [Classes](#classes), [Functions](#functions), [Variables](#variables)
 
 ---
+
 ### Variable: sign
 
 ```ts
@@ -114,6 +116,7 @@ See also: [Curve](./primitives.md#class-curve), [PrivateKey](./primitives.md#cla
 Links: [API](#api), [Classes](#classes), [Functions](#functions), [Variables](#variables)
 
 ---
+
 ### Variable: verify
 
 ```ts