Safe Haskell	None
Language	Haskell2010

Cardano.Chain.Update.Validation.Endorsement

Synopsis

data Environment = Environment {
- k ∷ !BlockCount
- currentSlot ∷ !SlotNumber
- adoptionThreshold ∷ !Int
- delegationMap ∷ !Map
- confirmedProposals ∷ !(Map UpId SlotNumber)
- registeredProtocolUpdateProposals ∷ !ProtocolUpdateProposals
}
data State = State {
- candidateProtocolVersions ∷ ![CandidateProtocolUpdate]
- registeredEndorsements ∷ !(Set Endorsement)
}
data Endorsement = Endorsement {
- endorsementProtocolVersion ∷ !ProtocolVersion
- endorsementKeyHash ∷ !KeyHash
}
data CandidateProtocolUpdate = CandidateProtocolUpdate {
- cpuSlot ∷ !SlotNumber
- cpuProtocolVersion ∷ !ProtocolVersion
- cpuProtocolParameters ∷ !ProtocolParameters
}
register ∷ MonadError Error m ⇒ Environment → State → Endorsement → m State
data Error = MultipleProposalsForProtocolVersion ProtocolVersion

Documentation

data Environment Source #

Constructors

Environment
Fields k ∷ !BlockCount Chain stability parameter. currentSlot ∷ !SlotNumber adoptionThreshold ∷ !Int delegationMap ∷ !Map confirmedProposals ∷ !(Map UpId SlotNumber) registeredProtocolUpdateProposals ∷ !ProtocolUpdateProposals

data State Source #

Constructors

State
Fields candidateProtocolVersions ∷ ![CandidateProtocolUpdate] registeredEndorsements ∷ !(Set Endorsement)

data Endorsement Source #

Constructors

Endorsement
Fields endorsementProtocolVersion ∷ !ProtocolVersion endorsementKeyHash ∷ !KeyHash

Instances

Instances details

FromCBOR Endorsement Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

fromCBOR ∷ Decoder s Endorsement Source #

label ∷ Proxy Endorsement → Text Source #

ToCBOR Endorsement Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

toCBOR ∷ Endorsement → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy Endorsement → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Endorsement] → Size Source #

DecCBOR Endorsement Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

decCBOR ∷ Decoder s Endorsement Source #

dropCBOR ∷ Proxy Endorsement → Decoder s () Source #

label ∷ Proxy Endorsement → Text Source #

EncCBOR Endorsement Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

encCBOR ∷ Endorsement → Encoding Source #

NFData Endorsement Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

rnf ∷ Endorsement → () #

Generic Endorsement Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Associated Types

type Rep Endorsement

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

type Rep Endorsement = D1 ('MetaData "Endorsement" "Cardano.Chain.Update.Validation.Endorsement" "cardano-ledger-byron-1.3.0.0-inplace" 'False) (C1 ('MetaCons "Endorsement" 'PrefixI 'True) (S1 ('MetaSel ('Just "endorsementProtocolVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProtocolVersion) :*: S1 ('MetaSel ('Just "endorsementKeyHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KeyHash)))

Methods

from ∷ Endorsement → Rep Endorsement x #

to ∷ Rep Endorsement x → Endorsement #

Show Endorsement Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

showsPrec ∷ Int → Endorsement → ShowS #

show ∷ Endorsement → String #

showList ∷ [Endorsement] → ShowS #

Eq Endorsement Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

(==) ∷ Endorsement → Endorsement → Bool #

(/=) ∷ Endorsement → Endorsement → Bool #

Ord Endorsement Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

compare ∷ Endorsement → Endorsement → Ordering #

(<) ∷ Endorsement → Endorsement → Bool #

(<=) ∷ Endorsement → Endorsement → Bool #

(>) ∷ Endorsement → Endorsement → Bool #

(>=) ∷ Endorsement → Endorsement → Bool #

max ∷ Endorsement → Endorsement → Endorsement #

min ∷ Endorsement → Endorsement → Endorsement #

NoThunks Endorsement Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

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

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

showTypeOf ∷ Proxy Endorsement → String Source #

type Rep Endorsement Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

type Rep Endorsement = D1 ('MetaData "Endorsement" "Cardano.Chain.Update.Validation.Endorsement" "cardano-ledger-byron-1.3.0.0-inplace" 'False) (C1 ('MetaCons "Endorsement" 'PrefixI 'True) (S1 ('MetaSel ('Just "endorsementProtocolVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProtocolVersion) :*: S1 ('MetaSel ('Just "endorsementKeyHash") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KeyHash)))

data CandidateProtocolUpdate Source #

Constructors

CandidateProtocolUpdate

Fields

cpuSlot ∷ !SlotNumber
Slot at which this protocol version and parameters gathered enough endorsements and became a candidate. This is used to check which versions became candidates 2k slots before the end of an epoch (and only those can be adopted at that epoch). Versions that became candidates later than 2k slots before the end of an epoch can be adopted in following epochs.
cpuProtocolVersion ∷ !ProtocolVersion
cpuProtocolParameters ∷ !ProtocolParameters

Instances

Instances details

FromCBOR CandidateProtocolUpdate Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

fromCBOR ∷ Decoder s CandidateProtocolUpdate Source #

label ∷ Proxy CandidateProtocolUpdate → Text Source #

ToCBOR CandidateProtocolUpdate Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

toCBOR ∷ CandidateProtocolUpdate → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy CandidateProtocolUpdate → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [CandidateProtocolUpdate] → Size Source #

DecCBOR CandidateProtocolUpdate Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

decCBOR ∷ Decoder s CandidateProtocolUpdate Source #

dropCBOR ∷ Proxy CandidateProtocolUpdate → Decoder s () Source #

label ∷ Proxy CandidateProtocolUpdate → Text Source #

EncCBOR CandidateProtocolUpdate Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

encCBOR ∷ CandidateProtocolUpdate → Encoding Source #

NFData CandidateProtocolUpdate Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

rnf ∷ CandidateProtocolUpdate → () #

Generic CandidateProtocolUpdate Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Associated Types

type Rep CandidateProtocolUpdate

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

type Rep CandidateProtocolUpdate = D1 ('MetaData "CandidateProtocolUpdate" "Cardano.Chain.Update.Validation.Endorsement" "cardano-ledger-byron-1.3.0.0-inplace" 'False) (C1 ('MetaCons "CandidateProtocolUpdate" 'PrefixI 'True) (S1 ('MetaSel ('Just "cpuSlot") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SlotNumber) :*: (S1 ('MetaSel ('Just "cpuProtocolVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProtocolVersion) :*: S1 ('MetaSel ('Just "cpuProtocolParameters") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProtocolParameters))))

Methods

from ∷ CandidateProtocolUpdate → Rep CandidateProtocolUpdate x #

to ∷ Rep CandidateProtocolUpdate x → CandidateProtocolUpdate #

Show CandidateProtocolUpdate Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

showsPrec ∷ Int → CandidateProtocolUpdate → ShowS #

show ∷ CandidateProtocolUpdate → String #

showList ∷ [CandidateProtocolUpdate] → ShowS #

Eq CandidateProtocolUpdate Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

(==) ∷ CandidateProtocolUpdate → CandidateProtocolUpdate → Bool #

(/=) ∷ CandidateProtocolUpdate → CandidateProtocolUpdate → Bool #

NoThunks CandidateProtocolUpdate Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

Methods

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

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

showTypeOf ∷ Proxy CandidateProtocolUpdate → String Source #

type Rep CandidateProtocolUpdate Source #

Instance details

Defined in Cardano.Chain.Update.Validation.Endorsement

type Rep CandidateProtocolUpdate = D1 ('MetaData "CandidateProtocolUpdate" "Cardano.Chain.Update.Validation.Endorsement" "cardano-ledger-byron-1.3.0.0-inplace" 'False) (C1 ('MetaCons "CandidateProtocolUpdate" 'PrefixI 'True) (S1 ('MetaSel ('Just "cpuSlot") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SlotNumber) :*: (S1 ('MetaSel ('Just "cpuProtocolVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProtocolVersion) :*: S1 ('MetaSel ('Just "cpuProtocolParameters") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProtocolParameters))))

register ∷ MonadError Error m ⇒ Environment → State → Endorsement → m State Source #

Register an endorsement.

This corresponds to the UPEND rule.

data Error Source #

Constructors

MultipleProposalsForProtocolVersion ProtocolVersion

Multiple proposals were found, which propose an update to the same protocol version.

Instances

Instances details

FromCBOR Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Endorsement Methods fromCBOR ∷ Decoder s Error Source # label ∷ Proxy Error → Text Source #
ToCBOR Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Endorsement Methods toCBOR ∷ Error → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy Error → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Error] → Size Source #
DecCBOR Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Endorsement Methods decCBOR ∷ Decoder s Error Source # dropCBOR ∷ Proxy Error → Decoder s () Source # label ∷ Proxy Error → Text Source #
EncCBOR Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Endorsement Methods encCBOR ∷ Error → Encoding Source #
Show Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Endorsement Methods showsPrec ∷ Int → Error → ShowS # show ∷ Error → String # showList ∷ [Error] → ShowS #
Eq Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Endorsement Methods (==) ∷ Error → Error → Bool # (/=) ∷ Error → Error → Bool #