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

Find a file

Dave Collins 25684a2ccb Don't add a genesis block by default. This commit modifies the way initial database creation is handled. Previously, the genesis for the main chain was inserted automatically upon creation of the database. However, that approach caused an issue since other networks such as the test network don't use the same genesis block as the main network. The new approach introduced by this commit is to leave it up to the caller to insert the desired genesis block. In order to support this, the InsertBlock function has been modified to allow the first (and only the first) block to be inserted without having an existing parent. Also, the NewestSha function has been modified to return a zero hash, -1 for the height, and no error when the database does not yet have any blocks. This allows the caller to determine the difference between no blocks and only the genesis block (in which case the return values would be the genesis hash and 0 for the height).		2013-07-29 11:48:10 -05:00
sqlite3	Don't add a genesis block by default.	2013-07-29 11:48:10 -05:00
.gitignore	Initial commit.	2013-05-28 19:03:53 -05:00
cov_report.sh	Add test coverage report and generate script.	2013-05-29 16:20:06 -05:00
db.go	Don't add a genesis block by default.	2013-07-29 11:48:10 -05:00
doc.go	Don't add a genesis block by default.	2013-07-29 11:48:10 -05:00
LICENSE	Initial implementation.	2013-05-29 10:09:26 -05:00
log.go	Add documentation for functions and types.	2013-05-31 15:19:34 -05:00
README.md	Don't add a genesis block by default.	2013-07-29 11:48:10 -05:00
test_coverage.txt	Add ExistsTxSha to db interface.	2013-07-10 00:11:02 +01:00

README.md

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/sqlite3"
		"github.com/conformal/btcutil"
		"github.com/conformal/btcwire"
	)

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


	// Insert the main network genesis block.
	pver := btcwire.ProtocolVersion
	genesis := btcutil.NewBlock(&btcwire.GenesisBlock, pver)
	newHeight, err := db.InsertBlock(block)
	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%
Allow other database backends

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.