cecfb5a0b4
This updates the installation and updating section of the README.md files in the various packages to call out the module they are a part of and instruct the consumer to use the standard go tooling instead of the old, and no longer correct, package-based 'go get -u' instructions. |
||
|---|---|---|
| .. | ||
| cmdinfo_test.go | ||
| cmdinfo.go | ||
| cmdparse_test.go | ||
| cmdparse.go | ||
| CONTRIBUTORS | ||
| doc.go | ||
| error_test.go | ||
| error.go | ||
| example_test.go | ||
| go.mod | ||
| go.sum | ||
| help_test.go | ||
| help.go | ||
| helpers_test.go | ||
| helpers.go | ||
| jsonerr.go | ||
| jsonrpc_test.go | ||
| jsonrpc.go | ||
| jsonrpcerr.go | ||
| parse_test.go | ||
| parse.go | ||
| README.md | ||
| register_test.go | ||
| register.go | ||
dcrjson
Package dcrjson implements infrastructure for marshalling to and from the decred JSON-RPC API via concrete types. A comprehensive suite of tests is provided to ensure proper functionality.
Although this package was primarily written for the decred, it has intentionally been designed so it can be used as a standalone package for any projects needing to marshal to and from decred JSON-RPC requests and responses.
Note that although it's possible to use this package directly to implement an RPC client, it is not recommended since it is only intended as an infrastructure package. Instead, RPC clients should use the rpcclient package which provides a full blown RPC client with many features such as automatic connection management, websocket support, automatic notification re-registration on reconnect, and conversion from the raw underlying RPC types (strings, floats, ints, etc) to higher-level types with many nice and useful properties.
Installation and Updating
This package is part of the github.com/decred/dcrd/dcrjson/v3 module. Use the
standard go tooling for working with modules to incorporate it.
Examples
-
Marshal Command Demonstrates how to create and marshal a command into a JSON-RPC request.
-
Parse Command Demonstrates how to unmarshal a JSON-RPC request and then parse the params of the concrete request into a concrete command.
-
Marshal Response Demonstrates how to marshal a JSON-RPC response.
-
Unmarshal Response Demonstrates how to unmarshal a JSON-RPC response and then unmarshal the result field in the response to a concrete type.
License
Package dcrjson is licensed under the copyfree ISC License.