Install
Prerequisites
- Node.js ≥ 22 — Check with
node --version - npm, pnpm, or yarn
- A BSV wallet browser extension (for browser apps — e.g. MetaNet Client)
Install @bsv/simple
The recommended entry point for most developers:
npm install @bsv/simple @bsv/sdk@bsv/sdk is a peer dependency and must be installed alongside @bsv/simple.
Entry Points
| Import path | Environment | Use case |
|---|---|---|
@bsv/simple/browser | Browser | Connect to user's wallet extension |
@bsv/simple/server | Node.js | Self-custodial server wallet |
Browser
import { createWallet, Certifier, DID, Overlay } from '@bsv/simple/browser'
import { CredentialSchema, CredentialIssuer, MemoryRevocationStore } from '@bsv/simple/browser'Server
import { ServerWallet, FileRevocationStore } from '@bsv/simple/server'In Next.js or frameworks with mixed SSR/browser bundling, use dynamic import to keep server-only deps out of the browser bundle:
const { ServerWallet } = await import('@bsv/simple/server')TypeScript
No additional @types/ packages needed — @bsv/simple ships full TypeScript declarations.
import type { BrowserWallet } from '@bsv/simple/browser'
import type { PaymentOptions, TokenOptions } from '@bsv/simple'Framework Notes
Next.js
Turbopack requires extra config to prevent server-only packages from being bundled for the browser. Add this to next.config.ts:
const nextConfig = {
serverExternalPackages: ['@bsv/wallet-toolbox', '@bsv/simple'],
}
export default nextConfigThen import @bsv/simple/server only in Server Components or API routes. See the Next.js integration guide for the complete setup.
React / Vite
No special configuration needed. Import from @bsv/simple/browser in your components.
Vanilla TypeScript / Node.js
No special configuration needed. Use @bsv/simple/server for Node.js scripts and agents.
Protocol-Level Work
If you need direct access to cryptographic primitives, Script, transaction construction, or BEEF encoding — skip @bsv/simple and use the SDK directly:
npm install @bsv/sdkSee @bsv/sdk for the full API surface.
Next Steps
- Get Started — Connect a wallet and send your first payment
- Choose Your Stack — Pick the right packages for your use case
- Key Concepts — BEEF, BRC-100, wallets, overlays, identity