dcrd/rpcclient
Dave Collins 318d81bc90
multi: Wrap errors for better errors.Is/As support.
This updates all remaining cases of unwrapped errors in fmt.Errorf calls
to wrap the underlying errors with the %w format verb to ensure they
work nicely with errors.Is and errors.As.
2023-08-25 16:31:11 -05:00
..
examples/dcrdwebsockets rpcclient: Start v8 module dev cycle. 2022-03-30 17:40:06 -05:00
chain.go gcs: Start v4 module dev cycle. 2022-05-08 11:47:32 -05:00
CONTRIBUTORS Import dcrrpcclient repo into rpcclient directory. 2017-10-11 14:22:32 -05:00
doc.go multi: Go 1.19 doc comment formatting. 2022-07-30 04:08:58 -05:00
extensions.go multi: Go 1.19 doc comment formatting. 2022-07-30 04:08:58 -05:00
go.mod rpcclient: Prepare v8.0.0. 2023-06-08 15:02:43 -05:00
go.sum rpcclient: Prepare v8.0.0. 2023-06-08 15:02:43 -05:00
infrastructure_test.go rpcclient: Implement fmt.Stringer for Client 2018-06-14 16:45:52 -05:00
infrastructure.go multi: Wrap errors for better errors.Is/As support. 2023-08-25 16:31:11 -05:00
log.go rpcclient: Prepare v7.0.0. 2021-12-17 13:58:35 -06:00
mining.go multi: Cleanup superfluous trailing newlines. 2023-08-25 12:39:15 -05:00
net.go rpc/jsonrpc/types: Start v4 module dev cycle. 2022-03-30 17:34:29 -05:00
notify.go rpcclient: Remove notifyspentandmissedtickets. 2022-04-30 00:16:25 -05:00
rawrequest.go dcrjson: Introduce v4 module. 2021-09-14 13:38:54 -05:00
rawtransactions.go multi: Remove a bunch of dup words in comments. 2023-08-23 14:13:51 -05:00
README.md docs: Update for rpcclient v8 module. 2023-06-08 14:49:54 -05:00

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/v8 module. Use the standard go tooling for working with modules to incorporate it.

License

Package rpcclient is licensed under the copyfree ISC License.