ouroboros-consensus

Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Peras.Cert.V1

Description

Concrete Peras certificate types using BLS signatures.

NOTE: this module is meant to be imported qualified.

NOTE: the validation performed during serialization is minimal, and does not cover any of additional semantic and cryptographic checks that must be performed on the certificate later on.

Synopsis

data PerasCert blk = PerasCert {
- pcRoundNo ∷ !PerasRoundNo
- pcBoostedBlock ∷ !PerasBoostedBlock
- pcVoters ∷ !PerasCertVoters
- pcSignature ∷ !(AggregateVoteSignature PerasBLSCrypto)
}
castPerasCert ∷ ∀ blk' blk. PerasCert blk → PerasCert blk'
newtype PerasCertVoters = PerasCertVoters {
- unPerasCertVoters ∷ NE (Map PerasSeatIndex PerasVoteEligibilityProof)
}

Documentation

data PerasCert blk Source #

Concrete Peras certificates using BLS signatures

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

Constructors

PerasCert
Fields pcRoundNo ∷ !PerasRoundNo Election identifier pcBoostedBlock ∷ !PerasBoostedBlock Certificate message, i.e., the hash of the block being boosted pcVoters ∷ !PerasCertVoters Voters who contributed to this certificate pcSignature ∷ !(AggregateVoteSignature PerasBLSCrypto) Aggregate BLS signature on the hash of the election identifier and the certificate message

Instances

Instances details

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

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

Methods

showProxy ∷ Proxy (PerasCert blk) → String #

Typeable blk ⇒ FromCBOR (PerasCert blk) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

Methods

fromCBOR ∷ Decoder s (PerasCert blk) Source #

label ∷ Proxy (PerasCert blk) → Text Source #

Typeable blk ⇒ ToCBOR (PerasCert blk) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

Methods

toCBOR ∷ PerasCert blk → Encoding Source #

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

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

Eq (PerasCert blk) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

Methods

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

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

Generic (PerasCert blk) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

Associated Types

type Rep (PerasCert blk)

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

type Rep (PerasCert blk) = D1 ('MetaData "PerasCert" "Ouroboros.Consensus.Peras.Cert.V1" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "PerasCert" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pcRoundNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PerasRoundNo) :*: S1 ('MetaSel ('Just "pcBoostedBlock") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PerasBoostedBlock)) :*: (S1 ('MetaSel ('Just "pcVoters") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PerasCertVoters) :*: S1 ('MetaSel ('Just "pcSignature") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (AggregateVoteSignature PerasBLSCrypto)))))

Methods

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

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

Show (PerasCert blk) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

Methods

showsPrec ∷ Int → PerasCert blk → ShowS #

show ∷ PerasCert blk → String #

showList ∷ [PerasCert blk] → ShowS #

NoThunks (PerasCert blk) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

Methods

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

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

showTypeOf ∷ Proxy (PerasCert blk) → String Source #

(ConvertRawHash blk, HashSize blk ~ 32) ⇒ IsPerasCert (PerasCert blk) blk Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

Methods

getPerasCertRound ∷ PerasCert blk → PerasRoundNo Source #

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

getPerasCertPoint ∷ PerasCert blk → Point blk Source #

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 #

type Rep (PerasCert blk) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

type Rep (PerasCert blk) = D1 ('MetaData "PerasCert" "Ouroboros.Consensus.Peras.Cert.V1" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "PerasCert" 'PrefixI 'True) ((S1 ('MetaSel ('Just "pcRoundNo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PerasRoundNo) :*: S1 ('MetaSel ('Just "pcBoostedBlock") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PerasBoostedBlock)) :*: (S1 ('MetaSel ('Just "pcVoters") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PerasCertVoters) :*: S1 ('MetaSel ('Just "pcSignature") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (AggregateVoteSignature PerasBLSCrypto)))))

type BoostedBlock (PerasCert blk) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

type BoostedBlock (PerasCert blk) = PerasBoostedBlock

castPerasCert ∷ ∀ blk' blk. PerasCert blk → PerasCert blk' Source #

Retag a PerasCert with a new phantom blk type.

newtype PerasCertVoters Source #

Voters contained in a certificate with their appropriate eligibility proof

Constructors

PerasCertVoters
Fields unPerasCertVoters ∷ NE (Map PerasSeatIndex PerasVoteEligibilityProof)

Instances

Instances details

FromCBOR PerasCertVoters Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

Methods

fromCBOR ∷ Decoder s PerasCertVoters Source #

label ∷ Proxy PerasCertVoters → Text Source #

ToCBOR PerasCertVoters Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

Methods

toCBOR ∷ PerasCertVoters → Encoding Source #

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

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

Eq PerasCertVoters Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

Methods

(==) ∷ PerasCertVoters → PerasCertVoters → Bool #

(/=) ∷ PerasCertVoters → PerasCertVoters → Bool #

Generic PerasCertVoters Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

Associated Types

type Rep PerasCertVoters

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

type Rep PerasCertVoters = D1 ('MetaData "PerasCertVoters" "Ouroboros.Consensus.Peras.Cert.V1" "ouroboros-consensus-4.0.0.0-inplace" 'True) (C1 ('MetaCons "PerasCertVoters" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPerasCertVoters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NE (Map PerasSeatIndex PerasVoteEligibilityProof)))))

Methods

from ∷ PerasCertVoters → Rep PerasCertVoters x #

to ∷ Rep PerasCertVoters x → PerasCertVoters #

Show PerasCertVoters Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

Methods

showsPrec ∷ Int → PerasCertVoters → ShowS #

show ∷ PerasCertVoters → String #

showList ∷ [PerasCertVoters] → ShowS #

NoThunks PerasCertVoters Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

Methods

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

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

showTypeOf ∷ Proxy PerasCertVoters → String Source #

type Rep PerasCertVoters Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.V1

type Rep PerasCertVoters = D1 ('MetaData "PerasCertVoters" "Ouroboros.Consensus.Peras.Cert.V1" "ouroboros-consensus-4.0.0.0-inplace" 'True) (C1 ('MetaCons "PerasCertVoters" 'PrefixI 'True) (S1 ('MetaSel ('Just "unPerasCertVoters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (NE (Map PerasSeatIndex PerasVoteEligibilityProof)))))