seedhammer/dcrd
seedhammer/dcrd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
170ba4fc99
dcrd/rpcclient
History
jholdstock e3f7f58a68 multi: Don't use deprecated ioutil package. 
As of go 1.16, the "io/ioutil" package is deprecated. All functionality
from "io/ioutil" has been moved to either the "io" or "os" packages.
2021-09-01 06:09:37 -05:00
..
examples/dcrdwebsockets multi: Don't use deprecated ioutil package. 2021-09-01 06:09:37 -05:00
chain.go stdaddr: Replace Address method with String 2021-04-15 16:51:33 -05:00
CONTRIBUTORS Import dcrrpcclient repo into rpcclient directory. 2017-10-11 14:22:32 -05:00
doc.go rpcclient: Prepare v6.0.0. 2020-10-15 11:42:40 -05:00
extensions.go multi: Address some linter complaints. 2021-07-26 20:51:03 -05:00
go.mod multi: Don't use deprecated ioutil package. 2021-09-01 06:09:37 -05:00
go.sum multi: Don't use deprecated ioutil package. 2021-09-01 06:09:37 -05:00
infrastructure_test.go rpcclient: Implement fmt.Stringer for Client 2018-06-14 16:45:52 -05:00
infrastructure.go multi: Don't use deprecated ioutil package. 2021-09-01 06:09:37 -05:00
log.go rpcclient: Remove deprecated DisableLog. 2020-12-28 13:40:48 -06:00
mining.go rpc/jsonrpc/types: Start v3 module dev cycle. 2020-12-23 23:23:08 -06:00
net.go rpcclient: Add GetNetworkInfo call. 2021-08-16 10:41:45 -05:00
notify.go stdaddr: Replace Address method with String 2021-04-15 16:51:33 -05:00
rawrequest.go rpcclient: Prepare v6.0.0. 2020-10-15 11:42:40 -05:00
rawtransactions.go stdaddr: Replace Address method with String 2021-04-15 16:51:33 -05:00
README.md multi: Update README.md files for go modules. 2021-01-22 14:39:23 -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

Major Features

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

This package is part of the github.com/decred/dcrd/rpcclient/v6 module. Use the standard go tooling for working with modules to incorporate it.

License

Package rpcclient is licensed under the copyfree ISC License.