Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.Node.Genesis

Contents

GenesisConfig
NodeKernel helpers

Synopsis

data GenesisConfig = GenesisConfig {
- gcChainSyncLoPBucketConfig ∷ !ChainSyncLoPBucketConfig
- gcCSJConfig ∷ !CSJConfig
- gcLoEAndGDDConfig ∷ !(LoEAndGDDConfig ())
- gcHistoricityCutoff ∷ !(Maybe HistoricityCutoff)
}
data LoEAndGDDConfig a
- = LoEAndGDDEnabled !a
- | LoEAndGDDDisabled
disableGenesisConfig ∷ GenesisConfig
enableGenesisConfigDefault ∷ GenesisConfig
data GenesisNodeKernelArgs m blk = GenesisNodeKernelArgs {
- gnkaGetLoEFragment ∷ !(LoEAndGDDConfig (StrictTVar m (GetLoEFragment m blk)))
}
mkGenesisNodeKernelArgs ∷ ∀ m blk. (IOLike m, GetHeader blk) ⇒ GenesisConfig → m (GenesisNodeKernelArgs m blk, Complete ChainDbArgs m blk → Complete ChainDbArgs m blk)
setGetLoEFragment ∷ ∀ m blk. (IOLike m, GetHeader blk) ⇒ STM m GsmState → STM m (AnchoredFragment (Header blk)) → StrictTVar m (GetLoEFragment m blk) → m ()

`GenesisConfig`

data GenesisConfig Source #

Aggregating the various configs for Genesis-related subcomponents.

Constructors

GenesisConfig
Fields gcChainSyncLoPBucketConfig ∷ !ChainSyncLoPBucketConfig gcCSJConfig ∷ !CSJConfig gcLoEAndGDDConfig ∷ !(LoEAndGDDConfig ()) gcHistoricityCutoff ∷ !(Maybe HistoricityCutoff)

data LoEAndGDDConfig a Source #

Whether to en-/disable the Limit on Eagerness and the Genesis Density Disconnector.

Constructors

LoEAndGDDEnabled !a
LoEAndGDDDisabled

Instances

Instances details

Foldable LoEAndGDDConfig Source #
Instance details Defined in Ouroboros.Consensus.Node.Genesis Methods fold ∷ Monoid m ⇒ LoEAndGDDConfig m → m # foldMap ∷ Monoid m ⇒ (a → m) → LoEAndGDDConfig a → m # foldMap' ∷ Monoid m ⇒ (a → m) → LoEAndGDDConfig a → m # foldr ∷ (a → b → b) → b → LoEAndGDDConfig a → b # foldr' ∷ (a → b → b) → b → LoEAndGDDConfig a → b # foldl ∷ (b → a → b) → b → LoEAndGDDConfig a → b # foldl' ∷ (b → a → b) → b → LoEAndGDDConfig a → b # foldr1 ∷ (a → a → a) → LoEAndGDDConfig a → a # foldl1 ∷ (a → a → a) → LoEAndGDDConfig a → a # toList ∷ LoEAndGDDConfig a → [a] # null ∷ LoEAndGDDConfig a → Bool # length ∷ LoEAndGDDConfig a → Int # elem ∷ Eq a ⇒ a → LoEAndGDDConfig a → Bool # maximum ∷ Ord a ⇒ LoEAndGDDConfig a → a # minimum ∷ Ord a ⇒ LoEAndGDDConfig a → a # sum ∷ Num a ⇒ LoEAndGDDConfig a → a # product ∷ Num a ⇒ LoEAndGDDConfig a → a #
Traversable LoEAndGDDConfig Source #
Instance details Defined in Ouroboros.Consensus.Node.Genesis Methods traverse ∷ Applicative f ⇒ (a → f b) → LoEAndGDDConfig a → f (LoEAndGDDConfig b) # sequenceA ∷ Applicative f ⇒ LoEAndGDDConfig (f a) → f (LoEAndGDDConfig a) # mapM ∷ Monad m ⇒ (a → m b) → LoEAndGDDConfig a → m (LoEAndGDDConfig b) # sequence ∷ Monad m ⇒ LoEAndGDDConfig (m a) → m (LoEAndGDDConfig a) #
Functor LoEAndGDDConfig Source #
Instance details Defined in Ouroboros.Consensus.Node.Genesis Methods fmap ∷ (a → b) → LoEAndGDDConfig a → LoEAndGDDConfig b # (<$) ∷ a → LoEAndGDDConfig b → LoEAndGDDConfig a #
Show a ⇒ Show (LoEAndGDDConfig a) Source #
Instance details Defined in Ouroboros.Consensus.Node.Genesis Methods showsPrec ∷ Int → LoEAndGDDConfig a → ShowS # show ∷ LoEAndGDDConfig a → String # showList ∷ [LoEAndGDDConfig a] → ShowS #

disableGenesisConfig ∷ GenesisConfig Source #

Disable all Genesis components, yielding Praos behavior.

enableGenesisConfigDefault ∷ GenesisConfig Source #

NodeKernel helpers

data GenesisNodeKernelArgs m blk Source #

Genesis-related arguments needed by the NodeKernel initialization logic.

Constructors

GenesisNodeKernelArgs
Fields gnkaGetLoEFragment ∷ !(LoEAndGDDConfig (StrictTVar m (GetLoEFragment m blk))) A TVar containing an action that returns the `GetLoEFragment` action. We use this extra indirection to update this action after we opened the ChainDB (which happens before we initialize the NodeKernel). After that, this TVar will not be modified again.

mkGenesisNodeKernelArgs ∷ ∀ m blk. (IOLike m, GetHeader blk) ⇒ GenesisConfig → m (GenesisNodeKernelArgs m blk, Complete ChainDbArgs m blk → Complete ChainDbArgs m blk) Source #

Create the initial 'GenesisNodeKernelArgs" (with a temporary GetLoEFragment that will be replaced via setGetLoEFragment) and a function to update the ChainDbArgs accordingly.

setGetLoEFragment Source #

Arguments

∷ ∀ m blk. (IOLike m, GetHeader blk)
⇒ STM m GsmState
→ STM m (AnchoredFragment (Header blk))	The LoE fragment.
→ StrictTVar m (GetLoEFragment m blk)
→ m ()

Set gnkaGetLoEFragment to the actual logic for determining the current LoE fragment.