lbcd/rpcclient/README.md

rpcclient
=========

[![Build Status](https://github.com/btcsuite/btcd/workflows/Build%20and%20Test/badge.svg)](https://github.com/btcsuite/btcd/actions)
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/btcsuite/btcd/rpcclient)

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 btcd/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.

## Documentation

* [API Reference](https://pkg.go.dev/github.com/btcsuite/btcd/rpcclient)
* [btcd Websockets Example](https://github.com/btcsuite/btcd/tree/master/rpcclient/examples/btcdwebsockets)
  Connects to a btcd RPC server using TLS-secured websockets, registers for
  block connected and block disconnected notifications, and gets the current
  block count
* [btcwallet Websockets Example](https://github.com/btcsuite/btcd/tree/master/rpcclient/examples/btcwalletwebsockets)
  Connects to a btcwallet RPC server using TLS-secured websockets, registers for
  notifications about changes to account balances, and gets a list of unspent
  transaction outputs (utxos) the wallet can sign
* [Bitcoin Core HTTP POST Example](https://github.com/btcsuite/btcd/tree/master/rpcclient/examples/bitcoincorehttp)
  Connects to a bitcoin core RPC server using HTTP POST mode with TLS disabled
  and gets the current block count

## Major Features

* Supports Websockets (btcd/btcwallet) and HTTP POST mode (bitcoin core)
* Provides callback and registration functions for btcd/btcwallet notifications
* Supports btcd 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

## Installation

```bash
$ go get -u github.com/btcsuite/btcd/rpcclient
```

## License

Package rpcclient is licensed under the [copyfree](http://copyfree.org) ISC
License.
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
docs: update shields 2021-03-04 23:12:45 +01:00			`[![Build Status](https://github.com/btcsuite/btcd/workflows/Build%20and%20Test/badge.svg)](https://github.com/btcsuite/btcd/actions)`
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)`
docs: update shields 2021-03-04 23:12:45 +01:00			`[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/btcsuite/btcd/rpcclient)`
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`
			`interfacing with a Bitcoin RPC server that uses a btcd/bitcoin core compatible`
			`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. 2014-05-10 03:48:05 +02:00			`## Documentation`
Add link to examples in README.md. 2014-05-02 06:18:43 +02:00
docs: update shields 2021-03-04 23:12:45 +01:00			`* [API Reference](https://pkg.go.dev/github.com/btcsuite/btcd/rpcclient)`
docs: Update example links in README 2018-05-30 22:41:32 +02:00			`* [btcd Websockets Example](https://github.com/btcsuite/btcd/tree/master/rpcclient/examples/btcdwebsockets)`
Add the new example to README.md and doc.go. 2014-06-06 03:58:47 +02:00			`Connects to a btcd RPC server using TLS-secured websockets, registers for`
			`block connected and block disconnected notifications, and gets the current`
			`block count`
docs: Update example links in README 2018-05-30 22:41:32 +02:00			`* [btcwallet Websockets Example](https://github.com/btcsuite/btcd/tree/master/rpcclient/examples/btcwalletwebsockets)`
Add the new example to README.md and doc.go. 2014-06-06 03:58:47 +02:00			`Connects to a btcwallet RPC server using TLS-secured websockets, registers for`
			`notifications about changes to account balances, and gets a list of unspent`
			`transaction outputs (utxos) the wallet can sign`
docs: Update example links in README 2018-05-30 22:41:32 +02:00			`* [Bitcoin Core HTTP POST Example](https://github.com/btcsuite/btcd/tree/master/rpcclient/examples/bitcoincorehttp)`
Update README.md. 2014-05-10 03:48:05 +02:00			`Connects to a bitcoin core RPC server using HTTP POST mode with TLS disabled`
			`and gets the current block count`

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`

			`* Supports Websockets (btcd/btcwallet) and HTTP POST mode (bitcoin core)`
			`* Provides callback and registration functions for btcd/btcwallet notifications`
			`* Supports btcd 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`

Update README.md. 2014-05-10 03:48:05 +02:00			`## Installation`

			```bash
multi: correct all import paths 2018-05-15 05:44:11 +02:00			`$ go get -u github.com/btcsuite/btcd/rpcclient`
Update README.md. 2014-05-10 03:48:05 +02:00			```
Add link to examples in README.md. 2014-05-02 06:18:43 +02:00
Initial commit. 2014-05-07 18:14:39 +02:00			`## License`

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			`Package rpcclient is licensed under the [copyfree](http://copyfree.org) ISC`
Initial commit. 2014-05-07 18:14:39 +02:00			`License.`