Safe Haskell	None
Language	Haskell2010

Cardano.Network.FetchMode

Synopsis

mkReadFetchMode :: Functor m => ConsensusMode -> m LedgerStateJudgement -> m PraosFetchMode -> m FetchMode
data ConsensusMode
- = GenesisMode
- | PraosMode
data LedgerStateJudgement
- = YoungEnough
- | TooOld
newtype Fingerprint = Fingerprint Word64
data FetchMode
- = FetchModeGenesis
- | PraosFetchMode PraosFetchMode
data PraosFetchMode
- = FetchModeBulkSync
- | FetchModeDeadline
data ChainSelStarvation
- = ChainSelStarvationOngoing
- | ChainSelStarvationEndedAt Time
data WithFingerprint a = WithFingerprint {
- forgetFingerprint :: !a
- getFingerprint :: !Fingerprint
}
initialWithFingerprint :: a -> WithFingerprint a
data BlockFetchConsensusInterface peer header block (m :: Type -> Type) = BlockFetchConsensusInterface {
- readCandidateChains :: STM m (Map peer (AnchoredFragment header))
- readCurrentChain :: STM m (AnchoredFragment header)
- readFetchMode :: STM m FetchMode
- readFetchedBlocks :: STM m (Point block -> Bool)
- mkAddFetchedBlock :: STM m (Point block -> block -> m ())
- readFetchedMaxSlotNo :: STM m MaxSlotNo
- readChainComparison :: STM m (WithFingerprint (ChainComparison header))
- blockFetchSize :: header -> SizeInBytes
- blockMatchesHeader :: header -> block -> Bool
- headerForgeUTCTime :: header -> UTCTime
- readChainSelStarvation :: STM m ChainSelStarvation
- demoteChainSyncJumpingDynamo :: peer -> m ()
}
data ChainComparison header = ChainComparison {
- plausibleCandidateChain :: HasCallStack => AnchoredFragment header -> AnchoredFragment header -> Bool
- compareCandidateChains :: HasCallStack => AnchoredFragment header -> AnchoredFragment header -> Ordering
}

Documentation

mkReadFetchMode Source #

Arguments

:: Functor m
=> ConsensusMode
-> m LedgerStateJudgement	Used for `GenesisMode`.
-> m PraosFetchMode	Used for `PraosMode` for backwards compatibility.
-> m FetchMode

Construct readFetchMode for BlockFetchConsensusInterface by branching on the ConsensusMode.

data ConsensusMode Source #

Diffusion layer configuration parameter.

The two modes determine which PeerSelectionTargets basis is used by churn and OG. The node's configuration sets this, and diffusion is initiated and remains only in this mode.

Constructors

GenesisMode	When `LedgerStateJudgement` is `TooOld`, the targets basis is changed from default to one specific for this mode, which uses more big ledger peers until syncing is complete.
PraosMode	The legacy mode which depends on official relays and/or bootstrap peers configuration. This mode uses only the default target basis irrespective ledger state.

Instances

Instances details

FromJSON ConsensusMode Source #

Instance details

Defined in Cardano.Network.ConsensusMode

Methods

parseJSON :: Value -> Parser ConsensusMode #

parseJSONList :: Value -> Parser [ConsensusMode] #

omittedField :: Maybe ConsensusMode #

Generic ConsensusMode Source #

Instance details

Defined in Cardano.Network.ConsensusMode

Associated Types

type Rep ConsensusMode
Instance details Defined in Cardano.Network.ConsensusMode type Rep ConsensusMode = D1 ('MetaData "ConsensusMode" "Cardano.Network.ConsensusMode" "cardano-diffusion-0.1.0.0-inplace-api" 'False) (C1 ('MetaCons "GenesisMode" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PraosMode" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: ConsensusMode -> Rep ConsensusMode x #

to :: Rep ConsensusMode x -> ConsensusMode #

Show ConsensusMode Source #

Instance details

Defined in Cardano.Network.ConsensusMode

Methods

showsPrec :: Int -> ConsensusMode -> ShowS #

show :: ConsensusMode -> String #

showList :: [ConsensusMode] -> ShowS #

Eq ConsensusMode Source #

Instance details

Defined in Cardano.Network.ConsensusMode

Methods

(==) :: ConsensusMode -> ConsensusMode -> Bool #

(/=) :: ConsensusMode -> ConsensusMode -> Bool #

type Rep ConsensusMode Source #

Instance details

Defined in Cardano.Network.ConsensusMode

type Rep ConsensusMode = D1 ('MetaData "ConsensusMode" "Cardano.Network.ConsensusMode" "cardano-diffusion-0.1.0.0-inplace-api" 'False) (C1 ('MetaCons "GenesisMode" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PraosMode" 'PrefixI 'False) (U1 :: Type -> Type))

data LedgerStateJudgement Source #

Wether the node is caught up or fell too far behind the chain

Constructors

YoungEnough
TooOld

Instances

Instances details

Generic LedgerStateJudgement Source #

Instance details

Defined in Cardano.Network.LedgerStateJudgement

Associated Types

type Rep LedgerStateJudgement
Instance details Defined in Cardano.Network.LedgerStateJudgement type Rep LedgerStateJudgement = D1 ('MetaData "LedgerStateJudgement" "Cardano.Network.LedgerStateJudgement" "cardano-diffusion-0.1.0.0-inplace-api" 'False) (C1 ('MetaCons "YoungEnough" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TooOld" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: LedgerStateJudgement -> Rep LedgerStateJudgement x #

to :: Rep LedgerStateJudgement x -> LedgerStateJudgement #

Show LedgerStateJudgement Source #

Instance details

Defined in Cardano.Network.LedgerStateJudgement

Methods

showsPrec :: Int -> LedgerStateJudgement -> ShowS #

show :: LedgerStateJudgement -> String #

showList :: [LedgerStateJudgement] -> ShowS #

Eq LedgerStateJudgement Source #

Instance details

Defined in Cardano.Network.LedgerStateJudgement

Methods

(==) :: LedgerStateJudgement -> LedgerStateJudgement -> Bool #

(/=) :: LedgerStateJudgement -> LedgerStateJudgement -> Bool #

NoThunks LedgerStateJudgement Source #

Instance details

Defined in Cardano.Network.LedgerStateJudgement

Methods

noThunks :: Context -> LedgerStateJudgement -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> LedgerStateJudgement -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy LedgerStateJudgement -> String #

type Rep LedgerStateJudgement Source #

Instance details

Defined in Cardano.Network.LedgerStateJudgement

type Rep LedgerStateJudgement = D1 ('MetaData "LedgerStateJudgement" "Cardano.Network.LedgerStateJudgement" "cardano-diffusion-0.1.0.0-inplace-api" 'False) (C1 ('MetaCons "YoungEnough" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TooOld" 'PrefixI 'False) (U1 :: Type -> Type))

newtype Fingerprint #

Constructors

Fingerprint Word64

Instances

Instances details

Enum Fingerprint

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

Methods

succ :: Fingerprint -> Fingerprint #

pred :: Fingerprint -> Fingerprint #

toEnum :: Int -> Fingerprint #

fromEnum :: Fingerprint -> Int #

enumFrom :: Fingerprint -> [Fingerprint] #

enumFromThen :: Fingerprint -> Fingerprint -> [Fingerprint] #

enumFromTo :: Fingerprint -> Fingerprint -> [Fingerprint] #

enumFromThenTo :: Fingerprint -> Fingerprint -> Fingerprint -> [Fingerprint] #

Generic Fingerprint

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

Associated Types

type Rep Fingerprint
Instance details Defined in Ouroboros.Network.BlockFetch.ConsensusInterface type Rep Fingerprint = D1 ('MetaData "Fingerprint" "Ouroboros.Network.BlockFetch.ConsensusInterface" "ouroboros-network-0.23.0.0-inplace-api" 'True) (C1 ('MetaCons "Fingerprint" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

Methods

from :: Fingerprint -> Rep Fingerprint x #

to :: Rep Fingerprint x -> Fingerprint #

Show Fingerprint

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

Methods

showsPrec :: Int -> Fingerprint -> ShowS #

show :: Fingerprint -> String #

showList :: [Fingerprint] -> ShowS #

Eq Fingerprint

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

Methods

(==) :: Fingerprint -> Fingerprint -> Bool #

(/=) :: Fingerprint -> Fingerprint -> Bool #

NoThunks Fingerprint

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

Methods

noThunks :: Context -> Fingerprint -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> Fingerprint -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy Fingerprint -> String #

type Rep Fingerprint

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

type Rep Fingerprint = D1 ('MetaData "Fingerprint" "Ouroboros.Network.BlockFetch.ConsensusInterface" "ouroboros-network-0.23.0.0-inplace-api" 'True) (C1 ('MetaCons "Fingerprint" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)))

data FetchMode #

Constructors

FetchModeGenesis
PraosFetchMode PraosFetchMode

Instances

Instances details

Show FetchMode
Instance details Defined in Ouroboros.Network.BlockFetch.ConsensusInterface Methods showsPrec :: Int -> FetchMode -> ShowS # show :: FetchMode -> String # showList :: [FetchMode] -> ShowS #
Eq FetchMode
Instance details Defined in Ouroboros.Network.BlockFetch.ConsensusInterface Methods (==) :: FetchMode -> FetchMode -> Bool # (/=) :: FetchMode -> FetchMode -> Bool #

data PraosFetchMode #

Constructors

FetchModeBulkSync
FetchModeDeadline

Instances

Instances details

Show PraosFetchMode
Instance details Defined in Ouroboros.Network.BlockFetch.ConsensusInterface Methods showsPrec :: Int -> PraosFetchMode -> ShowS # show :: PraosFetchMode -> String # showList :: [PraosFetchMode] -> ShowS #
Eq PraosFetchMode
Instance details Defined in Ouroboros.Network.BlockFetch.ConsensusInterface Methods (==) :: PraosFetchMode -> PraosFetchMode -> Bool # (/=) :: PraosFetchMode -> PraosFetchMode -> Bool #

data ChainSelStarvation #

Constructors

ChainSelStarvationOngoing
ChainSelStarvationEndedAt Time

Instances

Instances details

Generic ChainSelStarvation

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

Associated Types

type Rep ChainSelStarvation

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

type Rep ChainSelStarvation = D1 ('MetaData "ChainSelStarvation" "Ouroboros.Network.BlockFetch.ConsensusInterface" "ouroboros-network-0.23.0.0-inplace-api" 'False) (C1 ('MetaCons "ChainSelStarvationOngoing" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ChainSelStarvationEndedAt" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Time)))

Methods

from :: ChainSelStarvation -> Rep ChainSelStarvation x #

to :: Rep ChainSelStarvation x -> ChainSelStarvation #

Show ChainSelStarvation

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

Methods

showsPrec :: Int -> ChainSelStarvation -> ShowS #

show :: ChainSelStarvation -> String #

showList :: [ChainSelStarvation] -> ShowS #

Eq ChainSelStarvation

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

Methods

(==) :: ChainSelStarvation -> ChainSelStarvation -> Bool #

(/=) :: ChainSelStarvation -> ChainSelStarvation -> Bool #

NoThunks ChainSelStarvation

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

Methods

noThunks :: Context -> ChainSelStarvation -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> ChainSelStarvation -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy ChainSelStarvation -> String #

type Rep ChainSelStarvation

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

type Rep ChainSelStarvation = D1 ('MetaData "ChainSelStarvation" "Ouroboros.Network.BlockFetch.ConsensusInterface" "ouroboros-network-0.23.0.0-inplace-api" 'False) (C1 ('MetaCons "ChainSelStarvationOngoing" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ChainSelStarvationEndedAt" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Time)))

data WithFingerprint a #

Constructors

WithFingerprint
Fields forgetFingerprint :: !a getFingerprint :: !Fingerprint

Instances

Instances details

Functor WithFingerprint

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

Methods

fmap :: (a -> b) -> WithFingerprint a -> WithFingerprint b #

(<$) :: a -> WithFingerprint b -> WithFingerprint a #

Generic (WithFingerprint a)

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

Associated Types

type Rep (WithFingerprint a)

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

type Rep (WithFingerprint a) = D1 ('MetaData "WithFingerprint" "Ouroboros.Network.BlockFetch.ConsensusInterface" "ouroboros-network-0.23.0.0-inplace-api" 'False) (C1 ('MetaCons "WithFingerprint" 'PrefixI 'True) (S1 ('MetaSel ('Just "forgetFingerprint") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Just "getFingerprint") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Fingerprint)))

Methods

from :: WithFingerprint a -> Rep (WithFingerprint a) x #

to :: Rep (WithFingerprint a) x -> WithFingerprint a #

Show a => Show (WithFingerprint a)

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

Methods

showsPrec :: Int -> WithFingerprint a -> ShowS #

show :: WithFingerprint a -> String #

showList :: [WithFingerprint a] -> ShowS #

NoThunks a => NoThunks (WithFingerprint a)

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

Methods

noThunks :: Context -> WithFingerprint a -> IO (Maybe ThunkInfo) #

wNoThunks :: Context -> WithFingerprint a -> IO (Maybe ThunkInfo) #

showTypeOf :: Proxy (WithFingerprint a) -> String #

type Rep (WithFingerprint a)

Instance details

Defined in Ouroboros.Network.BlockFetch.ConsensusInterface

type Rep (WithFingerprint a) = D1 ('MetaData "WithFingerprint" "Ouroboros.Network.BlockFetch.ConsensusInterface" "ouroboros-network-0.23.0.0-inplace-api" 'False) (C1 ('MetaCons "WithFingerprint" 'PrefixI 'True) (S1 ('MetaSel ('Just "forgetFingerprint") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Just "getFingerprint") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 Fingerprint)))

initialWithFingerprint :: a -> WithFingerprint a #

data BlockFetchConsensusInterface peer header block (m :: Type -> Type) #

Constructors

BlockFetchConsensusInterface

Fields

readCandidateChains :: STM m (Map peer (AnchoredFragment header))
readCurrentChain :: STM m (AnchoredFragment header)
readFetchMode :: STM m FetchMode
readFetchedBlocks :: STM m (Point block -> Bool)
mkAddFetchedBlock :: STM m (Point block -> block -> m ())
readFetchedMaxSlotNo :: STM m MaxSlotNo
readChainComparison :: STM m (WithFingerprint (ChainComparison header))
blockFetchSize :: header -> SizeInBytes
blockMatchesHeader :: header -> block -> Bool
headerForgeUTCTime :: header -> UTCTime
readChainSelStarvation :: STM m ChainSelStarvation
demoteChainSyncJumpingDynamo :: peer -> m ()

data ChainComparison header #

Constructors

ChainComparison
Fields plausibleCandidateChain :: HasCallStack => AnchoredFragment header -> AnchoredFragment header -> Bool compareCandidateChains :: HasCallStack => AnchoredFragment header -> AnchoredFragment header -> Ordering