mirror of
https://github.com/kaspanet/kaspad.git
synced 2025-06-09 07:36:43 +00:00
1cd2eb9308
* [NOD-494] Updated main README.md * [NOD-494] Updated blockdag/README.md * [NOD-494] Aligned text length in main README.md * [NOD-494] Updated most remaining packages READMEs + deleted util/coinset * [NOD-494] Update integration README * [NOD-494] Did a final pass over all readmes * [NOD-494] Updated README for DNSSeeder with more info on how to create a functioning setup * [NOD-494] Remove all double spaces from readmes * [NOD-494] Minor fixes in READMEs + update license to kaspanet developers * [NOD-494] Add backtick around ecc and util in hdkeychain README
35 lines
1.7 KiB
Markdown
35 lines
1.7 KiB
Markdown
rpcmodel
|
|
=======
|
|
|
|
[](http://copyfree.org)
|
|
[](http://godoc.org/github.com/kaspanet/kaspad/rpcmodel)
|
|
|
|
Package rpcmodel implements concrete types for marshalling to and from the
|
|
kaspa JSON-RPC API. A comprehensive suite of tests is provided to ensure
|
|
proper functionality.
|
|
|
|
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.
|
|
|
|
## Examples
|
|
|
|
* [Marshal Command](http://godoc.org/github.com/kaspanet/kaspad/rpcmodel#example-MarshalCmd)
|
|
Demonstrates how to create and marshal a command into a JSON-RPC request.
|
|
|
|
* [Unmarshal Command](http://godoc.org/github.com/kaspanet/kaspad/rpcmodel#example-UnmarshalCmd)
|
|
Demonstrates how to unmarshal a JSON-RPC request and then unmarshal the
|
|
concrete request into a concrete command.
|
|
|
|
* [Marshal Response](http://godoc.org/github.com/kaspanet/kaspad/rpcmodel#example-MarshalResponse)
|
|
Demonstrates how to marshal a JSON-RPC response.
|
|
|
|
* [Unmarshal Response](http://godoc.org/github.com/kaspanet/kaspad/rpcmodel#example-package--UnmarshalResponse)
|
|
Demonstrates how to unmarshal a JSON-RPC response and then unmarshal the
|
|
result field in the response to a concrete type.
|
|
|