Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 13-May-2020 | - | ||||
CONTRIBUTORS | H A D | 13-May-2020 | 594 | 17 | 15 | |
README.md | H A D | 13-May-2020 | 2.8 KiB | 71 | 52 | |
btcdextcmds.go | H A D | 13-May-2020 | 4.8 KiB | 157 | 78 | |
btcdextcmds_test.go | H A D | 13-May-2020 | 8.3 KiB | 276 | 248 | |
btcdextresults.go | H A D | 13-May-2020 | 722 | 21 | 9 | |
btcdextresults_test.go | H A D | 13-May-2020 | 1.3 KiB | 56 | 42 | |
btcwalletextcmds.go | H A D | 13-May-2020 | 3 KiB | 107 | 66 | |
btcwalletextcmds_test.go | H A D | 13-May-2020 | 6 KiB | 210 | 183 | |
chainsvrcmds.go | H A D | 13-May-2020 | 27.2 KiB | 884 | 517 | |
chainsvrcmds_test.go | H A D | 13-May-2020 | 39.9 KiB | 1,257 | 1,223 | |
chainsvrresults.go | H A D | 13-May-2020 | 24.5 KiB | 667 | 505 | |
chainsvrresults_test.go | H A D | 13-May-2020 | 2.1 KiB | 89 | 76 | |
chainsvrwscmds.go | H A D | 13-May-2020 | 7.6 KiB | 242 | 119 | |
chainsvrwscmds_test.go | H A D | 13-May-2020 | 10 KiB | 298 | 270 | |
chainsvrwsntfns.go | H A D | 13-May-2020 | 9.9 KiB | 305 | 148 | |
chainsvrwsntfns_test.go | H A D | 13-May-2020 | 9 KiB | 297 | 268 | |
chainsvrwsresults.go | H A D | 13-May-2020 | 645 | 22 | 8 | |
chainsvrwsresults_test.go | H A D | 13-May-2020 | 1.1 KiB | 51 | 38 | |
cmdinfo.go | H A D | 13-May-2020 | 7.8 KiB | 250 | 157 | |
cmdinfo_test.go | H A D | 13-May-2020 | 9.7 KiB | 431 | 390 | |
cmdparse.go | H A D | 13-May-2020 | 17.7 KiB | 551 | 362 | |
cmdparse_test.go | H A D | 13-May-2020 | 12.3 KiB | 520 | 489 | |
doc.go | H A D | 13-May-2020 | 6.4 KiB | 147 | 1 | |
error.go | H A D | 13-May-2020 | 3.6 KiB | 112 | 50 | |
error_test.go | H A D | 13-May-2020 | 2.1 KiB | 81 | 64 | |
example_test.go | H A D | 13-May-2020 | 4.7 KiB | 147 | 71 | |
export_test.go | H A D | 13-May-2020 | 1.7 KiB | 49 | 12 | |
help.go | H A D | 13-May-2020 | 18.3 KiB | 561 | 340 | |
help_test.go | H A D | 13-May-2020 | 18.7 KiB | 738 | 691 | |
helpers.go | H A D | 13-May-2020 | 2.1 KiB | 78 | 46 | |
helpers_test.go | H A D | 13-May-2020 | 2 KiB | 116 | 104 | |
jsonrpc.go | H A D | 13-May-2020 | 5.1 KiB | 151 | 87 | |
jsonrpc_test.go | H A D | 13-May-2020 | 4.1 KiB | 162 | 131 | |
jsonrpcerr.go | H A D | 13-May-2020 | 2.7 KiB | 90 | 71 | |
register.go | H A D | 13-May-2020 | 8.7 KiB | 293 | 187 | |
register_test.go | H A D | 13-May-2020 | 6.7 KiB | 264 | 231 | |
walletsvrcmds.go | H A D | 13-May-2020 | 23.3 KiB | 725 | 447 | |
walletsvrcmds_test.go | H A D | 13-May-2020 | 41.4 KiB | 1,303 | 1,275 | |
walletsvrresults.go | H A D | 13-May-2020 | 6.6 KiB | 162 | 123 | |
walletsvrwscmds.go | H A D | 13-May-2020 | 4.3 KiB | 129 | 69 | |
walletsvrwscmds_test.go | H A D | 13-May-2020 | 7.9 KiB | 260 | 233 | |
walletsvrwsntfns.go | H A D | 13-May-2020 | 2.9 KiB | 96 | 52 | |
walletsvrwsntfns_test.go | H A D | 13-May-2020 | 5.9 KiB | 188 | 160 |
README.md
1btcjson 2======= 3 4[![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)](https://travis-ci.org/btcsuite/btcd) 5[![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) 6[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcd/btcjson) 7 8Package btcjson implements concrete types for marshalling to and from the 9bitcoin JSON-RPC API. A comprehensive suite of tests is provided to ensure 10proper functionality. 11 12Although this package was primarily written for the btcsuite, it has 13intentionally been designed so it can be used as a standalone package for any 14projects needing to marshal to and from bitcoin JSON-RPC requests and responses. 15 16Note that although it's possible to use this package directly to implement an 17RPC client, it is not recommended since it is only intended as an infrastructure 18package. Instead, RPC clients should use the 19[btcrpcclient](https://github.com/btcsuite/btcrpcclient) package which provides 20a full blown RPC client with many features such as automatic connection 21management, websocket support, automatic notification re-registration on 22reconnect, and conversion from the raw underlying RPC types (strings, floats, 23ints, etc) to higher-level types with many nice and useful properties. 24 25## Installation and Updating 26 27```bash 28$ go get -u github.com/btcsuite/btcd/btcjson 29``` 30 31## Examples 32 33* [Marshal Command](http://godoc.org/github.com/btcsuite/btcd/btcjson#example-MarshalCmd) 34 Demonstrates how to create and marshal a command into a JSON-RPC request. 35 36* [Unmarshal Command](http://godoc.org/github.com/btcsuite/btcd/btcjson#example-UnmarshalCmd) 37 Demonstrates how to unmarshal a JSON-RPC request and then unmarshal the 38 concrete request into a concrete command. 39 40* [Marshal Response](http://godoc.org/github.com/btcsuite/btcd/btcjson#example-MarshalResponse) 41 Demonstrates how to marshal a JSON-RPC response. 42 43* [Unmarshal Response](http://godoc.org/github.com/btcsuite/btcd/btcjson#example-package--UnmarshalResponse) 44 Demonstrates how to unmarshal a JSON-RPC response and then unmarshal the 45 result field in the response to a concrete type. 46 47## GPG Verification Key 48 49All official release tags are signed by Conformal so users can ensure the code 50has not been tampered with and is coming from the btcsuite developers. To 51verify the signature perform the following: 52 53- Download the public key from the Conformal website at 54 https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt 55 56- Import the public key into your GPG keyring: 57 ```bash 58 gpg --import GIT-GPG-KEY-conformal.txt 59 ``` 60 61- Verify the release tag with the following command where `TAG_NAME` is a 62 placeholder for the specific tag: 63 ```bash 64 git tag -v TAG_NAME 65 ``` 66 67## License 68 69Package btcjson is licensed under the [copyfree](http://copyfree.org) ISC 70License. 71