| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Ouroboros.Consensus.Peras.Cert.Inclusion
Description
This module defines the logic needed to evaluate when a Peras certificate must be included in a block.
NOTE: in this file, we use uncommon variable names such as _A because that
is their name in the CIP-0140, and we can't have variable names starting
with capital letters. Contrary to typical Haskell conventions, those do not
denote ignored variables.
Synopsis
- data LatestCertSeenView cert = LatestCertSeenView {
- lcsCert ∷ !cert
- lcsCertRound ∷ !PerasRoundNo
- data LatestCertOnChainView cert = LatestCertOnChainView {}
- data PerasCertInclusionView cert blk = PerasCertInclusionView {
- perasParams ∷ !(PerasParams blk)
- currRoundNo ∷ !PerasRoundNo
- latestCertSeen ∷ !(LatestCertSeenView cert)
- latestCertOnChain ∷ !(WithOrigin (LatestCertOnChainView cert))
- certIds ∷ !(Set PerasRoundNo)
- mkPerasCertInclusionView ∷ IsPerasCert cert blk ⇒ PerasParams blk → PerasRoundNo → cert → WithOrigin PerasRoundNo → Set PerasRoundNo → PerasCertInclusionView cert blk
- newtype PerasCertInclusionViewHandle (m ∷ Type → Type) blk = PerasCertInclusionViewHandle (PerasRoundNo → STM m (Maybe (PerasCertInclusionView (WithArrivalTime (ValidatedPerasCert blk)) blk)))
- data PerasCertInclusionRule
- data PerasCertInclusionRulesDecision cert
- needCert ∷ PerasCertInclusionView cert blk → PerasCertInclusionRulesDecision cert
- needCertWithHandle ∷ ∀ (m ∷ Type → Type) blk. MonadSTM m ⇒ PerasCertInclusionViewHandle m blk → PerasRoundNo → STM m (Maybe (PerasCertInclusionRulesDecision (WithArrivalTime (ValidatedPerasCert blk))))
- noCertsFromTwoRoundsAgo ∷ PerasCertInclusionView cert blk → Pred PerasCertInclusionRule
- needCertRules ∷ PerasCertInclusionView cert blk → Pred PerasCertInclusionRule
Documentation
data LatestCertSeenView cert Source #
View of the latest certificate seen by the voter
Constructors
| LatestCertSeenView | |
Fields
| |
Instances
| Show cert ⇒ Show (LatestCertSeenView cert) Source # | |
Defined in Ouroboros.Consensus.Peras.Cert.Inclusion Methods showsPrec ∷ Int → LatestCertSeenView cert → ShowS # show ∷ LatestCertSeenView cert → String # showList ∷ [LatestCertSeenView cert] → ShowS # | |
data LatestCertOnChainView cert Source #
View of the latest certificate present in our preferred chain
Constructors
| LatestCertOnChainView | |
Fields
| |
Instances
| Show (LatestCertOnChainView cert) Source # | |
Defined in Ouroboros.Consensus.Peras.Cert.Inclusion Methods showsPrec ∷ Int → LatestCertOnChainView cert → ShowS # show ∷ LatestCertOnChainView cert → String # showList ∷ [LatestCertOnChainView cert] → ShowS # | |
data PerasCertInclusionView cert blk Source #
Interface needed to evaluate the Peras cert inclusion rules
Constructors
| PerasCertInclusionView | |
Fields
| |
Instances
| Show cert ⇒ Show (PerasCertInclusionView cert blk) Source # | |
Defined in Ouroboros.Consensus.Peras.Cert.Inclusion Methods showsPrec ∷ Int → PerasCertInclusionView cert blk → ShowS # show ∷ PerasCertInclusionView cert blk → String # showList ∷ [PerasCertInclusionView cert blk] → ShowS # | |
mkPerasCertInclusionView Source #
Arguments
| ∷ IsPerasCert cert blk | |
| ⇒ PerasParams blk | Peras protocol parameters |
| → PerasRoundNo | Current Peras round number |
| → cert | Most recent certificate seen by the voter |
| → WithOrigin PerasRoundNo | Round number of the latest certificate present in our preferred chain |
| → Set PerasRoundNo | Set of certificates (by their round number) present in our database |
| → PerasCertInclusionView cert blk | Constructed certificate inclusion view |
Construct a PerasCertInclusionView from the given inputs.
NOTE: this assumes that the client code computes all the needed inputs within the same STM transaction, or the results may be inconsistent.
newtype PerasCertInclusionViewHandle (m ∷ Type → Type) blk Source #
Handle for querying the Peras certificate inclusion rules via STM.
Constructors
| PerasCertInclusionViewHandle (PerasRoundNo → STM m (Maybe (PerasCertInclusionView (WithArrivalTime (ValidatedPerasCert blk)) blk))) |
data PerasCertInclusionRule Source #
Certificate inclusion rules.
Each constructor corresponds to one of the members in the conjunction defined
in needCert per CIP-0140.
Constructors
| NoCertsFromTwoRoundsAgo | |
Fields
| |
| LatestCertSeenIsNotExpired | |
Fields
| |
| LatestCertSeenIsNewerThanLatestCertOnChain | |
Fields
| |
Instances
| Eq PerasCertInclusionRule Source # | |
Defined in Ouroboros.Consensus.Peras.Cert.Inclusion Methods (==) ∷ PerasCertInclusionRule → PerasCertInclusionRule → Bool # (/=) ∷ PerasCertInclusionRule → PerasCertInclusionRule → Bool # | |
| Show PerasCertInclusionRule Source # | |
Defined in Ouroboros.Consensus.Peras.Cert.Inclusion Methods showsPrec ∷ Int → PerasCertInclusionRule → ShowS # show ∷ PerasCertInclusionRule → String # showList ∷ [PerasCertInclusionRule] → ShowS # | |
| Explainable PerasCertInclusionRule Source # | |
Defined in Ouroboros.Consensus.Peras.Cert.Inclusion Methods explain ∷ ExplanationMode → PerasCertInclusionRule → String Source # explainPrec ∷ Int → ExplanationMode → PerasCertInclusionRule → String Source # | |
data PerasCertInclusionRulesDecision cert Source #
Whether we are expected to add a certificate to the block we are building according to the inclusion rules.
These rules are taken as verbatim as possible from the Peras CIP-0140: https://github.com/cardano-foundation/CIPs/blob/master/CIP-0140/README.md#block-creation
This type additionally carries the evidence for the decision taken.
Constructors
| IncludeCert (Evidence 'True PerasCertInclusionRule) cert | |
| DoNotIncludeCert (Evidence 'False PerasCertInclusionRule) |
Instances
needCert ∷ PerasCertInclusionView cert blk → PerasCertInclusionRulesDecision cert Source #
Evaluate whether we need to include a certificate in the block we are building.
needCertWithHandle ∷ ∀ (m ∷ Type → Type) blk. MonadSTM m ⇒ PerasCertInclusionViewHandle m blk → PerasRoundNo → STM m (Maybe (PerasCertInclusionRulesDecision (WithArrivalTime (ValidatedPerasCert blk)))) Source #
Query the Peras certificate inclusion rules via STM.
noCertsFromTwoRoundsAgo ∷ PerasCertInclusionView cert blk → Pred PerasCertInclusionRule Source #
noCertsFromTwoRoundsAgo: we haven't seen a certificate from two rounds ago
needCertRules ∷ PerasCertInclusionView cert blk → Pred PerasCertInclusionRule Source #
We need to include a certificate in the block we are building if all the rules in this conjunction are satisfied.