Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.Protocol.Praos

Synopsis

data family ConsensusConfig p
data Praos c
data PraosCannotForge c = PraosCannotForgeKeyNotUsableYet !KESPeriod !KESPeriod
class (Crypto c, Signable (DSIGN c) (OCertSignable c), Signable (DSIGN c) (Hash c EraIndependentTxBody), Signable (KES c) (HeaderBody c), Signable (VRF c) InputVRF) ⇒ PraosCrypto c
data PraosFields c toSign = PraosFields {
- praosSignature ∷ SignedKES c toSign
- praosToSign ∷ toSign
}
newtype PraosIsLeader c = PraosIsLeader {
- praosIsLeaderVrfRes ∷ CertifiedVRF c InputVRF
}
data PraosParams = PraosParams {
- praosSlotsPerKESPeriod ∷ !Word64
- praosLeaderF ∷ !ActiveSlotCoeff
- praosSecurityParam ∷ !SecurityParam
- praosMaxKESEvo ∷ !Word64
- praosQuorum ∷ !Word64
- praosMaxMajorPV ∷ !MaxMajorProtVer
- praosMaxLovelaceSupply ∷ !Word64
- praosNetworkId ∷ !Network
- praosSystemStart ∷ !SystemStart
- praosRandomnessStabilisationWindow ∷ !Word64
}
data PraosState c = PraosState {
- praosStateLastSlot ∷ !(WithOrigin SlotNo)
- praosStateOCertCounters ∷ !(Map (KeyHash 'BlockIssuer c) Word64)
- praosStateEvolvingNonce ∷ !Nonce
- praosStateCandidateNonce ∷ !Nonce
- praosStateEpochNonce ∷ !Nonce
- praosStateLabNonce ∷ !Nonce
- praosStateLastEpochBlockNonce ∷ !Nonce
}
data PraosToSign c = PraosToSign {
- praosToSignIssuerVK ∷ VKey 'BlockIssuer c
- praosToSignVrfVK ∷ VerKeyVRF c
- praosToSignVrfRes ∷ CertifiedVRF c InputVRF
- praosToSignOCert ∷ OCert c
}
data PraosValidationErr c
- = VRFKeyUnknown !(KeyHash StakePool c)
- | VRFKeyWrongVRFKey !(KeyHash StakePool c) !(Hash c (VerKeyVRF c)) !(Hash c (VerKeyVRF c))
- | VRFKeyBadProof !SlotNo !Nonce !(CertifiedVRF (VRF c) InputVRF)
- | VRFLeaderValueTooBig Natural Rational ActiveSlotCoeff
- | KESBeforeStartOCERT !KESPeriod !KESPeriod
- | KESAfterEndOCERT !KESPeriod !KESPeriod !Word64
- | CounterTooSmallOCERT !Word64 !Word64
- | CounterOverIncrementedOCERT !Word64 !Word64
- | InvalidSignatureOCERT !Word64 !KESPeriod !String
- | InvalidKesSignatureOCERT !Word !Word !Word !String
- | NoCounterForKeyHashOCERT !(KeyHash 'BlockIssuer c)
data family Ticked st
forgePraosFields ∷ (PraosCrypto c, KESignable c toSign, Monad m) ⇒ HotKey c m → CanBeLeader (Praos c) → IsLeader (Praos c) → (PraosToSign c → toSign) → m (PraosFields c toSign)
praosCheckCanForge ∷ ConsensusConfig (Praos c) → SlotNo → KESInfo → Either (PraosCannotForge c) ()

Documentation

data family ConsensusConfig p Source #

Static configuration required to run the consensus protocol

Every method in the ConsensusProtocol class takes the consensus configuration as a parameter, so having this as a data family rather than a type family resolves most ambiguity.

Defined out of the class so that protocols can define this type without having to define the entire protocol at the same time (or indeed in the same module).

Instances

Instances details

Generic (ConsensusConfig (Praos c)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Associated Types type Rep (ConsensusConfig (Praos c)) ∷ Type → Type # Methods from ∷ ConsensusConfig (Praos c) → Rep (ConsensusConfig (Praos c)) x # to ∷ Rep (ConsensusConfig (Praos c)) x → ConsensusConfig (Praos c) #
Generic (ConsensusConfig (TPraos c)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.TPraos Associated Types type Rep (ConsensusConfig (TPraos c)) ∷ Type → Type # Methods from ∷ ConsensusConfig (TPraos c) → Rep (ConsensusConfig (TPraos c)) x # to ∷ Rep (ConsensusConfig (TPraos c)) x → ConsensusConfig (TPraos c) #
PraosCrypto c ⇒ NoThunks (ConsensusConfig (Praos c)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods noThunks ∷ Context → ConsensusConfig (Praos c) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ConsensusConfig (Praos c) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (ConsensusConfig (Praos c)) → String Source #
PraosCrypto c ⇒ NoThunks (ConsensusConfig (TPraos c)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.TPraos Methods noThunks ∷ Context → ConsensusConfig (TPraos c) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ConsensusConfig (TPraos c) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (ConsensusConfig (TPraos c)) → String Source #
type Rep (ConsensusConfig (Praos c)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type Rep (ConsensusConfig (Praos c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.Praos" "ouroboros-consensus-protocol-0.9.0.0-inplace" 'False) (C1 ('MetaCons "PraosConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "praosParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PraosParams) :*: S1 ('MetaSel ('Just "praosEpochInfo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (EpochInfo (Except PastHorizonException)))))
type Rep (ConsensusConfig (TPraos c)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.TPraos type Rep (ConsensusConfig (TPraos c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.TPraos" "ouroboros-consensus-protocol-0.9.0.0-inplace" 'False) (C1 ('MetaCons "TPraosConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "tpraosParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 TPraosParams) :*: S1 ('MetaSel ('Just "tpraosEpochInfo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (EpochInfo (Except PastHorizonException)))))
data ConsensusConfig (Praos c) Source #	Static configuration
Instance details Defined in Ouroboros.Consensus.Protocol.Praos data ConsensusConfig (Praos c) = PraosConfig { praosParams ∷ !PraosParams praosEpochInfo ∷ !(EpochInfo (Except PastHorizonException)) }
data ConsensusConfig (TPraos c) Source #	Static configuration
Instance details Defined in Ouroboros.Consensus.Protocol.TPraos data ConsensusConfig (TPraos c) = TPraosConfig { tpraosParams ∷ !TPraosParams tpraosEpochInfo ∷ !(EpochInfo (Except PastHorizonException)) }

data Praos c Source #

Instances

Instances details

Generic (ConsensusConfig (Praos c)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Associated Types type Rep (ConsensusConfig (Praos c)) ∷ Type → Type # Methods from ∷ ConsensusConfig (Praos c) → Rep (ConsensusConfig (Praos c)) x # to ∷ Rep (ConsensusConfig (Praos c)) x → ConsensusConfig (Praos c) #
PraosCrypto c ⇒ NoThunks (ConsensusConfig (Praos c)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods noThunks ∷ Context → ConsensusConfig (Praos c) → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → ConsensusConfig (Praos c) → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (ConsensusConfig (Praos c)) → String Source #
PraosCrypto c ⇒ ConsensusProtocol (Praos c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Associated Types type ChainDepState (Praos c) Source # type IsLeader (Praos c) Source # type CanBeLeader (Praos c) Source # type SelectView (Praos c) Source # type LedgerView (Praos c) Source # type ValidationErr (Praos c) Source # type ValidateView (Praos c) Source # Methods checkIsLeader ∷ ConsensusConfig (Praos c) → CanBeLeader (Praos c) → SlotNo → Ticked (ChainDepState (Praos c)) → Maybe (IsLeader (Praos c)) Source # tickChainDepState ∷ ConsensusConfig (Praos c) → LedgerView (Praos c) → SlotNo → ChainDepState (Praos c) → Ticked (ChainDepState (Praos c)) Source # updateChainDepState ∷ ConsensusConfig (Praos c) → ValidateView (Praos c) → SlotNo → Ticked (ChainDepState (Praos c)) → Except (ValidationErr (Praos c)) (ChainDepState (Praos c)) Source # reupdateChainDepState ∷ ConsensusConfig (Praos c) → ValidateView (Praos c) → SlotNo → Ticked (ChainDepState (Praos c)) → ChainDepState (Praos c) Source # protocolSecurityParam ∷ ConsensusConfig (Praos c) → SecurityParam 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 #
c1 ~ c2 ⇒ TranslateProto (TPraos c1) (Praos c2) Source #	We can translate between TPraos and Praos, provided: They share the same HASH algorithm They share the same ADDRHASH algorithm They share the same DSIGN verification keys They share the same VRF verification keys
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods translateLedgerView ∷ Proxy (TPraos c1, Praos c2) → LedgerView (TPraos c1) → LedgerView (Praos c2) Source # translateChainDepState ∷ Proxy (TPraos c1, Praos c2) → ChainDepState (TPraos c1) → ChainDepState (Praos c2) Source #
type Rep (ConsensusConfig (Praos c)) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type Rep (ConsensusConfig (Praos c)) = D1 ('MetaData "ConsensusConfig" "Ouroboros.Consensus.Protocol.Praos" "ouroboros-consensus-protocol-0.9.0.0-inplace" 'False) (C1 ('MetaCons "PraosConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "praosParams") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 PraosParams) :*: S1 ('MetaSel ('Just "praosEpochInfo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (EpochInfo (Except PastHorizonException)))))
type CanBeLeader (Praos c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type CanBeLeader (Praos c) = PraosCanBeLeader c
type ChainDepState (Praos c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type ChainDepState (Praos c) = PraosState c
data ConsensusConfig (Praos c) Source #	Static configuration
Instance details Defined in Ouroboros.Consensus.Protocol.Praos data ConsensusConfig (Praos c) = PraosConfig { praosParams ∷ !PraosParams praosEpochInfo ∷ !(EpochInfo (Except PastHorizonException)) }
type IsLeader (Praos c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type IsLeader (Praos c) = PraosIsLeader c
type LedgerView (Praos c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type LedgerView (Praos c) = LedgerView c
type SelectView (Praos c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type SelectView (Praos c) = PraosChainSelectView c
type ValidateView (Praos c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type ValidateView (Praos c)
type ValidationErr (Praos c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type ValidationErr (Praos c) = PraosValidationErr c
type PraosProtocolSupportsNodeCrypto (Praos c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type PraosProtocolSupportsNodeCrypto (Praos c) = c

data PraosCannotForge c Source #

Expresses that, whilst we believe ourselves to be a leader for this slot, we are nonetheless unable to forge a block.

Constructors

PraosCannotForgeKeyNotUsableYet

The KES key in our operational certificate can't be used because the current (wall clock) period is before the start period of the key. current KES period.

Note: the opposite case, i.e., the wall clock period being after the end period of the key, is caught when trying to update the key in updateForgeState.

Fields

!KESPeriod
Current KES period according to the wallclock slot, i.e., the KES period in which we want to use the key.
!KESPeriod
Start KES period of the KES key.

Instances

Instances details

Generic (PraosCannotForge c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Associated Types type Rep (PraosCannotForge c) ∷ Type → Type # Methods from ∷ PraosCannotForge c → Rep (PraosCannotForge c) x # to ∷ Rep (PraosCannotForge c) x → PraosCannotForge c #
PraosCrypto c ⇒ Show (PraosCannotForge c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods showsPrec ∷ Int → PraosCannotForge c → ShowS # show ∷ PraosCannotForge c → String # showList ∷ [PraosCannotForge c] → ShowS #
type Rep (PraosCannotForge c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type Rep (PraosCannotForge c) = D1 ('MetaData "PraosCannotForge" "Ouroboros.Consensus.Protocol.Praos" "ouroboros-consensus-protocol-0.9.0.0-inplace" 'False) (C1 ('MetaCons "PraosCannotForgeKeyNotUsableYet" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KESPeriod) :*: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KESPeriod)))

class (Crypto c, Signable (DSIGN c) (OCertSignable c), Signable (DSIGN c) (Hash c EraIndependentTxBody), Signable (KES c) (HeaderBody c), Signable (VRF c) InputVRF) ⇒ PraosCrypto c Source #

Instances

Instances details

PraosCrypto StandardCrypto Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos

data PraosFields c toSign Source #

Constructors

PraosFields
Fields praosSignature ∷ SignedKES c toSign praosToSign ∷ toSign

Instances

Instances details

Generic (PraosFields c toSign) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Associated Types type Rep (PraosFields c toSign) ∷ Type → Type # Methods from ∷ PraosFields c toSign → Rep (PraosFields c toSign) x # to ∷ Rep (PraosFields c toSign) x → PraosFields c toSign #
(Show toSign, PraosCrypto c) ⇒ Show (PraosFields c toSign) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods showsPrec ∷ Int → PraosFields c toSign → ShowS # show ∷ PraosFields c toSign → String # showList ∷ [PraosFields c toSign] → ShowS #
(NoThunks toSign, PraosCrypto c) ⇒ NoThunks (PraosFields c toSign) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods noThunks ∷ Context → PraosFields c toSign → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → PraosFields c toSign → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (PraosFields c toSign) → String Source #
type Rep (PraosFields c toSign) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type Rep (PraosFields c toSign) = D1 ('MetaData "PraosFields" "Ouroboros.Consensus.Protocol.Praos" "ouroboros-consensus-protocol-0.9.0.0-inplace" 'False) (C1 ('MetaCons "PraosFields" 'PrefixI 'True) (S1 ('MetaSel ('Just "praosSignature") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (SignedKES c toSign)) :*: S1 ('MetaSel ('Just "praosToSign") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 toSign)))

newtype PraosIsLeader c Source #

Assembled proof that the issuer has the right to issue a block in the selected slot.

Constructors

PraosIsLeader
Fields praosIsLeaderVrfRes ∷ CertifiedVRF c InputVRF

Instances

Instances details

Generic (PraosIsLeader c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Associated Types type Rep (PraosIsLeader c) ∷ Type → Type # Methods from ∷ PraosIsLeader c → Rep (PraosIsLeader c) x # to ∷ Rep (PraosIsLeader c) x → PraosIsLeader c #
PraosCrypto c ⇒ NoThunks (PraosIsLeader c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods noThunks ∷ Context → PraosIsLeader c → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → PraosIsLeader c → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (PraosIsLeader c) → String Source #
type Rep (PraosIsLeader c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type Rep (PraosIsLeader c) = D1 ('MetaData "PraosIsLeader" "Ouroboros.Consensus.Protocol.Praos" "ouroboros-consensus-protocol-0.9.0.0-inplace" 'True) (C1 ('MetaCons "PraosIsLeader" 'PrefixI 'True) (S1 ('MetaSel ('Just "praosIsLeaderVrfRes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (CertifiedVRF c InputVRF))))

data PraosParams Source #

Praos parameters that are node independent

Constructors

PraosParams

Fields

praosSlotsPerKESPeriod ∷ !Word64
See slotsPerKESPeriod.
praosLeaderF ∷ !ActiveSlotCoeff
Active slots coefficient. This parameter represents the proportion of slots in which blocks should be issued. This can be interpreted as the probability that a party holding all the stake will be elected as leader for a given slot.
praosSecurityParam ∷ !SecurityParam
See securityParameter.
praosMaxKESEvo ∷ !Word64
Maximum number of KES iterations, see maxKESEvo.
praosQuorum ∷ !Word64
Quorum for update system votes and MIR certificates, see quorum.
praosMaxMajorPV ∷ !MaxMajorProtVer
All blocks invalid after this protocol version, see maxMajorPV.
praosMaxLovelaceSupply ∷ !Word64
Maximum number of lovelace in the system, see maxLovelaceSupply.
praosNetworkId ∷ !Network
Testnet or mainnet?
praosSystemStart ∷ !SystemStart
The system start, as projected from the chain's genesis block.
praosRandomnessStabilisationWindow ∷ !Word64
The number of slots before the start of an epoch where the corresponding epoch nonce is snapshotted. This has to be at least one stability window such that the nonce is stable at the beginning of the epoch. Ouroboros Genesis requires this to be even larger, see computeRandomnessStabilisationWindow.

Instances

Instances details

Generic PraosParams Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Associated Types type Rep PraosParams ∷ Type → Type # Methods from ∷ PraosParams → Rep PraosParams x # to ∷ Rep PraosParams x → PraosParams #
NoThunks PraosParams Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods noThunks ∷ Context → PraosParams → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → PraosParams → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy PraosParams → String Source #
type Rep PraosParams Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type Rep PraosParams = D1 ('MetaData "PraosParams" "Ouroboros.Consensus.Protocol.Praos" "ouroboros-consensus-protocol-0.9.0.0-inplace" 'False) (C1 ('MetaCons "PraosParams" 'PrefixI 'True) (((S1 ('MetaSel ('Just "praosSlotsPerKESPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64) :: S1 ('MetaSel ('Just "praosLeaderF") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 ActiveSlotCoeff)) :: (S1 ('MetaSel ('Just "praosSecurityParam") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SecurityParam) :: (S1 ('MetaSel ('Just "praosMaxKESEvo") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64) :: S1 ('MetaSel ('Just "praosQuorum") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64)))) :: ((S1 ('MetaSel ('Just "praosMaxMajorPV") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MaxMajorProtVer) :: S1 ('MetaSel ('Just "praosMaxLovelaceSupply") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64)) :: (S1 ('MetaSel ('Just "praosNetworkId") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Network) :: (S1 ('MetaSel ('Just "praosSystemStart") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SystemStart) :*: S1 ('MetaSel ('Just "praosRandomnessStabilisationWindow") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64))))))

data PraosState c Source #

Praos consensus state.

We track the last slot and the counters for operational certificates, as well as a series of nonces which get updated in different ways over the course of an epoch.

Constructors

PraosState

Fields

praosStateLastSlot ∷ !(WithOrigin SlotNo)
praosStateOCertCounters ∷ !(Map (KeyHash 'BlockIssuer c) Word64)
Operation Certificate counters
praosStateEvolvingNonce ∷ !Nonce
Evolving nonce
praosStateCandidateNonce ∷ !Nonce
Candidate nonce
praosStateEpochNonce ∷ !Nonce
Epoch nonce
praosStateLabNonce ∷ !Nonce
Nonce constructed from the hash of the previous block
praosStateLastEpochBlockNonce ∷ !Nonce
Nonce corresponding to the LAB nonce of the last block of the previous epoch

Instances

Instances details

Generic (PraosState c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Associated Types type Rep (PraosState c) ∷ Type → Type # Methods from ∷ PraosState c → Rep (PraosState c) x # to ∷ Rep (PraosState c) x → PraosState c #
Show (PraosState c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods showsPrec ∷ Int → PraosState c → ShowS # show ∷ PraosState c → String # showList ∷ [PraosState c] → ShowS #
PraosCrypto c ⇒ FromCBOR (PraosState c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods fromCBOR ∷ Decoder s (PraosState c) Source # label ∷ Proxy (PraosState c) → Text Source #
PraosCrypto c ⇒ ToCBOR (PraosState c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods toCBOR ∷ PraosState c → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (PraosState c) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [PraosState c] → Size Source #
Eq (PraosState c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods (==) ∷ PraosState c → PraosState c → Bool # (/=) ∷ PraosState c → PraosState c → Bool #
PraosCrypto c ⇒ NoThunks (PraosState c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods noThunks ∷ Context → PraosState c → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → PraosState c → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (PraosState c) → String Source #
PraosCrypto c ⇒ Serialise (PraosState c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods encode ∷ PraosState c → Encoding Source # decode ∷ Decoder s (PraosState c) Source # encodeList ∷ [PraosState c] → Encoding Source # decodeList ∷ Decoder s [PraosState c] Source #
type Rep (PraosState c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type Rep (PraosState c) = D1 ('MetaData "PraosState" "Ouroboros.Consensus.Protocol.Praos" "ouroboros-consensus-protocol-0.9.0.0-inplace" 'False) (C1 ('MetaCons "PraosState" 'PrefixI 'True) ((S1 ('MetaSel ('Just "praosStateLastSlot") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (WithOrigin SlotNo)) :: (S1 ('MetaSel ('Just "praosStateOCertCounters") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map (KeyHash 'BlockIssuer c) Word64)) :: S1 ('MetaSel ('Just "praosStateEvolvingNonce") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Nonce))) :: ((S1 ('MetaSel ('Just "praosStateCandidateNonce") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Nonce) :: S1 ('MetaSel ('Just "praosStateEpochNonce") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Nonce)) :: (S1 ('MetaSel ('Just "praosStateLabNonce") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Nonce) :: S1 ('MetaSel ('Just "praosStateLastEpochBlockNonce") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Nonce)))))
data Ticked (PraosState c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos data Ticked (PraosState c) = TickedPraosState { tickedPraosStateChainDepState ∷ PraosState c tickedPraosStateLedgerView ∷ LedgerView c }

data PraosToSign c Source #

Fields arising from praos execution which must be included in the block signature.

Constructors

PraosToSign

Fields

praosToSignIssuerVK ∷ VKey 'BlockIssuer c
Verification key for the issuer of this block.
praosToSignVrfVK ∷ VerKeyVRF c
praosToSignVrfRes ∷ CertifiedVRF c InputVRF
Verifiable random value. This is used both to prove the issuer is eligible to issue a block, and to contribute to the evolving nonce.
praosToSignOCert ∷ OCert c
Lightweight delegation certificate mapping the cold (DSIGN) key to the online KES key.

Instances

Instances details

Generic (PraosToSign c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Associated Types type Rep (PraosToSign c) ∷ Type → Type # Methods from ∷ PraosToSign c → Rep (PraosToSign c) x # to ∷ Rep (PraosToSign c) x → PraosToSign c #
PraosCrypto c ⇒ Show (PraosToSign c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods showsPrec ∷ Int → PraosToSign c → ShowS # show ∷ PraosToSign c → String # showList ∷ [PraosToSign c] → ShowS #
PraosCrypto c ⇒ NoThunks (PraosToSign c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods noThunks ∷ Context → PraosToSign c → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → PraosToSign c → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (PraosToSign c) → String Source #
type Rep (PraosToSign c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type Rep (PraosToSign c) = D1 ('MetaData "PraosToSign" "Ouroboros.Consensus.Protocol.Praos" "ouroboros-consensus-protocol-0.9.0.0-inplace" 'False) (C1 ('MetaCons "PraosToSign" 'PrefixI 'True) ((S1 ('MetaSel ('Just "praosToSignIssuerVK") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (VKey 'BlockIssuer c)) :: S1 ('MetaSel ('Just "praosToSignVrfVK") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (VerKeyVRF c))) :: (S1 ('MetaSel ('Just "praosToSignVrfRes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (CertifiedVRF c InputVRF)) :*: S1 ('MetaSel ('Just "praosToSignOCert") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (OCert c)))))

data PraosValidationErr c Source #

Errors which we might encounter

Constructors

VRFKeyUnknown !(KeyHash StakePool c)
VRFKeyWrongVRFKey !(KeyHash StakePool c) !(Hash c (VerKeyVRF c)) !(Hash c (VerKeyVRF c))
VRFKeyBadProof !SlotNo !Nonce !(CertifiedVRF (VRF c) InputVRF)
VRFLeaderValueTooBig Natural Rational ActiveSlotCoeff
KESBeforeStartOCERT !KESPeriod !KESPeriod
KESAfterEndOCERT !KESPeriod !KESPeriod !Word64
CounterTooSmallOCERT !Word64 !Word64
CounterOverIncrementedOCERT !Word64 !Word64	The KES counter has been incremented by more than 1
InvalidSignatureOCERT !Word64 !KESPeriod !String
InvalidKesSignatureOCERT !Word !Word !Word !String
NoCounterForKeyHashOCERT !(KeyHash 'BlockIssuer c)

Instances

Instances details

Generic (PraosValidationErr c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Associated Types type Rep (PraosValidationErr c) ∷ Type → Type # Methods from ∷ PraosValidationErr c → Rep (PraosValidationErr c) x # to ∷ Rep (PraosValidationErr c) x → PraosValidationErr c #
PraosCrypto c ⇒ Show (PraosValidationErr c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods showsPrec ∷ Int → PraosValidationErr c → ShowS # show ∷ PraosValidationErr c → String # showList ∷ [PraosValidationErr c] → ShowS #
PraosCrypto c ⇒ Eq (PraosValidationErr c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods (==) ∷ PraosValidationErr c → PraosValidationErr c → Bool # (/=) ∷ PraosValidationErr c → PraosValidationErr c → Bool #
PraosCrypto c ⇒ NoThunks (PraosValidationErr c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos Methods noThunks ∷ Context → PraosValidationErr c → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → PraosValidationErr c → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (PraosValidationErr c) → String Source #
type Rep (PraosValidationErr c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos type Rep (PraosValidationErr c) = D1 ('MetaData "PraosValidationErr" "Ouroboros.Consensus.Protocol.Praos" "ouroboros-consensus-protocol-0.9.0.0-inplace" 'False) (((C1 ('MetaCons "VRFKeyUnknown" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'StakePool c))) :+: C1 ('MetaCons "VRFKeyWrongVRFKey" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'StakePool c)) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Hash c (VerKeyVRF c))) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Hash c (VerKeyVRF c)))))) :+: (C1 ('MetaCons "VRFKeyBadProof" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SlotNo) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Nonce) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (CertifiedVRF (VRF c) InputVRF)))) :+: (C1 ('MetaCons "VRFLeaderValueTooBig" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Rational) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ActiveSlotCoeff))) :+: C1 ('MetaCons "KESBeforeStartOCERT" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KESPeriod) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KESPeriod))))) :+: ((C1 ('MetaCons "KESAfterEndOCERT" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KESPeriod) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KESPeriod) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64))) :+: (C1 ('MetaCons "CounterTooSmallOCERT" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64)) :+: C1 ('MetaCons "CounterOverIncrementedOCERT" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64)))) :+: (C1 ('MetaCons "InvalidSignatureOCERT" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KESPeriod) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String))) :+: (C1 ('MetaCons "InvalidKesSignatureOCERT" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word)) :: (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word) :: S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 String))) :+: C1 ('MetaCons "NoCounterForKeyHashOCERT" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (KeyHash 'BlockIssuer c)))))))

data family Ticked st Source #

" Ticked " piece of state, either LedgerState or ChainDepState

Ticking refers to the passage of time (the ticking of the clock). When a piece of state is marked as ticked, it means that time-related changes have been applied to the state. There are exactly two methods in the interface that do that: tickChainDepState and applyChainTickLedgerResult.

Also note that a successful forecast forecastFor (ledgerViewForecastAt cfg st) slot must equal protocolLedgerView cfg (applyChainTick cfg slot st). Thus a LedgerView can only be projected from a Ticked state, but cannot itself be ticked.

Some examples of time related changes:

Scheduled delegations might have been applied in Byron
New leader schedule computed for Shelley
Transition from Byron to Shelley activated in the hard fork combinator.
Nonces switched out at the start of a new epoch.

Instances

Instances details

Show (Ticked ())
Instance details Defined in Ouroboros.Consensus.Ticked Methods showsPrec ∷ Int → Ticked () → ShowS # show ∷ Ticked () → String # showList ∷ [Ticked ()] → ShowS #
Show (Ticked (f a)) ⇒ Show ((Ticked :.: f) a)
Instance details Defined in Ouroboros.Consensus.Ticked Methods showsPrec ∷ Int → (Ticked :.: f) a → ShowS # show ∷ (Ticked :.: f) a → String # showList ∷ [(Ticked :.: f) a] → ShowS #
NoThunks (Ticked (f a)) ⇒ NoThunks ((Ticked :.: f) a)
Instance details Defined in Ouroboros.Consensus.Ticked Methods noThunks ∷ Context → (Ticked :.: f) a → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → (Ticked :.: f) a → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy ((Ticked :.: f) a) → String Source #
data Ticked ()
Instance details Defined in Ouroboros.Consensus.Ticked data Ticked () = TickedTrivial
type HeaderHash (Ticked l ∷ Type)
Instance details Defined in Ouroboros.Consensus.Ticked type HeaderHash (Ticked l ∷ Type) = HeaderHash l
data Ticked (PraosState c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Praos data Ticked (PraosState c) = TickedPraosState { tickedPraosStateChainDepState ∷ PraosState c tickedPraosStateLedgerView ∷ LedgerView c }
data Ticked (TPraosState c) Source #
Instance details Defined in Ouroboros.Consensus.Protocol.TPraos data Ticked (TPraosState c) = TickedChainDepState { tickedTPraosStateChainDepState ∷ ChainDepState c tickedTPraosStateLedgerView ∷ LedgerView (TPraos c) }

forgePraosFields ∷ (PraosCrypto c, KESignable c toSign, Monad m) ⇒ HotKey c m → CanBeLeader (Praos c) → IsLeader (Praos c) → (PraosToSign c → toSign) → m (PraosFields c toSign) Source #

praosCheckCanForge ∷ ConsensusConfig (Praos c) → SlotNo → KESInfo → Either (PraosCannotForge c) () Source #