lbcd/rpcclient/README.md

57 lines
2.4 KiB
Markdown
Raw Normal View History

rpcclient
=========
2014-05-07 18:14:39 +02:00
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)
[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
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)
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.
2014-05-07 18:14:39 +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.
2014-05-07 18:14:39 +02:00
2014-05-10 03:48:05 +02:00
## Documentation
2014-05-02 06:18:43 +02:00
2021-03-04 23:12:45 +01:00
* [API Reference](https://pkg.go.dev/github.com/btcsuite/btcd/rpcclient)
2018-05-30 22:41:32 +02:00
* [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
2018-05-30 22:41:32 +02:00
* [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
2018-05-30 22:41:32 +02:00
* [Bitcoin Core HTTP POST Example](https://github.com/btcsuite/btcd/tree/master/rpcclient/examples/bitcoincorehttp)
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
## Major Features
* Supports Websockets (btcd/btcwallet) and HTTP POST mode (bitcoin core)
* Provides callback and registration functions for btcd/btcwallet notifications
* Supports btcd extensions
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
* 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
2014-05-10 03:48:05 +02:00
## Installation
```bash
2018-05-15 05:44:11 +02:00
$ go get -u github.com/btcsuite/btcd/rpcclient
2014-05-10 03:48:05 +02:00
```
2014-05-02 06:18:43 +02:00
2014-05-07 18:14:39 +02:00
## License
Package rpcclient is licensed under the [copyfree](http://copyfree.org) ISC
2014-05-07 18:14:39 +02:00
License.