ouroboros-consensus-0.18.0.0: Consensus layer for the Ouroboros blockchain protocol
Safe HaskellSafe-Inferred
LanguageHaskell2010

Ouroboros.Consensus.Config

Synopsis

The top-level node configuration

data TopLevelConfig blk Source #

The top-level node configuration

Constructors

TopLevelConfig 

Fields

Instances

Instances details
Isomorphic TopLevelConfig Source #

Projection/injection for TopLevelConfig

NOTE: We do not define one for LedgerConfig or ConsensusConfig, since we need the EraParams for their injections, which we can only derive if we have the top-level config.

Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Embed.Unary

Methods

project ∷ NoHardForks blk ⇒ TopLevelConfig (HardForkBlock '[blk]) → TopLevelConfig blk Source #

inject ∷ NoHardForks blk ⇒ TopLevelConfig blk → TopLevelConfig (HardForkBlock '[blk]) Source #

Generic (TopLevelConfig blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Config

Associated Types

type Rep (TopLevelConfig blk) ∷ Type → Type #

Methods

from ∷ TopLevelConfig blk → Rep (TopLevelConfig blk) x #

to ∷ Rep (TopLevelConfig blk) x → TopLevelConfig blk #

(ConsensusProtocol (BlockProtocol blk), NoThunks (LedgerConfig blk), NoThunks (BlockConfig blk), NoThunks (CodecConfig blk), NoThunks (StorageConfig blk), NoThunks (HeaderHash blk)) ⇒ NoThunks (TopLevelConfig blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Config

Methods

noThunks ∷ Context → TopLevelConfig blk → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → TopLevelConfig blk → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (TopLevelConfig blk) → String Source #

type Rep (TopLevelConfig blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Config

type Rep (TopLevelConfig blk) = D1 ('MetaData "TopLevelConfig" "Ouroboros.Consensus.Config" "ouroboros-consensus-0.18.0.0-inplace" 'False) (C1 ('MetaCons "TopLevelConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "topLevelConfigProtocol") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ConsensusConfig (BlockProtocol blk))) :*: (S1 ('MetaSel ('Just "topLevelConfigLedger") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (LedgerConfig blk)) :*: S1 ('MetaSel ('Just "topLevelConfigBlock") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (BlockConfig blk)))) :*: (S1 ('MetaSel ('Just "topLevelConfigCodec") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (CodecConfig blk)) :*: (S1 ('MetaSel ('Just "topLevelConfigStorage") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (StorageConfig blk)) :*: S1 ('MetaSel ('Just "topLevelConfigCheckpoints") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (CheckpointsMap blk))))))

castTopLevelConfig ∷ (Coercible (ConsensusConfig (BlockProtocol blk)) (ConsensusConfig (BlockProtocol blk')), LedgerConfig blk ~ LedgerConfig blk', Coercible (BlockConfig blk) (BlockConfig blk'), Coercible (CodecConfig blk) (CodecConfig blk'), Coercible (StorageConfig blk) (StorageConfig blk'), Coercible (HeaderHash blk) (HeaderHash blk')) ⇒ TopLevelConfig blk → TopLevelConfig blk' Source #

mkTopLevelConfig ∷ ConsensusConfig (BlockProtocol blk) → LedgerConfig blk → BlockConfig blk → CodecConfig blk → StorageConfig blk → CheckpointsMap blk → TopLevelConfig blk Source #

Checkpoints map

newtype CheckpointsMap blk Source #

Checkpoints are block hashes that are expected to be present in the honest historical chain.

Each checkpoint is associated with a BlockNo, and any block with a BlockNo in the checkpoints map is expected to have the corresponding hash.

Constructors

CheckpointsMap 

Fields

Instances

Instances details
Monoid (CheckpointsMap blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Config

Methods

mempty ∷ CheckpointsMap blk #

mappend ∷ CheckpointsMap blk → CheckpointsMap blk → CheckpointsMap blk #

mconcat ∷ [CheckpointsMap blk] → CheckpointsMap blk #

Semigroup (CheckpointsMap blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Config

Methods

(<>) ∷ CheckpointsMap blk → CheckpointsMap blk → CheckpointsMap blk #

sconcat ∷ NonEmpty (CheckpointsMap blk) → CheckpointsMap blk #

stimes ∷ Integral b ⇒ b → CheckpointsMap blk → CheckpointsMap blk #

Generic (CheckpointsMap blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Config

Associated Types

type Rep (CheckpointsMap blk) ∷ Type → Type #

Methods

from ∷ CheckpointsMap blk → Rep (CheckpointsMap blk) x #

to ∷ Rep (CheckpointsMap blk) x → CheckpointsMap blk #

NoThunks (HeaderHash blk) ⇒ NoThunks (CheckpointsMap blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Config

Methods

noThunks ∷ Context → CheckpointsMap blk → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → CheckpointsMap blk → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (CheckpointsMap blk) → String Source #

type Rep (CheckpointsMap blk) Source # 
Instance details

Defined in Ouroboros.Consensus.Config

type Rep (CheckpointsMap blk) = D1 ('MetaData "CheckpointsMap" "Ouroboros.Consensus.Config" "ouroboros-consensus-0.18.0.0-inplace" 'True) (C1 ('MetaCons "CheckpointsMap" 'PrefixI 'True) (S1 ('MetaSel ('Just "unCheckpointsMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map BlockNo (HeaderHash blk)))))

castCheckpointsMap ∷ Coercible (HeaderHash blk) (HeaderHash blk') ⇒ CheckpointsMap blk → CheckpointsMap blk' Source #

emptyCheckpointsMap ∷ CheckpointsMap blk Source #

Derived extraction functions

configBlock ∷ TopLevelConfig blk → BlockConfig blk Source #

configCodec ∷ TopLevelConfig blk → CodecConfig blk Source #

configConsensus ∷ TopLevelConfig blk → ConsensusConfig (BlockProtocol blk) Source #

configLedger ∷ TopLevelConfig blk → LedgerConfig blk Source #

configStorage ∷ TopLevelConfig blk → StorageConfig blk Source #

Additional convenience functions

configSecurityParam ∷ ConsensusProtocol (BlockProtocol blk) ⇒ TopLevelConfig blk → SecurityParam Source #

Re-exports

module Ouroboros.Consensus.Config.SecurityParam