Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Chain.Update.Validation.Interface

Contents

Environment
State
Signal
Error
Interface functions

Description

Blockchain interface validation rules.

Synopsis

data Environment = Environment {
- protocolMagic ∷ !(Annotated ProtocolMagicId ByteString)
- k ∷ !BlockCount
- currentSlot ∷ !SlotNumber
- numGenKeys ∷ !Word8
- delegationMap ∷ !Map
}
data State = State {
- currentEpoch ∷ !EpochNumber
- adoptedProtocolVersion ∷ !ProtocolVersion
- adoptedProtocolParameters ∷ !ProtocolParameters
- candidateProtocolUpdates ∷ ![CandidateProtocolUpdate]
- appVersions ∷ !ApplicationVersions
- registeredProtocolUpdateProposals ∷ !ProtocolUpdateProposals
- registeredSoftwareUpdateProposals ∷ !SoftwareUpdateProposals
- confirmedProposals ∷ !(Map UpId SlotNumber)
- proposalVotes ∷ !(Map UpId (Set KeyHash))
- registeredEndorsements ∷ !(Set Endorsement)
- proposalRegistrationSlot ∷ !(Map UpId SlotNumber)
}
initialState ∷ Config → State
data Signal = Signal {
- proposal ∷ !(Maybe (AProposal ByteString))
- votes ∷ ![AVote ByteString]
- endorsement ∷ !Endorsement
}
data Error
- = Registration Error
- | Voting Error
- | Endorsement Error
- | NumberOfGenesisKeysTooLarge (TooLarge Int)
registerUpdate ∷ MonadError Error m ⇒ Environment → State → Signal → m State
registerProposal ∷ MonadError Error m ⇒ Environment → State → AProposal ByteString → m State
registerVote ∷ MonadError Error m ⇒ Environment → State → AVote ByteString → m State
registerEndorsement ∷ MonadError Error m ⇒ Environment → State → Endorsement → m State
registerEpoch ∷ Environment → State → EpochNumber → State

Environment

data Environment Source #

Constructors

Environment

Fields

protocolMagic ∷ !(Annotated ProtocolMagicId ByteString)
k ∷ !BlockCount
TODO: this is the chain security parameter, a.k.a. stableAfter, it is not part of our protocol parameters, so it seems that we need to pass it in the environment. However we need to double-check this with others.
currentSlot ∷ !SlotNumber
numGenKeys ∷ !Word8
Number of genesis keys. This is used to calculate the proportion of genesis keys that need to endorse a new protocol version for it to be considered for adoption. See Cardano.Chain.Update.Validation.Endorsement.Environment.
delegationMap ∷ !Map

State

data State Source #

Update interface state.

Constructors

State

Fields

currentEpoch ∷ !EpochNumber
Current epoch
adoptedProtocolVersion ∷ !ProtocolVersion
adoptedProtocolParameters ∷ !ProtocolParameters
Adopted protocol parameters
candidateProtocolUpdates ∷ ![CandidateProtocolUpdate]
Candidate protocol versions
appVersions ∷ !ApplicationVersions
Current application versions
registeredProtocolUpdateProposals ∷ !ProtocolUpdateProposals
Registered protocol update proposals
registeredSoftwareUpdateProposals ∷ !SoftwareUpdateProposals
Registered software update proposals
confirmedProposals ∷ !(Map UpId SlotNumber)
Confirmed update proposals
proposalVotes ∷ !(Map UpId (Set KeyHash))
Update proposals votes
registeredEndorsements ∷ !(Set Endorsement)
Update proposals endorsements
proposalRegistrationSlot ∷ !(Map UpId SlotNumber)
Slot at which an update proposal was registered

Instances

Instances details

Generic State Source #
Instance details Defined in Cardano.Chain.Update.Validation.Interface Associated Types type Rep State ∷ Type → Type # Methods from ∷ State → Rep State x # to ∷ Rep State x → State #
Show State Source #
Instance details Defined in Cardano.Chain.Update.Validation.Interface Methods showsPrec ∷ Int → State → ShowS # show ∷ State → String # showList ∷ [State] → ShowS #
FromCBOR State Source #
Instance details Defined in Cardano.Chain.Update.Validation.Interface Methods fromCBOR ∷ Decoder s State Source # label ∷ Proxy State → Text Source #
ToCBOR State Source #
Instance details Defined in Cardano.Chain.Update.Validation.Interface Methods toCBOR ∷ State → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy State → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [State] → Size Source #
DecCBOR State Source #
Instance details Defined in Cardano.Chain.Update.Validation.Interface Methods decCBOR ∷ Decoder s State Source # dropCBOR ∷ Proxy State → Decoder s () Source # label ∷ Proxy State → Text Source #
EncCBOR State Source #
Instance details Defined in Cardano.Chain.Update.Validation.Interface Methods encCBOR ∷ State → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy State → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [State] → Size Source #
NFData State Source #
Instance details Defined in Cardano.Chain.Update.Validation.Interface Methods rnf ∷ State → () #
Eq State Source #
Instance details Defined in Cardano.Chain.Update.Validation.Interface Methods (==) ∷ State → State → Bool # (/=) ∷ State → State → Bool #
NoThunks State Source #
Instance details Defined in Cardano.Chain.Update.Validation.Interface Methods noThunks ∷ Context → State → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → State → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy State → String Source #
type Rep State Source #
Instance details Defined in Cardano.Chain.Update.Validation.Interface type Rep State = D1 ('MetaData "State" "Cardano.Chain.Update.Validation.Interface" "cardano-ledger-byron-1.2.0.0-inplace" 'False) (C1 ('MetaCons "State" 'PrefixI 'True) (((S1 ('MetaSel ('Just "currentEpoch") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 EpochNumber) :: S1 ('MetaSel ('Just "adoptedProtocolVersion") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProtocolVersion)) :: (S1 ('MetaSel ('Just "adoptedProtocolParameters") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProtocolParameters) :: (S1 ('MetaSel ('Just "candidateProtocolUpdates") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [CandidateProtocolUpdate]) :: S1 ('MetaSel ('Just "appVersions") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ApplicationVersions)))) :: ((S1 ('MetaSel ('Just "registeredProtocolUpdateProposals") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ProtocolUpdateProposals) :: (S1 ('MetaSel ('Just "registeredSoftwareUpdateProposals") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SoftwareUpdateProposals) :: S1 ('MetaSel ('Just "confirmedProposals") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map UpId SlotNumber)))) :: (S1 ('MetaSel ('Just "proposalVotes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map UpId (Set KeyHash))) :: (S1 ('MetaSel ('Just "registeredEndorsements") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Set Endorsement)) :: S1 ('MetaSel ('Just "proposalRegistrationSlot") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map UpId SlotNumber)))))))

initialState ∷ Config → State Source #

Initial update interface state

Signal

data Signal Source #

Signal combining signals from various rules

Constructors

Signal
Fields proposal ∷ !(Maybe (AProposal ByteString)) votes ∷ ![AVote ByteString] endorsement ∷ !Endorsement

Error

data Error Source #

Constructors

Registration Error
Voting Error
Endorsement Error
NumberOfGenesisKeysTooLarge (TooLarge Int)

Instances

Instances details

Show Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Interface Methods showsPrec ∷ Int → Error → ShowS # show ∷ Error → String # showList ∷ [Error] → ShowS #
FromCBOR Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Interface Methods fromCBOR ∷ Decoder s Error Source # label ∷ Proxy Error → Text Source #
ToCBOR Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Interface 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.Interface 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.Interface Methods encCBOR ∷ Error → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy Error → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Error] → Size Source #
Eq Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Interface Methods (==) ∷ Error → Error → Bool # (/=) ∷ Error → Error → Bool #

Interface functions

registerUpdate ∷ MonadError Error m ⇒ Environment → State → Signal → m State Source #

Group together the other registration rules in a single rule

This corresponds to the BUPI rule in the Byron chain specification.

registerProposal ∷ MonadError Error m ⇒ Environment → State → AProposal ByteString → m State Source #

Register an update proposal.

This corresponds to the UPIREG rule in the Byron ledger specification.

registerVote ∷ MonadError Error m ⇒ Environment → State → AVote ByteString → m State Source #

Register a vote for the given proposal.

This corresponds to the UPIVOTE rule in the Byron ledger

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

Register an endorsement.

An endorsement represents the fact that a genesis key is ready to start using the protocol version being endorsed. In the decentralized era only genesis key holders can endorse protocol versions.

This corresponds to the UPIEND rule in the Byron ledger specification.

registerEpoch Source #

Arguments

∷ Environment
→ State
→ EpochNumber	Epoch seen on the block.
→ State

Register an epoch. Whenever an epoch number is seen on a block this epoch number should be passed to this function so that on epoch change the protocol parameters can be updated, provided that there is an update candidate that was accepted and endorsed by a majority of the genesis keys.

This corresponds to the UPIEC rules in the Byron ledger specification.