ts-sdk

Tutorials

Welcome to the BSV TypeScript SDK tutorials. These step-by-step lessons will teach you how to use the SDK through practical examples.

🚀 Try Examples Interactively

Before diving into the tutorials, you can experiment with many of these concepts in our Interactive BSV Coding Environment. Run SDK code directly in your browser without any setup required!

Getting Started Track

Your First BSV Transaction

• Duration: 30 minutes
• Prerequisites: Node.js, basic TypeScript knowledge
• Learning Goals:
  • Install and configure the SDK
  • Create a simple P2PKH transaction
  • Understand BSV transaction anatomy

Transaction Types and Data

• Duration: 30 minutes
• Prerequisites: Completed “Your First BSV Transaction” tutorial
• Learning Goals:
  • Create transactions with multiple outputs
  • Add data to transactions
  • Work with different output types
  • Use advanced WalletClient features

Key Management and Cryptography

• Duration: 45 minutes
• Prerequisites: Completed “Your First BSV Transaction” tutorial
• Learning Goals:
  • Generate and manage private/public keys
  • Understand ECDSA signatures
  • Create and verify digital signatures

Transaction Broadcasting

• Duration: 25 minutes
• Prerequisites: Completed “Your First BSV Transaction” tutorial, Node.js, basic TypeScript knowledge
• Learning Goals:
  • Understand WalletClient vs direct broadcasting approaches
  • Configure broadcasting for testnet vs mainnet
  • Implement custom broadcasters (ARC, WhatsOnChain)
  • Handle broadcasting errors and implement retry logic
  • Monitor and verify transaction acceptance

Intermediate Development Track

Working with ProtoWallet for Development

• Duration: 45 minutes
• Prerequisites: Basic TypeScript knowledge, understanding of cryptographic concepts
• Learning Goals:
  • Create and configure ProtoWallet instances
  • Perform key derivation and management
  • Implement signing, encryption, and HMAC operations
  • Build development toolkits and testing environments

Authenticated HTTP Requests with AuthFetch

• Duration: 60 minutes
• Prerequisites: Understanding of HTTP protocols, basic cryptography knowledge
• Learning Goals:
  • Implement BRC-103/104 authentication protocols
  • Set up certificate exchange and peer authentication
  • Build secure API clients with cryptographic request signing
  • Handle authentication errors and implement retry logic

Decentralized File Storage with UHRP

• Duration: 75 minutes
• Prerequisites: Understanding of content-addressed storage concepts
• Learning Goals:
  • Upload and download files using UHRP protocol
  • Implement file integrity verification
  • Manage file retention and renewal
  • Build batch file operations and management systems

Identity Management and Certificates

• Duration: 90 minutes
• Prerequisites: Understanding of PKI and certificate concepts
• Learning Goals:
  • Work with decentralized identity systems
  • Resolve identities by keys and attributes
  • Manage identity certificates and verification
  • Build identity-based authentication services

Advanced Transaction Construction

• Duration: 75 minutes
• Learning Goals:
  • Multi-input/multi-output transactions
  • Fee calculation and optimization
  • Change output handling

Script Construction and Custom Logic

• Duration: 90 minutes
• Learning Goals:
  • Understand Bitcoin Script basics
  • Create custom locking scripts
  • Implement unlocking logic

SPV and Merkle Proof Verification

• Duration: 90 minutes
• Learning Goals:
  • Understand SPV principles
  • Verify Merkle proofs
  • Implement lightweight verification

Error Handling and Edge Cases

• Duration: 60 minutes
• Learning Goals:
  • Robust error handling patterns
  • Network failure recovery
  • Transaction validation edge cases

Low-Level Cryptography Track

Elliptic Curve Fundamentals: Numbers & Points

• Duration: 90 minutes
• Learning Goals:
  • Understand the mathematical foundations of elliptic curves
  • Work with BigInteger numbers in the SDK
  • Manipulate elliptic curve points
  • Implement point addition and scalar multiplication

ECDH Key Exchange

• Duration: 75 minutes
• Learning Goals:
  • Understand Elliptic Curve Diffie-Hellman (ECDH) key exchange principles
  • Implement secure key exchange using the SDK
  • Create shared secrets for encrypted communication
  • Apply ECDH in practical Bitcoin applications

AES Symmetric Encryption

• Duration: 60 minutes
• Learning Goals:
  • Understand AES-GCM symmetric encryption principles
  • Use the SymmetricKey class for encryption and decryption
  • Implement secure key generation and management
  • Apply AES encryption in practical Bitcoin applications
  • Combine AES with ECDH for secure communication
  • Handle different data formats and encoding

Hashes and HMACs

• Duration: 75 minutes
• Learning Goals:
  • Understand cryptographic hash functions and their properties
  • Master the Hash module classes and helper functions in the BSV TypeScript SDK
  • Implement various hash algorithms (SHA-256, SHA-512, SHA-1, RIPEMD-160)
  • Create and verify HMACs for message authentication
  • Apply Bitcoin-specific hashing patterns (hash256, hash160)
  • Build practical applications using hashing for data integrity and authentication
  • Understand performance considerations and security best practices

Type-42 Key Derivation

• Duration: 75 minutes
• Prerequisites: Basic TypeScript knowledge, Elliptic Curve Fundamentals tutorial completed, ECDH Key Exchange tutorial completed
• Learning Goals:
  • Understand Type-42 key derivation protocol and its use cases
  • Implement Type-42 operations with the BSV TypeScript SDK
  • Create shared key universes between two parties
  • Apply Type-42 in practical Bitcoin applications like message signing and encryption
  • Understand the “anyone key” concept and its applications

Alternative Low-Level Transaction API Track

These tutorials demonstrate how to use the lower-level APIs of the BSV TypeScript SDK for more direct control over transaction creation and management.

Your First BSV Transaction (Low-level API)

• Duration: 45 minutes
• Prerequisites: Node.js, basic TypeScript knowledge
• Learning Goals:
  • Work with low-level transaction APIs
  • Create transactions without WalletClient abstraction
  • Understand transaction construction internals
  • Manually manage inputs, outputs, and signing

Working with Testnet Transactions (Low-level API)

• Duration: 60 minutes
• Prerequisites: Completed “Your First BSV Transaction (Low-level API)” tutorial
• Learning Goals:
  • Set up a BSV testnet environment with low-level APIs
  • Manually handle testnet transactions
  • Understand UTXO management without WalletClient
  • Implement custom transaction workflows

This site is open source. Improve this page.