mirror of
https://github.com/lightningnetwork/lnd.git
synced 2025-02-23 14:40:30 +01:00
01ac713aec
In this commit, a minimal implementation of `Blockbeat` is added to synchronize block heights, which will be used in `ChainArb`, `Sweeper`, and `TxPublisher` so blocks are processed sequentially among them.
53 lines
2.1 KiB
Go
53 lines
2.1 KiB
Go
package chainio
|
|
|
|
import "github.com/btcsuite/btclog/v2"
|
|
|
|
// Blockbeat defines an interface that can be used by subsystems to retrieve
|
|
// block data. It is sent by the BlockbeatDispatcher to all the registered
|
|
// consumers whenever a new block is received. Once the consumer finishes
|
|
// processing the block, it must signal it by calling `NotifyBlockProcessed`.
|
|
//
|
|
// The blockchain is a state machine - whenever there's a state change, it's
|
|
// manifested in a block. The blockbeat is a way to notify subsystems of this
|
|
// state change, and to provide them with the data they need to process it. In
|
|
// other words, subsystems must react to this state change and should consider
|
|
// being driven by the blockbeat in their own state machines.
|
|
type Blockbeat interface {
|
|
// blockbeat is a private interface that's only used in this package.
|
|
blockbeat
|
|
|
|
// Height returns the current block height.
|
|
Height() int32
|
|
}
|
|
|
|
// blockbeat defines a set of private methods used in this package to make
|
|
// interaction with the blockbeat easier.
|
|
type blockbeat interface {
|
|
// logger returns the internal logger used by the blockbeat which has a
|
|
// block height prefix.
|
|
logger() btclog.Logger
|
|
}
|
|
|
|
// Consumer defines a blockbeat consumer interface. Subsystems that need block
|
|
// info must implement it.
|
|
type Consumer interface {
|
|
// TODO(yy): We should also define the start methods used by the
|
|
// consumers such that when implementing the interface, the consumer
|
|
// will always be started with a blockbeat. This cannot be enforced at
|
|
// the moment as we need refactor all the start methods to only take a
|
|
// beat.
|
|
//
|
|
// Start(beat Blockbeat) error
|
|
|
|
// Name returns a human-readable string for this subsystem.
|
|
Name() string
|
|
|
|
// ProcessBlock takes a blockbeat and processes it. It should not
|
|
// return until the subsystem has updated its state based on the block
|
|
// data.
|
|
//
|
|
// NOTE: The consumer must try its best to NOT return an error. If an
|
|
// error is returned from processing the block, it means the subsystem
|
|
// cannot react to onchain state changes and lnd will shutdown.
|
|
ProcessBlock(b Blockbeat) error
|
|
}
|