Skip to content

Latest commit

 

History

History
56 lines (44 loc) · 2.4 KB

README.md

File metadata and controls

56 lines (44 loc) · 2.4 KB
Raw

rpcclient

Build Status ISC License GoDoc

rpcclient implements a Websocket-enabled Bitcoin JSON-RPC client package written in Go. It provides a robust and easy to use client for interfacing with a Bitcoin RPC server that uses a bchd/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
  • bchd Websockets Example Connects to a bchd RPC server using TLS-secured websockets, registers for block connected and block disconnected notifications, and gets the current block count
  • bchwallet Websockets Example Connects to a bchwallet 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 Connects to a bitcoin core RPC server using HTTP POST mode with TLS disabled and gets the current block count

Major Features

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

$ go get -u github.com/gcash/bchd/rpcclient

License

Package rpcclient is licensed under the copyfree ISC License.