6e463c1634
This commit is a direct copy of the complete channeldb package. It only changes the package declaration at the top of every file. We make this full copy so that review can be focused on the actual changes made. Otherwise changes may drown in all the file moves. Linting for the new package is disabled, as it contains lots of pre-existing issues.
25 lines
1.1 KiB
Markdown
25 lines
1.1 KiB
Markdown
channeldb
|
|
==========
|
|
|
|
[![Build Status](http://img.shields.io/travis/lightningnetwork/lnd.svg)](https://travis-ci.org/lightningnetwork/lnd)
|
|
[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/lightningnetwork/lnd/blob/master/LICENSE)
|
|
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/lightningnetwork/lnd/channeldb)
|
|
|
|
The channeldb implements the persistent storage engine for `lnd` and
|
|
generically a data storage layer for the required state within the Lightning
|
|
Network. The backing storage engine is
|
|
[boltdb](https://github.com/coreos/bbolt), an embedded pure-go key-value store
|
|
based off of LMDB.
|
|
|
|
The package implements an object-oriented storage model with queries and
|
|
mutations flowing through a particular object instance rather than the database
|
|
itself. The storage implemented by the objects includes: open channels, past
|
|
commitment revocation states, the channel graph which includes authenticated
|
|
node and channel announcements, outgoing payments, and invoices
|
|
|
|
## Installation and Updating
|
|
|
|
```bash
|
|
$ go get -u github.com/lightningnetwork/lnd/channeldb
|
|
```
|