flip/dcrd

mirror of https://github.com/FlipsideCrypto/dcrd.git synced 2026-02-06 19:06:51 +00:00

History

Dave Collins 40d778dd2d docs: Make various README.md files consistent. Upstream commit `3942a116e4` This merge also includes a few Decred specific modifications and corrects some old btcjson references that should have been updated to dcrjson.		2016-05-20 16:00:12 -05:00
..
ldb	Add reverse order option to searchrawtransactions rpc	2016-05-17 17:26:53 -05:00
memdb	Add reverse order option to searchrawtransactions rpc	2016-05-17 17:26:53 -05:00
common_test.go	Revert sync merge	2016-03-08 22:16:06 -05:00
cov_report.sh	Import btcdb repo into database directory.	2015-01-27 13:15:15 -06:00
db_test.go	Initial Decred Commit.	2016-02-07 14:00:12 -05:00
db.go	Add reverse order option to searchrawtransactions rpc	2016-05-17 17:26:53 -05:00
doc.go	Initial Decred Commit.	2016-02-07 14:00:12 -05:00
example_test.go	Initial Decred Commit.	2016-02-07 14:00:12 -05:00
interface_test.go	Revert sync merge	2016-03-08 22:16:06 -05:00
log.go	Initial Decred Commit.	2016-02-07 14:00:12 -05:00
README.md	docs: Make various README.md files consistent.	2016-05-20 16:00:12 -05:00
reorg_test.go	Revert sync merge	2016-03-08 22:16:06 -05:00

README.md

database

[] (https://travis-ci.org/decred/dcrd) ![ISC License] (http://img.shields.io/badge/license-ISC-blue.svg) [] (http://godoc.org/github.com/decred/dcrd/database)

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

Please note that this package is intended to enable dcrd 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 dcrd.

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

Installation and Updating

$ go get -u github.com/decred/dcrd/database

Examples

[CreateDB Example] (http://godoc.org/github.com/decred/dcrd/database#example-CreateDB)
Demonstrates creating a new database and inserting the genesis block into it.
[NewestSha Example] (http://godoc.org/github.com/decred/dcrd/database#example-Db--NewestSha)
Demonstrates querying the database for the most recent best block height and hash.

TODO

Increase test coverage to 100%

License

Package database is licensed under the copyfree ISC License.