LBRYCommunity/lbcutil
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Provides bitcoin-specific convenience functions and types
22 commits 4 branches 9 tags 1,006 KiB
Go 99.4%
Shell 0.6%
Find a file
Dave Collins e402c62673 Add new Tx wrapper for btcwire.MsgTx. 
Currently, transaction hash caching is provided via Block directly, but a
transaction is not always part of a block and there are several cases
where only the transaction needs to be dealt with without wanting to pass
the entire block and transaction index around to be able to get at the
cached hash.

So, this commit adds a new type named Tx which is a wrapper that provides
easier and more efficient manipulation of raw wire protocol transactions.
It memoizes the hash for the transaction on its first access so subsequent
accesses don't have to repeat the relatively expensive hashing operations.
The idea is the callers can pass around pointers to these Tx types instead
of raw btcwire.MsgTx pointers.

For now, the Block API has not been changed, but the plan is to change it
to provide access to these wrapped transactions rather than having it do
the transaction hash caching directly.

This is only the first part of a series of changes working towards
optimizations noted in conformal/btcd#25.
2013-10-27 13:55:51 -05:00
.gitignore Initial commit. 2013-05-28 17:20:28 -05:00
addrconvs.go Encode and decode addresses with a btcwire.BitcoinNet, not a byte. 2013-10-08 13:00:41 -04:00
addrconvs_test.go Encode and decode addresses with a btcwire.BitcoinNet, not a byte. 2013-10-08 13:00:41 -04:00
base58.go Update comments to use proper form. 2013-08-06 12:40:08 -05:00
base58_test.go Fixed license statment on base58 files. 2013-06-13 13:09:51 -04:00
block.go Remove dependency on protocol version. 2013-08-05 16:28:55 -05:00
block_test.go Allow var def to infer type from right-hand side. 2013-08-06 12:37:20 -05:00
cov_report.sh Initial implementation. 2013-05-28 18:21:26 -05:00
doc.go Add new Tx wrapper for btcwire.MsgTx. 2013-10-27 13:55:51 -05:00
internal_test.go Remove dependency on protocol version. 2013-08-05 16:28:55 -05:00
LICENSE Initial implementation. 2013-05-28 18:21:26 -05:00
README.md Update README.md test coverage. 2013-05-30 12:52:51 -05:00
test_coverage.txt Update test coverage file 2013-10-08 13:14:04 -04:00
tx.go Add new Tx wrapper for btcwire.MsgTx. 2013-10-27 13:55:51 -05:00

README.md

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.