History

Oliver Gugger 02267565fe multi: unify code blocks in READMEs		2021-01-22 09:14:11 +01:00
..
bitcoindnotify	multi: move several wait group done calls to defer statements	2020-11-23 14:48:44 +01:00
btcdnotify	multi: move several wait group done calls to defer statements	2020-11-23 14:48:44 +01:00
neutrinonotify	Ensure chain notifier is started before accessed.	2020-04-30 12:54:33 +03:00
test	chainntnfs/test: parallelize iface tests by backend	2020-12-10 20:56:10 -08:00
height_hint_cache_test.go	chainntnfs: unit test disabled height hint cache behavior	2020-07-14 19:25:46 -07:00
height_hint_cache.go	multi: add reset closure to kvdb.View	2020-11-05 17:57:12 +01:00
interface_dev.go	chainntnfs: switch debug tag to dev	2018-10-05 12:59:34 +09:00
interface.go	trivial: typo fix	2020-08-13 07:33:52 +08:00
log.go	multi: init subsystem loggers via build pkg	2018-10-05 13:04:45 +09:00
README.md	multi: unify code blocks in READMEs	2021-01-22 09:14:11 +01:00
test_utils.go	kvdb: add timeout options for bbolt (#4787 )	2020-12-07 15:31:49 -08:00
txnotifier_test.go	txnotifier test: add test for confirmation after cancellation	2020-09-16 11:23:02 +02:00
txnotifier.go	txnotifier: delete ntfn by confirm height always	2020-09-16 11:20:37 +02: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