recovery

Documentation

Index

• func Follower(log zerolog.Logger, finalizer forks.Finalizer, validator hotstuff.Validator, ...) error
• func Participant(log zerolog.Logger, forks hotstuff.Forks, ...) error
• func Recover(log zerolog.Logger, finalized *flow.Header, pending []*flow.Header, ...) error

Functions

func Follower

func Follower(
	log zerolog.Logger,
	finalizer forks.Finalizer,
	validator hotstuff.Validator,
	finalized *flow.Header,
	pending []*flow.Header,
) error

Follower recovers the HotStuff state for a follower instance. It reads the pending blocks from storage and pass them to the input Finalizer instance to recover its state from before the restart.

func Participant

func Participant(
	log zerolog.Logger,
	forks hotstuff.Forks,
	voteAggregator hotstuff.VoteAggregator,
	validator hotstuff.Validator,
	finalized *flow.Header,
	pending []*flow.Header,
) error

Participant recovers the HotStuff state for a consensus participant. It reads the pending blocks from storage and pass them to the input Forks instance to recover its state from before the restart.

func Recover

func Recover(log zerolog.Logger, finalized *flow.Header, pending []*flow.Header, validator hotstuff.Validator, onProposal func(*model.Proposal) error) error

Recover implements the core logic for recovering HotStuff state after a restart. It accepts the finalized block and a list of pending blocks that have been received but not finalized, and that share the latest finalized block as a common ancestor.