akovalenko/lnd.xprv
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
d7a050b353
lnd.xprv/chainntnfs
History
Trevin Hofmann a13ac90d46 multi: add link to LICENSE in README license badges (#100)
2017-01-12 16:31:08 -08:00
..
btcdnotify chainntnfs: break out of loop once txIndex is found 2017-01-11 15:51:19 -08:00
interface_test.go multi: update btcsuite API's to latest upstream changes 2017-01-05 13:56:34 -08:00
interface.go multi: update btcsuite API's to latest upstream changes 2017-01-05 13:56:34 -08:00
log.go chainntnfs: add cross interface implementation tests 2016-09-01 19:13:10 -07:00
README.md multi: add link to LICENSE in README license badges (#100) 2017-01-12 16:31:08 -08:00

README.md

chainntnfs

[Build Status] (https://travis-ci.org/lightningnetwork/lnd) [MIT licensed] (https://github.com/lightningnetwork/lnd/blob/master/LICENSE) [GoDoc] (http://godoc.org/github.com/lightningnetwork/lnd/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