lbcd/database
Alex Akselrod ead39153af Fix #303 and #346 and change addrindex sort order
Fix #303 by changing the addrindex key prefix to 3 characters so that
it's easy to check length when dropping the index. To drop the old
index, check to make sure we aren't dropping any entries that end in
"sx" or "tx" as those aren't part of the addrindex. Update test to
deal with the new prefix length.

Fix #346 by changing the pointers in the mempool's addrindex map to
wire.ShaHash 32-byte values. This lets them be deleted even if the
transaction data changes places in memory upon expanding the maps.

Change the way addrindex uint32s are stored to big-endian in order to
sort the transactions on disk in chronological/dependency order.

Change the "searchrawtransactions" RPC call to return transactions
from the database before the memory pool so that they're returned in
order. This commit DOES NOT do topological sorting of the memory pool
transactions to ensure they're returned in dependency order. This may
be a good idea for a future enhancement.

Add addrindex versioning to automatically drop the old/incompatible
version of the index and rebuild with the new sort method and key
prefix.
2015-03-23 13:05:54 -04:00
..
ldb Fix #303 and #346 and change addrindex sort order 2015-03-23 13:05:54 -04:00
memdb Update btcnet path import paths to new location. 2015-02-05 23:24:53 -06:00
testdata Import btcdb repo into database directory. 2015-01-27 13:15:15 -06:00
common_test.go Update btcnet path import paths to new location. 2015-02-05 23:24:53 -06:00
cov_report.sh Import btcdb repo into database directory. 2015-01-27 13:15:15 -06:00
db.go Fix #303 and #346 and change addrindex sort order 2015-03-23 13:05:54 -04:00
db_test.go Import btcdb repo into database directory. 2015-01-27 13:15:15 -06:00
doc.go Import btcdb repo into database directory. 2015-01-27 13:15:15 -06:00
example_test.go Update btcnet path import paths to new location. 2015-02-05 23:24:53 -06:00
interface_test.go Update btcwire path import paths to new location. 2015-02-05 15:16:39 -06:00
log.go Import btcdb repo into database directory. 2015-01-27 13:15:15 -06:00
README.md Clarify how the database package is used. 2015-01-27 18:58:27 -06:00

database

[Build Status] (https://travis-ci.org/btcsuite/btcd) ![ISC License] (http://img.shields.io/badge/license-ISC-blue.svg)

Package database provides a database interface for the bitcoin block chain and transactions.

Please note that this package is intended to enable btcd to support different database backends and is not something that a client can directly access as only one entity can have the database open at a time (for most database backends), and that entity will be btcd.

When a client wants programmatic access to the data provided by btcd, they'll likely want to use the btcrpcclient package which makes use of the [JSON-RPC API] (https://github.com/btcsuite/btcd/tree/master/docs/json_rpc_api.md).

Documentation

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

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

Installation

$ go get github.com/btcsuite/btcd/database

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 database is licensed under the copyfree ISC License.