Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Peras.Voting.Adapter

Description

Conversion between concrete Peras types and abstract committee types

Synopsis

class PerasVoteCompatibleWithVotingCommittee vote crypto committee | vote → crypto where
- toPerasVote ∷ Vote crypto committee → Either PerasConversionError vote
- fromPerasVote ∷ vote → Either PerasConversionError (Vote crypto committee)
class PerasCertCompatibleWithVotingCommittee cert crypto committee | cert → crypto where
- toPerasCert ∷ Cert crypto committee → Either PerasConversionError cert
- fromPerasCert ∷ cert → Either PerasConversionError (Cert crypto committee)
data PerasConversionError
fromPerasSeatIndex ∷ PerasSeatIndex → SeatIndex
toPerasSeatIndex ∷ SeatIndex → Either PerasConversionError PerasSeatIndex

Documentation

class PerasVoteCompatibleWithVotingCommittee vote crypto committee | vote → crypto where Source #

Conversion between (concrete) Peras votes and (abstract) committee votes.

NOTE: the functional dependency vote -> crypto explicitly ties each concrete Peras vote type to a specific crypto scheme.

Methods

toPerasVote ∷ Vote crypto committee → Either PerasConversionError vote Source #

fromPerasVote ∷ vote → Either PerasConversionError (Vote crypto committee) Source #

Instances

Instances details

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 #
PerasVoteCompatibleWithVotingCommittee (VoidPerasVote blk) (VoidPerasCrypto blk) VoidPerasVotingCommitteeScheme Source #
Instance details Defined in Ouroboros.Consensus.Peras.Void Methods toPerasVote ∷ Vote (VoidPerasCrypto blk) VoidPerasVotingCommitteeScheme → Either PerasConversionError (VoidPerasVote blk) Source # fromPerasVote ∷ VoidPerasVote blk → Either PerasConversionError (Vote (VoidPerasCrypto blk) VoidPerasVotingCommitteeScheme) Source #
PerasVoteCompatibleWithVotingCommittee (MockPerasVote blk) (MockPerasCrypto blk) (MockPerasVotingCommitteeScheme blk) Source #
Instance details Defined in Ouroboros.Consensus.Peras.Crypto.Mock Methods toPerasVote ∷ Vote (MockPerasCrypto blk) (MockPerasVotingCommitteeScheme blk) → Either PerasConversionError (MockPerasVote blk) Source # fromPerasVote ∷ MockPerasVote blk → Either PerasConversionError (Vote (MockPerasCrypto blk) (MockPerasVotingCommitteeScheme blk)) Source #

class PerasCertCompatibleWithVotingCommittee cert crypto committee | cert → crypto where Source #

Conversion between (concrete) Peras certificates and (abstract) committee certificates.

NOTE: the functional dependency cert -> crypto explicitly ties each concrete Peras certificate type to a specific crypto scheme.

Methods

toPerasCert ∷ Cert crypto committee → Either PerasConversionError cert Source #

fromPerasCert ∷ cert → Either PerasConversionError (Cert crypto committee) Source #

Instances

Instances details

PerasCertCompatibleWithVotingCommittee (PerasCert blk) PerasBLSCrypto EveryoneVotes Source #
Instance details Defined in Ouroboros.Consensus.Peras.Cert.V1 Methods toPerasCert ∷ Cert PerasBLSCrypto EveryoneVotes → Either PerasConversionError (PerasCert blk) Source # fromPerasCert ∷ PerasCert blk → Either PerasConversionError (Cert PerasBLSCrypto EveryoneVotes) Source #
PerasCertCompatibleWithVotingCommittee (PerasCert blk) PerasBLSCrypto WFALS Source #
Instance details Defined in Ouroboros.Consensus.Peras.Cert.V1 Methods toPerasCert ∷ Cert PerasBLSCrypto WFALS → Either PerasConversionError (PerasCert blk) Source # fromPerasCert ∷ PerasCert blk → Either PerasConversionError (Cert PerasBLSCrypto WFALS) Source #
PerasCertCompatibleWithVotingCommittee (VoidPerasCert blk) (VoidPerasCrypto blk) VoidPerasVotingCommitteeScheme Source #
Instance details Defined in Ouroboros.Consensus.Peras.Void Methods toPerasCert ∷ Cert (VoidPerasCrypto blk) VoidPerasVotingCommitteeScheme → Either PerasConversionError (VoidPerasCert blk) Source # fromPerasCert ∷ VoidPerasCert blk → Either PerasConversionError (Cert (VoidPerasCrypto blk) VoidPerasVotingCommitteeScheme) Source #
PerasCertCompatibleWithVotingCommittee (MockPerasCert blk) (MockPerasCrypto blk) (MockPerasVotingCommitteeScheme blk) Source #
Instance details Defined in Ouroboros.Consensus.Peras.Crypto.Mock Methods toPerasCert ∷ Cert (MockPerasCrypto blk) (MockPerasVotingCommitteeScheme blk) → Either PerasConversionError (MockPerasCert blk) Source # fromPerasCert ∷ MockPerasCert blk → Either PerasConversionError (Cert (MockPerasCrypto blk) (MockPerasVotingCommitteeScheme blk)) Source #

data PerasConversionError Source #

Errors that can occur when converting between Peras and committee types

Constructors

EveryoneVotesButFoundNonPersistentVoterInVote SeatIndex
EveryoneVotesButFoundNonPersistentVotersInCert (NE [SeatIndex])
SeatIndexOverflowError Word64
CryptoError String

Instances

Instances details

Eq PerasConversionError Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Voting.Adapter

Methods

(==) ∷ PerasConversionError → PerasConversionError → Bool #

(/=) ∷ PerasConversionError → PerasConversionError → Bool #

Generic PerasConversionError Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Voting.Adapter

Associated Types

type Rep PerasConversionError

Instance details

Defined in Ouroboros.Consensus.Peras.Voting.Adapter

type Rep PerasConversionError = D1 ('MetaData "PerasConversionError" "Ouroboros.Consensus.Peras.Voting.Adapter" "ouroboros-consensus-4.0.0.0-inplace" 'False) ((C1 ('MetaCons "EveryoneVotesButFoundNonPersistentVoterInVote" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SeatIndex)) :+: C1 ('MetaCons "EveryoneVotesButFoundNonPersistentVotersInCert" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NE [SeatIndex])))) :+: (C1 ('MetaCons "SeatIndexOverflowError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)) :+: C1 ('MetaCons "CryptoError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

Methods

from ∷ PerasConversionError → Rep PerasConversionError x #

to ∷ Rep PerasConversionError x → PerasConversionError #

Show PerasConversionError Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Voting.Adapter

Methods

showsPrec ∷ Int → PerasConversionError → ShowS #

show ∷ PerasConversionError → String #

showList ∷ [PerasConversionError] → ShowS #

NoThunks PerasConversionError Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Voting.Adapter

Methods

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

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

showTypeOf ∷ Proxy PerasConversionError → String Source #

type Rep PerasConversionError Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Voting.Adapter

type Rep PerasConversionError = D1 ('MetaData "PerasConversionError" "Ouroboros.Consensus.Peras.Voting.Adapter" "ouroboros-consensus-4.0.0.0-inplace" 'False) ((C1 ('MetaCons "EveryoneVotesButFoundNonPersistentVoterInVote" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SeatIndex)) :+: C1 ('MetaCons "EveryoneVotesButFoundNonPersistentVotersInCert" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NE [SeatIndex])))) :+: (C1 ('MetaCons "SeatIndexOverflowError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Word64)) :+: C1 ('MetaCons "CryptoError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

fromPerasSeatIndex ∷ PerasSeatIndex → SeatIndex Source #

Convert a Peras seat index to a committee seat index.

toPerasSeatIndex ∷ SeatIndex → Either PerasConversionError PerasSeatIndex Source #

Convert a committee seat index to a Peras seat index

NOTE: this can fail if the seat index in the committee vote or certificate overflows the smaller Word16 type used by Peras votes and certificates. In practice, this should never happen unless there is a bug in the voting committee logic.