chainview

Documentation

Index

• func DisableLog()
• func UseLogger(logger slog.Logger)
• type DcrdFilteredChainView
  • func NewDcrdFilteredChainView(config rpcclient.ConnConfig) (*DcrdFilteredChainView, error)
  • func (b *DcrdFilteredChainView) DisconnectedBlocks() <-chan *FilteredBlock
  • func (b *DcrdFilteredChainView) FilterBlock(blockHash *chainhash.Hash) (*FilteredBlock, error)
  • func (b *DcrdFilteredChainView) FilteredBlocks() <-chan *FilteredBlock
  • func (b *DcrdFilteredChainView) Start() error
  • func (b *DcrdFilteredChainView) Stop() error
  • func (b *DcrdFilteredChainView) UpdateFilter(ops []channeldb.EdgePoint, updateHeight int64) error
• type FilteredBlock
• type FilteredChainView

Functions

func DisableLog

func DisableLog()

DisableLog disables all library log output. Logging output is disabled by default until either UseLogger or SetLogWriter are called.

func UseLogger

func UseLogger(logger slog.Logger)

UseLogger uses a specified Logger to output package logging info. This should be used in preference to SetLogWriter if the caller is also using slog.

Types

type DcrdFilteredChainView

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

DcrdFilteredChainView is an implementation of the FilteredChainView interface which is backed by an active websockets connection to dcrd.

func NewDcrdFilteredChainView

func NewDcrdFilteredChainView(config rpcclient.ConnConfig) (*DcrdFilteredChainView, error)

NewDcrdFilteredChainView creates a new instance of a FilteredChainView from RPC credentials for an active dcrd instance.

func (*DcrdFilteredChainView) DisconnectedBlocks

func (b *DcrdFilteredChainView) DisconnectedBlocks() <-chan *FilteredBlock

DisconnectedBlocks returns a receive only channel which will be sent upon with the empty filtered blocks of blocks which are disconnected from the main chain in the case of a re-org.

NOTE: This is part of the FilteredChainView interface.

func (*DcrdFilteredChainView) FilterBlock

func (b *DcrdFilteredChainView) FilterBlock(blockHash *chainhash.Hash) (*FilteredBlock, error)

FilterBlock takes a block hash, and returns a FilteredBlocks which is the result of applying the current registered UTXO sub-set on the block corresponding to that block hash. If any watched UTOX's are spent by the selected lock, then the internal chainFilter will also be updated.

NOTE: This is part of the FilteredChainView interface.

func (*DcrdFilteredChainView) FilteredBlocks

func (b *DcrdFilteredChainView) FilteredBlocks() <-chan *FilteredBlock

FilteredBlocks returns the channel that filtered blocks are to be sent over. Each time a block is connected to the end of a main chain, and appropriate FilteredBlock which contains the transactions which mutate our watched UTXO set is to be returned.

NOTE: This is part of the FilteredChainView interface.

func (*DcrdFilteredChainView) Start

func (b *DcrdFilteredChainView) Start() error

Start starts all goroutines necessary for normal operation.

NOTE: This is part of the FilteredChainView interface.

func (*DcrdFilteredChainView) Stop

func (b *DcrdFilteredChainView) Stop() error

Stop stops all goroutines which we launched by the prior call to the Start method.

NOTE: This is part of the FilteredChainView interface.

func (*DcrdFilteredChainView) UpdateFilter

func (b *DcrdFilteredChainView) UpdateFilter(ops []channeldb.EdgePoint,
	updateHeight int64) error

UpdateFilter updates the UTXO filter which is to be consulted when creating FilteredBlocks to be sent to subscribed clients. This method is cumulative meaning repeated calls to this method should _expand_ the size of the UTXO sub-set currently being watched. If the set updateHeight is _lower_ than the best known height of the implementation, then the state should be rewound to ensure all relevant notifications are dispatched.

NOTE: This is part of the FilteredChainView interface.

type FilteredBlock

type FilteredBlock struct {
	// Hash is the hash of the newly filtered block.
	Hash chainhash.Hash

	// Height is the height of the newly filtered block.
	Height int64

	// Transactions is the set of transactions which modify (spend) the
	// subscribed UTXO subset.
	Transactions []*wire.MsgTx
}

FilteredBlock is a block which includes the transactions that modify the subscribed sub-set of the UTXO set registered to the current FilteredChainView concrete implementation.

type FilteredChainView

type FilteredChainView interface {
	// FilteredBlocks returns the channel that filtered blocks are to be
	// sent over. Each time a block is connected to the end of a main
	// chain, and appropriate FilteredBlock which contains the transactions
	// which mutate our watched UTXO set is to be returned. In case of a
	// UpdateFilter call with an updateHeight lower than the current best
	// height, blocks with the updated filter will be resent, and must be
	// handled by the receiver as an update to an already known block, NOT
	// as a new block being connected to the chain.
	FilteredBlocks() <-chan *FilteredBlock

	// DisconnectedBlocks returns a receive only channel which will be sent
	// upon with the empty filtered blocks of blocks which are disconnected
	// from the main chain in the case of a re-org.
	// NOTE: In case of a reorg, connected blocks will not be available to
	// read from the FilteredBlocks() channel before all disconnected block
	// have been received.
	DisconnectedBlocks() <-chan *FilteredBlock

	// UpdateFilter updates the UTXO filter which is to be consulted when
	// creating FilteredBlocks to be sent to subscribed clients. This
	// method is cumulative meaning repeated calls to this method should
	// _expand_ the size of the UTXO sub-set currently being watched.  If
	// the set updateHeight is _lower_ than the best known height of the
	// implementation, then the state should be rewound to ensure all
	// relevant notifications are dispatched, meaning blocks with a height
	// lower than the best known height might be sent over the
	// FilteredBlocks() channel.
	UpdateFilter(ops []channeldb.EdgePoint, updateHeight int64) error

	// FilterBlock takes a block hash, and returns a FilteredBlocks which
	// is the result of applying the current registered UTXO sub-set on the
	// block corresponding to that block hash.
	//
	// TODO(roasbeef): make a version that does by height also?
	FilterBlock(blockHash *chainhash.Hash) (*FilteredBlock, error)

	// Start starts all goroutine necessary for the operation of the
	// FilteredChainView implementation.
	Start() error

	// Stop stops all goroutines which we launched by the prior call to the
	// Start method.
	Stop() error
}

FilteredChainView represents a subscription to a certain subset of the UTXO set for a particular chain. This interface is useful from the point of view of maintaining an up-to-date channel graph for the Lightning Network. The subset of the UTXO to be subscribed is that of all the currently opened channels. Each time a channel is closed (the output is spent), a notification is to be sent allowing the graph to be pruned.

NOTE: As FilteredBlocks are generated, it is recommended that implementations reclaim the space occupied by newly spent outputs.