SDK Components Overview

This directory contains detailed documentation for each component of the BSV TypeScript SDK. These components are the building blocks for BSV blockchain applications.

Purpose

SDK Components serve as modular reference documentation that can be:

  • Referenced from learning path modules

  • Used as quick-reference guides

  • Linked from code examples

  • Combined to build complete solutions

Organization

Components are organized by functionality and complexity level. Each component includes:

  • Overview and purpose

  • API reference

  • Usage examples

  • Related components

  • Common patterns

Core Components

Transaction Management

Cryptography & Keys

Scripts

Blockchain Verification

Broadcasting & Network

  • ARC - Transaction broadcasting with ARC

Standards (BRC)

How to Use

Each component directory contains:

  1. README.md - Component overview and API

  2. examples.md - Code examples and patterns

  3. api-reference.md - Detailed API documentation

Components can be referenced in learning paths like this:

For more details on transactions, see [Transaction Component](../../sdk-components/transaction/README.md)

Component Status

  • ✅ Core components documented

  • 🚧 Additional components in progress

  • 📋 Planned components

Contributing

When adding new components:

  1. Create a dedicated folder with descriptive name

  2. Include README.md with overview

  3. Add examples.md with practical code

  4. Document all public APIs

  5. Link related components

PreviousCrowdfunding PlatformNextPrivate Keys

Last updated