Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Peras.Vote.V1

Description

Concrete Peras vote types using BLS signatures.

NOTE: this module is meant to be imported qualified.

Synopsis

data PerasVote blk = PerasVote {
- pvRoundNo ∷ !PerasRoundNo
- pvBoostedBlock ∷ !PerasBoostedBlock
- pvSeatIndex ∷ !PerasSeatIndex
- pvEligibilityProof ∷ !PerasVoteEligibilityProof
- pvSignature ∷ !(VoteSignature PerasBLSCrypto)
}
castPerasVote ∷ ∀ blk' blk. PerasVote blk → PerasVote blk'
data PerasVoteEligibilityProof
- = PersistentPerasVoteEligibilityProof
- | NonPersistentPerasVoteEligibilityProof !(VRFOutput PerasBLSCrypto)

Documentation

data PerasVote blk Source #

Concrete Peras votes using BLS signatures

NOTE: the blk parameter is a phantom type used to track the block type that the vote is associated with, to ensure injectivity when PerasVote is used as a type instance for BlockSupportsPeras class.

Constructors

PerasVote

Fields

pvRoundNo ∷ !PerasRoundNo
Election identifier
pvBoostedBlock ∷ !PerasBoostedBlock
Vote message, i.e., the hash of the block being voted for
pvSeatIndex ∷ !PerasSeatIndex
Seat index assigned to the committee member (identifies the voter)
pvEligibilityProof ∷ !PerasVoteEligibilityProof
Proof of eligibility for voting, depending on the type of membership to the committee (persistent vs non-persistent)
pvSignature ∷ !(VoteSignature PerasBLSCrypto)
BLS signature on the hash of the election identifier and vote message

Instances

Instances details

ShowProxy blk ⇒ ShowProxy (PerasVote blk ∷ Type) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Vote.V1

Methods

showProxy ∷ Proxy (PerasVote blk) → String #

Typeable blk ⇒ FromCBOR (PerasVote blk) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Vote.V1

Methods

fromCBOR ∷ Decoder s (PerasVote blk) Source #

label ∷ Proxy (PerasVote blk) → Text Source #

Typeable blk ⇒ ToCBOR (PerasVote blk) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Vote.V1

Methods

toCBOR ∷ PerasVote blk → Encoding Source #

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

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

Eq (PerasVote blk) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Vote.V1

Methods

(==) ∷ PerasVote blk → PerasVote blk → Bool #

(/=) ∷ PerasVote blk → PerasVote blk → Bool #

Generic (PerasVote blk) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Vote.V1

Associated Types

type Rep (PerasVote blk)

Instance details

Defined in Ouroboros.Consensus.Peras.Vote.V1

type Rep (PerasVote blk) = D1 ('MetaData "PerasVote" "Ouroboros.Consensus.Peras.Vote.V1" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "PerasVote" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pvRoundNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PerasRoundNo) :*: S1 ('MetaSel ('Just "pvBoostedBlock") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PerasBoostedBlock)) :*: (S1 ('MetaSel ('Just "pvSeatIndex") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PerasSeatIndex) :*: (S1 ('MetaSel ('Just "pvEligibilityProof") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PerasVoteEligibilityProof) :*: S1 ('MetaSel ('Just "pvSignature") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (VoteSignature PerasBLSCrypto))))))

Methods

from ∷ PerasVote blk → Rep (PerasVote blk) x #

to ∷ Rep (PerasVote blk) x → PerasVote blk #

Show (PerasVote blk) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Vote.V1

Methods

showsPrec ∷ Int → PerasVote blk → ShowS #

show ∷ PerasVote blk → String #

showList ∷ [PerasVote blk] → ShowS #

NoThunks (PerasVote blk) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Vote.V1

Methods

noThunks ∷ Context → PerasVote blk → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → PerasVote blk → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (PerasVote blk) → String Source #

(ConvertRawHash blk, HashSize blk ~ 32) ⇒ IsPerasVote (PerasVote blk) blk Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Vote.V1

Methods

getPerasVoteRound ∷ PerasVote blk → PerasRoundNo Source #

getPerasVoteBlock ∷ PerasVote blk → BoostedBlock (PerasVote blk) Source #

getPerasVoteSeatIndex ∷ PerasVote blk → PerasSeatIndex Source #

getPerasVotePoint ∷ PerasVote blk → Point blk Source #

PerasVoteCompatibleWithVotingCommittee (PerasVote blk) PerasBLSCrypto EveryoneVotes Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Vote.V1

Methods

toPerasVote ∷ Vote PerasBLSCrypto EveryoneVotes → Either PerasConversionError (PerasVote blk) Source #

fromPerasVote ∷ PerasVote blk → Either PerasConversionError (Vote PerasBLSCrypto EveryoneVotes) Source #

PerasVoteCompatibleWithVotingCommittee (PerasVote blk) PerasBLSCrypto WFALS Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Vote.V1

Methods

toPerasVote ∷ Vote PerasBLSCrypto WFALS → Either PerasConversionError (PerasVote blk) Source #

fromPerasVote ∷ PerasVote blk → Either PerasConversionError (Vote PerasBLSCrypto WFALS) Source #

type Rep (PerasVote blk) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Vote.V1

type Rep (PerasVote blk) = D1 ('MetaData "PerasVote" "Ouroboros.Consensus.Peras.Vote.V1" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "PerasVote" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pvRoundNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PerasRoundNo) :*: S1 ('MetaSel ('Just "pvBoostedBlock") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PerasBoostedBlock)) :*: (S1 ('MetaSel ('Just "pvSeatIndex") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PerasSeatIndex) :*: (S1 ('MetaSel ('Just "pvEligibilityProof") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PerasVoteEligibilityProof) :*: S1 ('MetaSel ('Just "pvSignature") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (VoteSignature PerasBLSCrypto))))))

type BoostedBlock (PerasVote blk) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Vote.V1

type BoostedBlock (PerasVote blk) = PerasBoostedBlock

castPerasVote ∷ ∀ blk' blk. PerasVote blk → PerasVote blk' Source #

Retag a PerasVote with a new phantom blk type.

data PerasVoteEligibilityProof Source #

Proof of eligibility for voting for committee members

Constructors

PersistentPerasVoteEligibilityProof	Persistent committee members require no additional proof of eligibility
NonPersistentPerasVoteEligibilityProof !(VRFOutput PerasBLSCrypto)	Non-persistent committee members provide a VRF proof of eligibility