Welcome to BSV Code Academy

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.

📚 How to Use This Repository

This academy is organized into three complementary systems that work together:

1. 🎓 Learning Paths (Structured Courses)

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

2. 🔧 SDK Components (Technical Reference)

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

3. 💻 Code Features (Ready-to-Use Examples)

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

🚀 Quick Start Guides

For Complete Beginners

"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

For Experienced Developers

"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

For SDK Reference

"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

For Code Examples

"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

📖 Learning Paths (Structured Courses)

🟢 Beginner Path

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

🟡 Intermediate Path

Goal: Build production applications

Core Projects (Build Real 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

🔧 SDK Components (Technical Reference)

Complete API documentation for the BSV TypeScript SDK

Core Cryptography

Transaction Components

Advanced Features

Network & Standards

  • 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.

💻 Code Features (Ready-to-Use Examples)

Production-ready code you can copy and adapt

Transaction Operations

Wallet & Keys

Scripts & Templates

Verification & Security

Advanced Patterns

Business Applications

How to use: Browse features, find what you need, copy the code, adapt to your project.

🎯 Learning by Use Case

"I want to build a wallet"

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/

"I want to integrate payments"

1. Learning: beginner/first-transaction/
2. Components: transaction/, arc/, brc-29/
3. Code: payment-processing/, transaction-broadcasting/, batch-operations/

🗺️ Complete Repository Map

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

📊 What's Inside

  • 📚 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

🛠️ Installation & Setup

Prerequisites

  • Node.js 18+

  • TypeScript 4.9+

  • Basic terminal/command line knowledge

Install BSV SDK

npm install @bsv/sdk

Quick Test

import { PrivateKey } from '@bsv/sdk'

const key = PrivateKey.fromRandom()
console.log('Address:', key.toPublicKey().toAddress())

Full setup guide: learning-paths/beginner/development-environment/

🤝 How Components Work Together

Modular Architecture

┌─────────────────────────────────────────────────────────┐
│                    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:

  1. You're learning about transactions → Read learning-paths/beginner/first-transaction/

  2. Need API details → Reference sdk-components/transaction/

  3. Want working code → Copy from code-features/transaction-building/

🎓 Recommended Learning Sequences

Fastest Path to Production (1 week intensive)

Days 1-3: Beginner essentials (getting-started, fundamentals, first-wallet, first-transaction)
Days 4-7: Intermediate project (crowdfunding-platform) + code-features implementation

Comprehensive Mastery (1-2 weeks part-time)

Week 1: All beginner courses (7 courses, ~5 hours)
Week 2: Intermediate project (crowdfunding-platform, 4-6 hours)
        + code-features for additional patterns

SDK Reference User (ongoing)

- Keep sdk-components/ bookmarked
- Jump to specific components as needed
- Use code-features/ for implementation patterns

🌟 Key Features

✅ 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

📚 External Resources

Official BSV Resources

Developer Tools

Community

🤝 Contributing

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!

📄 License

This documentation is provided as-is for educational purposes.

🚀 Get Started Now!

Choose your path:

Happy Building on BSV! 🎉

Built with ❤️ for the BSV developer community

NextBeginner Overview

Last updated