History

Olaoluwa Osuntokun 6b3a258e86 multi: fix formatting issues in packge README's		2017-03-27 16:25:25 -07:00
..
btcdnotify	lnd: fix golint warning which requires to add additional comments	2017-03-13 16:30:23 -07:00
interface_test.go	lnd: fix gofmt warnings	2017-03-13 16:30:23 -07:00
interface.go	chainntnfs: add the ability to cancel spend+epoch notifications	2017-02-21 01:42:50 -08:00
log.go	lnd: partially fix golint warnings	2017-03-13 16:30:23 -07:00
README.md	multi: fix formatting issues in packge README's	2017-03-27 16:25:25 -07:00

README.md

chainntnfs

The chainntnfs package implements a set of interfaces which allow callers to receive notifications in response to specific on-chain events. The set of notifications available include:

Notifications for each new block connected to the current best chain.
Notifications once a txid has reached a specified number of confirmations.
Notifications once a target outpoint (txid:index) has been spent.

These notifications are used within lnd in order to properly handle the workflows for: channel funding, cooperative channel closures, forced channel closures, channel contract breaches, sweeping time-locked outputs, and finally pruning the channel graph.

This package is intentionally general enough to be applicable outside the specific use cases within lnd outlined above. The current sole concrete implementation of the ChainNotifier interface depends on btcd.

Installation and Updating

$ go get -u github.com/lightningnetwork/lnd/chainntnfs