btcdnotify

Documentation

Index

• type BtcdNotifier
  • func New(config *rpcclient.ConnConfig, chainParams *chaincfg.Params, ...) (*BtcdNotifier, error)
  • func (b *BtcdNotifier) GetBlock(hash *chainhash.Hash) (*wire.MsgBlock, error)
  • func (b *BtcdNotifier) RegisterBlockEpochNtfn(bestBlock *chainntnfs.BlockEpoch) (*chainntnfs.BlockEpochEvent, error)
  • func (b *BtcdNotifier) RegisterConfirmationsNtfn(txid *chainhash.Hash, pkScript []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) Started() bool
  • func (b *BtcdNotifier) Stop() error

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, chainParams *chaincfg.Params,
	spendHintCache chainntnfs.SpendHintCache,
	confirmHintCache chainntnfs.ConfirmHintCache,
	blockCache *blockcache.BlockCache) (*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) GetBlock

func (b *BtcdNotifier) GetBlock(hash *chainhash.Hash) (*wire.MsgBlock,
	error)

GetBlock is used to retrieve the block with the given hash. This function wraps the blockCache's GetBlock function.

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. If they do not provide one, then a notification will be dispatched immediately for the current tip of the chain upon a successful registration.

func (*BtcdNotifier) RegisterConfirmationsNtfn

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

RegisterConfirmationsNtfn registers an intent to be notified once the target txid/output script has reached numConfs confirmations on-chain. When intending to be notified of the confirmation of an output script, a nil txid must be used. The heightHint should represent the earliest height at which the txid/output script could have been included in the chain.

Progress on the number of confirmations left can be read from the 'Updates' channel. Once it has reached all of its confirmations, a notification will be sent across the 'Confirmed' channel.

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/output script has been spent by a transaction on-chain. When intending to be notified of the spend of an output script, a nil outpoint must be used. The heightHint should represent the earliest height in the chain of the transaction that spent the outpoint/output script.

Once a spend of has been detected, the details of the spending event will be sent across the 'Spend' channel.

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) Started

func (b *BtcdNotifier) Started() bool

Started returns true if this instance has been started, and false otherwise.

func (*BtcdNotifier) Stop

func (b *BtcdNotifier) Stop() error

Stop shutsdown the BtcdNotifier.