ts-sdk

BSV TypeScript SDK Documentation

SDK Overview

The BSV TypeScript SDK is designed to provide an updated and unified layer for developing scalable applications on the BSV Blockchain. It addresses the limitations of previous tools by offering a fresh, peer-to-peer approach, adhering to SPV principles, and ensuring privacy and scalability.

This documentation is organized to help you learn, solve problems, understand concepts, and find technical references.

Documentation Categories

🚀 Tutorials

Learn step-by-step with practical, guided examples:

• Your First BSV Transaction
• Key Management and Cryptography
• Transaction Broadcasting and ARC
• View all tutorials →

🔧 How-To Guides

Problem-oriented guides for specific tasks:

• Creating Multi-signature Transactions
• Implementing Transaction Batching
• Configuring Custom ARC Endpoints
• View all guides →

📚 Reference

Complete technical specifications and API documentation:

• BRC-100 Wallet Interface (Swagger)
• Primitives
• Script
• Transaction
• View all references →

🏗️ Concepts & Explanations

Understanding the architecture and design principles:

• SDK Design Philosophy
• Transaction Structure
• SPV Verification
• BEEF Format
• View all concepts →

Getting Started

If you’re new to the BSV TypeScript SDK, we recommend starting with our Getting Started Tutorial.

Try It Interactive

🚀 Interactive BSV Coding Environment

Experience the BSV TypeScript SDK directly in your browser! Our interactive coding environment lets you:

• Run SDK code examples without any setup
• Experiment with transactions, keys, and scripts in real-time
• Learn by doing with immediate feedback
• Test concepts from our tutorials interactively

Perfect for getting started quickly or experimenting with new ideas.

Installation

To install the SDK, run:

npm install @bsv/sdk

This site is open source. Improve this page.