TypeScript Library API Documentation
The documentation is split into various pages, each covering a set of related functionality. The pages are as follows:
- Primitives — Covers public and private keys, key derivation, digital signaturs, symmetric keys, and low-level operations
- Script — Covers Bitcoin scripts, the templating system, serialization, and the Spend class (script interpreter)
- Transaction — Covers transaction construction, signing, broadcasters, fee models, merkle proofs, and SPV structures like BUMP
- Messages — Covers generalizable message signing, verification, encryption and decryption
- TOTP - Covers Time-based One Time Password, useful for validating counterparties across unsecured mediums.
- Wallet - Covers the Wallet Substrates for communication between applications and wallets using a standard interface.
- Overlay Tools - Covers the use of Overlays for broadcast of transactions based on topics, as well as distributed lookup of tokens.
- Auth - Mutual Authentication and Service Monetization Framework
- Compat — Covers deprecated functionality for legacy systems like BIP32 and ECIES
Swagger
BRC-100 defines a Unified, Vendor-Neutral, Unchanging, and Open BSV Blockchain Standard Wallet-to-Application Interface which is implemented in this library within the WalletClient class. The API is laid out here as a swagger openapi document to offer a fast-track to understanding the interface which is implemented across multiple substrates. The JSON api is generally considered a developer friendly introduction to the WalletClient, where an binary equivalent ABI may be preferred for production use cases.