Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Protocol.Praos.Common

Contents

node support

Description

Various things common to iterations of the Praos protocol.

Synopsis

newtype MaxMajorProtVer = MaxMajorProtVer {
- getMaxMajorProtVer :: Natural
}
data PraosCanBeLeader c = PraosCanBeLeader {
- praosCanBeLeaderOpCert :: !( OCert c)
- praosCanBeLeaderColdVerKey :: !( VKey ' BlockIssuer c)
- praosCanBeLeaderSignKeyVRF :: !( SignKeyVRF c)
}
data PraosChainSelectView c = PraosChainSelectView {
- csvChainLength :: BlockNo
- csvSlotNo :: SlotNo
- csvIssuer :: VKey ' BlockIssuer c
- csvIssueNo :: Word64
- csvLeaderVRF :: OutputVRF ( VRF c)
}
data PraosNonces = PraosNonces {
- candidateNonce :: ! Nonce
- epochNonce :: ! Nonce
- evolvingNonce :: ! Nonce
- labNonce :: ! Nonce
- previousLabNonce :: ! Nonce
}
class ConsensusProtocol p => PraosProtocolSupportsNode p where
- type PraosProtocolSupportsNodeCrypto p
- getPraosNonces :: proxy p -> ChainDepState p -> PraosNonces
- getOpCertCounters :: proxy p -> ChainDepState p -> Map ( KeyHash ' BlockIssuer ( PraosProtocolSupportsNodeCrypto p)) Word64

Documentation

newtype MaxMajorProtVer Source #

The maximum major protocol version.

Must be at least the current major protocol version. For Cardano mainnet, the Shelley era has major protocol verison 2 .

Constructors

MaxMajorProtVer
Fields getMaxMajorProtVer :: Natural

Instances

Instances details

Eq MaxMajorProtVer Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common Methods (==) :: MaxMajorProtVer -> MaxMajorProtVer -> Bool Source # (/=) :: MaxMajorProtVer -> MaxMajorProtVer -> Bool Source #
Show MaxMajorProtVer Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common Methods showsPrec :: Int -> MaxMajorProtVer -> ShowS Source # show :: MaxMajorProtVer -> String Source # showList :: [ MaxMajorProtVer ] -> ShowS Source #
Generic MaxMajorProtVer Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common Associated Types type Rep MaxMajorProtVer :: Type -> Type Source # Methods from :: MaxMajorProtVer -> Rep MaxMajorProtVer x Source # to :: Rep MaxMajorProtVer x -> MaxMajorProtVer Source #
NoThunks MaxMajorProtVer Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common Methods noThunks :: Context -> MaxMajorProtVer -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> MaxMajorProtVer -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy MaxMajorProtVer -> String Source #
type Rep MaxMajorProtVer Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common type Rep MaxMajorProtVer = D1 (' MetaData "MaxMajorProtVer" "Ouroboros.Consensus.Protocol.Praos.Common" "ouroboros-consensus-protocol-0.1.0.1-zKRBoYOfUlKsvZd6xB0lb" ' True ) ( C1 (' MetaCons "MaxMajorProtVer" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "getMaxMajorProtVer") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Natural )))

data PraosCanBeLeader c Source #

Constructors

PraosCanBeLeader
Fields praosCanBeLeaderOpCert :: !( OCert c) Certificate delegating rights from the stake pool cold key (or genesis stakeholder delegate cold key) to the online KES key. praosCanBeLeaderColdVerKey :: !( VKey ' BlockIssuer c) Stake pool cold key or genesis stakeholder delegate cold key. praosCanBeLeaderSignKeyVRF :: !( SignKeyVRF c)

Instances

Instances details

Generic ( PraosCanBeLeader c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common Associated Types type Rep ( PraosCanBeLeader c) :: Type -> Type Source # Methods from :: PraosCanBeLeader c -> Rep ( PraosCanBeLeader c) x Source # to :: Rep ( PraosCanBeLeader c) x -> PraosCanBeLeader c Source #
Crypto c => NoThunks ( PraosCanBeLeader c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common Methods noThunks :: Context -> PraosCanBeLeader c -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> PraosCanBeLeader c -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( PraosCanBeLeader c) -> String Source #
type Rep ( PraosCanBeLeader c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common type Rep ( PraosCanBeLeader c) = D1 (' MetaData "PraosCanBeLeader" "Ouroboros.Consensus.Protocol.Praos.Common" "ouroboros-consensus-protocol-0.1.0.1-zKRBoYOfUlKsvZd6xB0lb" ' False ) ( C1 (' MetaCons "PraosCanBeLeader" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "praosCanBeLeaderOpCert") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( OCert c)) :: ( S1 (' MetaSel (' Just "praosCanBeLeaderColdVerKey") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( VKey ' BlockIssuer c)) :: S1 (' MetaSel (' Just "praosCanBeLeaderSignKeyVRF") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( SignKeyVRF c)))))

data PraosChainSelectView c Source #

View of the ledger tip for chain selection.

We order between chains as follows:

By chain length, with longer chains always preferred.
If the tip of each chain was issued by the same agent, then we prefer the chain whose tip has the highest ocert issue number.
By the leader value of the chain tip, with lower values preferred.

Constructors

PraosChainSelectView
Fields csvChainLength :: BlockNo csvSlotNo :: SlotNo csvIssuer :: VKey ' BlockIssuer c csvIssueNo :: Word64 csvLeaderVRF :: OutputVRF ( VRF c)

Instances

Instances details

Crypto c => Eq ( PraosChainSelectView c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common Methods (==) :: PraosChainSelectView c -> PraosChainSelectView c -> Bool Source # (/=) :: PraosChainSelectView c -> PraosChainSelectView c -> Bool Source #
Crypto c => Ord ( PraosChainSelectView c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common Methods compare :: PraosChainSelectView c -> PraosChainSelectView c -> Ordering Source # (<) :: PraosChainSelectView c -> PraosChainSelectView c -> Bool Source # (<=) :: PraosChainSelectView c -> PraosChainSelectView c -> Bool Source # (>) :: PraosChainSelectView c -> PraosChainSelectView c -> Bool Source # (>=) :: PraosChainSelectView c -> PraosChainSelectView c -> Bool Source # max :: PraosChainSelectView c -> PraosChainSelectView c -> PraosChainSelectView c Source # min :: PraosChainSelectView c -> PraosChainSelectView c -> PraosChainSelectView c Source #
Crypto c => Show ( PraosChainSelectView c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common Methods showsPrec :: Int -> PraosChainSelectView c -> ShowS Source # show :: PraosChainSelectView c -> String Source # showList :: [ PraosChainSelectView c] -> ShowS Source #
Generic ( PraosChainSelectView c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common Associated Types type Rep ( PraosChainSelectView c) :: Type -> Type Source # Methods from :: PraosChainSelectView c -> Rep ( PraosChainSelectView c) x Source # to :: Rep ( PraosChainSelectView c) x -> PraosChainSelectView c Source #
Crypto c => NoThunks ( PraosChainSelectView c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common Methods noThunks :: Context -> PraosChainSelectView c -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> PraosChainSelectView c -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( PraosChainSelectView c) -> String Source #
type Rep ( PraosChainSelectView c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos.Common type Rep ( PraosChainSelectView c) = D1 (' MetaData "PraosChainSelectView" "Ouroboros.Consensus.Protocol.Praos.Common" "ouroboros-consensus-protocol-0.1.0.1-zKRBoYOfUlKsvZd6xB0lb" ' False ) ( C1 (' MetaCons "PraosChainSelectView" ' PrefixI ' True ) (( S1 (' MetaSel (' Just "csvChainLength") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 BlockNo ) :: S1 (' MetaSel (' Just "csvSlotNo") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 SlotNo )) :: ( S1 (' MetaSel (' Just "csvIssuer") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( VKey ' BlockIssuer c)) :: ( S1 (' MetaSel (' Just "csvIssueNo") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Word64 ) :: S1 (' MetaSel (' Just "csvLeaderVRF") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( OutputVRF ( VRF c)))))))

node support

data PraosNonces Source #

See PraosProtocolSupportsNode

Constructors

PraosNonces
Fields candidateNonce :: ! Nonce epochNonce :: ! Nonce evolvingNonce :: ! Nonce labNonce :: ! Nonce Nonce constructed from the hash of the Last Applied Block previousLabNonce :: ! Nonce Nonce corresponding to the LAB nonce of the last block of the previous epoch

class ConsensusProtocol p => PraosProtocolSupportsNode p where Source #

The node has Praos-aware code that inspects nonces in order to support some Cardano API queries that are crucial to the user exprience

The interface being used for that has grown and needs review, but we're adding to it here under time pressure. See https://github.com/input-output-hk/cardano-node/issues/3864

Associated Types

type PraosProtocolSupportsNodeCrypto p Source #

Methods

getPraosNonces :: proxy p -> ChainDepState p -> PraosNonces Source #

getOpCertCounters :: proxy p -> ChainDepState p -> Map ( KeyHash ' BlockIssuer ( PraosProtocolSupportsNodeCrypto p)) Word64 Source #

Instances

Instances details

PraosCrypto c => PraosProtocolSupportsNode ( TPraos c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.TPraos Associated Types type PraosProtocolSupportsNodeCrypto ( TPraos c) Source # Methods getPraosNonces :: proxy ( TPraos c) -> ChainDepState ( TPraos c) -> PraosNonces Source # getOpCertCounters :: proxy ( TPraos c) -> ChainDepState ( TPraos c) -> Map ( KeyHash ' BlockIssuer ( PraosProtocolSupportsNodeCrypto ( TPraos c))) Word64 Source #
PraosCrypto c => PraosProtocolSupportsNode ( Praos c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Associated Types type PraosProtocolSupportsNodeCrypto ( Praos c) Source # Methods getPraosNonces :: proxy ( Praos c) -> ChainDepState ( Praos c) -> PraosNonces Source # getOpCertCounters :: proxy ( Praos c) -> ChainDepState ( Praos c) -> Map ( KeyHash ' BlockIssuer ( PraosProtocolSupportsNodeCrypto ( Praos c))) Word64 Source #