github.com/decred/dcrlnd@v0.7.6/chainntnfs/README.md (about)

     1  chainntnfs
     2  ==========
     3  
     4  [![Build Status](http://img.shields.io/travis/decred/dcrlnd.svg)](https://travis-ci.org/decred/dcrlnd) 
     5  [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/decred/dcrlnd/blob/master/LICENSE)
     6  [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/decred/dcrlnd/chainntnfs)
     7  
     8  The chainntnfs package implements a set of interfaces which allow callers to
     9  receive notifications in response to specific on-chain events. The set of
    10  notifications available include: 
    11  
    12    * Notifications for each new block connected to the current best chain.
    13    * Notifications once a `txid` has reached a specified number of
    14      confirmations.
    15    * Notifications once a target outpoint (`txid:index:tree`) has been spent.
    16  
    17  These notifications are used within `dcrlnd` in order to properly handle the
    18  workflows for: channel funding, cooperative channel closures, forced channel
    19  closures, channel contract breaches, sweeping time-locked outputs, and finally
    20  pruning the channel graph. 
    21  
    22  This package is intentionally general enough to be applicable outside the
    23  specific use cases within `dcrlnd` outlined above. The current sole concrete
    24  implementation of the `ChainNotifier` interface depends on `dcrd`.
    25  
    26  ## Installation and Updating
    27  
    28  ```bash
    29  $ go get -u github.com/decred/dcrlnd/chainntnfs
    30  ```