Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,17 @@ The documentation is split into various pages, each covering a set of related fu
- [Services](./services.md) — Support for abstracted external network services.
- [Monitor](./monitor.md) — Background task manager for wallet action validation and processing.

## Swagger
## Open API

[BRC-100](https://brc.dev/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.

- [Wallet JSON API Swagger](https://bitcoin-sv.github.io/ts-sdk/swagger)
- [Wallet API Swagger UI](https://bitcoin-sv.github.io/ts-sdk/swagger)

## Open RPC

StorageClient implements the WalletStorageProvider interface over https using a JSON-RPC api which can be explored using the JSight UI.

- [StorageClient JSight UI](https://bitcoin-sv.github.io/wallet-toolbox/open-rpc)

## Getting Started

Expand Down
Loading