Reference Documentation
Complete technical specifications and API documentation for the BSV TypeScript SDK.
Standards and Interfaces
- Unified wallet-to-application interface standard
- WalletClient implementation details
- JSON API specifications
Core Classes
- Constructor options and methods
- Input/output management
- Serialization formats
- Key generation methods
- Import/export formats
- Cryptographic operations
- ECDSA signature components
- DER encoding format
- Signature hash types (SIGHASH flags)
- Script construction utilities
- Standard script templates
- Custom script patterns
- Complete opcode listing and descriptions
- Opcode categories and usage patterns
- Script execution examples
Module Reference
- Cryptographic primitives
- Hash functions
- Security implementation notes
- Transaction lifecycle
- Fee calculation details
- Broadcasting options
- SPV verification
- Wallet architecture patterns
- Integration guidelines
- BRC-100 compliance notes
Configuration Reference
interface SDKConfig {
network: 'mainnet' | 'testnet' | 'regtest'
arc: ARCConfig
fees: FeeConfig
security: SecurityConfig
}
- Endpoint configuration
- Authentication methods
- Rate limiting options
- Failover settings
- Mainnet vs testnet settings
- Custom network parameters
- Node endpoint configurations
Error Reference
- Transaction validation errors
- Network connectivity errors
- Cryptographic operation errors
- Troubleshooting steps
- SDK logging configuration
- Debug mode activation
- Transaction inspection tools
Swagger
BRC-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.