Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.Shelley.Ledger.Inspect

Contents

Orphan instances

Synopsis

data ProtocolUpdate era = ProtocolUpdate {
- protocolUpdateProposal :: UpdateProposal era
- protocolUpdateState :: UpdateState (EraCrypto era)
}
data ShelleyLedgerUpdate era = ShelleyUpdatedProtocolUpdates [ProtocolUpdate era]
data UpdateProposal era = UpdateProposal {
- proposalParams :: PParamsUpdate era
- proposalVersion :: Maybe ProtVer
- proposalEpoch :: EpochNo
}
data UpdateState c = UpdateState {
- proposalVotes :: [KeyHash 'Genesis c]
- proposalReachedQuorum :: Bool
}
protocolUpdates :: forall era proto. ShelleyBasedEra era => ShelleyGenesis (EraCrypto era) -> LedgerState (ShelleyBlock proto era) -> [ProtocolUpdate era]

Documentation

data ProtocolUpdate era Source #

Constructors

ProtocolUpdate
Fields protocolUpdateProposal :: UpdateProposal era protocolUpdateState :: UpdateState (EraCrypto era)

Instances

Instances details

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

data ShelleyLedgerUpdate era Source #

Constructors

ShelleyUpdatedProtocolUpdates [ProtocolUpdate era]

Instances

Instances details

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

data UpdateProposal era Source #

Update proposal

As in Byron, a proposal is a partial map from parameters to their values.

Constructors

UpdateProposal

Fields

proposalParams :: PParamsUpdate era
The protocol parameters changed by this update proposal
An update is identified by how it updates the protocol parameters.
proposalVersion :: Maybe ProtVer
New version (if changed by this proposal)
The protocol version itself is also considered to be just another parameter, and parameters can change without changing the protocol version, although a convention could be established that the protocol version must change if any of the parameters do; but the specification itself does not mandate this.
We record the version separately for the convenience of the HFC.
proposalEpoch :: EpochNo
The EpochNo the proposal becomes active in, if it is adopted

Instances

Instances details

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

data UpdateState c Source #

Proposal state

The update mechanism in Shelley is simpler than it is in Byron. There is no distinction between votes and proposals: to "vote" for a proposal one merely submits the exact same proposal. There is also no separate endorsement step. The procedure is as follows:

During each epoch, a genesis key can submit (via its delegates) zero, one, or many proposals; each submission overrides the previous one.
"Voting" (submitting of proposals) ends 2 * stabilityWindow slots (i.e. 6k/f) before the end of the epoch. In other words, proposals for the upcoming epoch must be submitted within the first 4k/f slots of this one.
At the end of an epoch, if the majority of nodes (as determined by the Quorum specification constant, which must be greater than half the nodes) have most recently submitted the same exact proposal, then it is adopted.
The next epoch is always started with a clean slate, proposals from the previous epoch that didn't make it are discarded (except for "future proposals" that are explicitly marked for future epochs).

Constructors

UpdateState
Fields proposalVotes :: [KeyHash 'Genesis c] The genesis delegates that voted for this proposal proposalReachedQuorum :: Bool Has this proposal reached sufficient votes to be adopted?

Instances

Instances details

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

protocolUpdates :: forall era proto. ShelleyBasedEra era => ShelleyGenesis (EraCrypto era) -> LedgerState (ShelleyBlock proto era) -> [ProtocolUpdate era] Source #

Orphan instances

ShelleyBasedEra era => InspectLedger (ShelleyBlock proto era) Source #
Instance details Associated Types type LedgerWarning (ShelleyBlock proto era) type LedgerUpdate (ShelleyBlock proto era) Methods inspectLedger :: TopLevelConfig (ShelleyBlock proto era) -> LedgerState (ShelleyBlock proto era) -> LedgerState (ShelleyBlock proto era) -> [LedgerEvent (ShelleyBlock proto era)]