Moduleouroboros-consensus-4.2.1.0

Ouroboros.Consensus.Protocol.Abstract

7 types
3 classes
2 values

Packageouroboros-consensus-4.2.1.0
Exports13
LicenceApache-2.0

valueshouldSwitch :: ShouldSwitch reason -> Bool

valueshouldSwitchToMaybe :: ShouldSwitch reason -> Maybe reason

newtypenewtype SecurityParam

Constructors

SecurityParam
- maxRollbacks :: NonZero Word64

Instances7Eq, Show, Generic, NoThunks, FromCBOR, ToCBOR, …

Eq SecurityParamDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Config.SecurityParam
Show SecurityParamDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Config.SecurityParam
Generic SecurityParamDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Config.SecurityParam
NoThunks SecurityParamDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Config.SecurityParam
FromCBOR SecurityParamDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Config.SecurityParam
ToCBOR SecurityParamDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Config.SecurityParam
type Rep SecurityParam = D1 ('MetaData "SecurityParam" "Ouroboros.Consensus.Config.SecurityParam" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'True) (C1 ('MetaCons "SecurityParam" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxRollbacks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NonZero Word64))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Config.SecurityParam

classclass Ord sv => ChainOrder sv where

Associated types

type family ChainOrderConfig sv
type family ReasonForSwitch sv

Methods

preferCandidate :: ChainOrderConfig sv -> sv -> sv -> ShouldSwitch (ReasonForSwitch sv)

Instances8ChainOrder, …

ChainOrder NoTiebreakerDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
ChainOrder PBftTiebreakerViewDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.PBFT
Ord sv => ChainOrder (SimpleChainOrder sv)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
CanHardFork xs => ChainOrder (HardForkTiebreakerView xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Protocol
ChainOrder (TiebreakerView (BlockProtocol blk)) => ChainOrder (WrapTiebreakerView blk)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.TypeFamilyWrappers
ChainOrder (TiebreakerView p) => ChainOrder (SelectView p)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
ChainOrder (TiebreakerView proto) => ChainOrder (WeightedSelectView proto)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Peras.SelectView
ChainOrder a => ChainOrder (WithEmptyFragment a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Peras.SelectView

datadata Comparing a

Constructors

Comparing
- compareToThat :: a
- compareThis :: a

Instances1Show

Show a => Show (Comparing a)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract

data familydata family ConsensusConfig p

Instances16Generic, NoThunks, Rep, ConsensusConfig, …

Generic (ConsensusConfig (HardForkProtocol xs))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Basics
Generic (ConsensusConfig (Bft c))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.BFT
Generic (ConsensusConfig (ModChainSel p t))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.ModChainSel
Generic (ConsensusConfig (PBft c))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.PBFT
NoThunks (ConsensusConfig (PBft c))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.PBFT
CanHardFork xs => NoThunks (ConsensusConfig (HardForkProtocol xs))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Basics
ConsensusProtocol p => NoThunks (ConsensusConfig (ModChainSel p t))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.ModChainSel
BftCrypto c => NoThunks (ConsensusConfig (Bft c))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.BFT
type Rep (ConsensusConfig (HardForkProtocol xs)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.HardFork.Combinator.Basics" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "HardForkConsensusConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "hardForkConsensusConfigK") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 SecurityParam) :*: (S1 ('MetaSel ('Just "hardForkConsensusConfigShape") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Shape xs)) :*: S1 ('MetaSel ('Just "hardForkConsensusConfigPerEra") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PerEraConsensusConfig xs)))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Basics
type Rep (ConsensusConfig (Bft c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.BFT" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" '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)))))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.BFT
type Rep (ConsensusConfig (ModChainSel p t)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.ModChainSel" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'True) (C1 ('MetaCons "McsConsensusConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "mcsConfigP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ConsensusConfig p))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.ModChainSel
type Rep (ConsensusConfig (PBft c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.PBFT" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'True) (C1 ('MetaCons "PBftConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PBftParams)))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.PBFT
data ConsensusConfig (HardForkProtocol xs)
- HardForkConsensusConfighardForkConsensusConfigK :: !SecurityParamhardForkConsensusConfigShape :: !Shape xshardForkConsensusConfigPerEra :: !PerEraConsensusConfig xs
Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Basics
data ConsensusConfig (Bft c)
- BftConfigbftParams :: !BftParamsbftSignKey :: !SignKeyDSIGN (BftDSIGN c)bftVerKeys :: !Map NodeId (VerKeyDSIGN (BftDSIGN c))
Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.BFT
data ConsensusConfig (ModChainSel p t)
- McsConsensusConfigmcsConfigP :: ConsensusConfig p
Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.ModChainSel
data ConsensusConfig (PBft c)
- PBftConfigpbftParams :: PBftParams
Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.PBFT

class

class (Show (ChainDepState p), Show (ValidationErr p), Show (TiebreakerView p), Show (LedgerView p), Eq (ChainDepState p), Eq (ValidationErr p), ChainOrder (TiebreakerView p), NoThunks (ConsensusConfig p), NoThunks (ChainDepState p), NoThunks (ValidationErr p), NoThunks (TiebreakerView p), Typeable p) => ConsensusProtocol p where

Associated types

type family ChainDepState p
type family IsLeader p
type family CanBeLeader p
type family TiebreakerView p
type family LedgerView p
type family ValidationErr p
type family ValidateView p

Methods

checkIsLeader :: HasCallStack => ConsensusConfig p -> CanBeLeader p -> SlotNo -> Ticked (ChainDepState p) -> Maybe (IsLeader p)
tickChainDepState :: ConsensusConfig p -> LedgerView p -> SlotNo -> ChainDepState p -> Ticked (ChainDepState p)
updateChainDepState :: HasCallStack => ConsensusConfig p -> ValidateView p -> SlotNo -> Ticked (ChainDepState p) -> Except (ValidationErr p) (ChainDepState p)
reupdateChainDepState :: HasCallStack => ConsensusConfig p -> ValidateView p -> SlotNo -> Ticked (ChainDepState p) -> ChainDepState p
protocolSecurityParam :: ConsensusConfig p -> SecurityParam

Instances4ConsensusProtocol

CanHardFork xs => ConsensusProtocol (HardForkProtocol xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.Protocol · orphan
BftCrypto c => ConsensusProtocol (Bft c)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.BFT
PBftCrypto c => ConsensusProtocol (PBft c)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.PBFT
(ConsensusProtocol p, ChainOrder t, Show t, Typeable t, NoThunks t) => ConsensusProtocol (ModChainSel p t)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.ModChainSel

datadata NoTiebreaker

NoTiebreaker

Instances9Eq, Ord, Show, Generic, NoThunks, ChainOrder, …

Eq NoTiebreakerDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
Ord NoTiebreakerDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
Show NoTiebreakerDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
Generic NoTiebreakerDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
NoThunks NoTiebreakerDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
ChainOrder NoTiebreakerDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
type Rep NoTiebreaker = D1 ('MetaData "NoTiebreaker" "Ouroboros.Consensus.Protocol.Abstract" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "NoTiebreaker" 'PrefixI 'False) U1)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
type ChainOrderConfig NoTiebreaker = ChainOrderConfig (SimpleChainOrder NoTiebreaker)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
type ReasonForSwitch NoTiebreaker = ReasonForSwitch (SimpleChainOrder NoTiebreaker)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract

datadata SelectView p

Constructors

SelectView
- svBlockNo :: !BlockNo
- svTiebreakerView :: !TiebreakerView p

Instances9Eq, Ord, Show, Generic, NoThunks, ChainOrder, …

Eq (TiebreakerView p) => Eq (SelectView p)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
Ord (TiebreakerView p) => Ord (SelectView p)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
Show (TiebreakerView p) => Show (SelectView p)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
Generic (SelectView p)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
NoThunks (TiebreakerView p) => NoThunks (SelectView p)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
ChainOrder (TiebreakerView p) => ChainOrder (SelectView p)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
type Rep (SelectView p) = D1 ('MetaData "SelectView" "Ouroboros.Consensus.Protocol.Abstract" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "SelectView" 'PrefixI 'True) (S1 ('MetaSel ('Just "svBlockNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 BlockNo) :*: S1 ('MetaSel ('Just "svTiebreakerView") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (TiebreakerView p))))Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
type ChainOrderConfig (SelectView p) = ChainOrderConfig (TiebreakerView p)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
type ReasonForSwitch (SelectView p) = SelectViewReasonForSwitch pDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract

datadata SelectViewReasonForSwitch p

Constructors

Longer (Comparing (WithOrigin BlockNo))
SelectViewTiebreak (ReasonForSwitch (TiebreakerView p))

Instances1Show

Show (ReasonForSwitch (TiebreakerView p)) => Show (SelectViewReasonForSwitch p)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract

datadata ShouldSwitch reason

Constructors

ShouldNotSwitch Ordering
ShouldSwitch reason

newtypenewtype SimpleChainOrder sv

Constructors

SimpleChainOrder sv

Instances5Eq, Ord, ChainOrder, ChainOrderConfig, ReasonForSwitch

Eq sv => Eq (SimpleChainOrder sv)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
Ord sv => Ord (SimpleChainOrder sv)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
Ord sv => ChainOrder (SimpleChainOrder sv)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
type ChainOrderConfig (SimpleChainOrder sv) = ()Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract
type ReasonForSwitch (SimpleChainOrder sv) = ()Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract

classclass TranslateProto protoFrom protoTo where

Methods

translateLedgerView :: Proxy (protoFrom, protoTo) -> LedgerView protoFrom -> LedgerView protoTo
translateChainDepState :: Proxy (protoFrom, protoTo) -> ChainDepState protoFrom -> ChainDepState protoTo

Instances1TranslateProto

TranslateProto singleProto singleProtoDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Protocol.Abstract