Skip to content

Simple Library to build in BSV typescript SDK

License

Notifications You must be signed in to change notification settings

bsv-blockchain/simple

 
 

Repository files navigation

@bsv/simple

A high-level TypeScript library that makes BSV blockchain development simple. Build wallets, send payments, create tokens, issue credentials, and more — in just a few lines of code.

What is @bsv/simple?

@bsv/simple wraps the low-level @bsv/sdk into a clean, modular API. Instead of manually constructing locking scripts, managing key derivation, and handling transaction internalization, you call methods like wallet.pay(), wallet.createToken(), and wallet.inscribeText().

What can you build?

Feature Description
Payments Send BSV to any identity key with optional memos and change recovery
Multi-Output Transactions Combine P2PKH payments, OP_RETURN data, and PushDrop tokens in a single transaction
Encrypted Tokens Create, transfer, and redeem PushDrop tokens with encrypted payloads
Inscriptions Write text, JSON, or file hashes permanently to the blockchain
MessageBox P2P Send and receive payments and tokens peer-to-peer via MessageBox
Certification Issue and manage BSV certificates with a standalone Certifier
Verifiable Credentials W3C-compatible VCs backed by BSV certificates, with on-chain revocation
DIDs Generate and resolve did:bsv: Decentralized Identifiers
Overlay Networks Broadcast to and query SHIP/SLAP overlay services
Server Wallet Run a backend wallet for automated operations and funding flows

Browser vs Server

The library has two entry points:

  • @bsv/simple — Uses WalletClient from @bsv/sdk to connect to the user's wallet on the client side.
  • @bsv/simple/server — Uses @bsv/wallet-toolbox to run a server side wallet from a private key. Used for agents, or servers receiving payments.

Both entry points provide the same API surface — the only difference is how they connect to the underlying wallet.

A taste of the API

import { createWallet } from '@bsv/simple/browser'

// Connect to the user's wallet
const wallet = await createWallet()

// Send a payment
await wallet.pay({ to: recipientKey, satoshis: 1000, memo: 'Coffee' })

// Create an encrypted token
await wallet.createToken({ data: { type: 'loyalty', points: 50 }, basket: 'rewards' })

// Inscribe text on-chain
await wallet.inscribeText('Hello BSV!')

// Get your DID
const did = wallet.getDID()
// { id: 'did:bsv:02abc...', ... }

Next Steps

About

Simple Library to build in BSV typescript SDK

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 100.0%