Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Committee.EveryoneVotes

Contents

Voting committee interface
Metrics about the voting committee composition

Description

A simple voting committee where pools with positive stake can vote.

Synopsis

data EveryoneVotes
data family VotingCommittee crypto committee
data family VotingCommitteeInput crypto committee
data family VotingCommitteeError crypto committee
data family EligibilityWitness crypto committee
data family Vote crypto committee
data family Cert crypto committee
candidateSeats ∷ VotingCommittee crypto EveryoneVotes → Map PoolId SeatIndex
numActiveVoters ∷ VotingCommittee crypto EveryoneVotes → NumPoolsWithPositiveStake

Voting committee interface

data EveryoneVotes Source #

Tag for a simple voting committee where pools with positive stake can vote.

Instances

Instances details

CryptoSupportsAggregateVoteSigning crypto ⇒ CryptoSupportsVotingCommittee crypto EveryoneVotes Source #

Instance details

Defined in Ouroboros.Consensus.Committee.EveryoneVotes

Associated Types

data VotingCommittee crypto EveryoneVotes
Instance details Defined in Ouroboros.Consensus.Committee.EveryoneVotes data VotingCommittee crypto EveryoneVotes = EveryoneVotesVotingCommittee { extWFAStakeDistr ∷ !(ExtWFAStakeDistr (PublicKey crypto)) candidateSeats ∷ !(Map PoolId SeatIndex) numActiveVoters ∷ !NumPoolsWithPositiveStake }
data VotingCommitteeInput crypto EveryoneVotes
Instance details Defined in Ouroboros.Consensus.Committee.EveryoneVotes data VotingCommitteeInput crypto EveryoneVotes = EveryoneVotesVotingCommitteeInput !(ExtWFAStakeDistr (PublicKey crypto))
data VotingCommitteeError crypto EveryoneVotes
Instance details Defined in Ouroboros.Consensus.Committee.EveryoneVotes data VotingCommitteeError crypto EveryoneVotes = WFAError WFAError \| MissingPoolId PoolId \| MissingSeatIndex SeatIndex \| PoolHasNoStake SeatIndex \| InvalidVoteSignature String \| InvalidCertSignature String \| CryptoError String
data EligibilityWitness crypto EveryoneVotes
Instance details Defined in Ouroboros.Consensus.Committee.EveryoneVotes data EligibilityWitness crypto EveryoneVotes = EveryoneVotesMember !SeatIndex !(NonZero LedgerStake)
data Vote crypto EveryoneVotes
Instance details Defined in Ouroboros.Consensus.Committee.EveryoneVotes data Vote crypto EveryoneVotes = EveryoneVotesVote !SeatIndex !(ElectionId crypto) !(VoteCandidate crypto) !(VoteSignature crypto)
data Cert crypto EveryoneVotes
Instance details Defined in Ouroboros.Consensus.Committee.EveryoneVotes data Cert crypto EveryoneVotes = EveryoneVotesCert !(ElectionId crypto) !(VoteCandidate crypto) !(NE (Set SeatIndex)) !(AggregateVoteSignature crypto)

Methods

mkVotingCommittee ∷ VotingCommitteeInput crypto EveryoneVotes → Either (VotingCommitteeError crypto EveryoneVotes) (VotingCommittee crypto EveryoneVotes) Source #

checkShouldVote ∷ VotingCommittee crypto EveryoneVotes → PoolId → PrivateKey crypto → ElectionId crypto → Either (VotingCommitteeError crypto EveryoneVotes) (Maybe (EligibilityWitness crypto EveryoneVotes)) Source #

forgeVote ∷ EligibilityWitness crypto EveryoneVotes → PrivateKey crypto → ElectionId crypto → VoteCandidate crypto → Vote crypto EveryoneVotes Source #

verifyVote ∷ VotingCommittee crypto EveryoneVotes → Vote crypto EveryoneVotes → Either (VotingCommitteeError crypto EveryoneVotes) (EligibilityWitness crypto EveryoneVotes) Source #

eligiblePartyVoteWeight ∷ VotingCommittee crypto EveryoneVotes → EligibilityWitness crypto EveryoneVotes → VoteWeight Source #

forgeCert ∷ UniqueVotesWithSameTarget crypto EveryoneVotes → Either (VotingCommitteeError crypto EveryoneVotes) (Cert crypto EveryoneVotes) Source #

verifyCert ∷ VotingCommittee crypto EveryoneVotes → Cert crypto EveryoneVotes → Either (VotingCommitteeError crypto EveryoneVotes) (NE [EligibilityWitness crypto EveryoneVotes]) Source #

Show (VotingCommitteeError crypto EveryoneVotes) Source #

Instance details

Defined in Ouroboros.Consensus.Committee.EveryoneVotes

Methods

showsPrec ∷ Int → VotingCommitteeError crypto EveryoneVotes → ShowS #

show ∷ VotingCommitteeError crypto EveryoneVotes → String #

showList ∷ [VotingCommitteeError crypto EveryoneVotes] → ShowS #

Eq (VotingCommitteeError crypto EveryoneVotes) Source #

Instance details

Defined in Ouroboros.Consensus.Committee.EveryoneVotes

Methods

(==) ∷ VotingCommitteeError crypto EveryoneVotes → VotingCommitteeError crypto EveryoneVotes → Bool #

(/=) ∷ VotingCommitteeError crypto EveryoneVotes → VotingCommitteeError crypto EveryoneVotes → Bool #

data Cert crypto EveryoneVotes Source #

Instance details

Defined in Ouroboros.Consensus.Committee.EveryoneVotes

data Cert crypto EveryoneVotes = EveryoneVotesCert !(ElectionId crypto) !(VoteCandidate crypto) !(NE (Set SeatIndex)) !(AggregateVoteSignature crypto)

data EligibilityWitness crypto EveryoneVotes Source #

Instance details

Defined in Ouroboros.Consensus.Committee.EveryoneVotes

data EligibilityWitness crypto EveryoneVotes = EveryoneVotesMember !SeatIndex !(NonZero LedgerStake)

data Vote crypto EveryoneVotes Source #

Instance details

Defined in Ouroboros.Consensus.Committee.EveryoneVotes

data Vote crypto EveryoneVotes = EveryoneVotesVote !SeatIndex !(ElectionId crypto) !(VoteCandidate crypto) !(VoteSignature crypto)

data VotingCommittee crypto EveryoneVotes Source #

Instance details

Defined in Ouroboros.Consensus.Committee.EveryoneVotes

data VotingCommittee crypto EveryoneVotes = EveryoneVotesVotingCommittee {

extWFAStakeDistr ∷ !(ExtWFAStakeDistr (PublicKey crypto))
candidateSeats ∷ !(Map PoolId SeatIndex)
numActiveVoters ∷ !NumPoolsWithPositiveStake

}

data VotingCommitteeError crypto EveryoneVotes Source #

Instance details

Defined in Ouroboros.Consensus.Committee.EveryoneVotes

data VotingCommitteeError crypto EveryoneVotes

= WFAError WFAError
| MissingPoolId PoolId
| MissingSeatIndex SeatIndex
| PoolHasNoStake SeatIndex
| InvalidVoteSignature String
| InvalidCertSignature String
| CryptoError String

data VotingCommitteeInput crypto EveryoneVotes Source #

Instance details

Defined in Ouroboros.Consensus.Committee.EveryoneVotes

data VotingCommitteeInput crypto EveryoneVotes = EveryoneVotesVotingCommitteeInput !(ExtWFAStakeDistr (PublicKey crypto))

data family VotingCommittee crypto committee Source #

Structure storing the voting committee context

Instances

Instances details

data VotingCommittee crypto EveryoneVotes Source #
Instance details Defined in Ouroboros.Consensus.Committee.EveryoneVotes data VotingCommittee crypto EveryoneVotes = EveryoneVotesVotingCommittee { extWFAStakeDistr ∷ !(ExtWFAStakeDistr (PublicKey crypto)) candidateSeats ∷ !(Map PoolId SeatIndex) numActiveVoters ∷ !NumPoolsWithPositiveStake }
data VotingCommittee crypto WFALS Source #
Instance details Defined in Ouroboros.Consensus.Committee.WFALS data VotingCommittee crypto WFALS = WFALSVotingCommittee { extWFAStakeDistr ∷ !(ExtWFAStakeDistr (PublicKey crypto)) candidateSeats ∷ !(Map PoolId SeatIndex) persistentCommitteeSize ∷ !PersistentCommitteeSize nonPersistentCommitteeSize ∷ !NonPersistentCommitteeSize totalPersistentStake ∷ !TotalPersistentStake totalNonPersistentStake ∷ !TotalNonPersistentStake epochNonce ∷ !Nonce }

data family VotingCommitteeInput crypto committee Source #

Input information needed to construct a voting committee

Instances

Instances details

data VotingCommitteeInput crypto EveryoneVotes Source #
Instance details Defined in Ouroboros.Consensus.Committee.EveryoneVotes data VotingCommitteeInput crypto EveryoneVotes = EveryoneVotesVotingCommitteeInput !(ExtWFAStakeDistr (PublicKey crypto))
data VotingCommitteeInput crypto WFALS Source #
Instance details Defined in Ouroboros.Consensus.Committee.WFALS data VotingCommitteeInput crypto WFALS = WFALSVotingCommitteeInput !Nonce !TargetCommitteeSize !(ExtWFAStakeDistr (PublicKey crypto))

data family VotingCommitteeError crypto committee Source #

Errors that can occur when operating on a voting committee

Instances

Instances details

Show (VotingCommitteeError crypto EveryoneVotes) Source #
Instance details Defined in Ouroboros.Consensus.Committee.EveryoneVotes Methods showsPrec ∷ Int → VotingCommitteeError crypto EveryoneVotes → ShowS # show ∷ VotingCommitteeError crypto EveryoneVotes → String # showList ∷ [VotingCommitteeError crypto EveryoneVotes] → ShowS #
Show (VotingCommitteeError crypto WFALS) Source #
Instance details Defined in Ouroboros.Consensus.Committee.WFALS Methods showsPrec ∷ Int → VotingCommitteeError crypto WFALS → ShowS # show ∷ VotingCommitteeError crypto WFALS → String # showList ∷ [VotingCommitteeError crypto WFALS] → ShowS #
Eq (VotingCommitteeError crypto EveryoneVotes) Source #
Instance details Defined in Ouroboros.Consensus.Committee.EveryoneVotes Methods (==) ∷ VotingCommitteeError crypto EveryoneVotes → VotingCommitteeError crypto EveryoneVotes → Bool # (/=) ∷ VotingCommitteeError crypto EveryoneVotes → VotingCommitteeError crypto EveryoneVotes → Bool #
Eq (VotingCommitteeError crypto WFALS) Source #
Instance details Defined in Ouroboros.Consensus.Committee.WFALS Methods (==) ∷ VotingCommitteeError crypto WFALS → VotingCommitteeError crypto WFALS → Bool # (/=) ∷ VotingCommitteeError crypto WFALS → VotingCommitteeError crypto WFALS → Bool #
data VotingCommitteeError crypto EveryoneVotes Source #
Instance details Defined in Ouroboros.Consensus.Committee.EveryoneVotes data VotingCommitteeError crypto EveryoneVotes = WFAError WFAError \| MissingPoolId PoolId \| MissingSeatIndex SeatIndex \| PoolHasNoStake SeatIndex \| InvalidVoteSignature String \| InvalidCertSignature String \| CryptoError String
data VotingCommitteeError crypto WFALS Source #
Instance details Defined in Ouroboros.Consensus.Committee.WFALS data VotingCommitteeError crypto WFALS = WFAError WFAError \| MissingPoolId PoolId \| NotAPersistentMember SeatIndex \| NotANonPersistentMember SeatIndex \| ZeroNonPersistentSeats SeatIndex \| InvalidVoteSignature String \| InvalidVoterEligibilityProof String \| InvalidCertSignature String \| CryptoError String

data family EligibilityWitness crypto committee Source #

Witness attesting that a party is eligible to vote in a given election

NOTE: this is not necessarily the same as the cryptographic proof of eligibility used in concrete votes and certificates sent over the wire.

Instances

Instances details

data EligibilityWitness crypto EveryoneVotes Source #
Instance details Defined in Ouroboros.Consensus.Committee.EveryoneVotes data EligibilityWitness crypto EveryoneVotes = EveryoneVotesMember !SeatIndex !(NonZero LedgerStake)
data EligibilityWitness crypto WFALS Source #
Instance details Defined in Ouroboros.Consensus.Committee.WFALS data EligibilityWitness crypto WFALS = WFALSPersistentMember !SeatIndex !LedgerStake \| WFALSNonPersistentMember !SeatIndex !LedgerStake !(VRFOutput crypto) !(NonZero LocalSortitionNumSeats)

data family Vote crypto committee Source #

Abstract vote cast by a committee member in a given election

Instances

Instances details

data Vote crypto EveryoneVotes Source #
Instance details Defined in Ouroboros.Consensus.Committee.EveryoneVotes data Vote crypto EveryoneVotes = EveryoneVotesVote !SeatIndex !(ElectionId crypto) !(VoteCandidate crypto) !(VoteSignature crypto)
data Vote crypto WFALS Source #
Instance details Defined in Ouroboros.Consensus.Committee.WFALS data Vote crypto WFALS = WFALSPersistentVote !SeatIndex !(ElectionId crypto) !(VoteCandidate crypto) !(VoteSignature crypto) \| WFALSNonPersistentVote !SeatIndex !(ElectionId crypto) !(VoteCandidate crypto) !(VRFOutput crypto) !(VoteSignature crypto)

data family Cert crypto committee Source #

Abstract certificate attesting the winner of a given election

Instances

Instances details

data Cert crypto EveryoneVotes Source #
Instance details Defined in Ouroboros.Consensus.Committee.EveryoneVotes data Cert crypto EveryoneVotes = EveryoneVotesCert !(ElectionId crypto) !(VoteCandidate crypto) !(NE (Set SeatIndex)) !(AggregateVoteSignature crypto)
data Cert crypto WFALS Source #
Instance details Defined in Ouroboros.Consensus.Committee.WFALS data Cert crypto WFALS = WFALSCert !(ElectionId crypto) !(VoteCandidate crypto) !(NE (Map SeatIndex (Maybe (VRFOutput crypto)))) !(AggregateVoteSignature crypto)

Metrics about the voting committee composition

candidateSeats ∷ VotingCommittee crypto EveryoneVotes → Map PoolId SeatIndex Source #

numActiveVoters ∷ VotingCommittee crypto EveryoneVotes → NumPoolsWithPositiveStake Source #