lbcd/rpcclient/README.md

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
Import btcrpcclient repo into rpcclient directory. This commit contains the entire btcrpcclient repository along with several changes needed to move all of the files into the rpcclient directory in order to prepare it for merging. This does NOT update btcd or any of the other packages to use the new location as that will be done separately. - All import paths in the old btcrpcclient files have been changed to the new location - All references to btcrpcclient as the package name have been changed to rpcclient 2017-07-22 04:53:54 +02:00			`rpcclient`
			`=========`
Initial commit. 2014-05-07 18:14:39 +02:00
Update markdown files for GFM changes. The github markdown interpreter has been changed such that it no longer allows spaces in between the brackets and parenthesis of links. This updates the markdown files accordingly. While here, it also corrects a couple of inconsistencies in regards to other README.md files in the project. 2017-05-25 19:42:31 +02:00			`[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)`
Add support for TravisCI. Also add TravisCI build status badge to README.md. 2014-05-09 08:16:47 +02:00
Import btcrpcclient repo into rpcclient directory. This commit contains the entire btcrpcclient repository along with several changes needed to move all of the files into the rpcclient directory in order to prepare it for merging. This does NOT update btcd or any of the other packages to use the new location as that will be done separately. - All import paths in the old btcrpcclient files have been changed to the new location - All references to btcrpcclient as the package name have been changed to rpcclient 2017-07-22 04:53:54 +02:00			`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`
[lbry] docs: update docs for LBRY Co-authored-by: Roy Lee <roylee17@gmail.com> 2021-08-19 20:41:48 +02:00			`interfacing with a Bitcoin RPC server that uses a lbcd/bitcoin core compatible`
Import btcrpcclient repo into rpcclient directory. This commit contains the entire btcrpcclient repository along with several changes needed to move all of the files into the rpcclient directory in order to prepare it for merging. This does NOT update btcd or any of the other packages to use the new location as that will be done separately. - All import paths in the old btcrpcclient files have been changed to the new location - All references to btcrpcclient as the package name have been changed to rpcclient 2017-07-22 04:53:54 +02:00			`Bitcoin JSON-RPC API.`
Initial commit. 2014-05-07 18:14:39 +02:00
Update README.md. This commit adds a description, status, and major features to the README. 2014-05-10 09:47:59 +02:00			`## 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.`
Initial commit. 2014-05-07 18:14:39 +02:00
Update README.md. This commit adds a description, status, and major features to the README. 2014-05-10 09:47:59 +02:00			`## Major Features`

[lbry] docs: update docs for LBRY Co-authored-by: Roy Lee <roylee17@gmail.com> 2021-08-19 20:41:48 +02:00			`* Supports Websockets (lbcd/lbcwallet) and HTTP POST mode (bitcoin core)`
			`* Provides callback and registration functions for lbcd/lbcwallet notifications`
			`* Supports lbcd extensions`
Fix a couple of typos in README.md. 2014-05-10 22:48:14 +02:00			`* Translates to and from higher-level and easier to use Go types`
			`* Offers a synchronous (blocking) and asynchronous API`
Update README.md. This commit adds a description, status, and major features to the README. 2014-05-10 09:47:59 +02:00			`* 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`
[lbry] docs: update docs for LBRY Co-authored-by: Roy Lee <roylee17@gmail.com> 2021-08-19 20:41:48 +02:00