Fields

• getCurrentChain ∷ STM m (AnchoredFragment (Header blk))
   
• getHeaderStateHistory ∷ STM m (HeaderStateHistory blk)
   
• getPastLedger ∷ Point blk → STM m (Maybe (ExtLedgerState blk))
   
• getIsInvalidBlock ∷ STM m (WithFingerprint (HeaderHash blk → Maybe (ExtValidationError blk)))
   

Fields

• mkPipelineDecision0 ∷ MkPipelineDecision

  The pipelining decider to use after MsgFoundIntersect arrives

• tracer ∷ Tracer m (TraceChainSyncClientEvent blk)
   
• cfg ∷ TopLevelConfig blk
   
• someHeaderInFutureCheck ∷ SomeHeaderInFutureCheck m blk
   
• historicityCheck ∷ HistoricityCheck m blk
   
• chainDbView ∷ ChainDbView m blk
   
• getDiffusionPipeliningSupport ∷ DiffusionPipeliningSupport
   

Fields

• version ∷ NodeToNodeVersion
   
• controlMessageSTM ∷ ControlMessageSTM m
   
• headerMetricsTracer ∷ HeaderMetricsTracer m
   
• setCandidate ∷ AnchoredFragment (Header blk) → STM m ()
   
• setLatestSlot ∷ WithOrigin SlotNo → STM m ()
   
• idling ∷ Idling m
   
• loPBucket ∷ LoPBucket m
   
• jumping ∷ Jumping m blk
   

Fields

• drainThePipe ∷ ∀ s n. NoThunks s ⇒ Nat n → Stateful m blk s (ClientPipelinedStIdle 'Z) → Stateful m blk s (ClientPipelinedStIdle n)

  "Drain the pipe": collect and discard all in-flight responses and finally execute the given action.

• disconnect ∷ ∀ m' a. MonadThrow m' ⇒ ChainSyncClientException → m' a

  Disconnect from the upstream node by throwing the given exception. The cleanup is handled in bracketChainSyncClient.

• headerInFutureCheck ∷ HeaderInFutureCheck m blk arrival judgment
   
• intersectsWithCurrentChain ∷ KnownIntersectionState blk → STM m (UpdatedIntersectionState blk ())

  A combinator necessary whenever relying on a KnownIntersectionState, since it's always possible that that intersection will go stale.

  Look at the current chain fragment that may have been updated in the background. Check whether the candidate fragment still intersects with it. If so, update the KnownIntersectionState and trim the candidate fragment to the new current chain fragment's anchor point. If not, return Nothing.

  INVARIANT: This a read-only STM transaction.

• terminate ∷ ChainSyncClientResult → m (Consensus (ClientPipelinedStIdle 'Z) blk m)

  Gracefully terminate the connection with the upstream node with the given result.

• terminateAfterDrain ∷ ∀ n. Nat n → ChainSyncClientResult → m (Consensus (ClientPipelinedStIdle n) blk m)

  Same as $sel:terminate:InternalEnv, but first $sel:drainThePipe:InternalEnv.

• traceException ∷ ∀ a. m a → m a

  Trace any ChainSyncClientException if thrown.

Fields

• (Point blk)

  Invalid header

• (HeaderError blk)
   
• (Our (Tip blk))
   
• (Their (Tip blk))

  Header validation threw an error.

Fields

• (Point blk)

  Intersection

• (Our (Tip blk))
   
• (Their (Tip blk))

  We send the upstream node a bunch of points from a chain fragment and the upstream node responded with an intersection point that is not on our chain fragment, and thus not among the points we sent.

  We store the intersection point the upstream node sent us.

Fields

• (Point blk)

  Block that triggered the validity check.

• (HeaderHash blk)

  Invalid block. If pipelining was negotiated, this can be different from the previous argument.

• (ExtValidationError blk)

  The upstream node's chain contained a block that we know is invalid.

Fields

• (Point blk)

  Intersection

• (Our (Tip blk))
   
• (Their (Tip blk))

  The server we're connecting to forked more than k blocks ago.

Fields

• (Point blk)

  Point asked to roll back to

• (Our (Tip blk))
   
• (Their (Tip blk))

  We were asked to roll back past the anchor point of the candidate's fragment. This means the candidate chain no longer forks off within k, making it impossible to switch to.

Fields

• unOur ∷ a
   

Fields

• unTheir ∷ a
   

Fields

• csjcJumpSize ∷ SlotNo

  The _ideal_ size for ChainSync jumps. Note that the algorithm is best-effort: there might not be exactly $sel:csjcJumpSize:CSJEnabledConfig slots between two jumps, depending on the chain.

  There can be a few less slots between jumps if there is not a block exactly at the boundary. Jumps are often made when a block is announced after the jump boundary.

  There can be even less slots if a dynamo is elected and it requires an initial jump regardless of how far we are from the next jump boundary.

  csjcJumpSize must be greater than 0 and smaller or equal to the genesis window size. The larger the jump size, the less jumps are made and peers are less involved in the syncing. A jump size as large as the genesis window has a higher change that dishonest peers can delay syncing by a small margin (around 2 minutes per dishonest peer with mainnet parameters).

Fields

• csbcCapacity ∷ Integer

  The capacity of the bucket (think number of tokens).

• csbcRate ∷ Rational

  The rate of the bucket (think tokens per second).

Fields

• cschGDDKill ∷ !(m ())

  Disconnects from the peer when the GDD considers it adversarial

• cschOnGsmStateChanged ∷ !(GsmState → Time → STM m ())

  Callback called by the GSM when the GSM state changes. They take the current time and should execute rapidly. Used to enable/disable the LoP.

• cschState ∷ !(StrictTVar m (ChainSyncState blk))

  Data shared between the client and external components like GDD.

• cschJumping ∷ !(StrictTVar m (ChainSyncJumpingState m blk))

  The state of the peer with respect to ChainSync jumping.

• cschJumpInfo ∷ !(StrictTVar m (Maybe (JumpInfo blk)))

  ChainSync state needed to jump to the tip of the candidate fragment of the peer.

Fields

• csCandidate ∷ !(AnchoredFragment (Header blk))

  The current candidate fragment.

• csIdling ∷ !Bool

  Whether the last message sent by the peer was MsgAwaitReply.

  This ChainSync client should ensure that its peer sets this flag while and only while both of the following conditions are satisfied: the peer's latest message has been fully processed (especially that its candidate has been updated; previous argument) and its latest message did not claim that it already has headers that extend its candidate.

  It's more important that the flag is unset promptly than it is for the flag to be set promptly, because of how this is used by the GSM to determine that the node is done syncing.

• csLatestSlot ∷ !(StrictMaybe (WithOrigin SlotNo))

  When the client receives a new header, it updates this field before processing it further, and the latest slot may refer to a header beyond the forecast horizon while the candidate fragment isn't extended yet, to signal to GDD that the density is known up to this slot.

Fields

• csvSetCandidate ∷ !(AnchoredFragment (Header blk) → STM m ())

  The current candidate fragment

• csvSetLatestSlot ∷ !(WithOrigin SlotNo → STM m ())

  Update the slot of the latest received header

• csvIdling ∷ !(Idling m)

  (Un)mark the peer as idling.

• csvLoPBucket ∷ !(LoPBucket m)

  Control the LeakyBucket for the LoP.

• csvJumping ∷ !(Jumping m blk)

  Jumping-related API.