Provides bitcoin-specific convenience functions and types
Find a file
Dave Collins 22c91fa80a Update for recent chainhash-related API changes. (#78)
This updates all code in the main package and subpackages to make use of
the new chainhash package since the old wire.ShaHash type and functions
have been removed in favor of the abstracted package.

Also, since this required API changes anyways and the hash algorithm is
no longer tied specifically to SHA, all other functions throughout the
code base which had "Sha" in their name have been changed to Hash so
they are not incorrectly implying the hash algorithm.

The following is an overview of the changes:

- Update all references to wire.ShaHash to the new chainhash.Hash type
- Rename the following functions and update all references:
  - Block.Sha -> Hash
  - Block.TxSha -> TxHash
  - Tx.Sha -> Hash
  - bloom.Filter.AddShaHash -> AddHash
- Rename all variables that included sha in their name to include hash
  instead
- Add license headers to coinset package files
2016-08-08 12:38:16 -05:00
base58 docs: Make various README.md files consistent. 2015-10-23 17:17:38 -05:00
bloom Update for recent chainhash-related API changes. (#78) 2016-08-08 12:38:16 -05:00
coinset Update for recent chainhash-related API changes. (#78) 2016-08-08 12:38:16 -05:00
hdkeychain Update for recent chainhash-related API changes. (#78) 2016-08-08 12:38:16 -05:00
txsort Update for recent chainhash-related API changes. (#78) 2016-08-08 12:38:16 -05:00
.gitignore Initial commit. 2013-05-28 17:20:28 -05:00
.travis.yml TravisCI: Remove external go vet reference. (#74) 2016-04-07 13:25:49 -05:00
address.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
address_test.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
amount.go Update docs for NewAmount 2015-08-12 07:01:50 +00:00
amount_test.go Fix tiny typo 2015-07-20 11:20:46 +00:00
appdata.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
appdata_test.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
block.go Update for recent chainhash-related API changes. (#78) 2016-08-08 12:38:16 -05:00
block_test.go Update for recent chainhash-related API changes. (#78) 2016-08-08 12:38:16 -05:00
certgen.go Add Common Name to certificate. 2015-06-15 16:14:08 -04:00
certgen_test.go Add Common Name to certificate. 2015-06-15 16:14:08 -04:00
const.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
cov_report.sh Initial implementation. 2013-05-28 18:21:26 -05:00
doc.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
example_test.go Add testable example for UnitConversions 2015-07-22 21:20:10 +00:00
goclean.sh Use container-based builds on TravisCI. 2015-07-28 03:45:19 -05:00
hash160.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
internal_test.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
LICENSE Initial implementation. 2013-05-28 18:21:26 -05:00
net.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
net_noop.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
README.md docs: Make various README.md files consistent. 2015-10-23 17:17:38 -05:00
test_coverage.txt Add PEM encode error checking 2014-12-13 10:29:36 -05:00
tx.go Update for recent chainhash-related API changes. (#78) 2016-08-08 12:38:16 -05:00
tx_test.go Update for recent chainhash-related API changes. (#78) 2016-08-08 12:38:16 -05:00
wif.go Update for recent chainhash-related API changes. (#78) 2016-08-08 12:38:16 -05:00
wif_test.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00

btcutil

[Build Status] (https://travis-ci.org/btcsuite/btcutil) [![Coverage Status] (http://img.shields.io/coveralls/btcsuite/btcutil.svg)] (https://coveralls.io/r/btcsuite/btcutil?branch=master) ![ISC License] (http://img.shields.io/badge/license-ISC-blue.svg) [GoDoc] (http://godoc.org/github.com/btcsuite/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.

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.

Installation and Updating

$ go get -u github.com/btcsuite/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 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 btcutil is licensed under the copyfree ISC License.