type PerasVote blk
Instance details Defined in Ouroboros.Consensus.Block.SupportsPeras type PerasVote blk = PerasVote' blk
type PerasCert blk
Instance details Defined in Ouroboros.Consensus.Block.SupportsPeras type PerasCert blk = PerasCert' blk
type PerasError blk
Instance details Defined in Ouroboros.Consensus.Block.SupportsPeras type PerasError blk = VoidPerasError blk
type PerasCrypto blk
Instance details Defined in Ouroboros.Consensus.Block.SupportsPeras type PerasCrypto blk = VoidPerasCrypto blk
type PerasVotingCommitteeScheme blk
Instance details Defined in Ouroboros.Consensus.Block.SupportsPeras type PerasVotingCommitteeScheme blk = VoidPerasVotingCommitteeScheme

Methods

validatePerasCert ∷ PerasParams blk → PerasCert blk → Either (PerasError blk) (ValidatedPerasCert blk) Source #

validatePerasVote ∷ PerasParams blk → PerasVoteStakeDistr → PerasVote blk → Either (PerasError blk) (ValidatedPerasVote blk) Source #

forgePerasCert ∷ PerasParams blk → PerasVoteCollectionWithQuorum blk → Either (PerasError blk) (ValidatedPerasCert blk) Source #

getPerasCertInBlock ∷ blk → Maybe (PerasCert blk) Source #

To be removed in favor of using per-blk definitions

data PerasCert' blk Source #

NOTE: to be removed in favor of using per-blk definitions.

Constructors

PerasCert
Fields pcCertRound ∷ PerasRoundNo pcCertBoostedBlock ∷ Point blk

Instances

Instances details

ConvertRawHash blk ⇒ SerialiseNodeToNode blk (PerasCert' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Node.Serialisation

Methods

encodeNodeToNode ∷ CodecConfig blk → BlockNodeToNodeVersion blk → PerasCert' blk → Encoding Source #

decodeNodeToNode ∷ CodecConfig blk → BlockNodeToNodeVersion blk → ∀ s. Decoder s (PerasCert' blk) Source #

ShowProxy blk ⇒ ShowProxy (PerasCert' blk ∷ Type) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

showProxy ∷ Proxy (PerasCert' blk) → String #

StandardHash blk ⇒ Eq (PerasCert' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

(==) ∷ PerasCert' blk → PerasCert' blk → Bool #

(/=) ∷ PerasCert' blk → PerasCert' blk → Bool #

StandardHash blk ⇒ Ord (PerasCert' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

compare ∷ PerasCert' blk → PerasCert' blk → Ordering #

(<) ∷ PerasCert' blk → PerasCert' blk → Bool #

(<=) ∷ PerasCert' blk → PerasCert' blk → Bool #

(>) ∷ PerasCert' blk → PerasCert' blk → Bool #

(>=) ∷ PerasCert' blk → PerasCert' blk → Bool #

max ∷ PerasCert' blk → PerasCert' blk → PerasCert' blk #

min ∷ PerasCert' blk → PerasCert' blk → PerasCert' blk #

Generic (PerasCert' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Associated Types

type Rep (PerasCert' blk)

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type Rep (PerasCert' blk) = D1 ('MetaData "PerasCert'" "Ouroboros.Consensus.Block.SupportsPeras" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "PerasCert" 'PrefixI 'True) (S1 ('MetaSel ('Just "pcCertRound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PerasRoundNo) :*: S1 ('MetaSel ('Just "pcCertBoostedBlock") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point blk))))

Methods

from ∷ PerasCert' blk → Rep (PerasCert' blk) x #

to ∷ Rep (PerasCert' blk) x → PerasCert' blk #

StandardHash blk ⇒ Show (PerasCert' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

showsPrec ∷ Int → PerasCert' blk → ShowS #

show ∷ PerasCert' blk → String #

showList ∷ [PerasCert' blk] → ShowS #

StandardHash blk ⇒ NoThunks (PerasCert' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

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

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

showTypeOf ∷ Proxy (PerasCert' blk) → String Source #

Serialise (HeaderHash blk) ⇒ Serialise (PerasCert' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

encode ∷ PerasCert' blk → Encoding Source #

decode ∷ Decoder s (PerasCert' blk) Source #

encodeList ∷ [PerasCert' blk] → Encoding Source #

decodeList ∷ Decoder s [PerasCert' blk] Source #

IsPerasCert (PerasCert' blk) blk Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

getPerasCertRound ∷ PerasCert' blk → PerasRoundNo Source #

getPerasCertBlock ∷ PerasCert' blk → BoostedBlock (PerasCert' blk) Source #

getPerasCertPoint ∷ PerasCert' blk → Point blk Source #

type Rep (PerasCert' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type Rep (PerasCert' blk) = D1 ('MetaData "PerasCert'" "Ouroboros.Consensus.Block.SupportsPeras" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "PerasCert" 'PrefixI 'True) (S1 ('MetaSel ('Just "pcCertRound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PerasRoundNo) :*: S1 ('MetaSel ('Just "pcCertBoostedBlock") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point blk))))

type BoostedBlock (PerasCert' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type BoostedBlock (PerasCert' blk) = Point blk

data PerasVote' blk Source #

NOTE: to be removed in favor of using per-blk definitions.

Constructors

PerasVote
Fields pvVoteRound ∷ PerasRoundNo pvVoteBlock ∷ Point blk pvVoteVoterId ∷ PerasSeatIndex

Instances

Instances details

ConvertRawHash blk ⇒ SerialiseNodeToNode blk (PerasVote' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Node.Serialisation

Methods

encodeNodeToNode ∷ CodecConfig blk → BlockNodeToNodeVersion blk → PerasVote' blk → Encoding Source #

decodeNodeToNode ∷ CodecConfig blk → BlockNodeToNodeVersion blk → ∀ s. Decoder s (PerasVote' blk) Source #

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

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

showProxy ∷ Proxy (PerasVote' blk) → String #

StandardHash blk ⇒ Eq (PerasVote' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

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

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

StandardHash blk ⇒ Ord (PerasVote' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

compare ∷ PerasVote' blk → PerasVote' blk → Ordering #

(<) ∷ PerasVote' blk → PerasVote' blk → Bool #

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

(>) ∷ PerasVote' blk → PerasVote' blk → Bool #

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

max ∷ PerasVote' blk → PerasVote' blk → PerasVote' blk #

min ∷ PerasVote' blk → PerasVote' blk → PerasVote' blk #

Generic (PerasVote' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Associated Types

type Rep (PerasVote' blk)

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type Rep (PerasVote' blk) = D1 ('MetaData "PerasVote'" "Ouroboros.Consensus.Block.SupportsPeras" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "PerasVote" 'PrefixI 'True) (S1 ('MetaSel ('Just "pvVoteRound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PerasRoundNo) :*: (S1 ('MetaSel ('Just "pvVoteBlock") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point blk)) :*: S1 ('MetaSel ('Just "pvVoteVoterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PerasSeatIndex))))

Methods

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

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

StandardHash blk ⇒ Show (PerasVote' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

showsPrec ∷ Int → PerasVote' blk → ShowS #

show ∷ PerasVote' blk → String #

showList ∷ [PerasVote' blk] → ShowS #

StandardHash blk ⇒ NoThunks (PerasVote' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

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

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

showTypeOf ∷ Proxy (PerasVote' blk) → String Source #

Serialise (HeaderHash blk) ⇒ Serialise (PerasVote' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

encode ∷ PerasVote' blk → Encoding Source #

decode ∷ Decoder s (PerasVote' blk) Source #

encodeList ∷ [PerasVote' blk] → Encoding Source #

decodeList ∷ Decoder s [PerasVote' blk] Source #

IsPerasVote (PerasVote' blk) blk Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

getPerasVoteRound ∷ PerasVote' blk → PerasRoundNo Source #

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

getPerasVoteSeatIndex ∷ PerasVote' blk → PerasSeatIndex Source #

getPerasVotePoint ∷ PerasVote' blk → Point blk Source #

type Rep (PerasVote' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type Rep (PerasVote' blk) = D1 ('MetaData "PerasVote'" "Ouroboros.Consensus.Block.SupportsPeras" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "PerasVote" 'PrefixI 'True) (S1 ('MetaSel ('Just "pvVoteRound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PerasRoundNo) :*: (S1 ('MetaSel ('Just "pvVoteBlock") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Point blk)) :*: S1 ('MetaSel ('Just "pvVoteVoterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PerasSeatIndex))))

type BoostedBlock (PerasVote' blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type BoostedBlock (PerasVote' blk) = Point blk

To be removed in favor of using a `PerasEpochContext` directly

newtype PerasVoteStakeDistr Source #

Constructors

PerasVoteStakeDistr
Fields unPerasVoteStakeDistr ∷ Map PerasSeatIndex VoteWeight

Instances

Instances details

Eq PerasVoteStakeDistr Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

(==) ∷ PerasVoteStakeDistr → PerasVoteStakeDistr → Bool #

(/=) ∷ PerasVoteStakeDistr → PerasVoteStakeDistr → Bool #

Generic PerasVoteStakeDistr Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Associated Types

type Rep PerasVoteStakeDistr

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type Rep PerasVoteStakeDistr = D1 ('MetaData "PerasVoteStakeDistr" "Ouroboros.Consensus.Block.SupportsPeras" "ouroboros-consensus-4.0.0.0-inplace" 'True) (C1 ('MetaCons "PerasVoteStakeDistr" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPerasVoteStakeDistr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map PerasSeatIndex VoteWeight))))

Methods

from ∷ PerasVoteStakeDistr → Rep PerasVoteStakeDistr x #

to ∷ Rep PerasVoteStakeDistr x → PerasVoteStakeDistr #

Show PerasVoteStakeDistr Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

showsPrec ∷ Int → PerasVoteStakeDistr → ShowS #

show ∷ PerasVoteStakeDistr → String #

showList ∷ [PerasVoteStakeDistr] → ShowS #

NoThunks PerasVoteStakeDistr Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

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

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

showTypeOf ∷ Proxy PerasVoteStakeDistr → String Source #

type Rep PerasVoteStakeDistr Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type Rep PerasVoteStakeDistr = D1 ('MetaData "PerasVoteStakeDistr" "Ouroboros.Consensus.Block.SupportsPeras" "ouroboros-consensus-4.0.0.0-inplace" 'True) (C1 ('MetaCons "PerasVoteStakeDistr" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPerasVoteStakeDistr") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map PerasSeatIndex VoteWeight))))

Validated types

data ValidatedPerasCert blk Source #

Constructors

ValidatedPerasCert
Fields vpcCert ∷ !(PerasCert blk) vpcCertBoost ∷ !PerasWeight

Instances

Instances details

Eq (PerasCert blk) ⇒ Eq (ValidatedPerasCert blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

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

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

Ord (PerasCert blk) ⇒ Ord (ValidatedPerasCert blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

compare ∷ ValidatedPerasCert blk → ValidatedPerasCert blk → Ordering #

(<) ∷ ValidatedPerasCert blk → ValidatedPerasCert blk → Bool #

(<=) ∷ ValidatedPerasCert blk → ValidatedPerasCert blk → Bool #

(>) ∷ ValidatedPerasCert blk → ValidatedPerasCert blk → Bool #

(>=) ∷ ValidatedPerasCert blk → ValidatedPerasCert blk → Bool #

max ∷ ValidatedPerasCert blk → ValidatedPerasCert blk → ValidatedPerasCert blk #

min ∷ ValidatedPerasCert blk → ValidatedPerasCert blk → ValidatedPerasCert blk #

Generic (ValidatedPerasCert blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Associated Types

type Rep (ValidatedPerasCert blk)

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type Rep (ValidatedPerasCert blk) = D1 ('MetaData "ValidatedPerasCert" "Ouroboros.Consensus.Block.SupportsPeras" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "ValidatedPerasCert" 'PrefixI 'True) (S1 ('MetaSel ('Just "vpcCert") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PerasCert blk)) :*: S1 ('MetaSel ('Just "vpcCertBoost") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PerasWeight)))

Methods

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

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

Show (PerasCert blk) ⇒ Show (ValidatedPerasCert blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

showsPrec ∷ Int → ValidatedPerasCert blk → ShowS #

show ∷ ValidatedPerasCert blk → String #

showList ∷ [ValidatedPerasCert blk] → ShowS #

NoThunks (PerasCert blk) ⇒ NoThunks (ValidatedPerasCert blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

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

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

showTypeOf ∷ Proxy (ValidatedPerasCert blk) → String Source #

(IsPerasCert (PerasCert blk) blk, BoostedBlockCompatibleWithPoint (BoostedBlock (PerasCert blk)) blk) ⇒ IsPerasCert (ValidatedPerasCert blk) blk Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

getPerasCertRound ∷ ValidatedPerasCert blk → PerasRoundNo Source #

getPerasCertBlock ∷ ValidatedPerasCert blk → BoostedBlock (ValidatedPerasCert blk) Source #

getPerasCertPoint ∷ ValidatedPerasCert blk → Point blk Source #

type Rep (ValidatedPerasCert blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type Rep (ValidatedPerasCert blk) = D1 ('MetaData "ValidatedPerasCert" "Ouroboros.Consensus.Block.SupportsPeras" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "ValidatedPerasCert" 'PrefixI 'True) (S1 ('MetaSel ('Just "vpcCert") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PerasCert blk)) :*: S1 ('MetaSel ('Just "vpcCertBoost") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PerasWeight)))

type BoostedBlock (ValidatedPerasCert blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type BoostedBlock (ValidatedPerasCert blk) = BoostedBlock (PerasCert blk)

data ValidatedPerasVote blk Source #

Constructors

ValidatedPerasVote
Fields vpvVote ∷ !(PerasVote blk) vpvVoteWeight ∷ !VoteWeight

Instances

Instances details

Eq (PerasVote blk) ⇒ Eq (ValidatedPerasVote blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

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

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

Ord (PerasVote blk) ⇒ Ord (ValidatedPerasVote blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

compare ∷ ValidatedPerasVote blk → ValidatedPerasVote blk → Ordering #

(<) ∷ ValidatedPerasVote blk → ValidatedPerasVote blk → Bool #

(<=) ∷ ValidatedPerasVote blk → ValidatedPerasVote blk → Bool #

(>) ∷ ValidatedPerasVote blk → ValidatedPerasVote blk → Bool #

(>=) ∷ ValidatedPerasVote blk → ValidatedPerasVote blk → Bool #

max ∷ ValidatedPerasVote blk → ValidatedPerasVote blk → ValidatedPerasVote blk #

min ∷ ValidatedPerasVote blk → ValidatedPerasVote blk → ValidatedPerasVote blk #

Generic (ValidatedPerasVote blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Associated Types

type Rep (ValidatedPerasVote blk)

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type Rep (ValidatedPerasVote blk) = D1 ('MetaData "ValidatedPerasVote" "Ouroboros.Consensus.Block.SupportsPeras" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "ValidatedPerasVote" 'PrefixI 'True) (S1 ('MetaSel ('Just "vpvVote") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PerasVote blk)) :*: S1 ('MetaSel ('Just "vpvVoteWeight") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 VoteWeight)))

Methods

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

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

Show (PerasVote blk) ⇒ Show (ValidatedPerasVote blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

showsPrec ∷ Int → ValidatedPerasVote blk → ShowS #

show ∷ ValidatedPerasVote blk → String #

showList ∷ [ValidatedPerasVote blk] → ShowS #

NoThunks (PerasVote blk) ⇒ NoThunks (ValidatedPerasVote blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

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

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

showTypeOf ∷ Proxy (ValidatedPerasVote blk) → String Source #

(IsPerasVote (PerasVote blk) blk, BoostedBlockCompatibleWithPoint (BoostedBlock (PerasVote blk)) blk) ⇒ IsPerasVote (ValidatedPerasVote blk) blk Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

getPerasVoteRound ∷ ValidatedPerasVote blk → PerasRoundNo Source #

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

getPerasVoteSeatIndex ∷ ValidatedPerasVote blk → PerasSeatIndex Source #

getPerasVotePoint ∷ ValidatedPerasVote blk → Point blk Source #

type Rep (ValidatedPerasVote blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type Rep (ValidatedPerasVote blk) = D1 ('MetaData "ValidatedPerasVote" "Ouroboros.Consensus.Block.SupportsPeras" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "ValidatedPerasVote" 'PrefixI 'True) (S1 ('MetaSel ('Just "vpvVote") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PerasVote blk)) :*: S1 ('MetaSel ('Just "vpvVoteWeight") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 VoteWeight)))

type BoostedBlock (ValidatedPerasVote blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type BoostedBlock (ValidatedPerasVote blk) = BoostedBlock (PerasVote blk)

Peras error types

class IsPerasError err blk | err → blk where Source #

Error types that support injecting certain types of Peras errors

Methods

injectVotingCommitteeError ∷ PerasVotingCommitteeError blk → err Source #

injectConversionError ∷ PerasConversionError → err Source #

injectQuorumNotReachedError ∷ VoteWeight → err Source #

Instances

Instances details

IsPerasError (VoidPerasError blk) blk Source #
Instance details Defined in Ouroboros.Consensus.Block.SupportsPeras Methods injectVotingCommitteeError ∷ PerasVotingCommitteeError blk → VoidPerasError blk Source # injectConversionError ∷ PerasConversionError → VoidPerasError blk Source # injectQuorumNotReachedError ∷ VoteWeight → VoidPerasError blk Source #
IsPerasError (PerasError blk) blk ⇒ IsPerasError (WrapPerasError blk) blk Source #
Instance details Defined in Ouroboros.Consensus.TypeFamilyWrappers Methods injectVotingCommitteeError ∷ PerasVotingCommitteeError blk → WrapPerasError blk Source # injectConversionError ∷ PerasConversionError → WrapPerasError blk Source # injectQuorumNotReachedError ∷ VoteWeight → WrapPerasError blk Source #

Types and functions related to Peras vote collection and quorum checking

data PerasVoteCollection blk Source #

Collection of Peras votes for a given target.

NOTE: votes in this collection are uniquely identified by their vote ID.

Instances

Instances details

(StandardHash blk, Eq (PerasVote blk), Eq (PerasCert blk)) ⇒ Eq (PerasVoteCollection blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

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

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

Generic (PerasVoteCollection blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Associated Types

type Rep (PerasVoteCollection blk)

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type Rep (PerasVoteCollection blk) = D1 ('MetaData "PerasVoteCollection" "Ouroboros.Consensus.Block.SupportsPeras" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "PerasVoteCollection" 'PrefixI 'True) (S1 ('MetaSel ('Just "pvcTarget") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PerasVoteTarget blk)) :*: (S1 ('MetaSel ('Just "pvcVotes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (NE (Map PerasVoteId (WithArrivalTime (ValidatedPerasVote blk))))) :*: S1 ('MetaSel ('Just "pvcTotalWeight") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 VoteWeight))))

Methods

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

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

(StandardHash blk, Show (PerasVote blk), Show (PerasCert blk)) ⇒ Show (PerasVoteCollection blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

showsPrec ∷ Int → PerasVoteCollection blk → ShowS #

show ∷ PerasVoteCollection blk → String #

showList ∷ [PerasVoteCollection blk] → ShowS #

(StandardHash blk, NoThunks (PerasVote blk), NoThunks (PerasCert blk)) ⇒ NoThunks (PerasVoteCollection blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

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

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

showTypeOf ∷ Proxy (PerasVoteCollection blk) → String Source #

type Rep (PerasVoteCollection blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type Rep (PerasVoteCollection blk) = D1 ('MetaData "PerasVoteCollection" "Ouroboros.Consensus.Block.SupportsPeras" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "PerasVoteCollection" 'PrefixI 'True) (S1 ('MetaSel ('Just "pvcTarget") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PerasVoteTarget blk)) :*: (S1 ('MetaSel ('Just "pvcVotes") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (NE (Map PerasVoteId (WithArrivalTime (ValidatedPerasVote blk))))) :*: S1 ('MetaSel ('Just "pvcTotalWeight") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 VoteWeight))))

perasVoteCollectionSingleton ∷ IsPerasVote (PerasVote blk) blk ⇒ WithArrivalTime (ValidatedPerasVote blk) → PerasVoteCollection blk Source #

Construct a PerasVoteCollection with a single vote.

perasVoteCollectionAddVote ∷ (StandardHash blk, IsPerasVote (PerasVote blk) blk) ⇒ WithArrivalTime (ValidatedPerasVote blk) → PerasVoteCollection blk → PerasVoteCollection blk Source #

Add a vote to an existing vote collection if it isn't already present, and update the total weight accordingly.

PRECONDITION: the vote's target must match the collection's target.

unsafePerasVoteCollection ∷ (IsPerasVote (PerasVote blk) blk, StandardHash blk) ⇒ NE (Map PerasVoteId (WithArrivalTime (ValidatedPerasVote blk))) → PerasVoteCollection blk Source #

Unsafe constructor for PerasVoteCollection.

The only recorded use at the moment is in the HFC implementation, to turn an existing PerasVoteCollection for the HardForkBlock into a PerasVoteCollection of a concrete era.

data PerasVoteCollectionWithQuorum blk Source #

A collection of Peras votes for a given target that has reached quorum

Instances

Instances details

(StandardHash blk, Eq (PerasVote blk), Eq (PerasCert blk)) ⇒ Eq (PerasVoteCollectionWithQuorum blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

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

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

Generic (PerasVoteCollectionWithQuorum blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Associated Types

type Rep (PerasVoteCollectionWithQuorum blk)
Instance details Defined in Ouroboros.Consensus.Block.SupportsPeras type Rep (PerasVoteCollectionWithQuorum blk) = Rep (PerasVoteCollection blk)

Methods

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

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

(StandardHash blk, Show (PerasVote blk), Show (PerasCert blk)) ⇒ Show (PerasVoteCollectionWithQuorum blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

showsPrec ∷ Int → PerasVoteCollectionWithQuorum blk → ShowS #

show ∷ PerasVoteCollectionWithQuorum blk → String #

showList ∷ [PerasVoteCollectionWithQuorum blk] → ShowS #

(StandardHash blk, NoThunks (PerasVote blk), NoThunks (PerasCert blk)) ⇒ NoThunks (PerasVoteCollectionWithQuorum blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

Methods

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

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

showTypeOf ∷ Proxy (PerasVoteCollectionWithQuorum blk) → String Source #

type Rep (PerasVoteCollectionWithQuorum blk) Source #

Instance details

Defined in Ouroboros.Consensus.Block.SupportsPeras

type Rep (PerasVoteCollectionWithQuorum blk) = Rep (PerasVoteCollection blk)

unsafeAssumeQuorum ∷ PerasVoteCollection blk → PerasVoteCollectionWithQuorum blk Source #

Transforms a PerasVoteCollection into a PerasVoteCollectionWithQuorum without actually checking the quorum condition.

NOTE: the only recorded use at the moment is in the HFC implementation, to turn an existing PerasVoteCollectionWithQuorum for the HardForkBlock into a PerasVoteCollectionWithQuorum of a concrete era.

perasVoteCollectionCheckQuorum ∷ PerasParams blk → PerasVoteCollection blk → Maybe (PerasVoteCollectionWithQuorum blk) Source #

Smart constructor for PerasVoteCollectionWithQuorum

toUniqueVotesWithSameTarget ∷ (vote ~ PerasVote blk, crypto ~ PerasCrypto blk, committee ~ PerasVotingCommitteeScheme blk, PerasVoteCompatibleWithVotingCommittee vote crypto committee, Eq (VoteCandidate crypto)) ⇒ PerasVoteCollectionWithQuorum blk → Either PerasConversionError (UniqueVotesWithSameTarget (PerasCrypto blk) (PerasVotingCommitteeScheme blk)) Source #

Convert a collection of Peras votes that has reached quorum into the corresponding abstract representation of votes used by the voting committee to forge certificates.

UniqueVotesWithSameTarget and PerasVoteCollection enforce the same invariants, which are: - The collection is not empty - All votes have the same target - All votes have a unique vote ID (or unique seat index, which is equivalent assuming they also have the same target, see second point) In addition to that, PerasVoteCollectionWithQuorum guarantees that the total weight of the votes is above the threshold.

Helpers

weightAboveThreshold ∷ PerasParams blk → VoteWeight → Bool Source #

Check whether a given vote weight is above the quorum threshold.

NOTE: this function assumes that the VoteWeight and the quorum threshold used in PerasParams are expressed in the same units. That is, both are either absolute or relative (normalized) values. Under the current current implementation of PerasParams, this function only makes sense when both values are relative (normalized) values.