60 lines
1.7 KiB
Markdown
60 lines
1.7 KiB
Markdown
btcdb
|
|
=====
|
|
|
|
Package btcdb provides a database interface for the bitcoin block chain and
|
|
transactions. There is a test suite which is aiming to reach 100% code coverage
|
|
coverage. See `test_coverage.txt` for the current coverage (using gocov). On a
|
|
UNIX-like OS, the script `cov_report.sh` can be used to generate the report.
|
|
Package btcjson is licensed under the liberal ISC license.
|
|
|
|
## Sample Use
|
|
|
|
```Go
|
|
db, err := btcdb.CreateDB("sqlite", "dbexample")
|
|
newHeight, err := db.InsertBlock(block)
|
|
db.Sync()
|
|
```
|
|
|
|
## Documentation
|
|
|
|
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/conformal/btcdb).
|
|
|
|
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/conformal/btcdb
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
$ go get github.com/conformal/btcdb
|
|
```
|
|
|
|
## TODO
|
|
- Increase test coverage to 100%
|
|
- Allow other database backends
|
|
|
|
## 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 btcdb is licensed under the liberal ISC License.
|