An alternative full node implementation of LBRY's blockchain written in Go (golang)

Go to file

Dave Collins 16dc2cf2d0 Add errors to all interface methods. This commit adds error returns to all of the Db interface methods except for FetchTxByShaList and FetchUnSpentTxByShaList since they expose the errors on each individual transaction. It also updates all tests and code for both the leveldb and memdb drivers for the changes. Closes #5. ok @drahn		2014-07-07 12:55:46 -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 btcnet genesis params for examples and tests.	2014-05-28 01:29:51 -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	Update TODO section of README.md.	2014-07-07 09:34:41 -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

[] (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.

Note that the main Db interface is not yet finalized, so it is subject to change.

Sample Use

	// Import packages.
	import (
		"github.com/conformal/btcdb"
		_ "github.com/conformal/btcdb/ldb"
		"github.com/conformal/btcnet"
		"github.com/conformal/btcutil"
	)

	// Create a database and schedule it to be closed on exit.
	dbName := "example"
	db, err := btcdb.CreateDB("leveldb", dbName)
	if err != nil {
		// Log and handle the error
	}
	defer db.Close()


	// Insert the main network genesis block.
	genesis := btcutil.NewBlock(btcnet.MainNetParams.GenesisBlock)
	newHeight, err := db.InsertBlock(genesis)
	if err != nil {
		// Log and handle the error
	}

Documentation

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

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.