LBRYCommunity/lbcutil
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Provides bitcoin-specific convenience functions and types
74 commits 4 branches 9 tags 1,006 KiB
Go 99.4%
Shell 0.6%
Find a file
Josh Rickmar 5bcc7790a0 Update Address and WIF APIs to use btcnet. 
This change removes all occurances of btcwire.BitcoinNet from exported
APIs, replacing each with *btcnet.Params.  This simplifies the logic
for verifying string encodings of addresses and WIF private keys which
use leading identifier numbers to differentiate between address types
and the network they are intended for.  It also allows the use of this
package for non-standard networks (not mainnet, regtest, or testnet3)
and future proofs it for the possible addition of future testnet
networks.

To update across this change, replace each btcwire.BitcoinNet
parameter with the associated *btcnet.Params.  For the standard
networks, these changes are:

  btcwire.MainNet  -> &btcnet.MainNetParams
  btcwire.TestNet  -> &btcnet.RegressionNetParams
  btcwire.TestNet3 -> &btcnet.TestNet3Params

ok @davecgh
2014-05-27 17:08:45 -05:00
coinset Updated coinset interfaces to use btcutil.Amount for coin value 2014-04-23 20:04:03 -04:00
.gitignore Initial commit. 2013-05-28 17:20:28 -05:00
.travis.yml Add support for TravisCI. 2013-12-10 19:14:24 -06:00
address.go Update Address and WIF APIs to use btcnet. 2014-05-27 17:08:45 -05:00
address_test.go Update Address and WIF APIs to use btcnet. 2014-05-27 17:08:45 -05:00
amount.go Remove bounds check for NewAmount. 2014-04-12 16:20:11 -05:00
amount_test.go Remove bounds check for NewAmount. 2014-04-12 16:20:11 -05:00
appdata.go Add 2014 to copyright dates. 2014-01-08 23:46:05 -06:00
appdata_test.go Add 2014 to copyright dates. 2014-01-08 23:46:05 -06:00
base58.go Preallocate space for the answer in Base58Encode. 2014-04-16 20:43:01 -04:00
base58_test.go Add 2014 to copyright dates. 2014-01-08 23:46:05 -06:00
block.go Remove deprecated TxShas func from btcutil.Block. 2014-03-24 13:56:43 -05:00
block_test.go Remove deprecated TxShas func from btcutil.Block. 2014-03-24 13:56:43 -05:00
certgen.go Correct and improve cert generation. 2014-01-29 03:48:46 -06:00
const.go Add 2014 to copyright dates. 2014-01-08 23:46:05 -06:00
cov_report.sh Initial implementation. 2013-05-28 18:21:26 -05:00
doc.go Add 2014 to copyright dates. 2014-01-08 23:46:05 -06:00
hash160.go Add 2014 to copyright dates. 2014-01-08 23:46:05 -06:00
internal_test.go Update Address and WIF APIs to use btcnet. 2014-05-27 17:08:45 -05:00
LICENSE Initial implementation. 2013-05-28 18:21:26 -05:00
README.md Add support for TravisCI. 2013-12-10 19:14:24 -06:00
test_coverage.txt Update Address and WIF APIs to use btcnet. 2014-05-27 17:08:45 -05:00
tx.go Add 2014 to copyright dates. 2014-01-08 23:46:05 -06:00
tx_test.go Add 2014 to copyright dates. 2014-01-08 23:46:05 -06:00
wif.go Update Address and WIF APIs to use btcnet. 2014-05-27 17:08:45 -05:00
wif_test.go Update Address and WIF APIs to use btcnet. 2014-05-27 17:08:45 -05:00

README.md

btcutil

[Build Status] (https://travis-ci.org/conformal/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. 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

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

Installation

$ go get github.com/conformal/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 Conformal. 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 liberal ISC License.