LBRYCommunity/lbcd
1
0
Fork 0
Code Issues 17 Pull requests 4 Packages Projects Releases 28 Wiki Activity
lbcd/rpcclient
History
Dave Collins 2be2f12b35 rpcclient: Update for go1.10 breaking changes. 
Go 1.10 made some changes such that json.Unmarshal can no longer
unmarshal into exported fields that are themselves embedded via an
uninitialized unexported pointer.

Since rpcclient previously relied on this behavior, this updates the
client to create the pointers before unmarshalling into the struct.
2018-02-19 18:56:35 -06:00
..
examples Import btcrpcclient repo into rpcclient directory. 2017-08-15 19:51:58 -05:00
chain.go Import btcrpcclient repo into rpcclient directory. 2017-08-15 19:51:58 -05:00
CONTRIBUTORS Import btcrpcclient repo into rpcclient directory. 2017-08-15 19:51:58 -05:00
doc.go Import btcrpcclient repo into rpcclient directory. 2017-08-15 19:51:58 -05:00
extensions.go btcd/multi: fix a number of typos in comments. 2018-01-25 23:23:59 -06:00
infrastructure.go rpcclient: Update for go1.10 breaking changes. 2018-02-19 18:56:35 -06:00
log.go Import btcrpcclient repo into rpcclient directory. 2017-08-15 19:51:58 -05:00
mining.go Import btcrpcclient repo into rpcclient directory. 2017-08-15 19:51:58 -05:00
net.go Import btcrpcclient repo into rpcclient directory. 2017-08-15 19:51:58 -05:00
notify.go btcd/multi: fix a number of typos in comments. 2018-01-25 23:23:59 -06:00
rawrequest.go Import btcrpcclient repo into rpcclient directory. 2017-08-15 19:51:58 -05:00
rawtransactions.go rpcclient: Add decodescript support. 2018-01-26 00:20:33 -06:00
README.md rpcclient: fix links in README.md 2017-08-28 01:50:25 -07:00
wallet.go rpcclient: implement addwitnessaddress 2018-01-26 01:20:40 -06:00

README.md

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 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
  • btcd Websockets Example
    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
    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
    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

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

License

Package rpcclient is licensed under the copyfree ISC License.