History

Wilmer Paulino 74139c9a3f chainntnfs/btcdnotify: remove old spend notification handling logic In this commit, we remove the old spend notification logic within the BtcdNotifier as it's been phased out by the TxNotifier.		2018-10-30 17:59:31 -07:00
..
bitcoindnotify	chainntnfs/bitcoindnotify: remove old spend notification handling logic	2018-10-30 17:59:31 -07:00
btcdnotify	chainntnfs/btcdnotify: remove old spend notification handling logic	2018-10-30 17:59:31 -07:00
neutrinonotify	chainntnfs/txnotifier: rename Register -> RegisterConf	2018-10-30 17:59:31 -07:00
height_hint_cache_test.go	chainntnfs/height_hint_cache_test: add tests for disabled cache	2018-08-26 15:32:09 -07:00
height_hint_cache.go	chainntnfs/height_hint_cache: prevent db transactions with no updates	2018-10-30 17:59:31 -07:00
interface_dev.go	chainntnfs: switch debug tag to dev	2018-10-05 12:59:34 +09:00
interface_test.go	chainntnfs/interface_test: stop UnsafeStart notifiers within test	2018-10-30 17:59:31 -07:00
interface.go	chainntnfs: extend SpendEvent with reorg channel	2018-10-30 17:59:31 -07:00
log.go	multi: init subsystem loggers via build pkg	2018-10-05 13:04:45 +09:00
README.md	multi: fix formatting issues in packge README's	2017-03-27 16:25:25 -07:00
test_utils.go	chainntnfs: switch debug tag to dev	2018-10-05 12:59:34 +09:00
txnotifier_test.go	chainntnfs/txnotifier_test: extend tests to handle spend notifications	2018-10-30 17:59:31 -07:00
txnotifier.go	chainntnfs/txnotifier: correctly update confirm/spend hints on chain updates	2018-10-30 17:59:31 -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