LBRYCommunity/lbcutil
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Provides bitcoin-specific convenience functions and types
15 commits 4 branches 9 tags 1,006 KiB
Go 99.4%
Shell 0.6%
Find a file
Dave Collins 43095c66bc Remove dependency on protocol version. 
This commit unfortunately changes the public API of Block which I
ordinarily don't like to do, but in this case, I felt it was necessary.

The blocks used throughout the database and elsewhere should be indepedent
of the protocol version which is used to encode the block to wire format.
Each block has its own Version field which should be the deciding factor
for the serialization and deserialization of blocks.  In practice, they
are currently the same encoding, but that may not always be the case, and
it's important the blocks are stable depending on their own version
regardless of the protocol version.

This makes use of the new Serialize and Deserialize functions on MsgBlock
which are intended for long-term storage as opposed to wire encoding.
2013-08-05 16:28:55 -05:00
.gitignore Initial commit. 2013-05-28 17:20:28 -05:00
base58.go Fixed license statment on base58 files. 2013-06-13 13:09:51 -04: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 Remove dependency on protocol version. 2013-08-05 16:28:55 -05:00
cov_report.sh Initial implementation. 2013-05-28 18:21:26 -05:00
doc.go Add Base58Encode and Base58Decode functions. ok davec@ 2013-06-13 13:01:46 -04: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 Add Base58Encode and Base58Decode functions. ok davec@ 2013-06-13 13:01:46 -04: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.