seedhammer/dcrd
seedhammer/dcrd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
b21feec2cd
dcrd/rpcclient
History
David Hill e26e71a9a2 multi: replace godoc.org with pkg.go.dev
2020-02-18 19:35:19 -06:00
..
examples rpcclient: add context 2020-01-31 15:05:03 -06:00
chain.go rpcclient: add context 2020-01-31 15:05:03 -06:00
CONTRIBUTORS Import dcrrpcclient repo into rpcclient directory. 2017-10-11 14:22:32 -05:00
doc.go multi: replace godoc.org with pkg.go.dev 2020-02-18 19:35:19 -06:00
extensions.go rpcclient: add context 2020-01-31 15:05:03 -06:00
go.mod multi: Round 4 prerel module release ver updates. 2020-02-14 22:55:06 -06:00
go.sum hdkeychain: Start v3 module dev cycle. 2020-02-14 17:41:50 -06:00
infrastructure_test.go rpcclient: Implement fmt.Stringer for Client 2018-06-14 16:45:52 -05:00
infrastructure.go rpcclient: add context 2020-01-31 15:05:03 -06:00
log.go multi: deprecate DisableLog 2019-03-18 11:16:35 -05:00
mining.go rpcclient: add context 2020-01-31 15:05:03 -06:00
net.go rpcclient: add context 2020-01-31 15:05:03 -06:00
notify.go rpcclient: add context 2020-01-31 15:05:03 -06:00
rawrequest.go rpcclient: add context 2020-01-31 15:05:03 -06:00
rawtransactions.go rpcclient: add context 2020-01-31 15:05:03 -06:00
README.md multi: replace godoc.org with pkg.go.dev 2020-02-18 19:35:19 -06:00
wallet.go hdkeychain: Start v3 module dev cycle. 2020-02-14 17:41:50 -06:00

README.md

rpcclient

Build Status ISC License Doc

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.