dcrd/dcrjson
Dave Collins 6d647094ee
multi: Return total chain work in RPC results.
This modifies the getblock and getblockheader RPC results to include the
total number of hashes expected to produce the chain up to the requested
block in hex and updates the JSON-RPC API documentation accordingly.
2018-10-16 11:30:58 -05:00
..
chainsvrcmds_test.go dcrjson: Consolidate tests into dcrjson package. 2018-07-23 18:20:13 -05:00
chainsvrcmds.go multi: add amount field to TransactionInput. 2018-06-21 23:54:42 +00:00
chainsvrresults_test.go dcrjson: Consolidate tests into dcrjson package. 2018-07-23 18:20:13 -05:00
chainsvrresults.go multi: Return total chain work in RPC results. 2018-10-16 11:30:58 -05:00
chainsvrwscmds_test.go dcrjson: Consolidate tests into dcrjson package. 2018-07-23 18:20:13 -05:00
chainsvrwscmds.go dcrjson: move cmd types 2017-08-06 20:53:32 +00:00
chainsvrwsntfns_test.go multi: Include additional fields on RPC tx results. 2018-09-10 09:18:01 -05:00
chainsvrwsntfns.go Use same notification for mined transactions and blocks. (#434) 2016-11-08 16:18:32 -05:00
chainsvrwsresults.go Use same notification for mined transactions and blocks. (#434) 2016-11-08 16:18:32 -05:00
cmdinfo_test.go dcrjson: Consolidate tests into dcrjson package. 2018-07-23 18:20:13 -05:00
cmdinfo.go blockchain: Rework to use new db interface. 2016-08-18 15:42:18 -04:00
cmdparse_test.go dcrjson: Consolidate tests into dcrjson package. 2018-07-23 18:20:13 -05:00
cmdparse.go multi: add amount field to TransactionInput. 2018-06-21 23:54:42 +00:00
CONTRIBUTORS Initial Decred Commit. 2016-02-07 14:00:12 -05:00
doc.go multi: Properly capitalize Decred. 2018-03-01 17:41:35 -06:00
error_test.go dcrjson: Consolidate tests into dcrjson package. 2018-07-23 18:20:13 -05:00
error.go blockchain: Rework to use new db interface. 2016-08-18 15:42:18 -04:00
example_test.go dcrjson: Consolidate tests into dcrjson package. 2018-07-23 18:20:13 -05:00
go.mod build: Refine build module support. 2018-08-05 20:45:45 -05:00
go.sum build: Refine build module support. 2018-08-05 20:45:45 -05:00
help_test.go dcrjson: Consolidate tests into dcrjson package. 2018-07-23 18:20:13 -05:00
help.go travis: enable gometalinter (#603) 2017-03-08 15:44:15 -05:00
helpers_test.go dcrjson: Consolidate tests into dcrjson package. 2018-07-23 18:20:13 -05:00
helpers.go blockchain: Rework to use new db interface. 2016-08-18 15:42:18 -04:00
jsonerr.go multi: fix misspell linter warnings 2018-02-18 12:26:52 -06:00
jsonrpc_test.go dcrjson: Consolidate tests into dcrjson package. 2018-07-23 18:20:13 -05:00
jsonrpc.go multi: fix misspell linter warnings 2018-02-18 12:26:52 -06:00
jsonrpcerr.go multi: Add initial committed filter (CF) support 2018-03-30 13:52:12 -04:00
parse_test.go dcrjson: Remove unused vote bit concat codec funcs. 2018-08-05 16:24:56 -05:00
parse.go dcrjson: Remove unused vote bit concat codec funcs. 2018-08-05 16:24:56 -05:00
README.md multi: Properly capitalize Decred. 2018-03-01 17:41:35 -06:00
register_test.go dcrjson: Consolidate tests into dcrjson package. 2018-07-23 18:20:13 -05:00
register.go blockchain: Rework to use new db interface. 2016-08-18 15:42:18 -04:00
walletsvrcmds_test.go multi: Cleanup the unsupported dcrwallet commands. 2018-10-11 14:15:22 -05:00
walletsvrcmds.go dcrjson: Add listtickets command. 2018-10-11 16:21:34 -05:00
walletsvrresults.go dcrjson: Add listtickets command. 2018-10-11 16:21:34 -05:00
walletsvrwscmds_test.go dcrjson: Consolidate tests into dcrjson package. 2018-07-23 18:20:13 -05:00
walletsvrwscmds.go blockchain: Rework to use new db interface. 2016-08-18 15:42:18 -04:00
walletsvrwsntfns_test.go dcrjson: Consolidate tests into dcrjson package. 2018-07-23 18:20:13 -05:00
walletsvrwsntfns.go multi: move extension commands into associated normal command files. 2018-06-03 12:04:20 -05:00

dcrjson

Build Status ISC License GoDoc

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_NAME is a placeholder for the specific tag:

    git tag -v TAG_NAME
    

License

Package dcrjson is licensed under the copyfree ISC License.