Apply suggestions from code review

Co-authored-by: Alexander Hentschel <[email protected]>

Author: durkmurder

consensus/follower.go

@@ -29,7 +29,7 @@ func NewFollower(log zerolog.Logger, committee hotstuff.DynamicCommittee, header
 	// initialize the Validator
 	validator := validator.New(committee, verifier)
 
-	// recover the hotstuff state as a follower
+	// recover the HotStuff follower's internal state (inserts all pending blocks into Forks)
 	err = recovery.Follower(log, forks, validator, pending)
 	if err != nil {
 		return nil, fmt.Errorf("could not recover hotstuff follower state: %w", err)

consensus/participant.go

@@ -46,7 +46,7 @@ func NewParticipant(
 	modules.VoteAggregator.PruneUpToView(finalized.View)
 	modules.TimeoutAggregator.PruneUpToView(finalized.View)
 
-	// recover the hotstuff state, mainly to recover all pending blocks in Forks
+	// recover hotstuff state (inserts all pending blocks into Forks and VoteAggregator)
 	err := recovery.Participant(log, modules.Forks, modules.VoteAggregator, modules.Validator, pending)
 	if err != nil {
 		return nil, fmt.Errorf("could not recover hotstuff state: %w", err)

consensus/recovery/recover.go

@@ -13,7 +13,7 @@ import (
 )
 
 // 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
+// It receives the list `pending` that should contain _all_ blocks that have been
 // received but not finalized, and that share the latest finalized block as a common
 // ancestor.
 func Recover(log zerolog.Logger, pending []*flow.Header, validator hotstuff.Validator, onProposal func(*model.Proposal) error) error {