dcrd/rpcclient
Dave Collins 8354a310bc
main: Consume latest module minors and patches.
This updates the main module to use the latest available minor and patch
versions of all modules and reverts the recent change that incorrectly
removed all of the blake256 references from the various go.sum files.

The following required direct dependencies are bumped as follows:

- github.com/decred/dcrd/blockchain/stake@v1.2.1
- github.com/decred/dcrd/blockchain/stake/v2@v2.0.1
- github.com/decred/dcrd/certgen@v1.1.0
- github.com/decred/dcrd/chaincfg@v1.5.2
- github.com/decred/dcrd/chaincfg/chainhash@v1.0.2
- github.com/decred/dcrd/chaincfg/v2@v2.2.0
- github.com/decred/dcrd/dcrutil/v2@v2.0.0
- github.com/decred/dcrd/gcs@v1.1.0
- github.com/decred/dcrd/hdkeychain/v2@v2.0.1
- github.com/decred/dcrd/txscript/v2@v2.0.0
- github.com/decred/dcrwallet/rpc/jsonrpc/types@v1.2.0
2019-08-08 10:05:35 -05:00
..
examples release: Introduce rpcclient v4 module. 2019-07-30 12:56:44 -05:00
chain.go rpcclient: Use dcrutil/v2 and chaincfg/v2. 2019-07-30 12:55:48 -05:00
CONTRIBUTORS Import dcrrpcclient repo into rpcclient directory. 2017-10-11 14:22:32 -05:00
doc.go Import dcrrpcclient repo into rpcclient directory. 2017-10-11 14:22:32 -05:00
extensions.go rpcclient: Use dcrutil/v2 and chaincfg/v2. 2019-07-30 12:55:48 -05:00
go.mod release: Introduce rpcclient v4 module. 2019-07-30 12:56:44 -05:00
go.sum main: Consume latest module minors and patches. 2019-08-08 10:05:35 -05:00
infrastructure_test.go rpcclient: Implement fmt.Stringer for Client 2018-06-14 16:45:52 -05:00
infrastructure.go rpcclient: Use dcrjson/v3. 2019-07-22 13:34:09 -05:00
log.go multi: deprecate DisableLog 2019-03-18 11:16:35 -05:00
mining.go rpcclient: Use dcrutil/v2 and chaincfg/v2. 2019-07-30 12:55:48 -05:00
net.go rpcclient: Use dcrjson/v3. 2019-07-22 13:34:09 -05:00
notify.go rpcclient: Use dcrutil/v2 and chaincfg/v2. 2019-07-30 12:55:48 -05:00
rawrequest.go rpcclient: Use dcrjson/v3. 2019-07-22 13:34:09 -05:00
rawtransactions.go rpcclient: Use dcrutil/v2 and chaincfg/v2. 2019-07-30 12:55:48 -05:00
README.md multi: Use https links where available. 2019-06-18 14:20:06 -05:00
wallet.go rpcclient: Use dcrutil/v2 and chaincfg/v2. 2019-07-30 12:55:48 -05:00

rpcclient

Build Status ISC License GoDoc

rpcclient implements a Websocket-enabled Decred JSON-RPC client package written in Go. It provides a robust and easy to use client for interfacing with a Decred RPC server that uses a dcrd compatible Decred 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
  • dcrd Websockets Example Connects to a dcrd RPC server using TLS-secured websockets, registers for block connected and block disconnected notifications, and gets the current block count
  • dcrwallet Websockets Example
    Connects to a dcrwallet 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

Major Features

  • Supports Websockets (dcrd/dcrwallet) and HTTP POST mode (bitcoin core-like)
  • Provides callback and registration functions for dcrd/dcrwallet notifications
  • Supports dcrd 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/decred/dcrd/rpcclient

License

Package rpcclient is licensed under the copyfree ISC License.