multi: add README's for all sub-packages
This commit is contained in:
9 files changed
+267
-237
No files matched your search
@@ -0,0 +1,26 @@
|
||||
channeldb
|
||||
==========
|
||||
|
||||
[]
|
||||
(https://travis-ci.org/lightningnetwork/lnd)
|
||||
[]
|
||||
[]
|
||||
(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/boltdb/bolt), an embedded pure-go key-value stored
|
||||
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
|
||||
```
|
||||
Reference in new issue
Block a user