BSV blockchainBSV blockchain

SDK API reference

The SDK API reference lists every method of the two wallet objects of @bsv/simple, a helper library on top of @bsv/sdk, with the options, defaults and errors the code shows. Use it to look up a method while you build, and the guides to see how the methods fit together. This page was written against @bsv/simple 0.7.2 with @bsv/sdk 4.0.1.

Wallet objects

The two objects share the methods of WalletCore and seven modules, and ServerWallet adds the deprecated receivePayment(). They differ in where your code runs and who holds the key:

Wallet objectWhere your code runsHow you create itWho holds the key
BrowserWalletA web appcreateWallet() from @bsv/simple/browserThe user’s BRC-100BSV Request for Comments 100, the standard interface between apps and wallets wallet
ServerWalletNode.js 22 or laterServerWallet.create() from @bsv/simple/serverYour server

The Wallet API and the HTTP APIs of BSV blockchain services are in the Reference tab. For the main SDK, @bsv/sdk, start from the TypeScript SDK page. For the Go SDK, see its documentation on pkg.go.dev, and for the Python SDK, its repository on GitHub.

Next steps

Open the page of the wallet object your code uses: