lnd/chainntnfs
habibitcoin 0b1e881d18
scripted-diff: replace ⛰ emoji with $ [skip ci]
-BEGIN VERIFY SCRIPT-
sed -i 's/⛰/$/g' $(git grep -l '⛰')
-END VERIFY SCRIPT-
2022-10-28 12:06:49 -04:00
..
bitcoindnotify chainntnfs: replace defer cleanup with t.Cleanup 2022-10-13 17:01:35 +08:00
btcdnotify chainntnfs: replace defer cleanup with t.Cleanup 2022-10-13 17:01:35 +08:00
neutrinonotify multi: fix make fmt 2022-08-23 22:10:24 +08:00
test chainntnfs: replace defer cleanup with t.Cleanup 2022-10-13 17:01:35 +08:00
height_hint_cache_test.go chainntnfs: use T.TempDir to create temporary test directory 2022-08-24 08:58:16 +08: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 scripted-diff: replace ⛰ emoji with $ [skip ci] 2022-10-28 12:06:49 -04:00
test_utils.go chainntnfs: replace defer cleanup with t.Cleanup 2022-10-13 17:01:35 +08:00
txnotifier_test.go chainntfns: add new option for conf notifications to send block 2022-08-01 19:59:21 -07:00
txnotifier.go multi: fix make fmt 2022-08-23 22:10:24 +08: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