dcrd/dcrjson
Dave Collins 64b440453c
dcrjson: Reject dup method type registrations.
This modifies the registration function to return an error as expected
in the case the same method type is registered more than once and adds
code to return an error when the parameter type is already registered
for some other method type.

The current code allowed the same method type to be registered again so
long as it had the same parameter type associated with it, which is not
desirable since it might have been registered with a different set of
flags and the new registration would simply be ignored.
2020-10-15 17:03:50 -05:00
..
cmdinfo_test.go dcrjson: Introduce v3 and move types to module. 2019-07-19 08:49:49 -05:00
cmdinfo.go dcrjson: Introduce v3 and move types to module. 2019-07-19 08:49:49 -05:00
cmdparse_test.go dcrjson: Prepare v3.1.0. 2020-09-25 12:06:26 -05:00
cmdparse.go multi: Correct typos. 2019-08-16 17:37:58 -05:00
CONTRIBUTORS Initial Decred Commit. 2016-02-07 14:00:12 -05:00
doc.go dcrjson: Prepare v3.1.0. 2020-09-25 12:06:26 -05:00
error_test.go dcrjson: Consolidate tests into dcrjson package. 2018-07-23 18:20:13 -05:00
error.go multi: Correct typos. 2019-08-16 17:37:58 -05:00
example_test.go dcrjson: Introduce v3 and move types to module. 2019-07-19 08:49:49 -05:00
go.mod dcrjson: Prepare v3.0.1. 2019-10-14 15:54:11 -05:00
go.sum dcrjson: Prepare v3.0.1. 2019-10-14 15:54:11 -05:00
help_test.go multi: Correct typos. 2019-08-16 17:37:58 -05:00
help.go dcrjson: Prepare v3.1.0. 2020-09-25 12:06:26 -05:00
helpers_test.go dcrjson: Introduce v3 and move types to module. 2019-07-19 08:49:49 -05:00
helpers.go dcrjson: Introduce v3 and move types to module. 2019-07-19 08:49:49 -05: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 dcrjson: Prepare v3.1.0. 2020-09-25 12:06:26 -05:00
jsonrpcerr.go dcrjson: Prepare v3.1.0. 2020-09-25 12:06:26 -05:00
parse_test.go multi: preallocate memory. 2019-03-09 16:43:48 -06:00
parse.go dcrjson: Remove unused vote bit concat codec funcs. 2018-08-05 16:24:56 -05:00
README.md multi: replace godoc.org with pkg.go.dev 2020-02-18 19:35:19 -06:00
register_test.go dcrjson: Introduce v3 and move types to module. 2019-07-19 08:49:49 -05:00
register.go dcrjson: Reject dup method type registrations. 2020-10-15 17:03:50 -05:00

dcrjson

Build Status ISC License Doc

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

$ go get -u github.com/decred/dcrd/dcrjson

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.