lbcd/database/ffldb
Dave Collins bd4e64d1d4 chainhash: Abstract hash logic to new package. (#729)
This is mostly a backport of some of the same modifications made in
Decred along with a few additional things cleaned up.  In particular,
this updates the code to make use of the new chainhash package.

Also, since this required API changes anyways and the hash algorithm is
no longer tied specifically to SHA, all other functions throughout the
code base which had "Sha" in their name have been changed to Hash so
they are not incorrectly implying the hash algorithm.

The following is an overview of the changes:

- Remove the wire.ShaHash type
- Update all references to wire.ShaHash to the new chainhash.Hash type
- Rename the following functions and update all references:
  - wire.BlockHeader.BlockSha -> BlockHash
  - wire.MsgBlock.BlockSha -> BlockHash
  - wire.MsgBlock.TxShas -> TxHashes
  - wire.MsgTx.TxSha -> TxHash
  - blockchain.ShaHashToBig -> HashToBig
  - peer.ShaFunc -> peer.HashFunc
- Rename all variables that included sha in their name to include hash
  instead
- Update for function name changes in other dependent packages such as
  btcutil
- Update copyright dates on all modified files
- Update glide.lock file to use the required version of btcutil
2016-08-08 14:04:33 -05:00
..
bench_test.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
blockio.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
db.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
dbcache.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
doc.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
driver.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
driver_test.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
export_test.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
interface_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
ldbtreapiter.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
mockfile_test.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
README.md database: Replace with new version. 2016-04-12 14:55:15 -05:00
reconcile.go database: Replace with new version. 2016-04-12 14:55:15 -05:00
whitebox_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00

ffldb

[Build Status] (https://travis-ci.org/btcsuite/btcd)

Package ffldb implements a driver for the database package that uses leveldb for the backing metadata and flat files for block storage.

This driver is the recommended driver for use with btcd. It makes use leveldb for the metadata, flat files for block storage, and checksums in key areas to ensure data integrity.

Package ffldb is licensed under the copyfree ISC license.

Usage

This package is a driver to the database package and provides the database type of "ffldb". The parameters the Open and Create functions take are the database path as a string and the block network.

db, err := database.Open("ffldb", "path/to/database", wire.MainNet)
if err != nil {
	// Handle error
}
db, err := database.Create("ffldb", "path/to/database", wire.MainNet)
if err != nil {
	// Handle error
}

Documentation

[GoDoc] (http://godoc.org/github.com/btcsuite/btcd/database/ffldb)

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/btcsuite/btcd/database/ffldb

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/btcsuite/btcd/database/ffldb

License

Package ffldb is licensed under the copyfree ISC License.