Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Byron.Ledger.Inspect

Contents

Layer around the Byron protocol update inteface
Orphan instances

Synopsis

data ByronLedgerUpdate = ByronUpdatedProtocolUpdates [ ProtocolUpdate ]
data ProtocolUpdate = ProtocolUpdate {
- protocolUpdateVersion :: ProtocolVersion
- protocolUpdateState :: UpdateState
}
data UpdateState
- = UpdateRegistered SlotNo
- | UpdateActive ( Set KeyHash )
- | UpdateConfirmed SlotNo
- | UpdateStablyConfirmed ( Set KeyHash )
- | UpdateCandidate SlotNo EpochNo
- | UpdateStableCandidate EpochNo
protocolUpdates :: LedgerConfig ByronBlock -> LedgerState ByronBlock -> [ ProtocolUpdate ]

Documentation

data ByronLedgerUpdate Source #

Constructors

ByronUpdatedProtocolUpdates [ ProtocolUpdate ]

Instances

Instances details

Eq ByronLedgerUpdate Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Inspect Methods (==) :: ByronLedgerUpdate -> ByronLedgerUpdate -> Bool Source # (/=) :: ByronLedgerUpdate -> ByronLedgerUpdate -> Bool Source #
Show ByronLedgerUpdate Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Inspect Methods showsPrec :: Int -> ByronLedgerUpdate -> ShowS Source # show :: ByronLedgerUpdate -> String Source # showList :: [ ByronLedgerUpdate ] -> ShowS Source #
Condense ByronLedgerUpdate Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Inspect Methods condense :: ByronLedgerUpdate -> String Source #

Layer around the Byron protocol update inteface

data ProtocolUpdate Source #

Wrapper around a Byron protocol update with information about its state

NOTE: We don't currently record the ProtocolParameters here because we don't really need to track them, and adding them would add a lot of output to the Show instance. We could easily add them however if that would be useful.

Constructors

ProtocolUpdate
Fields protocolUpdateVersion :: ProtocolVersion protocolUpdateState :: UpdateState

Instances

Instances details

Eq ProtocolUpdate Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Inspect Methods (==) :: ProtocolUpdate -> ProtocolUpdate -> Bool Source # (/=) :: ProtocolUpdate -> ProtocolUpdate -> Bool Source #
Show ProtocolUpdate Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Inspect Methods showsPrec :: Int -> ProtocolUpdate -> ShowS Source # show :: ProtocolUpdate -> String Source # showList :: [ ProtocolUpdate ] -> ShowS Source #

data UpdateState Source #

The various states a protocol update goes through

Listed in chronological order.

Constructors

UpdateRegistered SlotNo	The update was registered, but does not yet have any votes We record the `SlotNo` of the slot in which the update was registered. After registration, nodes must vote on it.
UpdateActive ( Set KeyHash )	The update is accumulating votes We record which nodes have voted for the proposal. The proposal must accumulate a sufficient number of votes before it can be confirmed.
UpdateConfirmed SlotNo	The update has amassed a sufficient number of votes We record the `SlotNo` of the slot in which the required threshold of votes was met. At this point `2k` slots need to pass before the update can be endorsed.
UpdateStablyConfirmed ( Set KeyHash )	The votes are stable. We can start to accumulate endorsements. We record which nodes have endorsed the proposal. The proposal must accumulate a sufficient number of endorsements before it is nominated and becomes a candidate.
UpdateCandidate SlotNo EpochNo	The update has amassed a sufficient number of endorsements We record the `SlotNo` of the slot in which the required threshold of endorsement was met. At this point a further `2k` slots need to pass before the update becomes a stable candidate and can be adopted. We additionally record the `EpochNo` in which the candidate will be adopted, if it becomes stable.
UpdateStableCandidate EpochNo	The endorsements are stable. The update will be accepted. We record the `EpochNo` of the epoch in which it will become active.

Instances

Instances details

Eq UpdateState Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Inspect Methods (==) :: UpdateState -> UpdateState -> Bool Source # (/=) :: UpdateState -> UpdateState -> Bool Source #
Show UpdateState Source #
Instance details Defined in Ouroboros.Consensus.Byron.Ledger.Inspect Methods showsPrec :: Int -> UpdateState -> ShowS Source # show :: UpdateState -> String Source # showList :: [ UpdateState ] -> ShowS Source #

protocolUpdates :: LedgerConfig ByronBlock -> LedgerState ByronBlock -> [ ProtocolUpdate ] Source #

All proposal updates, from new to old

Orphan instances

InspectLedger ByronBlock Source #
Instance details Associated Types type LedgerWarning ByronBlock Source # type LedgerUpdate ByronBlock Source # Methods inspectLedger :: TopLevelConfig ByronBlock -> LedgerState ByronBlock -> LedgerState ByronBlock -> [ LedgerEvent ByronBlock ] Source #