BSV blockchainBSV blockchain

Find more TypeScript packages

Pick the @bsv/* package that adds messaging, API authentication, payments or an overlay serviceA service that indexes an app's transactions. Topic managers decide which outputs it admits, and lookup services answer queries about them to an app built on @bsv/sdk, and see what each one does and its status.

Before you choose a package

Start with @bsv/sdk and add the package your app needs next to it. In your project folder, run, for example:

npm install @bsv/sdk @bsv/wallet-helper

The packages declare Node.js 22 or newer, and this page was written against @bsv/sdk 4.0.1. Two other pages can settle the choice first:

Packages with their own page

Three packages have a page of their own:

Find the other packages by task

The rows link to the package folder in ts-stack, the repository that holds the TypeScript stack. The status is the maturity that ts-stack and the package README give it. A stable package has a locked API. A beta package can still change its API. An experimental package is in early development. The versions are the latest published on npm on 2 November 2026.

Authenticate and charge the callers of an API

To know which user calls your Express API, start from the Authenticate users with their wallet guide. To charge for routes, the Gate an API behind payments guide uses @bsv/402-pay.

PackageVersionStatusWhat it does
@bsv/auth-express-middleware2.3.0StableExpress middleware for BRC-103BSV Request for Comments 103, mutual authentication between two peers mutual authentication. It handles the handshake, verifies each authenticated request and signs the response.
@bsv/payment-express-middleware2.1.11StableExpress middleware that answers with an HTTP 402 challenge and checks the payment. It runs after @bsv/auth-express-middleware and uses the earlier x-bsv-payment flow, a different protocol from the BRC-121BSV Request for Comments 121, Simple 402 Payments flow of @bsv/402-pay, so choose one of the two for an API.
@bsv/auth0.1.8BetaWallet login that does not depend on a web framework. The wallet signs a short-lived proof that it controls an identity key, and the server verifies it and accepts it once.

Authenticated sockets and Paymail

Open an authenticated Socket.IO connection between a client and a server, or add PaymailA handle that resolves to a user's identity key. Its domain lists the Paymail services it supports support to an Express app, with:

PackageVersionStatusWhat it does
@bsv/authsocket2.1.11StableServer side of Socket.IO with BRC-103 mutual authentication on every connected client.
@bsv/authsocket-client2.1.10StableClient side of the same Socket.IO connection. It signs outbound messages and verifies inbound ones.
@bsv/paymail2.4.12StableA Paymail client and an Express router for capability discovery, public profiles and transaction delivery.

Build an overlay

@bsv/overlay-express runs an overlay service and builds on @bsv/overlay and @bsv/overlay-discovery-services. The packages below are the pieces to use on their own or to add to it. To see how an overlay works, read How overlays work. To use one in an app, follow Track transactions with overlays.

PackageVersionStatusWhat it does
@bsv/overlay2.7.0StableThe engine of an overlay service. It admits transactions through topic managers, keeps the state of the outputs and serves lookup services.
@bsv/overlay-topics2.0.3ExperimentalTopic managers and lookup services for protocols such as identity certificates, key and value storage, message boxes and file storage.
@bsv/overlay-discovery-services2.2.9StableThe SHIPServices Host Interconnect Protocol and SLAPServices Lookup Availability Protocol services that let overlay nodes advertise the topics they host and the lookup services they offer.
@bsv/gasp1.3.10StableThe Graph Aware Sync Protocol. It synchronizes transaction data between two parties. Each side fetches only what it does not have and validates what it receives.

Build transactions and connect wallets

To build transactions or connect your app to a wallet, pick from:

PackageVersionStatusWhat it does
@bsv/wallet-helper0.1.11BetaTransaction builders and script templates that work through a BRC-100BSV Request for Comments 100, the standard wallet-to-application interface wallet, so the application layer does not handle a private key.
@bsv/templates2.2.0StableA collection of script templates for @bsv/sdk, such as OpReturn.
@bsv/wallet-relay0.7.0BetaLets a web app offer a connection to a mobile wallet. The desktop shows a QR code, and the wallet app signs over an encrypted WebSocket relay.
@bsv/did0.3.2BetaDecentralized identifiers (DIDs) for identity keys, a bridge for existing BRC-52BSV Request for Comments 52, identity certificates certificates and helpers for SD-JWT verifiable credentials.
@bsv/verifast0.3.9BetaOptional script verification for @bsv/sdk in WebAssembly. It runs in Node and in the browser.

Tools and specialized packages

create-bsv-app and @bsv/fund-wallet are command line tools that you run from a terminal. The other packages are libraries:

PackageVersionStatusWhat it does
create-bsv-app1.2.0StableGenerates a BSV blockchain app with a React, Express or full-stack starter, copies a complete example or adds wallet support to an existing project. See Start a project from a template.
@bsv/fund-wallet1.5.5StableFunds a Metanet wallet with BSV, on testnet or Mainnet, chosen with the --chain option.
@bsv/amountinator2.1.9StableConverts between satoshis, BSV and fiat currencies with live exchange rates, and formats amounts for a wallet interface.
@bsv/teranode-listener1.1.9StableSubscribes to the peer-to-peer topics of Teranode, the next generation BSV blockchain node, over libp2p, with support for private networks.
@bsv/air-gap0.1.3ExperimentalSends bytes between two devices through a sequence of QR codes, in one direction only. It implements BRC-141BSV Request for Comments 141, the optical air-gap wire protocol, an experimental protocol.
@bsv/chirp0.1.6ExperimentalThe reference implementation of BRC-167BSV Request for Comments 167, the Chunked, Hashed, Interleaved Resolution Protocol, which publishes large files in hashed chunks and downloads them progressively on top of UHRPUniversal Hash Resolution Protocol (BRC-26): file storage where a file is found by the hash of its content.
@bsv/lch0.3.0ExperimentalImplements BRC-170BSV Request for Comments 170, the Licensed Content Header protocol, the Licensed Content Header, for encrypted content that buyers pay to open.

To learn more about the TypeScript packages on the BSV blockchain, review these articles: