5db19ddcab
This modifies the results provided by the getrawtransaction and searchrawtransactions RPCs to make them consistent with each other. In particular, it adds the transaction expiry, block height, and block index fields to the searchrawtransactions result and ensures that both omit the block height when it is zero so that it is not included in the results for mempool transactions. Since populating the block index requires additional details to be stored to the transaction index to efficiently provide, only the infrastructure is added and the value is left as the default for now, which means it will be omitted and therefore not change the visible behavior. Finally, it also updates the RPC server help to provide consistent descriptions for the fields and also updates the JSON-RPC documentation. |
||
|---|---|---|
| .. | ||
| 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 | ||
| 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 | ||
| 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.