Skip to content

docs(fork-choice): document checkpoint return values #9908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wemeetagain merged 1 commit into from
Aug 24, 2026
Merged

docs(fork-choice): document checkpoint return values #9908

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions packages/fork-choice/src/forkChoice/forkChoice.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1741,6 +1741,8 @@ export class ForkChoice implements IForkChoice {
* May need the justified balances of:
* - unrealizedJustified: Already available in `CheckpointWithBalance`
* Since this balances are already available the getter is just `() => balances`, without cache interaction
*
* @returns Whether either checkpoint was updated.
*/
private updateCheckpoints(
justifiedCheckpoint: CheckpointWithHex,
Expand Down Expand Up @@ -2049,6 +2051,8 @@ export class ForkChoice implements IForkChoice {
* Equivalent to:
*
* https://github.com/ethereum/consensus-specs/blob/v1.1.10/specs/phase0/fork-choice.md#on_tick
*
* @returns Whether an epoch-boundary checkpoint was updated.
*/
private onTick(time: Slot): boolean {
const previousSlot = this.fcStore.currentSlot;
Expand All @@ -2074,8 +2078,7 @@ export class ForkChoice implements IForkChoice {
return false;
}

// If a new epoch, pull-up justification and finalization from previous epoch. Returns whether a
// checkpoint moved, so the caller can decide to recompute the head (see `updateTime`).
// If a new epoch, pull-up justification and finalization from previous epoch.
return this.updateCheckpoints(
this.fcStore.unrealizedJustified.checkpoint,
this.fcStore.unrealizedFinalizedCheckpoint,
Expand Down