Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Chain.Update.Validation.Voting

Description

Validation rules for registering votes and confirming proposals

This is an implementation of the rules defined in the Byron ledger specification

Synopsis

data Environment = Environment {
}
data RegistrationEnvironment = RegistrationEnvironment {
- vreRegisteredUpdateProposal ∷ !(Set UpId)
- vreDelegationMap ∷ !Map
}
data State = State {
- vsVotes ∷ !RegisteredVotes
- vsConfirmedProposals ∷ !(Map UpId SlotNumber)
}
data Error
registerVoteWithConfirmation ∷ MonadError Error m ⇒ Annotated ProtocolMagicId ByteString → Environment → State → AVote ByteString → m State

Documentation

data Environment Source #

Environment used to register votes and confirm proposals

Constructors

Environment
Fields veCurrentSlot ∷ SlotNumber veConfirmationThreshold ∷ Int veVotingRegistrationEnvironment ∷ RegistrationEnvironment

Instances

Instances details

Generic Environment Source #
Instance details Defined in Cardano.Chain.Update.Validation.Voting Associated Types type Rep Environment ∷ Type → Type Source # Methods from ∷ Environment → Rep Environment x Source # to ∷ Rep Environment x → Environment Source #
Show Environment Source #
Instance details Defined in Cardano.Chain.Update.Validation.Voting Methods showsPrec ∷ Int → Environment → ShowS Source # show ∷ Environment → String Source # showList ∷ [Environment] → ShowS Source #
NFData Environment Source #
Instance details Defined in Cardano.Chain.Update.Validation.Voting Methods rnf ∷ Environment → () Source #
Eq Environment Source #
Instance details Defined in Cardano.Chain.Update.Validation.Voting Methods (==) ∷ Environment → Environment → Bool Source # (/=) ∷ Environment → Environment → Bool Source #
type Rep Environment Source #
Instance details Defined in Cardano.Chain.Update.Validation.Voting type Rep Environment = D1 ('MetaData "Environment" "Cardano.Chain.Update.Validation.Voting" "cardano-ledger-byron-1.0.2.0-inplace" 'False) (C1 ('MetaCons "Environment" 'PrefixI 'True) (S1 ('MetaSel ('Just "veCurrentSlot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SlotNumber) :: (S1 ('MetaSel ('Just "veConfirmationThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: S1 ('MetaSel ('Just "veVotingRegistrationEnvironment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 RegistrationEnvironment))))

data RegistrationEnvironment Source #

Environment required to validate and register a vote

Constructors

RegistrationEnvironment
Fields vreRegisteredUpdateProposal ∷ !(Set UpId) vreDelegationMap ∷ !Map

Instances

Instances details

Generic RegistrationEnvironment Source #
Instance details Defined in Cardano.Chain.Update.Validation.Voting Associated Types type Rep RegistrationEnvironment ∷ Type → Type Source # Methods from ∷ RegistrationEnvironment → Rep RegistrationEnvironment x Source # to ∷ Rep RegistrationEnvironment x → RegistrationEnvironment Source #
Show RegistrationEnvironment Source #
Instance details Defined in Cardano.Chain.Update.Validation.Voting Methods showsPrec ∷ Int → RegistrationEnvironment → ShowS Source # show ∷ RegistrationEnvironment → String Source # showList ∷ [RegistrationEnvironment] → ShowS Source #
NFData RegistrationEnvironment Source #
Instance details Defined in Cardano.Chain.Update.Validation.Voting Methods rnf ∷ RegistrationEnvironment → () Source #
Eq RegistrationEnvironment Source #
Instance details Defined in Cardano.Chain.Update.Validation.Voting Methods (==) ∷ RegistrationEnvironment → RegistrationEnvironment → Bool Source # (/=) ∷ RegistrationEnvironment → RegistrationEnvironment → Bool Source #
type Rep RegistrationEnvironment Source #
Instance details Defined in Cardano.Chain.Update.Validation.Voting type Rep RegistrationEnvironment = D1 ('MetaData "RegistrationEnvironment" "Cardano.Chain.Update.Validation.Voting" "cardano-ledger-byron-1.0.2.0-inplace" 'False) (C1 ('MetaCons "RegistrationEnvironment" 'PrefixI 'True) (S1 ('MetaSel ('Just "vreRegisteredUpdateProposal") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Set UpId)) :*: S1 ('MetaSel ('Just "vreDelegationMap") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Map)))

data State Source #

State keeps track of registered votes and confirmed proposals

Constructors

State
Fields vsVotes ∷ !RegisteredVotes vsConfirmedProposals ∷ !(Map UpId SlotNumber)

data Error Source #

Error captures the ways in which vote registration could fail

Constructors

VotingInvalidSignature
VotingProposalNotRegistered UpId
VotingVoterNotDelegate KeyHash
VotingVoteAlreadyCast KeyHash

Instances

Instances details

Show Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Voting Methods showsPrec ∷ Int → Error → ShowS Source # show ∷ Error → String Source # showList ∷ [Error] → ShowS Source #
FromCBOR Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Voting Methods fromCBOR ∷ Decoder s Error Source # label ∷ Proxy Error → Text Source #
ToCBOR Error Source #
Instance details Defined in Cardano.Chain.Update.Validation.Voting 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.Voting 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.Voting 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.Voting Methods (==) ∷ Error → Error → Bool Source # (/=) ∷ Error → Error → Bool Source #

registerVoteWithConfirmation ∷ MonadError Error m ⇒ Annotated ProtocolMagicId ByteString → Environment → State → AVote ByteString → m State Source #

Register a vote and confirm the corresponding proposal if it passes the voting threshold. This corresponds to the UPVOTE rules in the spec.