stop

Documentation

Index

• type StopControl
  • func NewStopControl(log zerolog.Logger) *StopControl
  • func (sc *StopControl) OnVersionUpdate(height uint64, version *semver.Version)
  • func (sc *StopControl) RegisterHeightRecorder(recorder execution_data.ProcessedHeightRecorder)
• type VersionMetadata

Types

type StopControl

type StopControl struct {
	component.Component
	// contains filtered or unexported fields
}

StopControl is responsible for managing the stopping behavior of the node when an incompatible block height is encountered.

func NewStopControl

func NewStopControl(
	log zerolog.Logger,
) *StopControl

NewStopControl creates a new StopControl instance.

Parameters:

• log: The logger used for logging.

Returns:

• A pointer to the newly created StopControl instance.

func (*StopControl) OnVersionUpdate

func (sc *StopControl) OnVersionUpdate(height uint64, version *semver.Version)

OnVersionUpdate is called when a version update occurs.

It updates the incompatible block height and the expected node version based on the provided height and semver.

Parameters:

• height: The block height that is incompatible with the current node version.
• version: The new semantic version object that is expected for compatibility.

func (*StopControl) RegisterHeightRecorder

func (sc *StopControl) RegisterHeightRecorder(recorder execution_data.ProcessedHeightRecorder)

RegisterHeightRecorder registers an execution data height recorder with the StopControl.

Parameters:

• recorder: The execution data height recorder to register.

type VersionMetadata

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