Fields

• enterCaughtUp ∷ ∀ neverTerminates. m neverTerminates

  ASSUMPTION the marker file is present on disk, a la setCaughtUpPersistentMark True

  Thus this can be invoked at node start up after determining the marker file is present (and the tip is still not stale)

• enterPreSyncing ∷ ∀ neverTerminates. m neverTerminates

  ASSUMPTION the marker file is absent on disk, a la setCaughtUpPersistentMark False

  Thus this can be invoked at node start up after determining the marker file is absent.

Fields

• gsmAntiThunderingHerd ∷ StdGen

  See antiThunderingHerd

• gsmDurationUntilTooOld ∷ Maybe (WrapDurationUntilTooOld m blk)

  See durationUntilTooOld

• gsmMarkerFileView ∷ MarkerFileView m
   
• gsmMinCaughtUpDuration ∷ NominalDiffTime

  See minCaughtUpDuration

Fields

• antiThunderingHerd ∷ Maybe StdGen

  An initial seed used to randomly increase minCaughtUpDuration by up to 15% every transition from Syncing to CaughtUp, in order to avoid a thundering herd phenomenon.

  Nothing should only be used for testing.

• getCandidateOverSelection ∷ STM m (selection → chainSyncState → CandidateVersusSelection)

  Whether the candidate from the chainSyncState is preferable to the selection. This can depend on external state (Peras certificates boosting blocks).

• peerIsIdle ∷ chainSyncState → Bool
   
• durationUntilTooOld ∷ Maybe (selection → m DurationFromNow)

  How long from now until the selection will be so old that the node should exit the CaughtUp state

  Nothing means the selection can never become too old.

• equivalent ∷ selection → selection → Bool

  Whether the two selections are equivalent for the purpose of the Genesis State Machine

• getChainSyncStates ∷ STM m (Map upstreamPeer (StrictTVar m chainSyncState))

  The current ChainSync state with the latest candidates from the upstream peers

• getCurrentSelection ∷ STM m selection

  The node's current selection

• minCaughtUpDuration ∷ NominalDiffTime

  How long the node must stay in CaughtUp after transitioning to it from Syncing, regardless of the selection's age. This prevents the whole network from thrashing between CaughtUp and (Pre)Syncing if there's an outage in block production.

  See also antiThunderingHerd.

• setCaughtUpPersistentMark ∷ Bool → m ()

  EG touch/delete the marker file on disk

• writeGsmState ∷ GsmState → m ()

  EG update the TVar that the Diffusion Layer monitors, or en-/disable certain components of Genesis

• isHaaSatisfied ∷ STM m Bool

  Whether the Honest Availability Assumption is currently satisfied. This is used as the trigger for transitioning from PreSyncing to Syncing and vice versa.

Fields

• hasMarkerFile ∷ m Bool
   
• removeMarkerFile ∷ m ()

  Remove the marker file

  Will throw an FsResourceDoesNotExist error when it does not exist.

• touchMarkerFile ∷ m ()

  Create the marker file

  Idempotent.

Fields

• getDurationUntilTooOld ∷ WithOrigin SlotNo → m DurationFromNow