Your Complete Guide to Building on BSV Blockchain
Welcome to the BSV Code Academy - a comprehensive, modular learning platform for developers at all skill levels who want to build applications on the Bitcoin Satoshi Vision (BSV) blockchain. From beginner to intermediate production-ready applications.
This academy is organized into three complementary systems that work together:
Start here for guided learning
Follow progressive courses from beginner to intermediate. Each course teaches concepts and references the SDK Components and Code Features below.
- When to use: You want to learn systematically
- Path: Read courses in order, following the references to components
- Time: Full path ~9-11 hours
Use as reference documentation
Deep-dive documentation for each part of the BSV SDK. Think of these as your technical manual - comprehensive API docs with examples.
- When to use: You need detailed technical specs or API reference
- Path: Jump directly to the component you need
- Time: 15-30 minutes per component
Copy and adapt for your projects
Production-ready code examples for specific features. Copy, modify, and use in your applications.
- When to use: You need working code for a specific task
- Path: Find the feature, copy the code, adapt to your needs
- Time: 5-15 minutes per feature
"I'm new to BSV blockchain development"
1. Start → learning-paths/beginner/getting-started/
2. Follow → All 7 beginner courses in order
3. Practice → Use code-features examples
4. Reference → SDK components when needed
Estimated time: ~5 hours You'll learn: Development setup, BSV fundamentals, create wallet, build transactions, integrate wallets
"I know blockchain, new to BSV"
1. Quick scan → learning-paths/beginner/bsv-fundamentals/
2. Jump to → learning-paths/intermediate/
3. Reference → sdk-components/ for API details
4. Use → code-features/ for specific implementations
Estimated time: 3-4 hours to get productive You'll learn: BSV-specific features, transaction building, SPV, BRC standards, payment systems, tokenization
"I need API documentation"
1. Go to → sdk-components/
2. Find your component (e.g., transaction/, signatures/)
3. Read → API Reference section
4. Try → Common Patterns examples
Estimated time: 15-30 minutes per component You'll find: Complete API docs, usage patterns, best practices
"I need working code for [specific task]"
1. Go to → code-features/
2. Find relevant feature (e.g., transaction-building/, multi-signature/)
3. Copy → Code examples
4. Adapt → To your use case
Estimated time: 5-15 minutes per feature You'll get: Production-ready TypeScript code you can use immediately
Goal: Learn BSV development fundamentals
| Course | Time | What You'll Learn |
|---|---|---|
| Getting Started | 30 min | Install tools, understand workflow |
| Development Environment | 45 min | Set up BSV development environment |
| Development Paradigms | 30 min | BSV development patterns and paradigms |
| BSV Fundamentals | 1h | Core concepts: UTXOs, transactions, scripts |
| First Wallet | 45 min | Create and manage BSV wallets |
| First Transaction | 1h | Build, sign, and broadcast transactions |
| Wallet Client Integration | 45 min | Integrate wallets into client applications |
Total time: ~5 hours Prerequisites: Basic programming knowledge (JavaScript/TypeScript) Outcome: Build simple BSV applications
Goal: Build production applications
| Project | Time | What You'll Build |
|---|
| Crowdfunding Platform | 4-6h | Token-based crowdfunding with escrow and automated payouts |
Total time: 4-6 hours Prerequisites: Complete beginner path Outcome: Build a production-ready application with full frontend and backend
Complete API documentation for the BSV TypeScript SDK
- Private Keys - Key generation, WIF, signing
- Public Keys - Address derivation, verification
- Signatures - ECDSA, DER encoding, SIGHASH types
- Transaction - Build and manage transactions
- Transaction Input - UTXO spending
- Transaction Output - Locking scripts, OP_RETURN
- Script - Bitcoin Script operations and opcodes
- Script Templates - Reusable script patterns
- HD Wallets - BRC-42/43 hierarchical derivation
- UTXO Management - Coin selection strategies
- SPV - ChainTracker, header validation
- Merkle Proofs - Proof creation and verification
- P2PKH - Standard payment template
- BEEF - BRC-62 transaction envelopes
- ARC - Transaction broadcasting
- BRC-29 - Payment protocol
- BRC-42 - Key derivation standard
How to use: Click into any component for complete API reference, usage patterns, and examples.
Production-ready code you can copy and adapt
- Transaction Building - Multi-input, batch payments
- Transaction Creation - Create transactions from scratch
- Transaction Signing - All SIGHASH types
- Sign Transaction - Transaction signing examples
- Transaction Broadcasting - ARC integration
- Broadcast ARC - ARC broadcasting examples
- Transaction Chains - BEEF format chains
- Batch Operations - Efficient batch processing
- Create Wallet - HD wallet creation
- Generate Private Key - Key generation
- BRC-42 Derivation - Hierarchical keys
- UTXO Management - Selection strategies
- Message Signing - Sign and verify messages
- P2PKH Template - Standard payments
- Multi-Signature - M-of-N multisig
- Custom Scripts - Hash locks, timelocks
- Custom Templates - Template creation
- Standard Transactions - P2PKH, P2PK
- SPV - SPV client implementation
- SPV Verification - Merkle proof validation
- SPV Validation - Transaction validation with SPV
- Double Spend Detection - Security monitoring
- Smart Contracts - Escrow, vesting, oracles
- Atomic Swaps - Trustless exchanges
- Payment Channels - Off-chain payments
- OP_RETURN - Data embedding
- Payment Processing - Invoices, subscriptions
- Payment Distribution - Split payments
- E-commerce Integration - Checkout systems
- Marketplace - Escrow patterns
- Content Paywall - Paywalled content
How to use: Browse features, find what you need, copy the code, adapt to your project.
1. Learning: beginner/first-wallet/ + intermediate/bsv-primitives/
2. Components: hd-wallets/, private-keys/, utxo-management/
3. Code: create-wallet/, utxo-management/, brc-42-derivation/
1. Learning: beginner/first-transaction/
2. Components: transaction/, arc/, brc-29/
3. Code: payment-processing/, transaction-broadcasting/, batch-operations/
gitbook-bsv-code-academy/
│
├── learning-paths/ # 📚 Structured courses (follow in order)
│ ├── beginner/ # 7 courses (~5 hours)
│ └── intermediate/ # 1 project (~4-6 hours)
│
├── sdk-components/ # 🔧 Technical reference (jump to as needed)
│ ├── private-keys/ # API docs + patterns
│ ├── transaction/ # API docs + patterns
│ ├── script/ # API docs + patterns
│ └── ... (17 components total)
│
├── code-features/ # 💻 Ready-to-use code (copy & adapt)
│ ├── transaction-building/ # Production examples
│ ├── multi-signature/ # Production examples
│ ├── payment-processing/ # Production examples
│ └── ... (31 features total)
│
├── assets/ # 🎨 Images, diagrams, icons
└── resources/ # 📚 External links and references
- 📚 8 Structured Courses covering beginner → intermediate
- 7 Beginner courses
- 1 Intermediate project
- 🔧 17 SDK Components with complete API documentation
- 💻 31 Code Features with production-ready examples
- 📝 Comprehensive documentation covering all aspects of BSV development
- ⚡ Latest Tech including Teranode architecture and deployment
- Node.js 18+
- TypeScript 4.9+
- Basic terminal/command line knowledge
npm install @bsv/sdkimport { PrivateKey } from '@bsv/sdk'
const key = PrivateKey.fromRandom()
console.log('Address:', key.toPublicKey().toAddress())Full setup guide: learning-paths/beginner/development-environment/
┌─────────────────────────────────────────────────────────┐
│ LEARNING PATHS │
│ (Teach concepts, guide through building applications) │
│ ↓ │
│ References ↓ │
└─────────────────────────────────────────────────────────┘
↓
┌─────────────────────────────────────────────────────────┐
│ SDK COMPONENTS │
│ (Technical reference - "What is this? How does │
│ this API work? What are the methods?") │
└─────────────────────────────────────────────────────────┘
↓
┌─────────────────────────────────────────────────────────┐
│ CODE FEATURES │
│ (Production examples - "Show me working code!") │
└─────────────────────────────────────────────────────────┘
Example Flow:
- You're learning about transactions → Read
learning-paths/beginner/first-transaction/ - Need API details → Reference
sdk-components/transaction/ - Want working code → Copy from
code-features/transaction-building/
Days 1-3: Beginner essentials (getting-started, fundamentals, first-wallet, first-transaction)
Days 4-7: Intermediate project (crowdfunding-platform) + code-features implementation
Week 1: All beginner courses (7 courses, ~5 hours)
Week 2: Intermediate project (crowdfunding-platform, 4-6 hours)
+ code-features for additional patterns
- Keep sdk-components/ bookmarked
- Jump to specific components as needed
- Use code-features/ for implementation patterns
✅ Complete Coverage - From "Hello World" to running Teranode infrastructure ✅ Production Ready - All code examples tested with real @bsv/sdk API ✅ Modular Design - Use what you need, skip what you don't ✅ Latest Technology - Includes Teranode, latest BRC standards ✅ TypeScript First - Modern, type-safe development ✅ Cross-Referenced - Easy navigation between related topics
- BSV Blockchain - Official BSV website
- BSV Skills Center - Official learning hub
- Teranode Docs - Teranode documentation
- BRC Standards Hub - BSV protocol standards
- BRC GitHub Repository - BRC specifications source
- BSV TypeScript SDK - Official SDK repository
- BSV SDK Documentation - SDK API reference
- MetaNet Desktop Wallet - BSV desktop wallet
- Wallet Toolbox - WalletClient API documentation
- Get BSV - Orange Gateway - Purchase BSV with fiat
- WhatsOnChain - BSV blockchain explorer
- Gorilla Pool - Mining pool and tools
- BSV Discord - Developer community
- BSV Developers - Reddit community
- Stack Overflow - Q&A (tag: bsv)
This is a living documentation project. Contributions are welcome!
- Found an error? Open an issue
- Have improvements? Submit a pull request
- Want to add examples? We'd love to see them!
This documentation is provided as-is for educational purposes.
Choose your path:
- 🆕 New to BSV? → Start Learning
- 📖 Need API docs? → Browse SDK Components
- 💻 Want code examples? → Explore Code Features
Happy Building on BSV! 🎉
Built with ❤️ for the BSV developer community
