mirror of
https://github.com/lightningnetwork/lnd.git
synced 2024-11-19 09:53:54 +01:00
c602ac07e7
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). |
||
---|---|---|
.. | ||
bitcoindnotify | ||
btcdnotify | ||
neutrinonotify | ||
test | ||
errors.go | ||
interface_dev.go | ||
interface.go | ||
log.go | ||
README.md | ||
test_utils.go | ||
txnotifier_test.go | ||
txnotifier.go |
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
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