016e69cd51
This commit modifies the RawCmd type to use a slice of json.RawMessages so
that unmarshalling each individual parameter can be deferred to the
handler for the command.
This is superior to the old method of using a []interface{} because it
means that each parameter is now unmarshalled into the expected concrete
type directly instead of whatever it happens to be in the JSON. Due to
this, the old behavior where every number was unmarshlled as a float64 and
converted to the appropriate final type, which could lead to odd behavior
when going through marshal/unmarshal cycles, has been eliminated. This
change also means each individual parameter can now be full blown structs
(JSON objects) that marshal and unmarshal themselves which greatly
simplifies complex parameters and removes the need for additional and
error prone code.
This commit contains a lot of changes because every command needed its
MarshalJSON and UnmarshalJSON methods updated to support the new
mechanism. As a part of changing these functions, a new common creation
function for the the RawCmd struct was added to avoid the previous
duplication of the common fields. Also, rather than repeating the method
string in each MarshJSON functon, it makes use of cmd.Method().
Finally, some of the error messages were incorrect and have been corrected
as well as made consistent.
ok @jcvernaleo, @jrick, @owainga
|
||
|---|---|---|
| .gitignore | ||
| .travis.yml | ||
| cmdhelp.go | ||
| cov_report.sh | ||
| doc.go | ||
| internal_test.go | ||
| jsonapi.go | ||
| jsonapi_test.go | ||
| jsoncmd.go | ||
| jsoncmd_test.go | ||
| jsonerr.go | ||
| jsonfxns.go | ||
| jsonfxns_test.go | ||
| LICENSE | ||
| README.md | ||
| test_coverage.txt | ||
btcjson
[
]
(https://travis-ci.org/conformal/btcjson)
Package btcjson implements the bitcoin JSON-RPC API. There is a test
suite which is aiming to reach 100% code coverage. See
test_coverage.txt for the current coverage (using gocov). On a
UNIX-like OS, the script cov_report.sh can be used to generate the
report. Package btcjson is licensed under the liberal ISC license.
This package is one of the core packages from btcd, an alternative full-node implementation of bitcoin which is under active development by Conformal. Although it was primarily written for btcd, this package has intentionally been designed so it can be used as a standalone package for any projects needing to communicate with a bitcoin client using the json rpc interface. BlockSafari is one such program that uses btcjson to communicate with btcd (or bitcoind to help test btcd).
JSON RPC
Bitcoin provides an extensive API call list to control bitcoind or bitcoin-qt through json-rpc. These can be used to get information from the client or to cause the client to perform some action.
The general form of the commands are:
{"jsonrpc": "1.0", "id":"test", "method": "getinfo", "params": []}
btcjson provides code to easily create these commands from go (as some of the commands can be fairly complex), to send the commands to a running bitcoin rpc server, and to handle the replies (putting them in useful Go data structures).
Sample Use
msg, err := btcjson.CreateMessage("getinfo")
reply, err := btcjson.RpcCommand(user, password, server, msg)
Documentation
Full go doc style documentation for the project can be viewed online without
installing this package by using the GoDoc site
here.
You can also view the documentation locally once the package is installed with
the godoc tool by running godoc -http=":6060" and pointing your browser to
http://localhost:6060/pkg/github.com/conformal/btcjson
Installation
$ go get github.com/conformal/btcjson
TODO
- Add data structures for remaining commands.
- Increase test coverage to 100%.
- Add https support.
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 Conformal. 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_NAMEis a placeholder for the specific tag:git tag -v TAG_NAME
License
Package btcjson is licensed under the liberal ISC License.