recovery

Documentation

Index

• func Recover(log zerolog.Logger, pending []*flow.Header, scanners ...BlockScanner) error
• type BlockScanner
  • func CollectParentQCs(collector Collector[*flow.QuorumCertificate]) BlockScanner
  • func CollectTCs(collector Collector[*flow.TimeoutCertificate]) BlockScanner
  • func ForksState(forks hotstuff.Forks) BlockScanner
  • func VoteAggregatorState(voteAggregator hotstuff.VoteAggregator) BlockScanner
• type Collector
  • func NewCollector[T any]() Collector[T]
  • func (c Collector[T]) Append(t ...T)
  • func (c Collector[T]) Retrieve() []T

Functions

func Recover

func Recover(log zerolog.Logger, pending []*flow.Header, scanners ...BlockScanner) error

Recover is a utility method for recovering the HotStuff state after a restart. It receives the list `pending` containing _all_ blocks that

• have passed the compliance layer and stored in the protocol state
• descend from the latest finalized block
• are listed in ancestor-first order (i.e. for any block B ∈ pending, B's parent must be listed before B, unless B's parent is the latest finalized block)

CAUTION: all pending blocks are required to be valid (guaranteed if the block passed the compliance layer)

Types

type BlockScanner

type BlockScanner func(proposal *model.Proposal) error

BlockScanner describes a function for ingesting pending blocks. Any returned errors are considered fatal.

func CollectParentQCs

func CollectParentQCs(collector Collector[*flow.QuorumCertificate]) BlockScanner

CollectParentQCs collects all parent QCs included in the blocks descending from the latest finalized block. Caution, input blocks must be valid.

func CollectTCs

func CollectTCs(collector Collector[*flow.TimeoutCertificate]) BlockScanner

CollectTCs collect all TCs included in the blocks descending from the latest finalized block. Caution, input blocks must be valid.

func ForksState

func ForksState(forks hotstuff.Forks) BlockScanner

ForksState recovers Forks' internal state of blocks descending from the latest finalized block. Caution, input blocks must be valid and in parent-first order (unless parent is the latest finalized block).

func VoteAggregatorState

func VoteAggregatorState(voteAggregator hotstuff.VoteAggregator) BlockScanner

VoteAggregatorState recovers the VoteAggregator's internal state as follows:

• Add all blocks descending from the latest finalized block to accept votes. Those blocks should be rapidly pruned as the node catches up.

Caution: input blocks must be valid.

type Collector

type Collector[T any] struct {
	// contains filtered or unexported fields
}

Collector for objects of generic type. Essentially, it is a stateful list. Safe to be passed by value. Retrieve() returns the current state of the list and is unaffected by subsequent appends.

func NewCollector

func NewCollector[T any]() Collector[T]

func (Collector[T]) Append

func (c Collector[T]) Append(t ...T)

Append adds new elements to the end of the list.

func (Collector[T]) Retrieve

func (c Collector[T]) Retrieve() []T

Retrieve returns the current state of the list (unaffected by subsequent append)