e62476cd72
This change makes the following fields omitempty so they can be ignored by SPV wallets: * poolsize * allmempooltix * live * proportionlive * missed * proportionmissed * expired As a side-effect, non-SPV wallets will also omit these fields from the result if the value is zero. The following counts remain: * ownmempooltix * immature * voted * revoked And two new fields have been added to allow SPV wallets to provide a fuller picture of the wallet's ticket state counts: * unspent * unspentexpired The `unspent` field describes the number of tickets that have gone live and have not been spent by a vote or revocation. The `unspentexpired` field describes the number of unspent tickets that must certainly be revoked as they have not been spent by a vote and have passed the expiry period. These tickets may have been called and missed, or actually expired, but a SPV wallet is aware that they must be revoked as they cannot possibly be live. These changes are being made due to SPV wallets being unaware of what state a matured ticket is in (whether live, picked, or missed) and because SPV wallets do not know the ticket pool size or the number of all unmined tickets. |
||
|---|---|---|
| .. | ||
| chainsvrcmds_test.go | ||
| chainsvrcmds.go | ||
| chainsvrresults_test.go | ||
| chainsvrresults.go | ||
| chainsvrwscmds_test.go | ||
| chainsvrwscmds.go | ||
| chainsvrwsntfns_test.go | ||
| chainsvrwsntfns.go | ||
| chainsvrwsresults.go | ||
| cmdinfo_test.go | ||
| cmdinfo.go | ||
| cmdparse_test.go | ||
| cmdparse.go | ||
| CONTRIBUTORS | ||
| doc.go | ||
| error_test.go | ||
| error.go | ||
| example_test.go | ||
| export_test.go | ||
| go.mod | ||
| go.modverify | ||
| 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 | ||
| walletsvrcmds_test.go | ||
| walletsvrcmds.go | ||
| walletsvrresults.go | ||
| walletsvrwscmds_test.go | ||
| walletsvrwscmds.go | ||
| walletsvrwsntfns_test.go | ||
| walletsvrwsntfns.go | ||
dcrjson
Package dcrjson implements concrete types for marshalling to and from the bitcoin 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 bitcoin 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_NAMEis a placeholder for the specific tag:git tag -v TAG_NAME
License
Package dcrjson is licensed under the copyfree ISC License.