ouroboros-consensus-0.1.0.0: Consensus layer for the Ouroboros blockchain protocol
Safe HaskellNone
LanguageHaskell2010

Ouroboros.Consensus.Protocol.LeaderSchedule

Synopsis

Documentation

newtype LeaderSchedule Source #

Constructors

LeaderSchedule 

Fields

Instances

Instances details
Eq LeaderSchedule Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Methods

(==) :: LeaderSchedule -> LeaderSchedule -> Bool #

(/=) :: LeaderSchedule -> LeaderSchedule -> Bool #

Ord LeaderSchedule Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Methods

compare :: LeaderSchedule -> LeaderSchedule -> Ordering #

(<) :: LeaderSchedule -> LeaderSchedule -> Bool #

(<=) :: LeaderSchedule -> LeaderSchedule -> Bool #

(>) :: LeaderSchedule -> LeaderSchedule -> Bool #

(>=) :: LeaderSchedule -> LeaderSchedule -> Bool #

max :: LeaderSchedule -> LeaderSchedule -> LeaderSchedule #

min :: LeaderSchedule -> LeaderSchedule -> LeaderSchedule #

Show LeaderSchedule Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Methods

showsPrec :: Int -> LeaderSchedule -> ShowS #

show :: LeaderSchedule -> String #

showList :: [LeaderSchedule] -> ShowS #

Generic LeaderSchedule Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Associated Types

type Rep LeaderSchedule :: Type -> Type #

Methods

from :: LeaderSchedule -> Rep LeaderSchedule x #

to :: Rep LeaderSchedule x -> LeaderSchedule #

Semigroup LeaderSchedule Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Methods

(<>) :: LeaderSchedule -> LeaderSchedule -> LeaderSchedule #

sconcat :: NonEmpty LeaderSchedule -> LeaderSchedule #

stimes :: Integral b => b -> LeaderSchedule -> LeaderSchedule #

NoThunks LeaderSchedule Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Methods

noThunks :: Context -> LeaderSchedule -> IO (Maybe ThunkInfo) Source #

wNoThunks :: Context -> LeaderSchedule -> IO (Maybe ThunkInfo) Source #

showTypeOf :: Proxy LeaderSchedule -> String Source #

Condense LeaderSchedule Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Methods

condense :: LeaderSchedule -> String Source #

type Rep LeaderSchedule Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

type Rep LeaderSchedule = D1 ('MetaData "LeaderSchedule" "Ouroboros.Consensus.Protocol.LeaderSchedule" "ouroboros-consensus-0.1.0.0-GfJNvFcM6lj2s5utKAUPEp" 'True) (C1 ('MetaCons "LeaderSchedule" 'PrefixI 'True) (S1 ('MetaSel ('Just "getLeaderSchedule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map SlotNo [CoreNodeId]))))

leaderScheduleFor :: CoreNodeId -> LeaderSchedule -> Set SlotNo Source #

The Slots a given node is supposed to lead in

data WithLeaderSchedule p Source #

Extension of protocol p by a static leader schedule.

Instances

Instances details
Generic (ConsensusConfig (WithLeaderSchedule p)) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Associated Types

type Rep (ConsensusConfig (WithLeaderSchedule p)) :: Type -> Type #

Methods

from :: ConsensusConfig (WithLeaderSchedule p) -> Rep (ConsensusConfig (WithLeaderSchedule p)) x #

to :: Rep (ConsensusConfig (WithLeaderSchedule p)) x -> ConsensusConfig (WithLeaderSchedule p) #

ConsensusProtocol p => NoThunks (ConsensusConfig (WithLeaderSchedule p)) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Methods

noThunks :: Context -> ConsensusConfig (WithLeaderSchedule p) -> IO (Maybe ThunkInfo) Source #

wNoThunks :: Context -> ConsensusConfig (WithLeaderSchedule p) -> IO (Maybe ThunkInfo) Source #

showTypeOf :: Proxy (ConsensusConfig (WithLeaderSchedule p)) -> String Source #

ConsensusProtocol p => ConsensusProtocol (WithLeaderSchedule p) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Associated Types

type ChainDepState (WithLeaderSchedule p) Source #

type IsLeader (WithLeaderSchedule p) Source #

type CanBeLeader (WithLeaderSchedule p) Source #

type LedgerView (WithLeaderSchedule p) Source #

type ValidationErr (WithLeaderSchedule p) Source #

type ValidateView (WithLeaderSchedule p) Source #

Methods

chainSelConfig :: ConsensusConfig (WithLeaderSchedule p) -> ChainSelConfig (WithLeaderSchedule p) Source #

checkIsLeader :: ConsensusConfig (WithLeaderSchedule p) -> CanBeLeader (WithLeaderSchedule p) -> SlotNo -> Ticked (ChainDepState (WithLeaderSchedule p)) -> Maybe (IsLeader (WithLeaderSchedule p)) Source #

tickChainDepState :: ConsensusConfig (WithLeaderSchedule p) -> Ticked (LedgerView (WithLeaderSchedule p)) -> SlotNo -> ChainDepState (WithLeaderSchedule p) -> Ticked (ChainDepState (WithLeaderSchedule p)) Source #

updateChainDepState :: ConsensusConfig (WithLeaderSchedule p) -> ValidateView (WithLeaderSchedule p) -> SlotNo -> Ticked (ChainDepState (WithLeaderSchedule p)) -> Except (ValidationErr (WithLeaderSchedule p)) (ChainDepState (WithLeaderSchedule p)) Source #

reupdateChainDepState :: ConsensusConfig (WithLeaderSchedule p) -> ValidateView (WithLeaderSchedule p) -> SlotNo -> Ticked (ChainDepState (WithLeaderSchedule p)) -> ChainDepState (WithLeaderSchedule p) Source #

protocolSecurityParam :: ConsensusConfig (WithLeaderSchedule p) -> SecurityParam Source #

ChainSelection p => ChainSelection (WithLeaderSchedule p) Source #

Chain selection is unchanged

Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Associated Types

type ChainSelConfig (WithLeaderSchedule p) Source #

type SelectView (WithLeaderSchedule p) Source #

Methods

preferCandidate :: proxy (WithLeaderSchedule p) -> ChainSelConfig (WithLeaderSchedule p) -> SelectView (WithLeaderSchedule p) -> SelectView (WithLeaderSchedule p) -> Bool Source #

compareCandidates :: proxy (WithLeaderSchedule p) -> ChainSelConfig (WithLeaderSchedule p) -> SelectView (WithLeaderSchedule p) -> SelectView (WithLeaderSchedule p) -> Ordering Source #

type Rep (ConsensusConfig (WithLeaderSchedule p)) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

type Rep (ConsensusConfig (WithLeaderSchedule p)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.LeaderSchedule" "ouroboros-consensus-0.1.0.0-GfJNvFcM6lj2s5utKAUPEp" 'False) (C1 ('MetaCons "WLSConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "wlsConfigSchedule") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 LeaderSchedule) :*: (S1 ('MetaSel ('Just "wlsConfigP") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ConsensusConfig p)) :*: S1 ('MetaSel ('Just "wlsConfigNodeId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CoreNodeId))))
type ChainDepState (WithLeaderSchedule p) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

type ChainDepState (WithLeaderSchedule p) = ()
type IsLeader (WithLeaderSchedule p) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

type IsLeader (WithLeaderSchedule p) = ()
type CanBeLeader (WithLeaderSchedule p) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

type CanBeLeader (WithLeaderSchedule p) = ()
type LedgerView (WithLeaderSchedule p) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

type LedgerView (WithLeaderSchedule p) = ()
type ValidationErr (WithLeaderSchedule p) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

type ValidationErr (WithLeaderSchedule p) = ()
type ValidateView (WithLeaderSchedule p) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

type ValidateView (WithLeaderSchedule p) = ()
type ChainSelConfig (WithLeaderSchedule p) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

type ChainSelConfig (WithLeaderSchedule p) = ChainSelConfig p
type SelectView (WithLeaderSchedule p) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

type SelectView (WithLeaderSchedule p) = SelectView p
data ConsensusConfig (WithLeaderSchedule p) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

data ConsensusConfig (WithLeaderSchedule p) = WLSConfig {}

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 (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 (WithLeaderSchedule p)) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Associated Types

type Rep (ConsensusConfig (WithLeaderSchedule p)) :: Type -> Type #

Methods

from :: ConsensusConfig (WithLeaderSchedule p) -> Rep (ConsensusConfig (WithLeaderSchedule p)) x #

to :: Rep (ConsensusConfig (WithLeaderSchedule p)) x -> ConsensusConfig (WithLeaderSchedule p) #

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

(ConsensusProtocol p, ChainSelection s) => 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 => NoThunks (ConsensusConfig (WithLeaderSchedule p)) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Methods

noThunks :: Context -> ConsensusConfig (WithLeaderSchedule p) -> IO (Maybe ThunkInfo) Source #

wNoThunks :: Context -> ConsensusConfig (WithLeaderSchedule p) -> IO (Maybe ThunkInfo) Source #

showTypeOf :: Proxy (ConsensusConfig (WithLeaderSchedule p)) -> 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 #

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 #

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 (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.1.0.0-GfJNvFcM6lj2s5utKAUPEp" 'False) (C1 ('MetaCons "McsConsensusConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "mcsConfigS") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ChainSelConfig s)) :*: S1 ('MetaSel ('Just "mcsConfigP") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (ConsensusConfig p))))
type Rep (ConsensusConfig (WithLeaderSchedule p)) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

type Rep (ConsensusConfig (WithLeaderSchedule p)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.LeaderSchedule" "ouroboros-consensus-0.1.0.0-GfJNvFcM6lj2s5utKAUPEp" 'False) (C1 ('MetaCons "WLSConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "wlsConfigSchedule") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 LeaderSchedule) :*: (S1 ('MetaSel ('Just "wlsConfigP") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (ConsensusConfig p)) :*: S1 ('MetaSel ('Just "wlsConfigNodeId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 CoreNodeId))))
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.1.0.0-GfJNvFcM6lj2s5utKAUPEp" '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 (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.1.0.0-GfJNvFcM6lj2s5utKAUPEp" '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 (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.1.0.0-GfJNvFcM6lj2s5utKAUPEp" 'False) (C1 ('MetaCons "PBftConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "pbftParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PBftParams)))
data ConsensusConfig (WithLeaderSchedule p) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

data ConsensusConfig (WithLeaderSchedule p) = WLSConfig {}
data ConsensusConfig (Bft c) Source #

(Static) node configuration

Instance details

Defined in Ouroboros.Consensus.Protocol.BFT

data ConsensusConfig (Bft c) = BftConfig {}
data ConsensusConfig (HardForkProtocol xs) Source # 
Instance details

Defined in Ouroboros.Consensus.HardFork.Combinator.Basics

data ConsensusConfig (HardForkProtocol xs) = HardForkConsensusConfig {}
data ConsensusConfig (PBft c) Source #

(Static) node configuration

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

data ConsensusConfig (PBft c) = PBftConfig {}
data ConsensusConfig (ModChainSel p s) Source # 
Instance details

Defined in Ouroboros.Consensus.Protocol.ModChainSel

data ConsensusConfig (ModChainSel p s) = McsConsensusConfig {}