Documentation

• Rusty Kaspa README contains build instructions for the Rusty Kaspa framework.
• WASM SDK README contains build instructions for the WASM SDK as well as instructions on running WASM SDK examples.

WASM SDK

TypeScript and Rust API documentation is available at the following URLs:

• WASM TypeScript documentation (TypeDoc is built from development releases)

Rust crates

Rust documentation is broken into multiple crates (modules) comprising the Rusty Kaspa framework. Each crate is documented separately and can be accessed using links below.

Client-side framework

These crates are available to client-side applications.

General

• kaspa-consensus-client - client-side transaction primitives
• kaspa-consensus-core - consensus primitives
• kaspa-consensus-wasm - consensus primitives for WASM
• kaspa-hashes - hash functions
• kaspa-math - math functions
• kaspa-metrics-core - performance metrics data
• kaspa-notify - notification subsystem
• kaspa-pow - proof-of-work primitives
• kaspa-txscript - transaction scripts
• kaspa-txscript-errors - transaction script errors
• kaspa-utils - general utilities and trait extensions

Wallet

• kaspa-addresses - address management
• kaspa-bip32 - BIP32 & BIP39 implementation
• kaspa-wallet-keys - secp256k1 key management
• kaspa-wallet-pskt - PSKT (Partially Signed Kaspa Transactions)
• kaspa-wallet-core - Wallet SDK & core wallet implementation
• kaspa-wallet-macros - Wallet macros

RPC

• kaspa-grpc-client - gRPC client
• kaspa-grpc-core - gRPC core (used by client and server)
• kaspa-rpc-core - Kaspa Node RPC API
• kaspa-rpc-macros - RPC macros
• kaspa-wrpc-client - wRPC client
• kaspa-wrpc-wasm - wRPC WASM client

WASM

• kaspa-wasm - WASM SDK
• kaspa-wasm-core - Base WASM type declarations

Applications

• kaspa-cli - Kaspa command line RPC interface and wallet

Rusty Kaspa Node framework

These crates comprize the Rusty Kaspa node framework. They can be used in Rust native applications only.

Consensus & p2p

• kaspa-addressmanager - p2p address management
• kaspa-alloc - memory allocator
• kaspa-connectionmanager - p2p connection management
• kaspa-consensus-notify - consensus notifications
• kaspa-consensus - consensus
• kaspa-consensusmanager - consensus
• kaspa-core - node runtime management
• kaspa-database - database
• kaspa-index-core - UTXO indexing
• kaspa-index-processor - UTXO indexing
• kaspa-merkle - Merkle tree processing
• kaspa-mining - PoW algorithms
• kaspa-mining-errors - PoW errors
• kaspa-muhash - MuHash
• kaspa-p2p-flows - p2p message flows
• kaspa-p2p-lib - p2p library
• kaspa-perf-monitor - performance monitoring
• kaspa-utils-tower - gRPC tower middleware
• kaspa-utxoindex - UTXO indexing

RPC

• kaspa-grpc-server - gRPC server
• kaspa-rpc-service - Kaspa RPC service
• kaspa-wrpc-server - wRPC server

Applications

• kaspad - Kaspa p2p node daemon