Provides bitcoin-specific convenience functions and types
Find a file
Dave Collins 0df67ee064 txsort: Add InPlaceSort function.
This adds a new function with loud warnings which allows sorting a
transaction in place by mutating it.  This is more efficient for the
caller if they are the ones creating the transaction and are sure it
will not invalid any cache or containing structures.

The Sort function which makes a copy and is therefore does not mutate
the passed transaction is still available and the default method.
2015-10-23 12:46:06 -05:00
base58 Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
bloom Return matched tx indices from NewMerkleBlock. 2015-07-28 04:02:49 -05:00
coinset Update btcwire path import paths to new location. 2015-02-05 14:48:38 -06:00
hdkeychain Fix tiny typo in docs. 2015-07-24 06:59:43 +00:00
txsort txsort: Add InPlaceSort function. 2015-10-23 12:46:06 -05:00
.gitignore Initial commit. 2013-05-28 17:20:28 -05:00
.travis.yml Use container-based builds on TravisCI. 2015-07-28 03:45:19 -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 Convert block heights to int32. 2015-08-07 22:30:27 -05:00
block_test.go Convert block heights to int32. 2015-08-07 22:30:27 -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 Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
test_coverage.txt Add PEM encode error checking 2014-12-13 10:29:36 -05:00
tx.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
tx_test.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
wif.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -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] (https://coveralls.io/repos/btcsuite/btcutil/badge.png?branch=master)] (https://coveralls.io/r/btcsuite/btcutil?branch=master)

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

Installation

$ go get 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.