Moduleouroboros-consensus-4.2.1.0

Ouroboros.Consensus.MiniProtocol.ChainSync.Client

18 types
9 values

Packageouroboros-consensus-4.2.1.0
Exports27
LicenceApache-2.0

valuebracketChainSyncClient

:: (IOLike m, Ord peer, LedgerSupportsProtocol blk, MonadTimer m)
=> Tracer m (TraceChainSyncClientEvent blk)
-> Tracer m (TraceEventCsj peer blk)
-> ChainDbView m blk
-> ChainSyncClientHandleCollection peer m blk
-> STM m GsmState
-> peer
-> NodeToNodeVersion
-> ChainSyncLoPBucketConfig
-> CSJConfig
-> DiffusionPipeliningSupport
-> ChainSyncStateView m blk -> m a
-> m a

valuechainSyncClient

:: (IOLike m, LedgerSupportsProtocol blk)
=> ConfigEnv m blk
-> DynamicEnv m blk
-> Consensus ChainSyncClientPipelined blk m

valuechainSyncStateFor

:: (Ord peer, IOLike m)
=> StrictTVar m (Map peer (ChainSyncClientHandle m blk))
-> peer
-> STM m (ChainSyncState blk)

valuedefaultChainDbView :: ChainDB m blk -> ChainDbView m blk

valuenoIdling :: Applicative m => Idling m

valuenoLoPBucket :: Applicative m => LoPBucket m

valueviewChainSyncState

:: IOLike m
=> STM m (Map peer (ChainSyncClientHandle m blk))
-> ChainSyncState blk -> a
-> STM m (Map peer a)

valuenoJumping :: MonadSTM m => Jumping m blk

value

newChainSyncClientHandleCollection :: (Ord peer, IOLike m, LedgerSupportsProtocol blk, NoThunks peer) => STM m (ChainSyncClientHandleCollection peer m blk)

datadata CSJConfig

Instances4Eq, Show, Generic, Rep

Eq CSJConfigDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
Show CSJConfigDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
Generic CSJConfigDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
type Rep CSJConfig = D1 ('MetaData "CSJConfig" "Ouroboros.Consensus.MiniProtocol.ChainSync.Client" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "CSJDisabled" 'PrefixI 'False) U1 :+: C1 ('MetaCons "CSJEnabled" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CSJEnabledConfig)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client

newtypenewtype CSJEnabledConfig

Constructors

CSJEnabledConfig
- csjcJumpSize :: SlotNo

Instances4Eq, Show, Generic, Rep

Eq CSJEnabledConfigDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
Show CSJEnabledConfigDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
Generic CSJEnabledConfigDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
type Rep CSJEnabledConfig = D1 ('MetaData "CSJEnabledConfig" "Ouroboros.Consensus.MiniProtocol.ChainSync.Client" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'True) (C1 ('MetaCons "CSJEnabledConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "csjcJumpSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SlotNo)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client

datadata ChainDbView (m :: Type -> Type) blk

Constructors

ChainDbView
- getCurrentChain :: STM m (AnchoredFragment (Header blk))
- getHeaderStateHistory :: STM m (HeaderStateHistory blk)
- getPastLedger :: Point blk -> STM m (Maybe (ExtLedgerState blk EmptyMK))
- getIsInvalidBlock :: STM m (WithFingerprint (HeaderHash blk -> Maybe (ExtValidationError blk)))

datadata ChainSyncClientException

Constructors

forall blk. (BlockSupportsProtocol blk, ValidateEnvelope blk) => HeaderError (Point blk) (HeaderError blk) (Our (Tip blk)) (Their (Tip blk))
forall blk. BlockSupportsProtocol blk => InvalidIntersection (Point blk) (Our (Tip blk)) (Their (Tip blk))
forall blk. LedgerSupportsProtocol blk => InvalidBlock (Point blk) (HeaderHash blk) (ExtValidationError blk)
forall blk. BlockSupportsProtocol blk => CandidateTooSparse (Point blk) (Our (Tip blk)) (Their (Tip blk))
InFutureHeaderExceedsClockSkew !HeaderArrivalException
HistoricityError !HistoricityException
EmptyBucket
InvalidJumpResponse
DensityTooLow

Instances3Eq, Show, Exception

Eq ChainSyncClientExceptionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
Show ChainSyncClientExceptionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
Exception ChainSyncClientExceptionDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client

datadata ChainSyncClientResult

Constructors

forall blk. BlockSupportsProtocol blk => ForkTooDeep (Point blk) (Our (Tip blk)) (Their (Tip blk))
forall blk. BlockSupportsProtocol blk => NoMoreIntersection (Our (Tip blk)) (Their (Tip blk))
forall blk. BlockSupportsProtocol blk => RolledBackPastIntersection (Point blk) (Our (Tip blk)) (Their (Tip blk))
AskedToTerminate

Instances3Eq, Show, NFData

Eq ChainSyncClientResultDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
Show ChainSyncClientResultDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
NFData ChainSyncClientResultDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client

datadata ChainSyncLoPBucketConfig

Constructors

ChainSyncLoPBucketDisabled
ChainSyncLoPBucketEnabled ChainSyncLoPBucketEnabledConfig

Instances4Eq, Show, Generic, Rep

Eq ChainSyncLoPBucketConfigDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
Show ChainSyncLoPBucketConfigDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
Generic ChainSyncLoPBucketConfigDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
type Rep ChainSyncLoPBucketConfig = D1 ('MetaData "ChainSyncLoPBucketConfig" "Ouroboros.Consensus.MiniProtocol.ChainSync.Client" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "ChainSyncLoPBucketDisabled" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ChainSyncLoPBucketEnabled" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ChainSyncLoPBucketEnabledConfig)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client

datadata ChainSyncLoPBucketEnabledConfig

Constructors

ChainSyncLoPBucketEnabledConfig
- csbcCapacity :: Integer
- csbcRate :: Rational

Instances4Eq, Show, Generic, Rep

Eq ChainSyncLoPBucketEnabledConfigDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
Show ChainSyncLoPBucketEnabledConfigDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
Generic ChainSyncLoPBucketEnabledConfigDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
type Rep ChainSyncLoPBucketEnabledConfig = D1 ('MetaData "ChainSyncLoPBucketEnabledConfig" "Ouroboros.Consensus.MiniProtocol.ChainSync.Client" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "ChainSyncLoPBucketEnabledConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "csbcCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :*: S1 ('MetaSel ('Just "csbcRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Rational)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client

datadata ChainSyncStateView (m :: Type -> Type) blk

Constructors

ChainSyncStateView
- csvSetCandidate :: !AnchoredFragment (HeaderWithTime blk) -> STM m ()
- csvSetLatestSlot :: !WithOrigin SlotNo -> STM m ()
- csvIdling :: !Idling m
- csvLoPBucket :: !LoPBucket m
- csvJumping :: !Jumping m blk

Instances3Generic, NoThunks, Rep

Generic (ChainSyncStateView m blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
(IOLike m, HasHeader blk, NoThunks (Header blk)) => NoThunks (ChainSyncStateView m blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
type Rep (ChainSyncStateView m blk) = D1 ('MetaData "ChainSyncStateView" "Ouroboros.Consensus.MiniProtocol.ChainSync.Client" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "ChainSyncStateView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "csvSetCandidate") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (AnchoredFragment (HeaderWithTime blk) -> STM m ())) :*: S1 ('MetaSel ('Just "csvSetLatestSlot") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (WithOrigin SlotNo -> STM m ()))) :*: (S1 ('MetaSel ('Just "csvIdling") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Idling m)) :*: (S1 ('MetaSel ('Just "csvLoPBucket") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (LoPBucket m)) :*: S1 ('MetaSel ('Just "csvJumping") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Jumping m blk))))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client

datadata ConfigEnv (m :: Type -> Type) blk

Constructors

ConfigEnv
- mkPipelineDecision0 :: MkPipelineDecision
- tracer :: Tracer m (TraceChainSyncClientEvent blk)
- cfg :: TopLevelConfig blk
- someHeaderInFutureCheck :: SomeHeaderInFutureCheck m blk
- historicityCheck :: HistoricityCheck m blk
- chainDbView :: ChainDbView m blk
- getDiffusionPipeliningSupport :: DiffusionPipeliningSupport

type

type Consensus (client :: Type -> Type -> Type -> (Type -> Type) -> Type -> Type) blk (m :: Type -> Type) = client (Header blk) (Point blk) (Tip blk) m ChainSyncClientResult

datadata DynamicEnv (m :: Type -> Type) blk

Constructors

DynamicEnv
- version :: NodeToNodeVersion
- controlMessageSTM :: ControlMessageSTM m
- headerMetricsTracer :: HeaderMetricsTracer m
- setCandidate :: AnchoredFragment (HeaderWithTime blk) -> STM m ()
- setLatestSlot :: WithOrigin SlotNo -> STM m ()
- idling :: Idling m
- loPBucket :: LoPBucket m
- jumping :: Jumping m blk

datadata InternalEnv (m :: Type -> Type) blk arrival judgment

Constructors

InternalEnv
- drainThePipe :: forall s (n :: N). NoThunks s => Nat n -> Stateful m blk s (ClientPipelinedStIdle 'Z) -> Stateful m blk s (ClientPipelinedStIdle n)
- disconnect :: forall (m' :: Type -> Type) a. MonadThrow m' => ChainSyncClientException -> m' a
- headerInFutureCheck :: HeaderInFutureCheck m blk arrival judgment
- intersectsWithCurrentChain :: KnownIntersectionState blk -> STM m (UpdatedIntersectionState blk ())
- terminate :: ChainSyncClientResult -> m (Consensus (ClientPipelinedStIdle 'Z) blk m)
- terminateAfterDrain :: forall (n :: N). Nat n -> ChainSyncClientResult -> m (Consensus (ClientPipelinedStIdle n) blk m)
- traceException :: forall a. m a -> m a

newtypenewtype Our a

Constructors

Our
- unOur :: a

Instances4Eq, Show, NFData, NoThunks

Eq a => Eq (Our a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
Show a => Show (Our a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
NFData a => NFData (Our a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
NoThunks a => NoThunks (Our a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client

newtypenewtype Their a

Constructors

Their
- unTheir :: a

Instances4Eq, Show, NFData, NoThunks

Eq a => Eq (Their a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
Show a => Show (Their a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
NFData a => NFData (Their a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client
NoThunks a => NoThunks (Their a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client

datadata TraceChainSyncClientEvent blk

Constructors

TraceDownloadedHeader (Header blk)
TraceRolledBack (Point blk)
TraceFoundIntersection (Point blk) (Our (Tip blk)) (Their (Tip blk))
TraceException ChainSyncClientException
TraceTermination ChainSyncClientResult
TraceValidatedHeader (Header blk)
TraceWaitingBeyondForecastHorizon SlotNo
TraceAccessingForecastHorizon SlotNo
TraceGaveLoPToken Bool (Header blk) BlockNo
TraceOfferJump (Point blk)
TraceJumpResult (JumpResult blk)
TraceJumpingWaitingForNextInstruction
TraceJumpingInstructionIs (Instruction blk)
forall n. TraceDrainingThePipe (Nat n)

Instances1Show

(BlockSupportsProtocol blk, Show (Header blk)) => Show (TraceChainSyncClientEvent blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client

datadata ChainSyncClientHandle (m :: Type -> Type) blk

Constructors

ChainSyncClientHandle
- cschGDDKill :: !m ()
- cschOnGsmStateChanged :: !GsmState -> Time -> STM m ()
- cschState :: !StrictTVar m (ChainSyncState blk)
- cschJumping :: !StrictTVar m (ChainSyncJumpingState m blk)
- cschJumpInfo :: !StrictTVar m (Maybe (JumpInfo blk))

Instances3Generic, NoThunks, Rep

Generic (ChainSyncClientHandle m blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.State
(IOLike m, HasHeader blk, LedgerSupportsProtocol blk, NoThunks (Header blk)) => NoThunks (ChainSyncClientHandle m blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.State
type Rep (ChainSyncClientHandle m blk) = D1 ('MetaData "ChainSyncClientHandle" "Ouroboros.Consensus.MiniProtocol.ChainSync.Client.State" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "ChainSyncClientHandle" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cschGDDKill") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (m ())) :*: S1 ('MetaSel ('Just "cschOnGsmStateChanged") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (GsmState -> Time -> STM m ()))) :*: (S1 ('MetaSel ('Just "cschState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StrictTVar m (ChainSyncState blk))) :*: (S1 ('MetaSel ('Just "cschJumping") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StrictTVar m (ChainSyncJumpingState m blk))) :*: S1 ('MetaSel ('Just "cschJumpInfo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StrictTVar m (Maybe (JumpInfo blk))))))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.State

datadata ChainSyncClientHandleCollection peer (m :: Type -> Type) blk

Constructors

ChainSyncClientHandleCollection
- cschcMap :: !STM m (Map peer (ChainSyncClientHandle m blk))
- cschcSeq :: !STM m (StrictSeq (peer, ChainSyncClientHandle m blk))
- cschcAddHandle :: !peer -> ChainSyncClientHandle m blk -> STM m ()
- cschcRemoveHandle :: !peer -> STM m ()
- cschcRotateHandle :: !peer -> STM m ()
- cschcRemoveAllHandles :: !STM m ()

Instances3Generic, NoThunks, Rep

Generic (ChainSyncClientHandleCollection peer m blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.State
(IOLike m, HasHeader blk, LedgerSupportsProtocol blk, NoThunks (STM m ()), NoThunks (Header blk), NoThunks (STM m (Map peer (ChainSyncClientHandle m blk))), NoThunks (STM m (StrictSeq (peer, ChainSyncClientHandle m blk)))) => NoThunks (ChainSyncClientHandleCollection peer m blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.State
type Rep (ChainSyncClientHandleCollection peer m blk) = D1 ('MetaData "ChainSyncClientHandleCollection" "Ouroboros.Consensus.MiniProtocol.ChainSync.Client.State" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "ChainSyncClientHandleCollection" 'PrefixI 'True) ((S1 ('MetaSel ('Just "cschcMap") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (STM m (Map peer (ChainSyncClientHandle m blk)))) :*: (S1 ('MetaSel ('Just "cschcSeq") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (STM m (StrictSeq (peer, ChainSyncClientHandle m blk)))) :*: S1 ('MetaSel ('Just "cschcAddHandle") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (peer -> ChainSyncClientHandle m blk -> STM m ())))) :*: (S1 ('MetaSel ('Just "cschcRemoveHandle") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (peer -> STM m ())) :*: (S1 ('MetaSel ('Just "cschcRotateHandle") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (peer -> STM m ())) :*: S1 ('MetaSel ('Just "cschcRemoveAllHandles") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (STM m ()))))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.State

datadata ChainSyncState blk

Constructors

ChainSyncState
- csCandidate :: !AnchoredFragment (HeaderWithTime blk)
- csIdling :: !Bool
- csLatestSlot :: !StrictMaybe (WithOrigin SlotNo)

Instances3Generic, NoThunks, Rep

Generic (ChainSyncState blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.State
(HasHeader blk, NoThunks (Header blk)) => NoThunks (ChainSyncState blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.State
type Rep (ChainSyncState blk) = D1 ('MetaData "ChainSyncState" "Ouroboros.Consensus.MiniProtocol.ChainSync.Client.State" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "ChainSyncState" 'PrefixI 'True) (S1 ('MetaSel ('Just "csCandidate") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (AnchoredFragment (HeaderWithTime blk))) :*: (S1 ('MetaSel ('Just "csIdling") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "csLatestSlot") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StrictMaybe (WithOrigin SlotNo))))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.MiniProtocol.ChainSync.Client.State