2016-01-06 13:03:17 -08:00
|
|
|
package btcdnotify
|
|
|
|
|
|
|
|
import (
|
|
|
|
"container/heap"
|
|
|
|
"sync"
|
|
|
|
"sync/atomic"
|
2016-02-26 16:30:14 -08:00
|
|
|
"time"
|
2016-01-06 13:03:17 -08:00
|
|
|
|
2016-08-03 22:13:10 -07:00
|
|
|
"github.com/lightningnetwork/lnd/chainntnfs"
|
2016-05-15 07:17:44 -07:00
|
|
|
"github.com/roasbeef/btcd/btcjson"
|
|
|
|
"github.com/roasbeef/btcd/wire"
|
|
|
|
"github.com/roasbeef/btcrpcclient"
|
|
|
|
"github.com/roasbeef/btcutil"
|
2016-01-06 13:03:17 -08:00
|
|
|
)
|
|
|
|
|
2016-08-03 22:13:10 -07:00
|
|
|
const (
|
|
|
|
|
|
|
|
// notifierType uniquely identifies this concrete implementation of the
|
|
|
|
// ChainNotifier interface.
|
|
|
|
notifierType = "btcd"
|
|
|
|
)
|
|
|
|
|
2016-09-22 19:12:12 -07:00
|
|
|
// chainUpdate encapsulates an update to the current main chain. This struct is
|
|
|
|
// used as an element within an unbounded queue in order to avoid blocking the
|
|
|
|
// main rpc dispatch rule.
|
|
|
|
type chainUpdate struct {
|
|
|
|
blockHash *wire.ShaHash
|
|
|
|
blockHeight int32
|
|
|
|
}
|
|
|
|
|
|
|
|
// txUpdate encapsulates a transaction related notification sent from btcd to
|
|
|
|
// the registered RPC client. This struct is used as an element within an
|
|
|
|
// unbounded queue in order to avoid blocking the main rpc dispatch rule.
|
|
|
|
type txUpdate struct {
|
|
|
|
tx *btcutil.Tx
|
|
|
|
details *btcjson.BlockDetails
|
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// BtcdNotifier implements the ChainNotifier interface using btcd's websockets
|
|
|
|
// notifications. Multiple concurrent clients are supported. All notifications
|
|
|
|
// are achieved via non-blocking sends on client channels.
|
2016-01-06 13:03:17 -08:00
|
|
|
type BtcdNotifier struct {
|
2016-02-26 17:31:07 -08:00
|
|
|
started int32 // To be used atomically.
|
|
|
|
stopped int32 // To be used atomically.
|
2016-02-16 14:46:18 -08:00
|
|
|
|
2016-02-26 16:30:14 -08:00
|
|
|
chainConn *btcrpcclient.Client
|
2016-01-06 13:03:17 -08:00
|
|
|
|
|
|
|
notificationRegistry chan interface{}
|
|
|
|
|
2016-11-27 19:17:27 -08:00
|
|
|
spendNotifications map[wire.OutPoint][]*spendNotification
|
2016-09-08 11:27:07 -07:00
|
|
|
|
2016-09-09 11:25:12 -07:00
|
|
|
confNotifications map[wire.ShaHash][]*confirmationsNotification
|
2016-09-08 11:27:07 -07:00
|
|
|
confHeap *confirmationHeap
|
|
|
|
|
|
|
|
blockEpochClients []chan *chainntnfs.BlockEpoch
|
2016-01-06 13:03:17 -08:00
|
|
|
|
2016-02-26 16:30:14 -08:00
|
|
|
disconnectedBlockHashes chan *blockNtfn
|
2016-09-22 19:12:12 -07:00
|
|
|
|
|
|
|
chainUpdates []*chainUpdate
|
|
|
|
chainUpdateSignal chan struct{}
|
|
|
|
chainUpdateMtx sync.Mutex
|
|
|
|
|
|
|
|
txUpdates []*txUpdate
|
|
|
|
txUpdateSignal chan struct{}
|
|
|
|
txUpdateMtx sync.Mutex
|
2016-01-06 13:03:17 -08:00
|
|
|
|
2016-02-16 14:46:18 -08:00
|
|
|
wg sync.WaitGroup
|
|
|
|
quit chan struct{}
|
2016-01-06 13:03:17 -08:00
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// Ensure BtcdNotifier implements the ChainNotifier interface at compile time.
|
2016-01-06 13:03:17 -08:00
|
|
|
var _ chainntnfs.ChainNotifier = (*BtcdNotifier)(nil)
|
|
|
|
|
2016-08-03 22:13:10 -07:00
|
|
|
// New returns a new BtcdNotifier instance. This function assumes the btcd node
|
2016-11-27 19:17:27 -08:00
|
|
|
// detailed in the passed configuration is already running, and willing to
|
|
|
|
// accept new websockets clients.
|
2016-08-03 22:13:10 -07:00
|
|
|
func New(config *btcrpcclient.ConnConfig) (*BtcdNotifier, error) {
|
2016-02-26 16:30:14 -08:00
|
|
|
notifier := &BtcdNotifier{
|
2016-01-06 13:03:17 -08:00
|
|
|
notificationRegistry: make(chan interface{}),
|
|
|
|
|
2016-11-27 19:17:27 -08:00
|
|
|
spendNotifications: make(map[wire.OutPoint][]*spendNotification),
|
2016-09-09 11:25:12 -07:00
|
|
|
confNotifications: make(map[wire.ShaHash][]*confirmationsNotification),
|
2016-01-06 13:03:17 -08:00
|
|
|
confHeap: newConfirmationHeap(),
|
|
|
|
|
2016-02-26 16:30:14 -08:00
|
|
|
disconnectedBlockHashes: make(chan *blockNtfn, 20),
|
2016-09-22 19:12:12 -07:00
|
|
|
|
|
|
|
chainUpdateSignal: make(chan struct{}),
|
|
|
|
txUpdateSignal: make(chan struct{}),
|
2016-01-06 13:03:17 -08:00
|
|
|
|
|
|
|
quit: make(chan struct{}),
|
2016-02-26 16:30:14 -08:00
|
|
|
}
|
|
|
|
|
|
|
|
ntfnCallbacks := &btcrpcclient.NotificationHandlers{
|
|
|
|
OnBlockConnected: notifier.onBlockConnected,
|
|
|
|
OnBlockDisconnected: notifier.onBlockDisconnected,
|
|
|
|
OnRedeemingTx: notifier.onRedeemingTx,
|
|
|
|
}
|
|
|
|
|
2016-08-03 22:13:10 -07:00
|
|
|
// Disable connecting to btcd within the btcrpcclient.New method. We
|
|
|
|
// defer establishing the connection to our .Start() method.
|
2016-02-26 16:30:14 -08:00
|
|
|
config.DisableConnectOnNew = true
|
|
|
|
config.DisableAutoReconnect = false
|
|
|
|
chainConn, err := btcrpcclient.New(config, ntfnCallbacks)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
notifier.chainConn = chainConn
|
|
|
|
|
|
|
|
return notifier, nil
|
2016-01-06 13:03:17 -08:00
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// Start connects to the running btcd node over websockets, registers for block
|
|
|
|
// notifications, and finally launches all related helper goroutines.
|
2016-01-06 13:03:17 -08:00
|
|
|
func (b *BtcdNotifier) Start() error {
|
|
|
|
// Already started?
|
|
|
|
if atomic.AddInt32(&b.started, 1) != 1 {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// Connect to btcd, and register for notifications on connected, and
|
|
|
|
// disconnected blocks.
|
2016-02-26 16:30:14 -08:00
|
|
|
if err := b.chainConn.Connect(20); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
if err := b.chainConn.NotifyBlocks(); err != nil {
|
|
|
|
return err
|
|
|
|
}
|
|
|
|
|
2016-01-06 13:03:17 -08:00
|
|
|
b.wg.Add(1)
|
|
|
|
go b.notificationDispatcher()
|
|
|
|
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// Stop shutsdown the BtcdNotifier.
|
2016-01-06 13:03:17 -08:00
|
|
|
func (b *BtcdNotifier) Stop() error {
|
|
|
|
// Already shutting down?
|
|
|
|
if atomic.AddInt32(&b.stopped, 1) != 1 {
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// Shutdown the rpc client, this gracefully disconnects from btcd, and
|
|
|
|
// cleans up all related resources.
|
2016-02-26 16:30:14 -08:00
|
|
|
b.chainConn.Shutdown()
|
|
|
|
|
2016-01-06 13:03:17 -08:00
|
|
|
close(b.quit)
|
|
|
|
b.wg.Wait()
|
|
|
|
|
2016-02-26 17:04:14 -08:00
|
|
|
// Notify all pending clients of our shutdown by closing the related
|
|
|
|
// notification channels.
|
2016-11-27 19:17:27 -08:00
|
|
|
for _, spendClients := range b.spendNotifications {
|
|
|
|
for _, spendClient := range spendClients {
|
|
|
|
close(spendClient.spendChan)
|
|
|
|
}
|
2016-02-26 17:04:14 -08:00
|
|
|
}
|
2016-09-09 11:25:12 -07:00
|
|
|
for _, confClients := range b.confNotifications {
|
|
|
|
for _, confClient := range confClients {
|
|
|
|
close(confClient.finConf)
|
|
|
|
close(confClient.negativeConf)
|
|
|
|
}
|
2016-02-26 17:04:14 -08:00
|
|
|
}
|
2016-12-15 13:53:36 -08:00
|
|
|
for _, epochClient := range b.blockEpochClients {
|
|
|
|
close(epochClient)
|
|
|
|
}
|
2016-02-26 17:04:14 -08:00
|
|
|
|
2016-01-06 13:03:17 -08:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// blockNtfn packages a notification of a connected/disconnected block along
|
|
|
|
// with its height at the time.
|
2016-02-26 16:30:14 -08:00
|
|
|
type blockNtfn struct {
|
|
|
|
sha *wire.ShaHash
|
|
|
|
height int32
|
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// onBlockConnected implements on OnBlockConnected callback for btcrpcclient.
|
2016-09-22 19:12:12 -07:00
|
|
|
// Ingesting a block updates the wallet's internal utxo state based on the
|
|
|
|
// outputs created and destroyed within each block.
|
2016-02-26 16:30:14 -08:00
|
|
|
func (b *BtcdNotifier) onBlockConnected(hash *wire.ShaHash, height int32, t time.Time) {
|
2016-09-22 19:12:12 -07:00
|
|
|
// Append this new chain update to the end of the queue of new chain
|
|
|
|
// updates.
|
|
|
|
b.chainUpdateMtx.Lock()
|
|
|
|
b.chainUpdates = append(b.chainUpdates, &chainUpdate{hash, height})
|
|
|
|
b.chainUpdateMtx.Unlock()
|
|
|
|
|
|
|
|
// Launch a goroutine to signal the notification dispatcher that a new
|
|
|
|
// block update is available. We do this in a new goroutine in order to
|
|
|
|
// avoid blocking the main loop of the rpc client.
|
|
|
|
go func() {
|
|
|
|
b.chainUpdateSignal <- struct{}{}
|
|
|
|
}()
|
2016-02-26 16:30:14 -08:00
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// onBlockDisconnected implements on OnBlockDisconnected callback for btcrpcclient.
|
2016-02-26 16:30:14 -08:00
|
|
|
func (b *BtcdNotifier) onBlockDisconnected(hash *wire.ShaHash, height int32, t time.Time) {
|
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// onRedeemingTx implements on OnRedeemingTx callback for btcrpcclient.
|
2016-09-22 19:12:12 -07:00
|
|
|
func (b *BtcdNotifier) onRedeemingTx(tx *btcutil.Tx, details *btcjson.BlockDetails) {
|
2016-11-27 19:17:27 -08:00
|
|
|
// Append this new transaction update to the end of the queue of new
|
|
|
|
// chain updates.
|
2016-09-22 19:12:12 -07:00
|
|
|
b.txUpdateMtx.Lock()
|
|
|
|
b.txUpdates = append(b.txUpdates, &txUpdate{tx, details})
|
|
|
|
b.txUpdateMtx.Unlock()
|
|
|
|
|
|
|
|
// Launch a goroutine to signal the notification dispatcher that a new
|
|
|
|
// transaction update is available. We do this in a new goroutine in
|
|
|
|
// order to avoid blocking the main loop of the rpc client.
|
|
|
|
go func() {
|
|
|
|
b.txUpdateSignal <- struct{}{}
|
|
|
|
}()
|
2016-02-26 16:30:14 -08:00
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// notificationDispatcher is the primary goroutine which handles client
|
|
|
|
// notification registrations, as well as notification dispatches.
|
2016-01-06 13:03:17 -08:00
|
|
|
func (b *BtcdNotifier) notificationDispatcher() {
|
2016-12-08 16:15:58 -08:00
|
|
|
var currentHeight int32
|
|
|
|
|
2016-01-06 13:03:17 -08:00
|
|
|
out:
|
|
|
|
for {
|
|
|
|
select {
|
|
|
|
case registerMsg := <-b.notificationRegistry:
|
|
|
|
switch msg := registerMsg.(type) {
|
|
|
|
case *spendNotification:
|
2016-09-08 11:27:07 -07:00
|
|
|
chainntnfs.Log.Infof("New spend subscription: "+
|
|
|
|
"utxo=%v", msg.targetOutpoint)
|
2016-11-27 19:17:27 -08:00
|
|
|
op := *msg.targetOutpoint
|
|
|
|
b.spendNotifications[op] = append(b.spendNotifications[op], msg)
|
2016-01-06 13:03:17 -08:00
|
|
|
case *confirmationsNotification:
|
2016-06-20 21:33:41 -07:00
|
|
|
chainntnfs.Log.Infof("New confirmations "+
|
|
|
|
"subscription: txid=%v, numconfs=%v",
|
|
|
|
*msg.txid, msg.numConfirmations)
|
2016-12-08 16:15:58 -08:00
|
|
|
|
|
|
|
// If the notification can be partially or
|
|
|
|
// fully dispatched, then we can skip the first
|
|
|
|
// phase for ntfns.
|
|
|
|
if b.attemptHistoricalDispatch(msg, currentHeight) {
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
|
2016-09-09 11:25:12 -07:00
|
|
|
txid := *msg.txid
|
|
|
|
b.confNotifications[txid] = append(b.confNotifications[txid], msg)
|
2016-09-08 11:27:07 -07:00
|
|
|
case *blockEpochRegistration:
|
|
|
|
chainntnfs.Log.Infof("New block epoch subscription")
|
|
|
|
b.blockEpochClients = append(b.blockEpochClients,
|
|
|
|
msg.epochChan)
|
2016-01-06 13:03:17 -08:00
|
|
|
}
|
2016-02-26 16:30:14 -08:00
|
|
|
case staleBlockHash := <-b.disconnectedBlockHashes:
|
|
|
|
// TODO(roasbeef): re-orgs
|
|
|
|
// * second channel to notify of confirmation decrementing
|
|
|
|
// re-org?
|
|
|
|
// * notify of negative confirmations
|
2016-09-08 11:27:07 -07:00
|
|
|
chainntnfs.Log.Warnf("Block disconnected from main "+
|
|
|
|
"chain: %v", staleBlockHash)
|
2016-09-22 19:12:12 -07:00
|
|
|
case <-b.chainUpdateSignal:
|
|
|
|
// A new update is available, so pop the new chain
|
|
|
|
// update from the front of the update queue.
|
|
|
|
b.chainUpdateMtx.Lock()
|
|
|
|
update := b.chainUpdates[0]
|
|
|
|
b.chainUpdates[0] = nil // Set to nil to prevent GC leak.
|
|
|
|
b.chainUpdates = b.chainUpdates[1:]
|
|
|
|
b.chainUpdateMtx.Unlock()
|
|
|
|
|
2016-12-08 16:15:58 -08:00
|
|
|
currentHeight = update.blockHeight
|
|
|
|
|
2016-09-22 19:12:12 -07:00
|
|
|
newBlock, err := b.chainConn.GetBlock(update.blockHash)
|
2016-02-26 16:30:14 -08:00
|
|
|
if err != nil {
|
2016-09-08 11:27:07 -07:00
|
|
|
chainntnfs.Log.Errorf("Unable to get block: %v", err)
|
2016-02-26 16:30:14 -08:00
|
|
|
continue
|
2016-01-06 13:03:17 -08:00
|
|
|
}
|
|
|
|
|
2016-06-20 21:33:41 -07:00
|
|
|
chainntnfs.Log.Infof("New block: height=%v, sha=%v",
|
2016-09-22 19:12:12 -07:00
|
|
|
update.blockHeight, update.blockHash)
|
2016-06-20 21:33:41 -07:00
|
|
|
|
2016-09-22 19:12:12 -07:00
|
|
|
go b.notifyBlockEpochs(update.blockHeight,
|
|
|
|
update.blockHash)
|
2016-09-08 11:27:07 -07:00
|
|
|
|
2016-09-22 19:12:12 -07:00
|
|
|
newHeight := update.blockHeight
|
2016-12-12 15:35:25 -08:00
|
|
|
for _, tx := range newBlock.Transactions {
|
2016-02-26 16:30:14 -08:00
|
|
|
// Check if the inclusion of this transaction
|
|
|
|
// within a block by itself triggers a block
|
|
|
|
// confirmation threshold, if so send a
|
2016-11-27 19:17:27 -08:00
|
|
|
// notification. Otherwise, place the
|
|
|
|
// notification on a heap to be triggered in
|
|
|
|
// the future once additional confirmations are
|
|
|
|
// attained.
|
2016-12-12 15:35:25 -08:00
|
|
|
txSha := tx.TxSha()
|
|
|
|
b.checkConfirmationTrigger(&txSha, newHeight)
|
2016-02-26 16:30:14 -08:00
|
|
|
}
|
|
|
|
|
|
|
|
// A new block has been connected to the main
|
|
|
|
// chain. Send out any N confirmation notifications
|
|
|
|
// which may have been triggered by this new block.
|
|
|
|
b.notifyConfs(newHeight)
|
2016-09-22 19:12:12 -07:00
|
|
|
case <-b.txUpdateSignal:
|
|
|
|
// A new update is available, so pop the new chain
|
|
|
|
// update from the front of the update queue.
|
|
|
|
b.txUpdateMtx.Lock()
|
|
|
|
newSpend := b.txUpdates[0]
|
|
|
|
b.txUpdates[0] = nil // Set to nil to prevent GC leak.
|
|
|
|
b.txUpdates = b.txUpdates[1:]
|
|
|
|
b.txUpdateMtx.Unlock()
|
|
|
|
|
|
|
|
spendingTx := newSpend.tx
|
|
|
|
|
2016-02-26 16:30:14 -08:00
|
|
|
// First, check if this transaction spends an output
|
|
|
|
// that has an existing spend notification for it.
|
2016-09-22 19:12:12 -07:00
|
|
|
for i, txIn := range spendingTx.MsgTx().TxIn {
|
2016-02-26 16:30:14 -08:00
|
|
|
prevOut := txIn.PreviousOutPoint
|
|
|
|
|
|
|
|
// If this transaction indeed does spend an
|
2016-11-27 19:17:27 -08:00
|
|
|
// output which we have a registered
|
|
|
|
// notification for, then create a spend
|
|
|
|
// summary, finally sending off the details to
|
|
|
|
// the notification subscriber.
|
|
|
|
if clients, ok := b.spendNotifications[prevOut]; ok {
|
2016-09-22 19:12:12 -07:00
|
|
|
spenderSha := newSpend.tx.Sha()
|
2016-11-27 19:17:27 -08:00
|
|
|
for _, ntfn := range clients {
|
|
|
|
spendDetails := &chainntnfs.SpendDetail{
|
|
|
|
SpentOutPoint: ntfn.targetOutpoint,
|
|
|
|
SpenderTxHash: spenderSha,
|
|
|
|
// TODO(roasbeef): copy tx?
|
|
|
|
SpendingTx: spendingTx.MsgTx(),
|
|
|
|
SpenderInputIndex: uint32(i),
|
|
|
|
}
|
|
|
|
|
|
|
|
chainntnfs.Log.Infof("Dispatching "+
|
|
|
|
"spend notification for "+
|
|
|
|
"outpoint=%v", ntfn.targetOutpoint)
|
|
|
|
ntfn.spendChan <- spendDetails
|
2016-02-24 22:16:25 -08:00
|
|
|
}
|
2016-01-06 13:03:17 -08:00
|
|
|
|
2016-02-26 16:30:14 -08:00
|
|
|
delete(b.spendNotifications, prevOut)
|
2016-01-06 13:03:17 -08:00
|
|
|
}
|
|
|
|
}
|
|
|
|
case <-b.quit:
|
|
|
|
break out
|
|
|
|
}
|
|
|
|
}
|
2016-02-26 16:30:14 -08:00
|
|
|
b.wg.Done()
|
2016-01-06 13:03:17 -08:00
|
|
|
}
|
|
|
|
|
2016-12-08 16:15:58 -08:00
|
|
|
// attemptHistoricalDispatch tries to use historical information to decide if a
|
|
|
|
// notificaiton ca be disptahced immediately, or is partially confirmed so it
|
|
|
|
// can skip straight to the confirmations heap.
|
|
|
|
func (b *BtcdNotifier) attemptHistoricalDispatch(msg *confirmationsNotification,
|
|
|
|
currentHeight int32) bool {
|
|
|
|
|
|
|
|
// If the transaction already has some or all of the confirmations,
|
|
|
|
// then we may be able to
|
|
|
|
// dispatch it immediately.
|
|
|
|
tx, err := b.chainConn.GetRawTransactionVerbose(msg.txid)
|
|
|
|
if err != nil {
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
// If the transaction has more that enough confirmations, then we can
|
|
|
|
// dispatch it immediately after obtaininig for information w.r.t
|
|
|
|
// exaclty *when* if got all its confirmations.
|
|
|
|
if uint32(tx.Confirmations) >= msg.numConfirmations {
|
|
|
|
msg.finConf <- int32(tx.Confirmations)
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
|
|
|
|
// Otherwise, the transaciton has only been *partially* confirmed, so
|
|
|
|
// we need to insert it into the confirmationheap.
|
|
|
|
confsLeft := msg.numConfirmations - uint32(tx.Confirmations)
|
|
|
|
confHeight := uint32(currentHeight) + confsLeft
|
|
|
|
heapEntry := &confEntry{
|
|
|
|
msg,
|
|
|
|
confHeight,
|
|
|
|
}
|
|
|
|
heap.Push(b.confHeap, heapEntry)
|
|
|
|
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
2016-09-08 11:27:07 -07:00
|
|
|
// notifyBlockEpochs notifies all registered block epoch clients of the newly
|
|
|
|
// connected block to the main chain.
|
|
|
|
func (b *BtcdNotifier) notifyBlockEpochs(newHeight int32, newSha *wire.ShaHash) {
|
|
|
|
epoch := &chainntnfs.BlockEpoch{
|
|
|
|
Height: newHeight,
|
|
|
|
Hash: newSha,
|
|
|
|
}
|
|
|
|
|
|
|
|
// TODO(roasbeef): spwan a new goroutine for each client instead?
|
|
|
|
for _, epochChan := range b.blockEpochClients {
|
|
|
|
// Attempt a non-blocking send. If the buffered channel is
|
|
|
|
// full, then we no-op and move onto the next client.
|
|
|
|
select {
|
|
|
|
case epochChan <- epoch:
|
|
|
|
default:
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// notifyConfs examines the current confirmation heap, sending off any
|
|
|
|
// notifications which have been triggered by the connection of a new block at
|
|
|
|
// newBlockHeight.
|
2016-02-26 16:30:14 -08:00
|
|
|
func (b *BtcdNotifier) notifyConfs(newBlockHeight int32) {
|
|
|
|
// If the heap is empty, we have nothing to do.
|
|
|
|
if b.confHeap.Len() == 0 {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2016-02-24 22:16:25 -08:00
|
|
|
// Traverse our confirmation heap. The heap is a
|
|
|
|
// min-heap, so the confirmation notification which requires
|
|
|
|
// the smallest block-height will always be at the top
|
|
|
|
// of the heap. If a confirmation notification is eligible
|
|
|
|
// for triggering, then fire it off, and check if another
|
|
|
|
// is eligible until there are no more eligible entries.
|
|
|
|
nextConf := heap.Pop(b.confHeap).(*confEntry)
|
2016-02-26 16:30:14 -08:00
|
|
|
for nextConf.triggerHeight <= uint32(newBlockHeight) {
|
2016-06-20 21:33:41 -07:00
|
|
|
nextConf.finConf <- newBlockHeight
|
2016-02-24 22:16:25 -08:00
|
|
|
|
2016-02-26 16:30:14 -08:00
|
|
|
if b.confHeap.Len() == 0 {
|
|
|
|
return
|
|
|
|
}
|
|
|
|
|
2016-02-24 22:16:25 -08:00
|
|
|
nextConf = heap.Pop(b.confHeap).(*confEntry)
|
2016-01-06 13:03:17 -08:00
|
|
|
}
|
2016-02-24 22:16:25 -08:00
|
|
|
|
|
|
|
heap.Push(b.confHeap, nextConf)
|
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// checkConfirmationTrigger determines if the passed txSha included at blockHeight
|
|
|
|
// triggers any single confirmation notifications. In the event that the txid
|
|
|
|
// matches, yet needs additional confirmations, it is added to the confirmation
|
|
|
|
// heap to be triggered at a later time.
|
|
|
|
// TODO(roasbeef): perhaps lookup, then track by inputs instead?
|
2016-02-26 16:30:14 -08:00
|
|
|
func (b *BtcdNotifier) checkConfirmationTrigger(txSha *wire.ShaHash, blockHeight int32) {
|
2016-09-09 11:25:12 -07:00
|
|
|
|
2016-02-24 22:16:25 -08:00
|
|
|
// If a confirmation notification has been registered
|
|
|
|
// for this txid, then either trigger a notification
|
|
|
|
// event if only a single confirmation notification was
|
|
|
|
// requested, or place the notification on the
|
|
|
|
// confirmation heap for future usage.
|
2016-09-09 11:25:12 -07:00
|
|
|
if confClients, ok := b.confNotifications[*txSha]; ok {
|
|
|
|
// Either all of the registered confirmations wtill be
|
|
|
|
// dispatched due to a single confirmation, or added to the
|
|
|
|
// conf head. Therefor we unconditioanlly delete the registered
|
|
|
|
// confirmations from the staging zone.
|
|
|
|
defer func() {
|
|
|
|
delete(b.confNotifications, *txSha)
|
|
|
|
}()
|
|
|
|
|
|
|
|
for _, confClient := range confClients {
|
|
|
|
if confClient.numConfirmations == 1 {
|
|
|
|
chainntnfs.Log.Infof("Dispatching single conf "+
|
|
|
|
"notification, sha=%v, height=%v", txSha,
|
|
|
|
blockHeight)
|
|
|
|
confClient.finConf <- blockHeight
|
|
|
|
continue
|
|
|
|
}
|
2016-02-24 22:16:25 -08:00
|
|
|
|
2016-09-09 11:25:12 -07:00
|
|
|
// The registered notification requires more
|
|
|
|
// than one confirmation before triggering. So
|
|
|
|
// we create a heapConf entry for this notification.
|
|
|
|
// The heapConf allows us to easily keep track of
|
|
|
|
// which notification(s) we should fire off with
|
|
|
|
// each incoming block.
|
|
|
|
confClient.initialConfirmHeight = uint32(blockHeight)
|
|
|
|
finalConfHeight := uint32(confClient.initialConfirmHeight + confClient.numConfirmations - 1)
|
|
|
|
heapEntry := &confEntry{
|
|
|
|
confClient,
|
|
|
|
finalConfHeight,
|
|
|
|
}
|
|
|
|
heap.Push(b.confHeap, heapEntry)
|
2016-02-24 22:16:25 -08:00
|
|
|
}
|
|
|
|
}
|
2016-01-06 13:03:17 -08:00
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// spendNotification couples a target outpoint along with the channel used for
|
|
|
|
// notifications once a spend of the outpoint has been detected.
|
2016-01-06 13:03:17 -08:00
|
|
|
type spendNotification struct {
|
2016-02-16 14:46:18 -08:00
|
|
|
targetOutpoint *wire.OutPoint
|
2016-01-06 13:03:17 -08:00
|
|
|
|
2016-02-16 14:46:18 -08:00
|
|
|
spendChan chan *chainntnfs.SpendDetail
|
2016-01-06 13:03:17 -08:00
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// RegisterSpendNotification registers an intent to be notified once the target
|
|
|
|
// outpoint has been spent by a transaction on-chain. Once a spend of the target
|
|
|
|
// outpoint has been detected, the details of the spending event will be sent
|
|
|
|
// across the 'Spend' channel.
|
2016-02-16 14:46:18 -08:00
|
|
|
func (b *BtcdNotifier) RegisterSpendNtfn(outpoint *wire.OutPoint) (*chainntnfs.SpendEvent, error) {
|
2016-11-30 00:00:20 -08:00
|
|
|
|
2016-02-26 16:30:14 -08:00
|
|
|
if err := b.chainConn.NotifySpent([]*wire.OutPoint{outpoint}); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
2016-01-06 13:03:17 -08:00
|
|
|
|
|
|
|
ntfn := &spendNotification{
|
2016-02-16 14:46:18 -08:00
|
|
|
targetOutpoint: outpoint,
|
|
|
|
spendChan: make(chan *chainntnfs.SpendDetail, 1),
|
2016-01-06 13:03:17 -08:00
|
|
|
}
|
|
|
|
|
|
|
|
b.notificationRegistry <- ntfn
|
|
|
|
|
2016-11-30 00:00:20 -08:00
|
|
|
// The following conditional checks to ensure that when a spend notification
|
|
|
|
// is registered, the output hasn't already been spent. If the output
|
|
|
|
// is no longer in the UTXO set, the chain will be rescanned from the point
|
|
|
|
// where the output was added. The rescan will dispatch the notification.
|
|
|
|
txout, err := b.chainConn.GetTxOut(&outpoint.Hash, outpoint.Index, true)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
if txout == nil {
|
|
|
|
transaction, err := b.chainConn.GetRawTransactionVerbose(&outpoint.Hash)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
blockhash, err := wire.NewShaHashFromStr(transaction.BlockHash)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
|
|
|
ops := []*wire.OutPoint{outpoint}
|
|
|
|
if err := b.chainConn.Rescan(blockhash, nil, ops); err != nil {
|
|
|
|
chainntnfs.Log.Errorf("Rescan for spend notification txout failed: %v", err)
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2016-02-16 14:46:18 -08:00
|
|
|
return &chainntnfs.SpendEvent{ntfn.spendChan}, nil
|
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// confirmationNotification represents a client's intent to receive a
|
|
|
|
// notification once the target txid reaches numConfirmations confirmations.
|
2016-02-16 14:46:18 -08:00
|
|
|
type confirmationsNotification struct {
|
|
|
|
txid *wire.ShaHash
|
|
|
|
|
|
|
|
initialConfirmHeight uint32
|
|
|
|
numConfirmations uint32
|
|
|
|
|
2016-06-20 21:33:41 -07:00
|
|
|
finConf chan int32
|
2016-02-26 17:31:07 -08:00
|
|
|
negativeConf chan int32 // TODO(roasbeef): re-org funny business
|
2016-01-06 13:03:17 -08:00
|
|
|
}
|
|
|
|
|
2016-02-26 17:31:07 -08:00
|
|
|
// RegisterConfirmationsNotification registers a notification with BtcdNotifier
|
|
|
|
// which will be triggered once the txid reaches numConfs number of
|
|
|
|
// confirmations.
|
2016-02-16 14:46:18 -08:00
|
|
|
func (b *BtcdNotifier) RegisterConfirmationsNtfn(txid *wire.ShaHash,
|
|
|
|
numConfs uint32) (*chainntnfs.ConfirmationEvent, error) {
|
2016-01-06 13:03:17 -08:00
|
|
|
|
|
|
|
ntfn := &confirmationsNotification{
|
|
|
|
txid: txid,
|
|
|
|
numConfirmations: numConfs,
|
2016-06-20 21:33:41 -07:00
|
|
|
finConf: make(chan int32, 1),
|
2016-02-26 16:30:14 -08:00
|
|
|
negativeConf: make(chan int32, 1),
|
2016-01-06 13:03:17 -08:00
|
|
|
}
|
|
|
|
|
|
|
|
b.notificationRegistry <- ntfn
|
|
|
|
|
2016-02-16 14:46:18 -08:00
|
|
|
return &chainntnfs.ConfirmationEvent{
|
|
|
|
Confirmed: ntfn.finConf,
|
|
|
|
NegativeConf: ntfn.negativeConf,
|
|
|
|
}, nil
|
2016-01-06 13:03:17 -08:00
|
|
|
}
|
2016-06-20 21:31:05 -07:00
|
|
|
|
2016-09-08 11:27:07 -07:00
|
|
|
// blockEpochRegistration represents a client's intent to receive a
|
|
|
|
// notification with each newly connected block.
|
|
|
|
type blockEpochRegistration struct {
|
|
|
|
epochChan chan *chainntnfs.BlockEpoch
|
|
|
|
}
|
|
|
|
|
2016-06-20 21:31:05 -07:00
|
|
|
// RegisterBlockEpochNtfn returns a BlockEpochEvent which subscribes the
|
|
|
|
// caller to receive notificationsm, of each new block connected to the main
|
|
|
|
// chain.
|
2016-09-08 11:27:07 -07:00
|
|
|
func (b *BtcdNotifier) RegisterBlockEpochNtfn() (*chainntnfs.BlockEpochEvent, error) {
|
|
|
|
registration := &blockEpochRegistration{
|
|
|
|
epochChan: make(chan *chainntnfs.BlockEpoch, 20),
|
|
|
|
}
|
|
|
|
|
|
|
|
b.notificationRegistry <- registration
|
|
|
|
|
|
|
|
return &chainntnfs.BlockEpochEvent{
|
|
|
|
Epochs: registration.epochChan,
|
|
|
|
}, nil
|
2016-06-20 21:31:05 -07:00
|
|
|
}
|