Reference

Quick reference material for API details and protocol indices.

Contents

  • BRC Standards Index — All BRC standards with links to implementations
  • TypeDoc API docs — Per-package generated reference (see links below)

Packages by Domain

All 27 packages in the monorepo, with published npm names.

SDK

PackagenpmPurpose
SDK@bsv/sdkZero-dependency crypto primitives, script engine, BEEF, BRC-100 wallet interface

Wallet

PackagenpmPurpose
wallet-toolbox@bsv/wallet-toolboxModular toolkit for building BRC-100-compliant wallets
btms@bsv/btmsUTXO-based token client (BTMS)
btms-permission-module@bsv/btms-permission-modulePermission hooks for BTMS token operations
ts-wallet-relay@bsv/wallet-relayECDH-encrypted WebSocket tunnel between desktop and mobile wallets
wallet-toolbox-examples@bsv/wallet-toolbox-examplesReference wallet implementations using wallet-toolbox

Overlays

PackagenpmPurpose
overlay@bsv/overlayOverlay Engine: Topic Manager and Lookup Service framework
overlay-express@bsv/overlay-expressExpress server wrapping the Overlay Engine
overlay-topics@bsv/overlay-topicsBuilt-in Topic Managers and Lookup Services (UHRP, BTMS)
overlay-discovery-services@bsv/overlay-discovery-servicesSHIP/SLAP discovery for overlay networks
gasp-core@bsv/gaspGraph-Aware Sync Protocol for inter-node synchronization
btms-backend@bsv/btms-backendOverlay-server-side shell for BTMS; core logic now in @bsv/overlay-topics

Messaging

PackagenpmPurpose
message-box-client@bsv/message-box-clientClient for the MessageBox store-and-forward server
authsocket@bsv/authsocketBRC-103/104 authenticated WebSocket server
authsocket-client@bsv/authsocket-clientClient for authsocket servers
ts-paymail@bsv/paymailPaymail protocol (discovery + address lookup)

Middleware

PackagenpmPurpose
auth-express-middleware@bsv/auth-express-middlewareBRC-31 mutual-auth middleware for Express
payment-express-middleware@bsv/payment-express-middlewareBRC-121 payment-gated middleware for Express
402-pay@bsv/402-payBRC-121 HTTP 402 client

Helpers

PackagenpmPurpose
simple@bsv/simpleHigh-level wrapper for app developers (./browser and ./server entry points)
did@bsv/didSD-JWT VC and optional did:key helpers
did-client@bsv/did-clientDID creation and resolution client
wallet-helper@bsv/wallet-helperFluent transaction builder
amountinator@bsv/amountinatorBSV amount formatting and conversion
fund-wallet@bsv/fund-walletCLI tool for funding wallets on testnet
ts-templates@bsv/templatesLow-level script templates

Network

PackagenpmPurpose
ts-p2p@bsv/teranode-listenerBSV peer-to-peer node listener

Quick Navigation