compliance

Documentation

Index

• type Core
  • func NewCore(log zerolog.Logger, collector module.EngineMetrics, ...) (*Core, error)
  • func (c *Core) OnBlockProposal(originID flow.Identifier, proposal *messages.BlockProposal) error
  • func (c *Core) ProcessFinalizedBlock(finalized *flow.Header)
• type Engine
  • func NewEngine(log zerolog.Logger, me module.Local, core *Core) (*Engine, error)
  • func (e *Engine) OnBlockProposal(proposal flow.Slashable[messages.BlockProposal])
  • func (e *Engine) OnFinalizedBlock(block *model.Block)
  • func (e *Engine) OnSyncedBlock(syncedBlock flow.Slashable[messages.BlockProposal])

Types

type Core

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

Core contains the central business logic for the main consensus' compliance engine. It is responsible for handling communication for the embedded consensus algorithm. CAUTION with CONCURRENCY:

• At the moment, compliance.Core _can not_ process blocks concurrently. Callers of `OnBlockProposal` need to ensure single-threaded access.
• The only exception is calls to `ProcessFinalizedView`, which is the only concurrency-safe method of compliance.Core

func NewCore

func NewCore(
	log zerolog.Logger,
	collector module.EngineMetrics,
	mempool module.MempoolMetrics,
	hotstuffMetrics module.HotstuffMetrics,
	complianceMetrics module.ComplianceMetrics,
	tracer module.Tracer,
	cleaner storage.Cleaner,
	headers storage.Headers,
	payloads storage.Payloads,
	state protocol.MutableState,
	pending module.PendingBlockBuffer,
	sync module.BlockRequester,
	validator hotstuff.Validator,
	hotstuff module.HotStuff,
	voteAggregator hotstuff.VoteAggregator,
	timeoutAggregator hotstuff.TimeoutAggregator,
	opts ...compliance.Opt,
) (*Core, error)

NewCore instantiates the business logic for the main consensus' compliance engine.

func (*Core) OnBlockProposal

func (c *Core) OnBlockProposal(originID flow.Identifier, proposal *messages.BlockProposal) error

OnBlockProposal handles incoming block proposals. No errors are expected during normal operation. All returned exceptions are potential symptoms of internal state corruption and should be fatal.

func (*Core) ProcessFinalizedBlock

func (c *Core) ProcessFinalizedBlock(finalized *flow.Header)

ProcessFinalizedBlock performs pruning of stale data based on finalization event removes pending blocks below the finalized view

type Engine

type Engine struct {
	*component.ComponentManager
	// contains filtered or unexported fields
}

Engine is a wrapper around `compliance.Core`. The Engine queues inbound messages, relevant node-internal notifications, and manages the worker routines processing the inbound events, and forwards outbound messages to the networking layer. `compliance.Core` implements the actual compliance logic. Implements consensus.Compliance interface.

func NewEngine

func NewEngine(
	log zerolog.Logger,
	me module.Local,
	core *Core,
) (*Engine, error)

func (*Engine) OnBlockProposal

func (e *Engine) OnBlockProposal(proposal flow.Slashable[messages.BlockProposal])

OnBlockProposal feeds a new block proposal into the processing pipeline. Incoming proposals are queued and eventually dispatched by worker.

func (*Engine) OnFinalizedBlock

func (e *Engine) OnFinalizedBlock(block *model.Block)

OnFinalizedBlock implements the `OnFinalizedBlock` callback from the `hotstuff.FinalizationConsumer` It informs compliance.Core about finalization of the respective block.

CAUTION: the input to this callback is treated as trusted; precautions should be taken that messages from external nodes cannot be considered as inputs to this function

func (*Engine) OnSyncedBlock

func (e *Engine) OnSyncedBlock(syncedBlock flow.Slashable[messages.BlockProposal])

OnSyncedBlock feeds a block obtained from sync proposal into the processing pipeline. Incoming proposals are queued and eventually dispatched by worker.