LBRYCommunity/lbcd
1
0
Fork 0
Code Issues 17 Pull requests 4 Projects Releases 28 Packages Wiki Activity
lbcd/btcjson
History
jalavosus 57cb8e4b11 Refactor FutureGetBlockVerboseResult into two types: FutureGetBlockVerboseResult, and FutureGetBlockVerboseTxResult. 
Due to differences in how getblock returns data based on the provided verbosity parameter, it's necessary
to have two separate return types based on verbosity. This necessitates a separate unmarshalling function
(represented throughout rpcclient/chain.go as Result.Receive()) to ensure that data is correctly unmarshalled
and returned to the user.
2020-03-05 06:48:19 -05:00
..
btcdextcmds.go Port getheaders JSON-RPC command from dcrd 2017-01-10 19:11:18 -07:00
btcdextcmds_test.go Port getheaders JSON-RPC command from dcrd 2017-01-10 19:11:18 -07:00
btcdextresults.go Port getheaders JSON-RPC command from dcrd 2017-01-10 19:11:18 -07:00
btcdextresults_test.go Port getheaders JSON-RPC command from dcrd 2017-01-10 19:11:18 -07:00
btcwalletextcmds.go fix NewImportAddressCmd rescan wrong parameters 2018-03-05 19:25:40 +00:00
btcwalletextcmds_test.go fix NewImportAddressCmd rescan wrong parameters 2018-03-05 19:25:40 +00:00
chainsvrcmds.go Refactor GetBlockCmd type and NewGetBlockCmd() function to follow the bitcoin json RPC verbosity format for getblock, 2020-03-05 06:47:38 -05:00
chainsvrcmds_test.go Refactor FutureGetBlockVerboseResult into two types: FutureGetBlockVerboseResult, and FutureGetBlockVerboseTxResult. 2020-03-05 06:48:19 -05:00
chainsvrresults.go Refactor GetBlockVerboseResult into two separate types: one type for getblock "hash" verbosity=1, 2020-03-05 06:47:38 -05:00
chainsvrresults_test.go adds optional prevOut section to vin for searchrawtransactions api. See https://github.com/btcsuite/btcd/issues/485 2015-08-23 09:58:03 -07:00
chainsvrwscmds.go btcjson/docs: add rescanblocks command backported from dcrd 2017-01-27 15:32:15 -07:00
chainsvrwscmds_test.go btcjson/docs: add rescanblocks command backported from dcrd 2017-01-27 15:32:15 -07:00
chainsvrwsntfns.go btcjson/docs: add rescanblocks command backported from dcrd 2017-01-27 15:32:15 -07:00
chainsvrwsntfns_test.go btcjson/docs: add loadtxfilter command backported from dcrd 2017-01-27 15:32:15 -07:00
chainsvrwsresults.go btcjson/docs: add rescanblocks command backported from dcrd 2017-01-27 15:32:15 -07:00
chainsvrwsresults_test.go btcjson/docs: add rescanblocks command backported from dcrd 2017-01-27 15:32:15 -07:00
cmdinfo.go multi: Fix several misspellings in the comments. 2016-02-25 11:17:12 -06:00
cmdinfo_test.go Refactor FutureGetBlockVerboseResult into two types: FutureGetBlockVerboseResult, and FutureGetBlockVerboseTxResult. 2020-03-05 06:48:19 -05:00
cmdparse.go btcd/multi: fix a number of typos in comments. 2018-01-25 23:23:59 -06:00
cmdparse_test.go btcjson: fix formatting directives 2018-07-06 13:06:00 -07:00
CONTRIBUTORS Import btcjson repo into btcjson directory. 2015-02-19 11:10:46 -06:00
doc.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
error.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
error_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
example_test.go Refactor FutureGetBlockVerboseResult into two types: FutureGetBlockVerboseResult, and FutureGetBlockVerboseTxResult. 2020-03-05 06:48:19 -05:00
export_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
help.go Fix a ton of typos accumulated over time 2017-05-30 16:59:51 +02:00
help_test.go btcjson: fix formatting directives 2018-07-06 13:06:00 -07:00
helpers.go Fix listtransactions/gettransaction result structs. 2015-05-06 14:12:10 -04:00
helpers_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
jsonrpc.go btcjson, rpclient: Fix typo 2020-03-04 09:23:11 -05:00
jsonrpc_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
jsonrpcerr.go btcjson+rpc: match bitcoind's RPC error codes for rejected transactions 2019-05-22 13:08:12 -07:00
README.md multi: Update markdown files for GFM changes. 2017-05-25 12:06:16 -05:00
register.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
register_test.go btcd/multi: fix a number of typos in comments. 2018-01-25 23:23:59 -06:00
walletsvrcmds.go btcjson: Implement addwitnessaddress functionality. 2017-09-10 23:10:46 -05:00
walletsvrcmds_test.go btcjson: Implement addwitnessaddress functionality. 2017-09-10 23:10:46 -05:00
walletsvrresults.go btcjson: Add more fields to ListTransactionsResult 2017-01-23 15:56:45 -05:00
walletsvrwscmds.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
walletsvrwscmds_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
walletsvrwsntfns.go btcd/multi: fix a number of typos in comments. 2018-01-25 23:23:59 -06:00
walletsvrwsntfns_test.go btcjson: Add more fields to ListTransactionsResult 2017-01-23 15:56:45 -05:00

README.md

btcjson

Build Status ISC License GoDoc

Package btcjson 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 btcsuite, 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 btcrpcclient 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/btcsuite/btcd/btcjson

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 btcsuite 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 btcjson is licensed under the copyfree ISC License.