lnd/chainntnfs
Olaoluwa Osuntokun 08f1c2e93a
chainntfns: add new option for conf notifications to send block
In this commit, we add a new option for the existing confirmation
notification system that optionally allows the caller to specify that a
block should be included as well.

The only quirk w/ the implementation here is the neutrino backend:
usually we get filtered blocks, we so need to first fetch the block
again so we can deliver the full block to the notifier. On the notifier
end, it'll only be checking for the transactions we care about, to
sending a full block doesn't affect the correctness.

We also extend the `testBatchConfirmationNotification` test to assert
that a block is only included if the caller specifies it.
2022-08-01 19:59:21 -07:00
..
bitcoindnotify chainntfns: add new option for conf notifications to send block 2022-08-01 19:59:21 -07:00
btcdnotify chainntfns: add new option for conf notifications to send block 2022-08-01 19:59:21 -07:00
neutrinonotify chainntfns: add new option for conf notifications to send block 2022-08-01 19:59:21 -07:00
test chainntfns: add new option for conf notifications to send block 2022-08-01 19:59:21 -07:00
height_hint_cache_test.go multi: move many t.Fatalf calls to require.NoError 2022-06-17 04:26:55 +00:00
height_hint_cache.go multi: formatting and comment fixes 2022-02-10 11:02:02 +01:00
interface_dev.go multi: add golang 1.17 compatible build tags 2021-09-29 17:31:37 -07:00
interface.go chainntfns: add new option for conf notifications to send block 2022-08-01 19:59:21 -07: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 multi: move many t.Fatalf calls to require.NoError 2022-06-17 04:26:55 +00:00
txnotifier_test.go chainntfns: add new option for conf notifications to send block 2022-08-01 19:59:21 -07:00
txnotifier.go chainntfns: add new option for conf notifications to send block 2022-08-01 19:59:21 -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