Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Leios.Protocol

Description

What a consensus protocol says about the Leios announcement a header may carry.

Synopsis

data LeiosAnnouncement = MkLeiosAnnouncement {
- announcementElectee ∷ !(KeyHash 'BlockIssuer)
- announcementEbHash ∷ !EbHash
- announcementEbSize ∷ !BytesSize
}
decodeLeiosAnnouncement ∷ Decoder s LeiosAnnouncement
encodeLeiosAnnouncement ∷ LeiosAnnouncement → Encoding
data LeiosLedgerView = MkLeiosLedgerView {
- llvCommittee ∷ !LeiosCommittee
- llvQuorumStakeThreshold ∷ !UnitInterval
- llvAnnouncementPeriod ∷ !Milliseconds32
- llvVotePeriod ∷ !Milliseconds32
- llvDiffusionPeriod ∷ !Milliseconds32
- llvMaxEbBodySize ∷ !BytesSize
- llvMaxEbTxsSize ∷ !BytesSize
}
class ConsensusProtocol p ⇒ LeiosProtocol p where
- getLeiosAnnouncement ∷ proxy p → ValidateView p → Maybe LeiosAnnouncement
- validateLeiosAnnouncement ∷ ConsensusConfig p → ValidateView p → SlotNo → Ticked (ChainDepState p) → Except (ValidationErr p) OCINStaleness
- getLeiosLedgerView ∷ proxy p → LedgerView p → Maybe LeiosLedgerView
data OCINStaleness
- = FreshOCIN
- | StaleOCIN
defaultGetLeiosLedgerView ∷ proxy p → LedgerView p → Maybe LeiosLedgerView
defaultValidateLeiosAnnouncement ∷ ConsensusConfig p → ValidateView p → SlotNo → Ticked (ChainDepState p) → Except (ValidationErr p) OCINStaleness
defaultGetLeiosAnnouncement ∷ proxy p → ValidateView p → Maybe LeiosAnnouncement

Documentation

data LeiosAnnouncement Source #

The announcement a header carries, as its protocol view gives it.

Constructors

MkLeiosAnnouncement

Fields

announcementElectee ∷ !(KeyHash 'BlockIssuer)
the hash of the elected pool's cold verification key; with the header's slot, this identifies the election
announcementEbHash ∷ !EbHash
announcementEbSize ∷ !BytesSize
the announced endorser block's size
TODO Nothing reads it yet. A certifying ranking block's ChainSync MsgRollForward will be interpreted as an offer of the endorser block it certifies, of this size, and Leios voting will confirm that the size is accurate.

Instances

Instances details

Eq LeiosAnnouncement Source #

Instance details

Defined in Ouroboros.Consensus.Leios.Protocol

Methods

(==) ∷ LeiosAnnouncement → LeiosAnnouncement → Bool #

(/=) ∷ LeiosAnnouncement → LeiosAnnouncement → Bool #

Generic LeiosAnnouncement Source #

Instance details

Defined in Ouroboros.Consensus.Leios.Protocol

Associated Types

type Rep LeiosAnnouncement

Instance details

Defined in Ouroboros.Consensus.Leios.Protocol

type Rep LeiosAnnouncement = D1 ('MetaData "LeiosAnnouncement" "Ouroboros.Consensus.Leios.Protocol" "ouroboros-consensus-5.0.0.0-inplace" 'False) (C1 ('MetaCons "MkLeiosAnnouncement" 'PrefixI 'True) (S1 ('MetaSel ('Just "announcementElectee") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'BlockIssuer)) :*: (S1 ('MetaSel ('Just "announcementEbHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 EbHash) :*: S1 ('MetaSel ('Just "announcementEbSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BytesSize))))

Methods

from ∷ LeiosAnnouncement → Rep LeiosAnnouncement x #

to ∷ Rep LeiosAnnouncement x → LeiosAnnouncement #

Show LeiosAnnouncement Source #

Instance details

Defined in Ouroboros.Consensus.Leios.Protocol

Methods

showsPrec ∷ Int → LeiosAnnouncement → ShowS #

show ∷ LeiosAnnouncement → String #

showList ∷ [LeiosAnnouncement] → ShowS #

NoThunks LeiosAnnouncement Source #

Instance details

Defined in Ouroboros.Consensus.Leios.Protocol

Methods

noThunks ∷ Context → LeiosAnnouncement → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → LeiosAnnouncement → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy LeiosAnnouncement → String Source #

type Rep LeiosAnnouncement Source #

Instance details

Defined in Ouroboros.Consensus.Leios.Protocol

type Rep LeiosAnnouncement = D1 ('MetaData "LeiosAnnouncement" "Ouroboros.Consensus.Leios.Protocol" "ouroboros-consensus-5.0.0.0-inplace" 'False) (C1 ('MetaCons "MkLeiosAnnouncement" 'PrefixI 'True) (S1 ('MetaSel ('Just "announcementElectee") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'BlockIssuer)) :*: (S1 ('MetaSel ('Just "announcementEbHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 EbHash) :*: S1 ('MetaSel ('Just "announcementEbSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BytesSize))))

decodeLeiosAnnouncement ∷ Decoder s LeiosAnnouncement Source #

encodeLeiosAnnouncement ∷ LeiosAnnouncement → Encoding Source #

data LeiosLedgerView Source #

The Leios parameters a ledger view carries.

The periods are durations, as the protocol parameters define them; they need not be whole numbers of slots.

Constructors

MkLeiosLedgerView

Fields

llvCommittee ∷ !LeiosCommittee
who may vote this epoch, and with what weight
llvQuorumStakeThreshold ∷ !UnitInterval
the weight a certificate must accumulate
llvAnnouncementPeriod ∷ !Milliseconds32
L_hdr, the announcement period
llvVotePeriod ∷ !Milliseconds32
L_vote, the voting period
llvDiffusionPeriod ∷ !Milliseconds32
L_diff, the diffusion period
llvMaxEbBodySize ∷ !BytesSize
the largest endorser block the ledger admits, not counting its transactions
llvMaxEbTxsSize ∷ !BytesSize
the largest total size of the transactions an endorser block references

Instances

Instances details

Eq LeiosLedgerView Source #

Instance details

Defined in Ouroboros.Consensus.Leios.Protocol

Methods

(==) ∷ LeiosLedgerView → LeiosLedgerView → Bool #

(/=) ∷ LeiosLedgerView → LeiosLedgerView → Bool #

Generic LeiosLedgerView Source #

Instance details

Defined in Ouroboros.Consensus.Leios.Protocol

Associated Types

type Rep LeiosLedgerView

Instance details

Defined in Ouroboros.Consensus.Leios.Protocol

type Rep LeiosLedgerView = D1 ('MetaData "LeiosLedgerView" "Ouroboros.Consensus.Leios.Protocol" "ouroboros-consensus-5.0.0.0-inplace" 'False) (C1 ('MetaCons "MkLeiosLedgerView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "llvCommittee") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 LeiosCommittee) :*: (S1 ('MetaSel ('Just "llvQuorumStakeThreshold") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UnitInterval) :*: S1 ('MetaSel ('Just "llvAnnouncementPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Milliseconds32))) :*: ((S1 ('MetaSel ('Just "llvVotePeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Milliseconds32) :*: S1 ('MetaSel ('Just "llvDiffusionPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Milliseconds32)) :*: (S1 ('MetaSel ('Just "llvMaxEbBodySize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BytesSize) :*: S1 ('MetaSel ('Just "llvMaxEbTxsSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BytesSize)))))

Methods

from ∷ LeiosLedgerView → Rep LeiosLedgerView x #

to ∷ Rep LeiosLedgerView x → LeiosLedgerView #

Show LeiosLedgerView Source #

Instance details

Defined in Ouroboros.Consensus.Leios.Protocol

Methods

showsPrec ∷ Int → LeiosLedgerView → ShowS #

show ∷ LeiosLedgerView → String #

showList ∷ [LeiosLedgerView] → ShowS #

NoThunks LeiosLedgerView Source #

Instance details

Defined in Ouroboros.Consensus.Leios.Protocol

Methods

noThunks ∷ Context → LeiosLedgerView → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → LeiosLedgerView → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy LeiosLedgerView → String Source #

type Rep LeiosLedgerView Source #

Instance details

Defined in Ouroboros.Consensus.Leios.Protocol

type Rep LeiosLedgerView = D1 ('MetaData "LeiosLedgerView" "Ouroboros.Consensus.Leios.Protocol" "ouroboros-consensus-5.0.0.0-inplace" 'False) (C1 ('MetaCons "MkLeiosLedgerView" 'PrefixI 'True) ((S1 ('MetaSel ('Just "llvCommittee") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 LeiosCommittee) :*: (S1 ('MetaSel ('Just "llvQuorumStakeThreshold") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 UnitInterval) :*: S1 ('MetaSel ('Just "llvAnnouncementPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Milliseconds32))) :*: ((S1 ('MetaSel ('Just "llvVotePeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Milliseconds32) :*: S1 ('MetaSel ('Just "llvDiffusionPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Milliseconds32)) :*: (S1 ('MetaSel ('Just "llvMaxEbBodySize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BytesSize) :*: S1 ('MetaSel ('Just "llvMaxEbTxsSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 BytesSize)))))

class ConsensusProtocol p ⇒ LeiosProtocol p where Source #

Methods

getLeiosAnnouncement ∷ proxy p → ValidateView p → Maybe LeiosAnnouncement Source #

The announcement carried by the header with this view, if any.

validateLeiosAnnouncement ∷ ConsensusConfig p → ValidateView p → SlotNo → Ticked (ChainDepState p) → Except (ValidationErr p) OCINStaleness Source #

The protocol-level validation of a relayed announcement's header, done out of context: against the immutable tip's chain-dependent state ticked to the header's slot, rather than against the header's predecessor.

Since that state may lag, a check our lag could spuriously fail must not reject; a counter that is merely behind instead yields StaleOCIN.

Only called for a view that carries an announcement.

getLeiosLedgerView ∷ proxy p → LedgerView p → Maybe LeiosLedgerView Source #

The Leios parameters this ledger view carries, or Nothing if the protocol has no Leios.

Instances

Instances details

(CanHardFork xs, All SingleEraBlockAndLeiosProtocol xs) ⇒ LeiosProtocol (HardForkProtocol xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol Methods getLeiosAnnouncement ∷ proxy (HardForkProtocol xs) → ValidateView (HardForkProtocol xs) → Maybe LeiosAnnouncement Source # validateLeiosAnnouncement ∷ ConsensusConfig (HardForkProtocol xs) → ValidateView (HardForkProtocol xs) → SlotNo → Ticked (ChainDepState (HardForkProtocol xs)) → Except (ValidationErr (HardForkProtocol xs)) OCINStaleness Source # getLeiosLedgerView ∷ proxy (HardForkProtocol xs) → LedgerView (HardForkProtocol xs) → Maybe LeiosLedgerView Source #
BftCrypto c ⇒ LeiosProtocol (Bft c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.BFT Methods getLeiosAnnouncement ∷ proxy (Bft c) → ValidateView (Bft c) → Maybe LeiosAnnouncement Source # validateLeiosAnnouncement ∷ ConsensusConfig (Bft c) → ValidateView (Bft c) → SlotNo → Ticked (ChainDepState (Bft c)) → Except (ValidationErr (Bft c)) OCINStaleness Source # getLeiosLedgerView ∷ proxy (Bft c) → LedgerView (Bft c) → Maybe LeiosLedgerView Source #
PBftCrypto c ⇒ LeiosProtocol (PBft c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.PBFT Methods getLeiosAnnouncement ∷ proxy (PBft c) → ValidateView (PBft c) → Maybe LeiosAnnouncement Source # validateLeiosAnnouncement ∷ ConsensusConfig (PBft c) → ValidateView (PBft c) → SlotNo → Ticked (ChainDepState (PBft c)) → Except (ValidationErr (PBft c)) OCINStaleness Source # getLeiosLedgerView ∷ proxy (PBft c) → LedgerView (PBft c) → Maybe LeiosLedgerView Source #

data OCINStaleness Source #

Whether an announcement's operational certificate issue number (OCIN) is at least the one our immutable tip records for its issuer.

A stale one is accepted from the peer but neither processed nor relayed; see validateLeiosAnnouncement.

Constructors

FreshOCIN
StaleOCIN

Instances

Instances details

Eq OCINStaleness Source #
Instance details Defined in Ouroboros.Consensus.Leios.Protocol Methods (==) ∷ OCINStaleness → OCINStaleness → Bool # (/=) ∷ OCINStaleness → OCINStaleness → Bool #
Show OCINStaleness Source #
Instance details Defined in Ouroboros.Consensus.Leios.Protocol Methods showsPrec ∷ Int → OCINStaleness → ShowS # show ∷ OCINStaleness → String # showList ∷ [OCINStaleness] → ShowS #

defaultGetLeiosLedgerView ∷ proxy p → LedgerView p → Maybe LeiosLedgerView Source #

getLeiosLedgerView for a protocol that has no Leios.

defaultValidateLeiosAnnouncement ∷ ConsensusConfig p → ValidateView p → SlotNo → Ticked (ChainDepState p) → Except (ValidationErr p) OCINStaleness Source #

validateLeiosAnnouncement for a protocol whose headers never carry an announcement, which is therefore never called.

defaultGetLeiosAnnouncement ∷ proxy p → ValidateView p → Maybe LeiosAnnouncement Source #

getLeiosAnnouncement for a protocol whose headers never carry an announcement.