mirror of
https://github.com/LBRYFoundation/lbcd.git
synced 2025-09-03 12:30:14 +00:00
d574a3af6d
This commit contains the entire btcdb repository along with several changes needed to move all of the files into the database directory in order to prepare it for merging. This does NOT update btcd or any of the other packages to use the new location as that will be done separately. - All import paths in the old btcdb test files have been changed to the new location - All references to btcdb as the package name have been chagned to database - The coveralls badge has been removed since it unfortunately doesn't support coverage of sub-packages This is ongoing work toward #214.
67 lines
2 KiB
Markdown
67 lines
2 KiB
Markdown
database
|
|
========
|
|
|
|
[]
|
|
(https://travis-ci.org/btcsuite/btcd) [![ISC License]
|
|
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
|
|
|
Package database provides a database interface for the bitcoin block chain and
|
|
transactions.
|
|
|
|
## Documentation
|
|
|
|
[]
|
|
(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](http://godoc.org/github.com/btcsuite/btcd/database).
|
|
|
|
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
|
|
|
|
```bash
|
|
$ go get github.com/btcsuite/btcd/database
|
|
```
|
|
|
|
## Examples
|
|
|
|
* [CreateDB Example]
|
|
(http://godoc.org/github.com/btcsuite/btcd/database#example-CreateDB)
|
|
Demonstrates creating a new database and inserting the genesis block into it.
|
|
|
|
* [NewestSha Example]
|
|
(http://godoc.org/github.com/btcsuite/btcd/database#example-Db--NewestSha)
|
|
Demonstrates querying the database for the most recent best block height and
|
|
hash.
|
|
|
|
## 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:
|
|
```bash
|
|
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:
|
|
```bash
|
|
git tag -v TAG_NAME
|
|
```
|
|
|
|
## License
|
|
|
|
Package database is licensed under the [copyfree](http://copyfree.org) ISC
|
|
License.
|