fac8a9a582
The github markdown interpreter has been changed such that it no longer allows spaces in between the brackets and parenthesis of links. This updates all of the markdown files accordingly. While here, it also corrects a couple of inconsistencies in regards to other README.md files in the project. |
||
---|---|---|
base58 | ||
bloom | ||
coinset | ||
hdkeychain | ||
txsort | ||
.gitignore | ||
.travis.yml | ||
address.go | ||
address_test.go | ||
amount.go | ||
amount_test.go | ||
appdata.go | ||
appdata_test.go | ||
block.go | ||
block_test.go | ||
certgen.go | ||
certgen_test.go | ||
const.go | ||
cov_report.sh | ||
doc.go | ||
example_test.go | ||
goclean.sh | ||
hash160.go | ||
internal_test.go | ||
LICENSE | ||
net.go | ||
net_noop.go | ||
README.md | ||
test_coverage.txt | ||
tx.go | ||
tx_test.go | ||
wif.go | ||
wif_test.go |
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.