Reference
Compatibility
What create-bsv-app and the apps it generates run on, and what these docs have actually been tested against.
"Required" comes from the CLI's own checks. "Tested" means the commands and code in these docs were run there. Everything else is supported by design but not tested for these docs. Reports welcome on GitHub (opens in a new tab).
The CLI#
| Item | Status |
|---|---|
| Node.js | 22 or newer required (engines). Tested on 23.4 |
| macOS | tested |
| Linux, Windows | supported (the root runner switches to a shell on Windows); not tested here |
| npm | tested |
| pnpm, yarn, bun | supported with --package-manager; not tested here |
| git | required for complete examples only |
Generated apps#
| Package | Version | Notes |
|---|---|---|
| React | 19 | via create-vite, template react-ts |
| Vite | 8 | client dev server and build |
| Express | 5 | server, run with tsx in dev, node in production |
| TypeScript | 6 | both packages |
@bsv/sdk |
2.x | wallet interface, keys, transactions |
@bsv/auth |
0.1.x | proofs |
@bsv/wallet-relay |
0.2.x | mobile pairing |
Wallets and browsers#
| Item | Status |
|---|---|
| Any BRC-100 wallet | supported |
| BSV Browser (opens in a new tab) | recommended; desktop (macOS, Windows) connects directly, phone (iOS, Android) pairs by QR |
| Browsers | current Chrome, Edge, Firefox and Safari (Vite's default build target) |
Hosting#
| Part | Needs |
|---|---|
| Client | any static host, with a single-page fallback to index.html |
| Server | a long-running Node 22+ process with WebSocket support (for /ws) |
| Networks | main, test (default) and ttn |
See Deploy for the details.