collection

Documentation

Index

• type ClusterEvents
• type Compliance
• type EngineEvents

Types

type ClusterEvents

type ClusterEvents interface {
	// ActiveClustersChanged is called when a new cluster ID update event is distributed.
	// Any error encountered on consuming event must handle internally by the implementation.
	// The implementation must be concurrency safe, but can be blocking.
	ActiveClustersChanged(flow.ChainIDList)
}

ClusterEvents defines methods used to disseminate cluster ID update events. Cluster IDs are updated when a new set of epoch components start and the old set of epoch components stops. A new list of cluster IDs will be assigned when the new set of epoch components are started, and the old set of cluster IDs are removed when the current set of epoch components are stopped. The implementation must be concurrency safe and non-blocking.

type Compliance

type Compliance interface {
	component.Component

	// OnClusterBlockProposal feeds a new block proposal into the processing pipeline.
	// Incoming proposals will be queued and eventually dispatched by worker.
	// This method is non-blocking.
	OnClusterBlockProposal(proposal flow.Slashable[*messages.ClusterBlockProposal])
	// OnSyncedClusterBlock feeds a block obtained from sync proposal into the processing pipeline.
	// Incoming proposals will be queued and eventually dispatched by worker.
	// This method is non-blocking.
	OnSyncedClusterBlock(block flow.Slashable[*messages.ClusterBlockProposal])
}

Compliance defines the interface to the cluster consensus logic that precedes hotstuff logic. It's responsible for processing incoming block proposals broadcast by other cluster consensus participants as well as blocks obtained via the chain sync protocol. Compliance logic performs validation of incoming blocks by checking headers and payloads. Compliance logic guarantees that only valid blocks are added to chain state, passed to hotstuff and other components. Implementation need to be non-blocking and concurrency safe.

type EngineEvents

type EngineEvents interface {
	ClusterEvents
}

EngineEvents set of methods used to distribute and consume events related to collection node engine components.