Provides bitcoin-specific convenience functions and types
Go to file
Dave Collins 2539ca9860 Fix hdkeychain to avoid zeroing net version bytes.
This commit corrects the Zero function in hdkeychain to nil the version
instead of zeroing the bytes.  This is necessary because the keys are
holding onto a reference into the specific version bytes for the network
as provided by the btcnet package.  Zeroing them causes the bytes in the
btcnet package to be zeroed which then leads to issues later when trying
to use them.

Also, to prevent regressions, new tests have been added to exercise this
scenario.

Pointed out by @jimmysong.
2014-09-08 14:30:56 -05:00
bloom Update test coverage report. 2014-09-01 21:16:08 -05:00
coinset Add TravisCI build status badge to subpackages. 2014-07-09 20:47:32 -05:00
hdkeychain Fix hdkeychain to avoid zeroing net version bytes. 2014-09-08 14:30:56 -05:00
.gitignore Initial commit. 2013-05-28 17:20:28 -05:00
.travis.yml Add support for TravisCI. 2013-12-10 19:14:24 -06:00
address.go goimports -w . 2014-07-02 19:29:48 -05:00
address_test.go Update Address and WIF APIs to use btcnet. 2014-05-27 17:08:45 -05:00
amount.go Make amount constants untyped. 2014-07-08 11:13:12 -05:00
amount_test.go Make amount constants untyped. 2014-07-08 11:13:12 -05:00
appdata.go Add 2014 to copyright dates. 2014-01-08 23:46:05 -06:00
appdata_test.go goimports -w . 2014-07-02 19:29:48 -05:00
base58.go Preallocate space for the answer in Base58Encode. 2014-04-16 20:43:01 -04:00
base58_test.go goimports -w . 2014-07-02 19:29:48 -05:00
block.go goimports -w . 2014-07-02 19:29:48 -05:00
block_test.go goimports -w . 2014-07-02 19:29:48 -05:00
certgen.go Made App Engine runtime compatible. 2014-08-30 15:10:29 -05:00
const.go Make amount constants untyped. 2014-07-08 11:13:12 -05:00
cov_report.sh Initial implementation. 2013-05-28 18:21:26 -05:00
doc.go Add 2014 to copyright dates. 2014-01-08 23:46:05 -06:00
hash160.go goimports -w . 2014-07-02 19:29:48 -05:00
internal_test.go Update Address and WIF APIs to use btcnet. 2014-05-27 17:08:45 -05:00
LICENSE Initial implementation. 2013-05-28 18:21:26 -05:00
net.go Made App Engine runtime compatible. 2014-08-30 15:10:29 -05:00
net_noop.go Made App Engine runtime compatible. 2014-08-30 15:10:29 -05:00
README.md Use a more specific license adjective in README.md. 2014-07-09 20:39:11 -05:00
test_coverage.txt Update test coverage report. 2014-06-24 18:46:12 -05:00
tx.go goimports -w . 2014-07-02 19:29:48 -05:00
tx_test.go goimports -w . 2014-07-02 19:29:48 -05:00
wif.go Update Address and WIF APIs to use btcnet. 2014-05-27 17:08:45 -05:00
wif_test.go Update Address and WIF APIs to use btcnet. 2014-05-27 17:08:45 -05:00

btcutil

[Build Status] (https://travis-ci.org/conformal/btcutil)

Package btcutil provides bitcoin-specific convenience functions and types. A comprehensive suite of tests is provided to ensure proper functionality. See test_coverage.txt for the gocov coverage report. Alternatively, if you are running a POSIX OS, you can run the cov_report.sh script for a real-time report. Package btcutil is licensed under the liberal ISC license.

This package was developed for 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 the functionality provided.

Documentation

[GoDoc] (http://godoc.org/github.com/conformal/btcutil)

Full go doc style documentation for the project can be viewed online without installing this package by using the GoDoc site here: http://godoc.org/github.com/conformal/btcutil

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/btcutil

Installation

$ go get github.com/conformal/btcutil

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