lnd/chainntnfs
Olaoluwa Osuntokun 28eb8474f4
chainntnfs: modify all historical rescans to scan backwards
In this commit, we modify all existing historical rescans for
ChainNotifier backends to scan backwards rather than forwards. If we
know that a transaction has been confirmed, or outpoint spent, the it's
likely that the event has recently transpired assuming we've been
offline for a short period of time. Therefore, if we scan backwards
rather than forwards, then we can save potentially hundreds or thousands
of block fetches if the event recently happened close to the tip of the
chain.

We bound this search at the genesis block, to ensure we don't underflow
the uint32 used throughout the package in the main loop.
2018-11-24 15:50:12 -06:00
..
bitcoindnotify chainntnfs: modify all historical rescans to scan backwards 2018-11-24 15:50:12 -06:00
btcdnotify chainntnfs: modify all historical rescans to scan backwards 2018-11-24 15:50:12 -06:00
neutrinonotify chainntnfs: modify all historical rescans to scan backwards 2018-11-24 15:50:12 -06:00
height_hint_cache_test.go Revert "chainntnfs/height_hint_cache_test: add tests for disabled cache" 2018-10-31 09:20:22 -07:00
height_hint_cache.go Revert "chainntnfs/height_hint_cache: add disable flag to hint cache" 2018-10-31 09:20:22 -07:00
interface_dev.go chainntnfs: switch debug tag to dev 2018-10-05 12:59:34 +09:00
interface_test.go Revert "chainntnfs/interface_test: run tests w/ disabled cache" 2018-10-31 09:20:22 -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/txnotifer: prevent dispatching notifications within ConnectTip 2018-10-31 09:20:22 -07:00
txnotifier.go chainntnfs/txnotifer: prevent dispatching notifications within ConnectTip 2018-10-31 09:20:22 -07:00

chainntnfs

Build Status MIT licensed GoDoc

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