mirrors/btcd
1
0
Fork 0
mirror of https://github.com/btcsuite/btcd.git synced 2024-11-20 02:09:04 +01:00
Code Issues Projects Releases Wiki Activity
An alternative full node bitcoin implementation written in Go (golang)
124 Commits 4 Branches 66 Tags 58 MiB
Go 99.8%
Shell 0.1%
5135fd3203
Go to file
Dave Collins 5135fd3203 Allow getwork result to be a bool or JSON object. 
The getwork command alters the output depending on whether or not the
optional data parameter was specified.  It is a JSON object when no data
was provided, and a boolean indicating whether a solution was found
when data was provided.
2014-02-11 17:44:48 -06:00
.gitignore Initial commit. 2013-05-10 15:06:18 -05:00
.travis.yml Add support for TravisCI. 2013-12-10 16:30:47 -06:00
cmdhelp.go Correct getnettotals help message. 2014-02-05 10:51:59 -06:00
cov_report.sh Initial implementation. 2013-05-13 12:25:41 -04:00
doc.go Add 2014 to copyright dates. 2014-01-08 23:49:06 -06:00
internal_test.go Add 2014 to copyright dates. 2014-01-08 23:49:06 -06:00
jsonapi_test.go use bytes.Equal instead. 2014-02-04 15:40:16 -05:00
jsonapi.go Allow getwork result to be a bool or JSON object. 2014-02-11 17:44:48 -06:00
jsoncmd_test.go Correct GetWorkCmd. 2014-02-11 16:45:48 -06:00
jsoncmd.go Correct GetWorkCmd. 2014-02-11 16:45:48 -06:00
jsonerr.go Add 2014 to copyright dates. 2014-01-08 23:49:06 -06:00
jsonfxns_test.go Add 2014 to copyright dates. 2014-01-08 23:49:06 -06:00
jsonfxns.go Add 2014 to copyright dates. 2014-01-08 23:49:06 -06:00
LICENSE Add 2014 to copyright dates. 2014-01-08 23:49:06 -06:00
README.md Add support for TravisCI. 2013-12-10 16:30:47 -06:00
test_coverage.txt add newsize parameter to keypoolrefill 2014-01-22 16:20:08 +00:00

README.md

btcjson

[Build Status] (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_NAME is a placeholder for the specific tag:

    git tag -v TAG_NAME

License

Package btcjson is licensed under the liberal ISC License.