lbcd/rpcclient/README.md
Brannon King 4dd4505706 [lbry] docs: update docs for LBRY
Co-authored-by: Roy Lee <roylee17@gmail.com>
2022-05-24 00:01:46 -07:00

29 lines
No EOL
1.1 KiB
Markdown

rpcclient
=========
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
rpcclient implements a Websocket-enabled Bitcoin JSON-RPC client package written
in [Go](http://golang.org/). It provides a robust and easy to use client for
interfacing with a Bitcoin RPC server that uses a lbcd/bitcoin core compatible
Bitcoin JSON-RPC API.
## Status
This package is currently under active development. It is already stable and
the infrastructure is complete. However, there are still several RPCs left to
implement and the API is not stable yet.
## Major Features
* Supports Websockets (lbcd/lbcwallet) and HTTP POST mode (bitcoin core)
* Provides callback and registration functions for lbcd/lbcwallet notifications
* Supports lbcd extensions
* Translates to and from higher-level and easier to use Go types
* Offers a synchronous (blocking) and asynchronous API
* When running in Websockets mode (the default):
* Automatic reconnect handling (can be disabled)
* Outstanding commands are automatically reissued
* Registered notifications are automatically reregistered
* Back-off support on reconnect attempts