dcrjson
Package dcrjson implements concrete types for marshalling to and from the
decred JSON-RPC API. 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
$ go get -u github.com/decred/dcrd/dcrjson
Examples
-
Marshal Command
Demonstrates how to create and marshal a command into a JSON-RPC request.
-
Unmarshal Command
Demonstrates how to unmarshal a JSON-RPC request and then unmarshal 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.
GPG Verification Key
All official release tags are signed by Conformal so users can ensure the code
has not been tampered with and is coming from the Decred developers. To
verify the signature perform the following:
-
Download the public key from the Conformal website at
https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt
-
Import the public key into your GPG keyring:
gpg --import GIT-GPG-KEY-conformal.txt
-
Verify the release tag with the following command where TAG_NAME
is a
placeholder for the specific tag:
git tag -v TAG_NAME
License
Package dcrjson is licensed under the copyfree ISC
License.