23db973afa
In this commit, we add two new package level functions: `EncodeM`, and `DecodeGeneric`. The new encode method is intended to allow callers to specify that they want to use the new bech32m checksum. This should be used when encoding segwit addresses with version 1 and beyond. The new `DecodeGeneric` function allows a caller to decode a bech32 and bech32m string with a single function. A new return value is added which is the version of the returned bech32 string, which allows callers to perform additional segwit addr validation (v1+ should use bech32m etc). We opted to add new functions rather than modifying the existing functions to not cause a breaking API change, as most uses in the wild can just use the existing functions, and only taproot related logic/code needs to worry about the new methods. A series of tests have been added to ensure that `DecodeGeneric` extracts the proper bech version, and we've also adopted the bech32m tests from BIP 350. |
||
|---|---|---|
| .github/workflows | ||
| base58 | ||
| bech32 | ||
| bloom | ||
| coinset | ||
| gcs | ||
| hdkeychain | ||
| psbt | ||
| txsort | ||
| .gitignore | ||
| 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 | ||
| go.mod | ||
| go.sum | ||
| 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_NAMEis a placeholder for the specific tag:git tag -v TAG_NAME
License
Package btcutil is licensed under the copyfree ISC License.