2f0639f1af
This commit modifies two of the main methods in the ChainNotifier interface to be more light client friendly. In order to do so, we now tack on an extra parameter to the methods: heightHint. This value represents the earliest known height that the chain should be scanned when attempting to do a dispatch from historical data. All tests have also been updated to use these new parameters properly when excising the expected behavior of each interface implementation. |
||
|---|---|---|
| .. | ||
| btcdnotify | ||
| interface_test.go | ||
| interface.go | ||
| log.go | ||
| 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
txidhas 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