Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Config

Contents

The top-level node configuration
- Derived extraction functions
- Additional convenience functions
Re-exports

Synopsis

data TopLevelConfig blk = TopLevelConfig {
- topLevelConfigProtocol :: !( ConsensusConfig ( BlockProtocol blk))
- topLevelConfigLedger :: !( LedgerConfig blk)
- topLevelConfigBlock :: !( BlockConfig blk)
- topLevelConfigCodec :: !( CodecConfig blk)
- topLevelConfigStorage :: !( StorageConfig 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')) => TopLevelConfig blk -> TopLevelConfig blk'
mkTopLevelConfig :: ConsensusConfig ( BlockProtocol blk) -> LedgerConfig blk -> BlockConfig blk -> CodecConfig blk -> StorageConfig blk -> TopLevelConfig blk
configBlock :: TopLevelConfig blk -> BlockConfig blk
configCodec :: TopLevelConfig blk -> CodecConfig blk
configConsensus :: TopLevelConfig blk -> ConsensusConfig ( BlockProtocol blk)
configLedger :: TopLevelConfig blk -> LedgerConfig blk
configStorage :: TopLevelConfig blk -> StorageConfig blk
configSecurityParam :: ConsensusProtocol ( BlockProtocol blk) => TopLevelConfig blk -> SecurityParam
module Ouroboros.Consensus.Config.SecurityParam

The top-level node configuration

data TopLevelConfig blk Source #

Constructors

TopLevelConfig
Fields topLevelConfigProtocol :: !( ConsensusConfig ( BlockProtocol blk)) topLevelConfigLedger :: !( LedgerConfig blk) topLevelConfigBlock :: !( BlockConfig blk) topLevelConfigCodec :: !( CodecConfig blk) topLevelConfigStorage :: !( StorageConfig blk)

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 Source # Methods from :: TopLevelConfig blk -> Rep ( TopLevelConfig blk) x Source # to :: Rep ( TopLevelConfig blk) x -> TopLevelConfig blk Source #
( ConsensusProtocol ( BlockProtocol blk), NoThunks ( LedgerConfig blk), NoThunks ( BlockConfig blk), NoThunks ( CodecConfig blk), NoThunks ( StorageConfig 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.1.0.1-DT4Cvwf63DZKctsEvaJqCU" ' 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))))))

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')) => TopLevelConfig blk -> TopLevelConfig blk' Source #

mkTopLevelConfig :: ConsensusConfig ( BlockProtocol blk) -> LedgerConfig blk -> BlockConfig blk -> CodecConfig blk -> StorageConfig blk -> TopLevelConfig 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