diff --git a/README.md b/README.md index 2b38cf6f5..dfd8e2fa1 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,13 @@ Lnd is not yet functional, but we hope to have a proof of concept on testnet-L s Don't try to port it to mainnet or an altcoin and use it! No really. Lightning transactions will be fast, but for now, you have to wait. -## chainntfs +### chainntfs A package centered around a generic interface for receiving transaction/confirmation based notifications concerning the blockchain. Such notifications are required in order for pending payment channels to be notified once the funding transaction gains a specified number of confirmations, and in order to catch a counter-party attempting a non-cooperative close using a past commitment transaction to steal funds. At the moment, it only has a single concrete implementation: using btcd's websockets notifications. However, more implementations of the interface are planned, such as electrum, polling via JSON-RPC, Bitcoin Core's ZeroMQ notifications, and more. -## channeldb +### channeldb lnd's primary datastore. It uses a generic interface defined in [walletdb](https://godoc.org/github.com/btcsuite/btcwallet/walletdb) allowing for usage of any sotrage backend which adheres to the interface. The current concrete implementation used is driven by [bolt](https://github.com/boltdb/bolt). `channeldb` is responsible for storing state such as meta-data concerning the current open channels, closed channels, past routes we used, fee schedules within the network, and information about remote peers (ID, uptime, reputation, etc).