An alternative full node implementation of LBRY's blockchain written in Go (golang)
Go to file
Dave Collins 5290cb1186 Allow more BIP0022 fields in GetBlockTemplateCmd.
BIP0022 defines optional fields in a getblocktemplate request for long
polling and template tweaking.

In addition, for template tweaking, there are two fields, sigoplimit and
sizelimit, which are atypical in that they are allowed to be either
booleans or numeric.  This requires the fields to be represented as
interfaces which means any code making use of the struct will need to use
type assertions or a type switch.

This commit updates GetBlockTemplateCmd accordingly.

ok @jcvernaleo
2014-06-27 13:02:11 -05: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 Add support for estimatefee and estimatepriority. 2014-06-11 11:05:13 -04:00
CONTRIBUTORS Correct misspelled contributor name. 2014-05-05 22:15:37 -05:00
cov_report.sh Initial implementation. 2013-05-13 12:25:41 -04:00
doc.go Return pointers to structs 2014-05-05 17:18:22 -04:00
internal_test.go Add 2014 to copyright dates. 2014-01-08 23:49:06 -06:00
jsonapi.go Make params which reference txout indices uint32. 2014-06-16 14:44:04 -05:00
jsonapi_test.go Make params which reference txout indices uint32. 2014-06-16 14:44:04 -05:00
jsoncmd.go Allow more BIP0022 fields in GetBlockTemplateCmd. 2014-06-27 13:02:11 -05:00
jsoncmd_test.go Name field WorkID to make golint happy. 2014-06-27 00:30:37 -05:00
jsonerr.go Export a couple of peer-to-peer client errors. 2014-03-12 10:11:18 -05:00
jsonfxns.go Use NewReader instead of NewBuffer. 2014-06-05 13:52:37 -04:00
jsonfxns_test.go Add 2014 to copyright dates. 2014-01-08 23:49:06 -06:00
jsonresults.go Make params which reference txout indices uint32. 2014-06-16 14:44:04 -05:00
jsonresults_test.go Add type and handling for listreceivedbyaddress. 2014-06-10 16:25:53 -04: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 Update test coverage report. 2014-06-11 12:02:35 -05:00

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.