SDK Components Overview
Last updated
⌘Ctrlk
This directory contains detailed documentation for each component of the BSV TypeScript SDK. These components are the building blocks for BSV blockchain applications.
SDK Components serve as modular reference documentation that can be:
Referenced from learning path modules
Used as quick-reference guides
Linked from code examples
Combined to build complete solutions
Components are organized by functionality and complexity level. Each component includes:
Overview and purpose
API reference
Usage examples
Related components
Common patterns
Transaction - Creating and managing BSV transactions
Transaction Input - Working with transaction inputs
Transaction Output - Working with transaction outputs
UTXO Management - Managing unspent transaction outputs
Private Keys - Key generation and management
Public Keys - Public key derivation
Signatures - Digital signatures and verification
HD Wallets - Hierarchical Deterministic wallets (BIP32)
Script - Bitcoin Script fundamentals
Script Templates - Common script patterns
P2PKH - Pay-to-Public-Key-Hash
SPV - Simplified Payment Verification
Merkle Proofs - Merkle tree verification
BEEF Format - Background Evaluation Extended Format
ARC - Transaction broadcasting with ARC
Each component directory contains:
README.md - Component overview and API
examples.md - Code examples and patterns
api-reference.md - Detailed API documentation
Components can be referenced in learning paths like this:
✅ Core components documented
🚧 Additional components in progress
📋 Planned components
When adding new components:
Create a dedicated folder with descriptive name
Include README.md with overview
Add examples.md with practical code
Document all public APIs
Link related components
Last updated
For more details on transactions, see [Transaction Component](../../sdk-components/transaction/README.md)