lnd.xprv/chainntnfs
Yong 582b164c46
kvdb: add timeout options for bbolt (#4787)
* mod: bump btcwallet version to accept db timeout

* btcwallet: add DBTimeOut in config

* kvdb: add database timeout option for bbolt

This commit adds a DBTimeout option in bbolt config. The relevant
functions walletdb.Open/Create are updated to use this config. In
addition, the bolt compacter also applies the new timeout option.

* channeldb: add DBTimeout in db options

This commit adds the DBTimeout option for channeldb. A new unit
test file is created to test the default options. In addition,
the params used in kvdb.Create inside channeldb_test is updated
with a DefaultDBTimeout value.

* contractcourt+routing: use DBTimeout in kvdb

This commit touches multiple test files in contractcourt and routing.
The call of function kvdb.Create and kvdb.Open are now updated with
the new param DBTimeout, using the default value kvdb.DefaultDBTimeout.

* lncfg: add DBTimeout option in db config

The DBTimeout option is added to db config. A new unit test is
added to check the default DB config is created as expected.

* migration: add DBTimeout param in kvdb.Create/kvdb.Open

* keychain: update tests to use DBTimeout param

* htlcswitch+chainreg: add DBTimeout option

* macaroons: support DBTimeout config in creation

This commit adds the DBTimeout during the creation of macaroons.db.
The usage of kvdb.Create and kvdb.Open in its tests are updated with
a timeout value using kvdb.DefaultDBTimeout.

* walletunlocker: add dbTimeout option in UnlockerService

This commit adds a new param, dbTimeout, during the creation of
UnlockerService. This param is then passed to wallet.NewLoader
inside various service calls, specifying a timeout value to be
used when opening the bbolt. In addition, the macaroonService
is also called with this dbTimeout param.

* watchtower/wtdb: add dbTimeout param during creation

This commit adds the dbTimeout param for the creation of both
watchtower.db and wtclient.db.

* multi: add db timeout param for walletdb.Create

This commit adds the db timeout param for the function call
walletdb.Create. It touches only the test files found in chainntnfs,
lnwallet, and routing.

* lnd: pass DBTimeout config to relevant services

This commit enables lnd to pass the DBTimeout config to the following
services/config/functions,
  - chainControlConfig
  - walletunlocker
  - wallet.NewLoader
  - macaroons
  - watchtower
In addition, the usage of wallet.Create is updated too.

* sample-config: add dbtimeout option
2020-12-07 15:31:49 -08:00
..
bitcoindnotify multi: move several wait group done calls to defer statements 2020-11-23 14:48:44 +01:00
btcdnotify multi: move several wait group done calls to defer statements 2020-11-23 14:48:44 +01:00
neutrinonotify Ensure chain notifier is started before accessed. 2020-04-30 12:54:33 +03:00
height_hint_cache_test.go chainntnfs: unit test disabled height hint cache behavior 2020-07-14 19:25:46 -07:00
height_hint_cache.go multi: add reset closure to kvdb.View 2020-11-05 17:57:12 +01:00
interface_dev.go chainntnfs: switch debug tag to dev 2018-10-05 12:59:34 +09:00
interface_test.go multi: update to latest btcd version 2020-12-03 11:30:22 +01:00
interface.go trivial: typo fix 2020-08-13 07:33:52 +08: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 kvdb: add timeout options for bbolt (#4787) 2020-12-07 15:31:49 -08:00
txnotifier_test.go txnotifier test: add test for confirmation after cancellation 2020-09-16 11:23:02 +02:00
txnotifier.go txnotifier: delete ntfn by confirm height always 2020-09-16 11:20:37 +02: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