History

Valentine Wallace b3a5b3b576 chainntnfs: add ChainNotifier test interface for test methods TestChainNotifier wraps the ChainNotifier interface to allow adding additional testing methods with access to private fields in the notifiers. These testing methods are only compiled when the build tag "debug" is set. UnsafeStart allows starting a notifier with a specified best block. UnsafeStart is useful for the purpose of testing cases where a notifier's best block is out of date when it receives a new block.		2018-08-11 22:45:03 -07:00
..
bitcoindnotify	chainntnfs: add ChainNotifier test interface for test methods	2018-08-11 22:45:03 -07:00
btcdnotify	chainntnfs: add ChainNotifier test interface for test methods	2018-08-11 22:45:03 -07:00
neutrinonotify	chainntnfs: add ChainNotifier test interface for test methods	2018-08-11 22:45:03 -07:00
interface_debug.go	chainntnfs: add ChainNotifier test interface for test methods	2018-08-11 22:45:03 -07:00
interface_test.go	multi: update to latest RegisterBlockEpochNtfn interface	2018-08-10 01:08:57 -07:00
interface.go	chainntnfs: enable notifiers to catch up on missed blocks	2018-08-10 01:08:58 -07:00
log.go	lnd: remove seelog logger	2017-06-25 14:19:56 +01:00
queue_test.go	chainntnfs: Implement unbounded concurrent-safe FIFO queue.	2017-11-16 15:15:22 -08:00
queue.go	chainntnfs: Implement unbounded concurrent-safe FIFO queue.	2017-11-16 15:15:22 -08:00
README.md	multi: fix formatting issues in packge README's	2017-03-27 16:25:25 -07:00
txconfnotifier_test.go	chainntnfs/txconfnotifier: make confirmation notifcation registration async	2018-07-31 18:23:25 -07:00
txconfnotifier.go	chainntnfs/txconfnotifier: make confirmation notifcation registration async	2018-07-31 18:23: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