lnd/chainntnfs
positiveblue c602ac07e7
chainntnfs: move cache implementation to channeldb
This commit moves the `HeightHintCache` implementation to the
`channeldb` package and inverts the dependency relation between
`chainntnfs` and `channeldb`.

Many packages depend on channeldb for type definitions,
interfaces, etc. `chainntnfs` is an example of that. `chainntnfs`
defines the  `SpendHintCache` and `ConfirmHintCache` interfaces but
it also implments them (`HeightHintCache` struct). The implementation
uses logic that should not leak from channeldb (ex: bucket paths).
This makes our code highly coupled + it would not allow us to use any
of these interfaces in a package that is imported by `channeldb`
(circular dependency).
2023-01-16 03:13:17 -08:00
..
bitcoindnotify chainntnfs: move cache implementation to channeldb 2023-01-16 03:13:17 -08:00
btcdnotify chainntnfs: move cache implementation to channeldb 2023-01-16 03:13:17 -08:00
neutrinonotify multi: don't access loop variables in goroutines 2022-11-21 13:54:23 +01:00
test chainntnfs: move cache implementation to channeldb 2023-01-16 03:13:17 -08:00
errors.go chainntnfs: move cache implementation to channeldb 2023-01-16 03:13:17 -08:00
interface_dev.go multi: add golang 1.17 compatible build tags 2021-09-29 17:31:37 -07:00
interface.go chainntnfs: move cache implementation to channeldb 2023-01-16 03:13:17 -08: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 chainntnfs: move cache implementation to channeldb 2023-01-16 03:13:17 -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