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

Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

Synopsis

Documentation

data family ConsensusConfig p 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 (Bft c)) 
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 (PBft c)) 
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) #

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

Defined in Ouroboros.Consensus.Mock.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 (Praos c)) Source # 
Instance details

Defined in Ouroboros.Consensus.Mock.Protocol.Praos

Associated Types

type Rep (ConsensusConfig (Praos c)) ∷ Type → Type #

Methods

from ∷ ConsensusConfig (Praos c) → Rep (ConsensusConfig (Praos c)) x #

to ∷ Rep (ConsensusConfig (Praos c)) x → ConsensusConfig (Praos c) #

BftCrypto c ⇒ NoThunks (ConsensusConfig (Bft c)) 
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 #

NoThunks (ConsensusConfig (PBft c)) 
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 #

ConsensusProtocol p ⇒ NoThunks (ConsensusConfig (WithLeaderSchedule p)) Source # 
Instance details

Defined in Ouroboros.Consensus.Mock.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 #

PraosCrypto c ⇒ NoThunks (ConsensusConfig (Praos c)) Source # 
Instance details

Defined in Ouroboros.Consensus.Mock.Protocol.Praos

Methods

noThunks ∷ Context → ConsensusConfig (Praos c) → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → ConsensusConfig (Praos c) → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (ConsensusConfig (Praos c)) → String Source #

type Rep (ConsensusConfig (Bft c)) 
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 (PBft c)) 
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)))
type Rep (ConsensusConfig (WithLeaderSchedule p)) Source # 
Instance details

Defined in Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

type Rep (ConsensusConfig (WithLeaderSchedule p)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Mock.Protocol.LeaderSchedule" "ouroboros-consensus-0.18.0.0-inplace-unstable-mock-block" '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 (Praos c)) Source # 
Instance details

Defined in Ouroboros.Consensus.Mock.Protocol.Praos

type Rep (ConsensusConfig (Praos c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Mock.Protocol.Praos" "ouroboros-consensus-0.18.0.0-inplace-unstable-mock-block" 'False) (C1 ('MetaCons "PraosConfig" 'PrefixI 'True) ((S1 ('MetaSel ('Just "praosParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PraosParams) :*: (S1 ('MetaSel ('Just "praosInitialEta") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "praosInitialStake") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 StakeDist))) :*: (S1 ('MetaSel ('Just "praosEvolvingStake") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PraosEvolvingStake) :*: (S1 ('MetaSel ('Just "praosSignKeyVRF") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (SignKeyVRF (PraosVRF c))) :*: S1 ('MetaSel ('Just "praosVerKeys") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map CoreNodeId (VerKeyKES (PraosKES c), VerKeyVRF (PraosVRF c))))))))
data ConsensusConfig (Bft c)

(Static) node configuration

Instance details

Defined in Ouroboros.Consensus.Protocol.BFT

data ConsensusConfig (Bft c) = BftConfig {}
newtype ConsensusConfig (PBft c)

(Static) node configuration

Instance details

Defined in Ouroboros.Consensus.Protocol.PBFT

newtype ConsensusConfig (PBft c) = PBftConfig {}
data ConsensusConfig (WithLeaderSchedule p) Source # 
Instance details

Defined in Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

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

The configuration that will be provided to every node when running the MockPraos protocol.

Instance details

Defined in Ouroboros.Consensus.Mock.Protocol.Praos

data ConsensusConfig (Praos c) = PraosConfig {}

newtype LeaderSchedule Source #

Constructors

LeaderSchedule 

Fields

Instances

Instances details
Semigroup LeaderSchedule 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Methods

(<>) ∷ LeaderSchedule → LeaderSchedule → LeaderSchedule #

sconcat ∷ NonEmpty LeaderSchedule → LeaderSchedule #

stimes ∷ Integral b ⇒ b → LeaderSchedule → LeaderSchedule #

Generic LeaderSchedule 
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 #

Show LeaderSchedule 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Methods

showsPrec ∷ Int → LeaderSchedule → ShowS #

show ∷ LeaderSchedule → String #

showList ∷ [LeaderSchedule] → ShowS #

Eq LeaderSchedule 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Methods

(==) ∷ LeaderSchedule → LeaderSchedule → Bool #

(/=) ∷ LeaderSchedule → LeaderSchedule → Bool #

Ord LeaderSchedule 
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 #

NoThunks LeaderSchedule 
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 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

Methods

condense ∷ LeaderSchedule → String Source #

type Rep LeaderSchedule 
Instance details

Defined in Ouroboros.Consensus.Protocol.LeaderSchedule

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

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.Mock.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.Mock.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.Mock.Protocol.LeaderSchedule

Associated Types

type ChainDepState (WithLeaderSchedule p) Source #

type IsLeader (WithLeaderSchedule p) Source #

type CanBeLeader (WithLeaderSchedule p) Source #

type SelectView (WithLeaderSchedule p) Source #

type LedgerView (WithLeaderSchedule p) Source #

type ValidationErr (WithLeaderSchedule p) Source #

type ValidateView (WithLeaderSchedule p) Source #

Methods

checkIsLeader ∷ ConsensusConfig (WithLeaderSchedule p) → CanBeLeader (WithLeaderSchedule p) → SlotNo → Ticked (ChainDepState (WithLeaderSchedule p)) → Maybe (IsLeader (WithLeaderSchedule p)) Source #

tickChainDepState ∷ ConsensusConfig (WithLeaderSchedule p) → 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 #

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

Defined in Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

type Rep (ConsensusConfig (WithLeaderSchedule p)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Mock.Protocol.LeaderSchedule" "ouroboros-consensus-0.18.0.0-inplace-unstable-mock-block" '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 CanBeLeader (WithLeaderSchedule p) Source # 
Instance details

Defined in Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

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

Defined in Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

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

Defined in Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

data ConsensusConfig (WithLeaderSchedule p) = WLSConfig {}
type IsLeader (WithLeaderSchedule p) Source # 
Instance details

Defined in Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

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

Defined in Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

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

Defined in Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

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

Defined in Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

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

Defined in Ouroboros.Consensus.Mock.Protocol.LeaderSchedule

type ValidationErr (WithLeaderSchedule p) = ()

leaderScheduleFor ∷ CoreNodeId → LeaderSchedule → Set SlotNo Source #

The Slots a given node is supposed to lead in