Provides bitcoin-specific convenience functions and types
Find a file
Dave Collins 36377a3c8c bech32: Ensure HRP is lowercase when encoding.
BIP173 specifically calls out that encoders must always output an all
lowercase bech32 string and that the lowercase form is used when
determining a character's value for calculating the checksum.

Currently, the implementation does not respect either of those
requirements.

This modifies the Encode function to convert the provided HRP to
lowercase to ensure the requirements are satisfied and adds tests
accordingly.
2020-12-01 09:42:36 -05:00
.github/workflows build: replace travis with github ci 2020-10-26 09:48:59 -04:00
base58 base58: add new testcases from github.com/bitcoin 2020-11-24 13:21:44 -05:00
bech32 bech32: Ensure HRP is lowercase when encoding. 2020-12-01 09:42:36 -05:00
bloom Fix typo 2020-07-06 10:08:39 -04:00
coinset multi: Update markdown files for GFM changes. 2017-05-25 13:01:10 -05:00
gcs gcs/gcs: use sort.Slice instead of sort.Sort, remove uint64Slice 2019-04-25 16:57:16 -07:00
hdkeychain hdkeychain: correct BIP-32 derivation issue 2020-10-21 13:21:55 +02:00
psbt build: replace travis with github ci 2020-10-26 09:48:59 -04:00
txsort multi: Update markdown files for GFM changes. 2017-05-25 13:01:10 -05:00
.gitignore Initial commit. 2013-05-28 17:20:28 -05:00
address.go FIX: integers incorrectly encoded as a rune with append. Go no longer allows it. 2020-10-15 09:23:55 -04:00
address_test.go add test case for litecoin bech32 addresses 2020-07-13 09:59:11 -04: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 build: Add gosimple linter to goclean.sh 2017-01-11 15:38:44 -05:00
appdata_test.go Relicense to the btcsuite developers. 2015-05-01 12:41:58 -05:00
block.go Update block.go 2020-07-13 09:48:38 -04:00
block_test.go Fix OutOfRangeError checks in block_test.go 2020-07-13 09:48:38 -04:00
certgen.go build: replace travis with github ci 2020-10-26 09:48:59 -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
go.mod go.mod: bump to go 1.14, latest supported version 2020-10-26 09:48:59 -04:00
go.sum build: replace travis with github ci 2020-10-26 09:48:59 -04:00
goclean.sh build: replace travis with github ci 2020-10-26 09:48:59 -04:00
hash160.go Switch to upstream golang.org/x/crypto 2017-05-08 23:05:27 -05:00
internal_test.go build: replace travis with github ci 2020-10-26 09:48:59 -04:00
LICENSE gcs: add package for building and using Golomb-coded set filters 2018-05-15 19:14:18 -07: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 build: replace travis with github ci 2020-10-26 09:48:59 -04:00
test_coverage.txt Add PEM encode error checking 2014-12-13 10:29:36 -05:00
tx.go Fix nil pointer dereference when WitnessHash is called before HasWitness 2020-05-05 09:28:57 +05:30
tx_test.go Fix nil pointer dereference when WitnessHash is called before HasWitness 2020-05-05 09:28:57 +05:30
wif.go Update for recent chainhash-related API changes. (#78) 2016-08-08 12:38:16 -05:00
wif_test.go Improve test coverage of WIF decoder/encoder 2020-07-06 10:32:46 -04:00

btcutil

Build Status ISC License GoDoc

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.