Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Node.Genesis

Contents

GenesisConfig
NodeKernel helpers

Synopsis

data GenesisConfig = GenesisConfig {
- gcBlockFetchConfig ∷ !GenesisBlockFetchConfiguration
- gcChainSyncLoPBucketConfig ∷ !ChainSyncLoPBucketConfig
- gcCSJConfig ∷ !CSJConfig
- gcLoEAndGDDConfig ∷ !(LoEAndGDDConfig LoEAndGDDParams)
- gcHistoricityCutoff ∷ !(Maybe HistoricityCutoff)
}
data GenesisConfigFlags = GenesisConfigFlags {
- gcfEnableCSJ ∷ Bool
- gcfEnableLoEAndGDD ∷ Bool
- gcfEnableLoP ∷ Bool
- gcfBlockFetchGracePeriod ∷ Maybe DiffTime
- gcfBucketCapacity ∷ Maybe Integer
- gcfBucketRate ∷ Maybe Integer
- gcfCSJJumpSize ∷ Maybe SlotNo
- gcfGDDRateLimit ∷ Maybe DiffTime
}
data LoEAndGDDConfig a
- = LoEAndGDDEnabled !a
- | LoEAndGDDDisabled
defaultGenesisConfigFlags ∷ GenesisConfigFlags
disableGenesisConfig ∷ GenesisConfig
enableGenesisConfigDefault ∷ GenesisConfig
mkGenesisConfig ∷ Maybe GenesisConfigFlags → GenesisConfig
data GenesisNodeKernelArgs (m ∷ Type → Type) blk = GenesisNodeKernelArgs {
- gnkaLoEAndGDDArgs ∷ !(LoEAndGDDConfig (LoEAndGDDNodeKernelArgs m blk))
}
data LoEAndGDDNodeKernelArgs (m ∷ Type → Type) blk = LoEAndGDDNodeKernelArgs {
- lgnkaLoEFragmentTVar ∷ !(StrictTVar m (GetLoEFragment m blk))
- lgnkaGDDRateLimit ∷ DiffTime
}
mkGenesisNodeKernelArgs ∷ (IOLike m, GetHeader blk) ⇒ GenesisConfig → m (GenesisNodeKernelArgs m blk, Complete ChainDbArgs m blk → Complete ChainDbArgs m blk)
setGetLoEFragment ∷ (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.

Usually, enableGenesisConfigDefault or disableGenesisConfig can be used. See the haddocks of the types of the individual fields for details.

Constructors

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

Instances

Instances details

Generic GenesisConfig Source #

Instance details

Defined in Ouroboros.Consensus.Node.Genesis

Associated Types

type Rep GenesisConfig
Instance details Defined in Ouroboros.Consensus.Node.Genesis type Rep GenesisConfig

Methods

from ∷ GenesisConfig → Rep GenesisConfig x #

to ∷ Rep GenesisConfig x → GenesisConfig #

Show GenesisConfig Source #

Instance details

Defined in Ouroboros.Consensus.Node.Genesis

Methods

showsPrec ∷ Int → GenesisConfig → ShowS #

show ∷ GenesisConfig → String #

showList ∷ [GenesisConfig] → ShowS #

Eq GenesisConfig Source #

Instance details

Defined in Ouroboros.Consensus.Node.Genesis

Methods

(==) ∷ GenesisConfig → GenesisConfig → Bool #

(/=) ∷ GenesisConfig → GenesisConfig → Bool #

type Rep GenesisConfig Source #

Instance details

Defined in Ouroboros.Consensus.Node.Genesis

type Rep GenesisConfig

data GenesisConfigFlags Source #

Genesis configuration flags and low-level args, as parsed from config file or CLI

Constructors

GenesisConfigFlags
Fields gcfEnableCSJ ∷ Bool gcfEnableLoEAndGDD ∷ Bool gcfEnableLoP ∷ Bool gcfBlockFetchGracePeriod ∷ Maybe DiffTime gcfBucketCapacity ∷ Maybe Integer gcfBucketRate ∷ Maybe Integer gcfCSJJumpSize ∷ Maybe SlotNo gcfGDDRateLimit ∷ Maybe DiffTime

Instances

Instances details

Generic GenesisConfigFlags Source #

Instance details

Defined in Ouroboros.Consensus.Node.Genesis

Associated Types

type Rep GenesisConfigFlags

Instance details

Defined in Ouroboros.Consensus.Node.Genesis

Methods

from ∷ GenesisConfigFlags → Rep GenesisConfigFlags x #

to ∷ Rep GenesisConfigFlags x → GenesisConfigFlags #

Show GenesisConfigFlags Source #

Instance details

Defined in Ouroboros.Consensus.Node.Genesis

Methods

showsPrec ∷ Int → GenesisConfigFlags → ShowS #

show ∷ GenesisConfigFlags → String #

showList ∷ [GenesisConfigFlags] → ShowS #

Eq GenesisConfigFlags Source #

Instance details

Defined in Ouroboros.Consensus.Node.Genesis

Methods

(==) ∷ GenesisConfigFlags → GenesisConfigFlags → Bool #

(/=) ∷ GenesisConfigFlags → GenesisConfigFlags → Bool #

type Rep GenesisConfigFlags Source #

Instance details

Defined in Ouroboros.Consensus.Node.Genesis

data LoEAndGDDConfig a Source #

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

Constructors

LoEAndGDDEnabled !a
LoEAndGDDDisabled

Instances

Instances details

Functor LoEAndGDDConfig Source #

Instance details

Defined in Ouroboros.Consensus.Node.Genesis

Methods

fmap ∷ (a → b) → LoEAndGDDConfig a → LoEAndGDDConfig b #

(<$) ∷ a → LoEAndGDDConfig b → LoEAndGDDConfig a #

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) #

Generic (LoEAndGDDConfig a) Source #

Instance details

Defined in Ouroboros.Consensus.Node.Genesis

Associated Types

type Rep (LoEAndGDDConfig a)

Instance details

Defined in Ouroboros.Consensus.Node.Genesis

type Rep (LoEAndGDDConfig a) = D1 ('MetaData "LoEAndGDDConfig" "Ouroboros.Consensus.Node.Genesis" "ouroboros-consensus-diffusion-0.22.0.1-inplace" 'False) (C1 ('MetaCons "LoEAndGDDEnabled" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)) :+: C1 ('MetaCons "LoEAndGDDDisabled" 'PrefixI 'False) (U1 ∷ Type → Type))

Methods

from ∷ LoEAndGDDConfig a → Rep (LoEAndGDDConfig a) x #

to ∷ Rep (LoEAndGDDConfig a) x → 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 #

Eq a ⇒ Eq (LoEAndGDDConfig a) Source #

Instance details

Defined in Ouroboros.Consensus.Node.Genesis

Methods

(==) ∷ LoEAndGDDConfig a → LoEAndGDDConfig a → Bool #

(/=) ∷ LoEAndGDDConfig a → LoEAndGDDConfig a → Bool #

type Rep (LoEAndGDDConfig a) Source #

Instance details

Defined in Ouroboros.Consensus.Node.Genesis

type Rep (LoEAndGDDConfig a) = D1 ('MetaData "LoEAndGDDConfig" "Ouroboros.Consensus.Node.Genesis" "ouroboros-consensus-diffusion-0.22.0.1-inplace" 'False) (C1 ('MetaCons "LoEAndGDDEnabled" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)) :+: C1 ('MetaCons "LoEAndGDDDisabled" 'PrefixI 'False) (U1 ∷ Type → Type))

defaultGenesisConfigFlags ∷ GenesisConfigFlags Source #

disableGenesisConfig ∷ GenesisConfig Source #

Disable all Genesis components, yielding Praos behavior.

enableGenesisConfigDefault ∷ GenesisConfig Source #

mkGenesisConfig ∷ Maybe GenesisConfigFlags → GenesisConfig Source #

NodeKernel helpers

data GenesisNodeKernelArgs (m ∷ Type → Type) blk Source #

Genesis-related arguments needed by the NodeKernel initialization logic.

Constructors

GenesisNodeKernelArgs
Fields gnkaLoEAndGDDArgs ∷ !(LoEAndGDDConfig (LoEAndGDDNodeKernelArgs m blk))

data LoEAndGDDNodeKernelArgs (m ∷ Type → Type) blk Source #

Constructors

LoEAndGDDNodeKernelArgs
Fields lgnkaLoEFragmentTVar ∷ !(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. lgnkaGDDRateLimit ∷ DiffTime

mkGenesisNodeKernelArgs ∷ (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

∷ (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.