UNPKG

@bsv/sdk

Version:

BSV Blockchain Software Development Kit

73 lines (46 loc) • 2.61 kB
# 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](./tutorials/index.md) Learn step-by-step with practical, guided examples: - [Your First BSV Transaction](./tutorials/first-transaction.md) - [Key Management and Cryptography](./tutorials/key-management.md) - [Transaction Broadcasting and ARC](./tutorials/transaction-broadcasting.md) - [View all tutorials →](./tutorials/index.md) ### [šŸ”§ How-To Guides](./guides/index.md) Problem-oriented guides for specific tasks: - [Creating Multi-signature Transactions](./guides/multisig-transactions.md) - [Implementing Transaction Batching](./guides/transaction-batching.md) - [Configuring Custom ARC Endpoints](./guides/custom-arc-endpoints.md) - [View all guides →](./guides/index.md) ### [šŸ“š Reference](./reference/index.md) Complete technical specifications and API documentation: - [BRC-100 Wallet Interface (Swagger)](./reference/brc-100.md) - [Primitives](./reference/primitives.md) - [Script](./reference/script.md) - [Transaction](./reference/transaction.md) - [View all references →](./reference/index.md) ### [šŸ—ļø Concepts & Explanations](./concepts/index.md) Understanding the architecture and design principles: - [SDK Design Philosophy](./concepts/sdk-philosophy.md) - [Transaction Structure](./concepts/transaction-structure.md) - [SPV Verification](./concepts/spv-verification.md) - [BEEF Format](./concepts/beef.md) - [View all concepts →](./concepts/index.md) ## Getting Started If you're new to the BSV TypeScript SDK, we recommend starting with our [Getting Started Tutorial](./tutorials/first-transaction.md). ## Try It Interactive šŸš€ **[Interactive BSV Coding Environment](https://fast.brc.dev/)** 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: ```bash npm install @bsv/sdk ```