This is a fork of github.com/btcsuite/btcd aimed at eliminating the tangle and complexity of its structure and make it more amenable to reuse as a part of another application, as well as easier reuse of its parts.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Loki Verloren de4daa7ba9 huge cleanup 6 months ago
..
cmd/dbtool lots of test fixes 6 months ago
ffldb huge cleanup 6 months ago
internal/treap migrated 7 months ago
testdata database: Replace with new version. 3 years ago
README.md migrated 7 months ago
doc.go database: Update overview documentation in doc.go. 2 years ago
driver.go migrated 7 months ago
driver_test.go because long error prone change 6 months ago
error.go database: Replace with new version. 3 years ago
error_test.go because long error prone change 6 months ago
example_test.go yuge but now bug with receiving messages 6 months ago
export_test.go database: Replace with new version. 3 years ago
interface.go finished moving tx out 6 months ago
log.go migrated 7 months ago

README.md

database

Build Status ISC License GoDoc

Package database provides a block and metadata storage database.

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 rpcclient package which makes use of the JSON-RPC API.

However, this package could be extremely useful for any applications requiring Bitcoin block storage capabilities.

The default backend, ffldb, has a strong focus on speed, efficiency, and robustness. It makes use of leveldb for the metadata, flat files for block storage, and strict checksums in key areas to ensure data integrity.

Feature Overview

  • Key/value metadata store
  • Bitcoin block storage
  • Efficient retrieval of block headers and regions (transactions, scripts, etc)
  • Read-only and read-write transactions with both manual and managed modes
  • Nested buckets
  • Iteration support including cursors with seek capability
  • Supports registration of backend databases
  • Comprehensive test coverage

Installation and Updating

$ go get -u git.parallelcoin.io/dev/btcd/database

Examples

  • Basic Usage Example
    Demonstrates creating a new database and using a managed read-write transaction to store and retrieve metadata.

  • Block Storage and Retrieval Example
    Demonstrates creating a new database, using a managed read-write transaction to store a block, and then using a managed read-only transaction to fetch the block.

License

Package database is licensed under the copyfree ISC License.