Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.Protocol.ModChainSel

Contents

Type family instances

Synopsis

data ModChainSel p s
data family ConsensusConfig p ∷ Type

Documentation

data ModChainSel p s Source #

Instances

Instances details

Generic (ConsensusConfig (ModChainSel p s)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.ModChainSel Associated Types type Rep (ConsensusConfig (ModChainSel p s)) ∷ Type → Type # Methods from ∷ ConsensusConfig (ModChainSel p s) → Rep (ConsensusConfig (ModChainSel p s)) x # to ∷ Rep (ConsensusConfig (ModChainSel p s)) x → ConsensusConfig (ModChainSel p s) #
ConsensusProtocol p ⇒ NoThunks (ConsensusConfig (ModChainSel p s)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.ModChainSel Methods noThunks ∷ Context → ConsensusConfig (ModChainSel p s) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ConsensusConfig (ModChainSel p s) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (ConsensusConfig (ModChainSel p s)) → String Source #
(ConsensusProtocol p, ChainOrder s, Show s, Typeable s, NoThunks s) ⇒ ConsensusProtocol (ModChainSel p s) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.ModChainSel Associated Types type ChainDepState (ModChainSel p s) Source # type IsLeader (ModChainSel p s) Source # type CanBeLeader (ModChainSel p s) Source # type SelectView (ModChainSel p s) Source # type LedgerView (ModChainSel p s) Source # type ValidationErr (ModChainSel p s) Source # type ValidateView (ModChainSel p s) Source # Methods checkIsLeader ∷ ConsensusConfig (ModChainSel p s) → CanBeLeader (ModChainSel p s) → SlotNo → Ticked (ChainDepState (ModChainSel p s)) → Maybe (IsLeader (ModChainSel p s)) Source # tickChainDepState ∷ ConsensusConfig (ModChainSel p s) → LedgerView (ModChainSel p s) → SlotNo → ChainDepState (ModChainSel p s) → Ticked (ChainDepState (ModChainSel p s)) Source # updateChainDepState ∷ ConsensusConfig (ModChainSel p s) → ValidateView (ModChainSel p s) → SlotNo → Ticked (ChainDepState (ModChainSel p s)) → Except (ValidationErr (ModChainSel p s)) (ChainDepState (ModChainSel p s)) Source # reupdateChainDepState ∷ ConsensusConfig (ModChainSel p s) → ValidateView (ModChainSel p s) → SlotNo → Ticked (ChainDepState (ModChainSel p s)) → ChainDepState (ModChainSel p s) Source # protocolSecurityParam ∷ ConsensusConfig (ModChainSel p s) → SecurityParam Source #
type Rep (ConsensusConfig (ModChainSel p s)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.ModChainSel type Rep (ConsensusConfig (ModChainSel p s)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.ModChainSel" "ouroboros-consensus-0.18.0.0-inplace" 'True) (C1 ('MetaCons "McsConsensusConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "mcsConfigP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ConsensusConfig p))))
type CanBeLeader (ModChainSel p s) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.ModChainSel type CanBeLeader (ModChainSel p s) = CanBeLeader p
type ChainDepState (ModChainSel p s) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.ModChainSel type ChainDepState (ModChainSel p s) = ChainDepState p
newtype ConsensusConfig (ModChainSel p s) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.ModChainSel newtype ConsensusConfig (ModChainSel p s) = McsConsensusConfig { mcsConfigP ∷ ConsensusConfig p }
type IsLeader (ModChainSel p s) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.ModChainSel type IsLeader (ModChainSel p s) = IsLeader p
type LedgerView (ModChainSel p s) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.ModChainSel type LedgerView (ModChainSel p s) = LedgerView p
type SelectView (ModChainSel p s) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.ModChainSel type SelectView (ModChainSel p s) = s
type ValidateView (ModChainSel p s) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.ModChainSel type ValidateView (ModChainSel p s) = ValidateView p
type ValidationErr (ModChainSel p s) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.ModChainSel type ValidationErr (ModChainSel p s) = ValidationErr p

Type family instances

data family ConsensusConfig p ∷ Type Source #

Static configuration required to run the consensus protocol

Every method in the ConsensusProtocol class takes the consensus configuration as a parameter, so having this as a data family rather than a type family resolves most ambiguity.

Defined out of the class so that protocols can define this type without having to define the entire protocol at the same time (or indeed in the same module).

Instances

Instances details

Generic (ConsensusConfig (HardForkProtocol xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics Associated Types type Rep (ConsensusConfig (HardForkProtocol xs)) ∷ Type → Type # Methods from ∷ ConsensusConfig (HardForkProtocol xs) → Rep (ConsensusConfig (HardForkProtocol xs)) x # to ∷ Rep (ConsensusConfig (HardForkProtocol xs)) x → ConsensusConfig (HardForkProtocol xs) #
Generic (ConsensusConfig (Bft c)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.BFT Associated Types type Rep (ConsensusConfig (Bft c)) ∷ Type → Type # Methods from ∷ ConsensusConfig (Bft c) → Rep (ConsensusConfig (Bft c)) x # to ∷ Rep (ConsensusConfig (Bft c)) x → ConsensusConfig (Bft c) #
Generic (ConsensusConfig (ModChainSel p s)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.ModChainSel Associated Types type Rep (ConsensusConfig (ModChainSel p s)) ∷ Type → Type # Methods from ∷ ConsensusConfig (ModChainSel p s) → Rep (ConsensusConfig (ModChainSel p s)) x # to ∷ Rep (ConsensusConfig (ModChainSel p s)) x → ConsensusConfig (ModChainSel p s) #
Generic (ConsensusConfig (PBft c)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT Associated Types type Rep (ConsensusConfig (PBft c)) ∷ Type → Type # Methods from ∷ ConsensusConfig (PBft c) → Rep (ConsensusConfig (PBft c)) x # to ∷ Rep (ConsensusConfig (PBft c)) x → ConsensusConfig (PBft c) #
CanHardFork xs ⇒ NoThunks (ConsensusConfig (HardForkProtocol xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics Methods noThunks ∷ Context → ConsensusConfig (HardForkProtocol xs) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ConsensusConfig (HardForkProtocol xs) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (ConsensusConfig (HardForkProtocol xs)) → String Source #
BftCrypto c ⇒ NoThunks (ConsensusConfig (Bft c)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.BFT Methods noThunks ∷ Context → ConsensusConfig (Bft c) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ConsensusConfig (Bft c) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (ConsensusConfig (Bft c)) → String Source #
ConsensusProtocol p ⇒ NoThunks (ConsensusConfig (ModChainSel p s)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.ModChainSel Methods noThunks ∷ Context → ConsensusConfig (ModChainSel p s) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ConsensusConfig (ModChainSel p s) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (ConsensusConfig (ModChainSel p s)) → String Source #
NoThunks (ConsensusConfig (PBft c)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT Methods noThunks ∷ Context → ConsensusConfig (PBft c) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ConsensusConfig (PBft c) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (ConsensusConfig (PBft c)) → String Source #
type Rep (ConsensusConfig (HardForkProtocol xs)) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics type Rep (ConsensusConfig (HardForkProtocol xs)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.HardFork.Combinator.Basics" "ouroboros-consensus-0.18.0.0-inplace" 'False) (C1 ('MetaCons "HardForkConsensusConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "hardForkConsensusConfigK") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SecurityParam) :: (S1 ('MetaSel ('Just "hardForkConsensusConfigShape") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Shape xs)) :: S1 ('MetaSel ('Just "hardForkConsensusConfigPerEra") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PerEraConsensusConfig xs)))))
type Rep (ConsensusConfig (Bft c)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.BFT type Rep (ConsensusConfig (Bft c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.BFT" "ouroboros-consensus-0.18.0.0-inplace" 'False) (C1 ('MetaCons "BftConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "bftParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BftParams) :: (S1 ('MetaSel ('Just "bftSignKey") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SignKeyDSIGN (BftDSIGN c))) :: S1 ('MetaSel ('Just "bftVerKeys") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map NodeId (VerKeyDSIGN (BftDSIGN c)))))))
type Rep (ConsensusConfig (ModChainSel p s)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.ModChainSel type Rep (ConsensusConfig (ModChainSel p s)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.ModChainSel" "ouroboros-consensus-0.18.0.0-inplace" 'True) (C1 ('MetaCons "McsConsensusConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "mcsConfigP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ConsensusConfig p))))
type Rep (ConsensusConfig (PBft c)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT type Rep (ConsensusConfig (PBft c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-0.18.0.0-inplace" 'True) (C1 ('MetaCons "PBftConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PBftParams)))
data ConsensusConfig (HardForkProtocol xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Basics data ConsensusConfig (HardForkProtocol xs) = HardForkConsensusConfig { hardForkConsensusConfigK ∷ !SecurityParam hardForkConsensusConfigShape ∷ !(Shape xs) hardForkConsensusConfigPerEra ∷ !(PerEraConsensusConfig xs) }
data ConsensusConfig (Bft c) Source #	(Static) node configuration
Instance details Defined in Ouroboros.Consensus.Protocol.BFT data ConsensusConfig (Bft c) = BftConfig { bftParams ∷ !BftParams bftSignKey ∷ !(SignKeyDSIGN (BftDSIGN c)) bftVerKeys ∷ !(Map NodeId (VerKeyDSIGN (BftDSIGN c))) }
newtype ConsensusConfig (PBft c) Source #	(Static) node configuration
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT newtype ConsensusConfig (PBft c) = PBftConfig { pbftParams ∷ PBftParams }
newtype ConsensusConfig (ModChainSel p s) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.ModChainSel newtype ConsensusConfig (ModChainSel p s) = McsConsensusConfig { mcsConfigP ∷ ConsensusConfig p }