btcdnotify

Documentation

Index

• Variables
• type BtcdNotifier
  • func New(config *rpcclient.ConnConfig, spendHintCache chainntnfs.SpendHintCache, ...) (*BtcdNotifier, error)
  • func (b *BtcdNotifier) RegisterBlockEpochNtfn(bestBlock *chainntnfs.BlockEpoch) (*chainntnfs.BlockEpochEvent, error)
  • func (b *BtcdNotifier) RegisterConfirmationsNtfn(txid *chainhash.Hash, _ []byte, numConfs, heightHint uint32) (*chainntnfs.ConfirmationEvent, error)
  • func (b *BtcdNotifier) RegisterSpendNtfn(outpoint *wire.OutPoint, pkScript []byte, heightHint uint32) (*chainntnfs.SpendEvent, error)
  • func (b *BtcdNotifier) Start() error
  • func (b *BtcdNotifier) Stop() error

Variables

var (
	// ErrChainNotifierShuttingDown is used when we are trying to
	// measure a spend notification when notifier is already stopped.
	ErrChainNotifierShuttingDown = errors.New("chainntnfs: system interrupt " +
		"while attempting to register for spend notification.")
)

Types

type BtcdNotifier

type BtcdNotifier struct {
	// contains filtered or unexported fields
}

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.

func New

func New(config *rpcclient.ConnConfig, spendHintCache chainntnfs.SpendHintCache,
	confirmHintCache chainntnfs.ConfirmHintCache) (*BtcdNotifier, error)

New returns a new BtcdNotifier instance. This function assumes the btcd node detailed in the passed configuration is already running, and willing to accept new websockets clients.

func (*BtcdNotifier) RegisterBlockEpochNtfn

func (b *BtcdNotifier) RegisterBlockEpochNtfn(
	bestBlock *chainntnfs.BlockEpoch) (*chainntnfs.BlockEpochEvent, error)

RegisterBlockEpochNtfn returns a BlockEpochEvent which subscribes the caller to receive notifications, of each new block connected to the main chain. Clients have the option of passing in their best known block, which the notifier uses to check if they are behind on blocks and catch them up.

func (*BtcdNotifier) RegisterConfirmationsNtfn

func (b *BtcdNotifier) RegisterConfirmationsNtfn(txid *chainhash.Hash, _ []byte,
	numConfs, heightHint uint32) (*chainntnfs.ConfirmationEvent, error)

RegisterConfirmationsNtfn registers a notification with BtcdNotifier which will be triggered once the txid reaches numConfs number of confirmations.

func (*BtcdNotifier) RegisterSpendNtfn

func (b *BtcdNotifier) RegisterSpendNtfn(outpoint *wire.OutPoint,
	pkScript []byte, heightHint uint32) (*chainntnfs.SpendEvent, error)

RegisterSpendNtfn 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. The heightHint should represent the earliest height in the chain where the transaction could have been spent in.

func (*BtcdNotifier) Start

func (b *BtcdNotifier) Start() error

Start connects to the running btcd node over websockets, registers for block notifications, and finally launches all related helper goroutines.

func (*BtcdNotifier) Stop

func (b *BtcdNotifier) Stop() error

Stop shutsdown the BtcdNotifier.