2eea55ae1d
This commit prunes several unused functions from the Db interface and the underlying implementations. For the most part these are holdovers from the original sqlite implementation. It also removes the types associated with those functions since they are no longer needed. The following functions and types have been removed: - InvalidateCache - InvalidateBlockCache - InvalidateTxCache - SetDBInsertMode - InsertMode type and associated constants - NewIterateBlocks - BlockIterator interface The reasons for removing these are broken out below. - Neither of two current implementations implement these functions nor does any of the fully functional code using the interface invoke them. - After contemplating and testing caching of blocks and transactions at this layer, it doesn't seem to provide any real benefit unless very specific assumptions about the use case are made. Making those assumptions can make other use cases worse. For example, assuming a large cache is harmful to memory-constrained use cases. Leaving it up to the caller to choose when to cache block and transactions allows much greater flexibility. - The DB insert mode was an artifact of the original sqlite implementation and probably should have only been exposed specifically on the implementation as opposed through generic interface. If a specific implementation wishes to provide functionality such as special modes, that should be done through type assertions. |
||
|---|---|---|
| ldb | ||
| memdb | ||
| testdata | ||
| .gitignore | ||
| .travis.yml | ||
| common_test.go | ||
| cov_report.sh | ||
| db.go | ||
| db_test.go | ||
| doc.go | ||
| interface_test.go | ||
| LICENSE | ||
| log.go | ||
| README.md | ||
| test_coverage.txt | ||
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/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.
genesis := btcutil.NewBlock(&btcwire.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%
- 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_NAMEis a placeholder for the specific tag:git tag -v TAG_NAME
License
Package btcdb is licensed under the liberal ISC License.