Skip to content

BSV Ruby SDK

Ruby SDK for the BSV Blockchain. Part of the official BSV SDK family alongside Go, TypeScript, and Python.

Installation

Add to your Gemfile:

gem 'bsv-sdk'

Or install directly:

gem install bsv-sdk

Modules

The SDK is organised into three top-level modules:

  • Primitives — keys, curves, hashing, encryption, HD keys, mnemonics
  • Script — script parsing, opcodes, templates, interpreter
  • Transaction — building, signing, BEEF serialisation, merkle proofs

Ecosystem Clients

Higher-level overlay clients for working with on-chain services:

  • Storage — UHRP URL utilities and content download with hash verification
  • KVStore — read from the global key-value store overlay
  • Ecosystem Clients — Registry typed resolves, Overlay Historian

Overlay services

End-user facing explanations of the overlay protocols the SDK supports, including how each one fits with the bsv-wallet write paths:

  • Overlay services overview — what overlays are, BRC-22/24 architecture, SDK vs wallet split
  • UHRP Storage — content-addressed file storage (BRC-26)
  • Historian — walk on-chain state through transaction ancestry
  • KVStore — overlay-backed signed key-value entries
  • Registries — typed basket / protocol / certificate definitions

Companion gems

  • bsv-wallet — BRC-100 wallet interface with BSV::Wallet::Client, storage adapters, and broadcast queue
  • bsv-wallet-postgres — PostgreSQL storage adapter and async broadcast queue for production deployments
  • bsv-attest — document attestation via OP_RETURN on the BSV blockchain