LBRYCommunity/lbcd
1
0
Fork 0
Code Issues 17 Pull requests 4 Projects Releases 28 Packages Wiki Activity
An alternative full node implementation of LBRY's blockchain written in Go (golang)
136 commits 9 branches 35 tags 20 MiB
Go 99.9%
Shell 0.1%
Find a file
Dave Collins 9ed908f44a Use testable example and update README.md. 
This commit moves the example to a test file so it integrates nicely with
Go's example tooling.

This allows the example output to be tested as a part of running the
normal Go tests to help ensure it doesn't get out of date with the code.
It is also nice to have the example in one place rather than repeating it
in doc.go and README.md.

Links and information about the example have been included in README.md in
place of the example.
2014-07-08 08:47:18 -05:00
ldb Add errors to all interface methods. 2014-07-07 12:55:46 -05:00
memdb Add errors to all interface methods. 2014-07-07 12:55:46 -05:00
testdata Move testdata to root btcd directory. 2013-10-12 01:49:57 -05:00
.gitignore Initial commit. 2013-05-28 19:03:53 -05:00
.travis.yml Add support for TravisCI. 2013-12-10 19:17:59 -06:00
common_test.go goimports -w . 2014-07-02 19:47:24 -05:00
cov_report.sh Switch test coverage tool to new 'go tool cover'. 2014-01-19 02:35:41 -06:00
db.go Add errors to all interface methods. 2014-07-07 12:55:46 -05:00
db_test.go goimports -w . 2014-07-02 19:47:24 -05:00
doc.go Use testable example and update README.md. 2014-07-08 08:47:18 -05:00
example_test.go Use testable example and update README.md. 2014-07-08 08:47:18 -05:00
interface_test.go Add errors to all interface methods. 2014-07-07 12:55:46 -05:00
LICENSE Add 2014 to copyright dates. 2014-01-08 23:54:52 -06:00
log.go goimports -w . 2014-07-02 19:47:24 -05:00
README.md Use testable example and update README.md. 2014-07-08 08:47:18 -05:00
test_coverage.txt Switch test coverage tool to new 'go tool cover'. 2014-01-19 02:35:41 -06:00

README.md

btcdb

[Build Status] (https://travis-ci.org/conformal/btcdb)

Package btcdb provides a database interface for the bitcoin block chain and transactions. There is a test suite with a high percentage of code coverage. See test_coverage.txt for the current coverage (using gocov). Alternatively, if you are running a POSIX OS, you can run the cov_report.sh script for a real-time report. Package btcdb is licensed under the liberal ISC license.

Documentation

[GoDoc] (http://godoc.org/github.com/conformal/btcdb)

Full go doc style documentation for the project can be viewed online without installing this package by using the GoDoc site here.

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/btcdb

Installation

$ go get github.com/conformal/btcdb

Examples

TODO

  • Increase test coverage to 100%

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 btcdb is licensed under the liberal ISC License.