54 lines
1.8 KiB
Markdown
54 lines
1.8 KiB
Markdown
|
btcutil
|
||
|
|
=======
|
||
|
|
|
||
|
|
[]
|
||
|
|
(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)](http://copyfree.org)
|
||
|
|
[]
|
||
|
|
(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
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ 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:
|
||
|
|
```bash
|
||
|
|
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:
|
||
|
|
```bash
|
||
|
|
git tag -v TAG_NAME
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Package btcutil is licensed under the [copyfree](http://copyfree.org) ISC
|
||
|
|
License.
|