Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Protocol.Ledger.HotKey

Contents

Description

Hot key

Intended for qualified import

Synopsis

type KESEvolution = Period
data KESInfo = KESInfo {
- kesStartPeriod ∷ !KESPeriod
- kesEndPeriod ∷ !KESPeriod
- kesEvolution ∷ !KESEvolution
}
kesAbsolutePeriod ∷ KESInfo → KESPeriod
data KESStatus
- = BeforeKESStart KESPeriod KESPeriod
- | InKESRange KESEvolution
- | AfterKESEnd KESPeriod KESPeriod
kesStatus ∷ KESInfo → KESPeriod → KESStatus
data HotKey c m = HotKey {
- evolve ∷ KESPeriod → m KESEvolutionInfo
- getInfo ∷ m KESInfo
- isPoisoned ∷ m Bool
- sign_ ∷ ∀ toSign. (KESignable c toSign, HasCallStack) ⇒ toSign → m (SignedKES c toSign)
}
data KESEvolutionError
- = KESCouldNotEvolve KESInfo KESPeriod
- | KESKeyAlreadyPoisoned KESInfo KESPeriod
type KESEvolutionInfo = UpdateInfo KESInfo KESEvolutionError
mkHotKey ∷ ∀ m c. (Crypto c, IOLike m) ⇒ SignKeyKES c → KESPeriod → Word64 → m (HotKey c m)
sign ∷ (KESignable c toSign, HasCallStack) ⇒ HotKey c m → toSign → m (SignedKES c toSign)

KES Info

We call the relative periods that a KES key is valid its evolution, to avoid confusion with absolute periods.

Constructors

KESInfo
Fields kesStartPeriod ∷ !KESPeriod kesEndPeriod ∷ !KESPeriod Currently derived from `TPraosParams`: > kesEndPeriod = kesStartPeriod + tpraosMaxKESEvo kesEvolution ∷ !KESEvolution Current evolution or relative period. Invariant: > kesStartPeriod + kesEvolution in [kesStartPeriod, kesEndPeriod)

Instances details

Show KESInfo Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Ledger.HotKey Methods showsPrec ∷ Int → KESInfo → ShowS Source # show ∷ KESInfo → String Source # showList ∷ [KESInfo] → ShowS Source #
Generic KESInfo Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Ledger.HotKey Associated Types type Rep KESInfo ∷ Type → Type Source # Methods from ∷ KESInfo → Rep KESInfo x Source # to ∷ Rep KESInfo x → KESInfo Source #
NoThunks KESInfo Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Ledger.HotKey Methods noThunks ∷ Context → KESInfo → IO (Maybe ThunkInfo) # wNoThunks ∷ Context → KESInfo → IO (Maybe ThunkInfo) # showTypeOf ∷ Proxy KESInfo → String #
type Rep KESInfo Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Ledger.HotKey type Rep KESInfo = D1 ('MetaData "KESInfo" "Ouroboros.Consensus.Protocol.Ledger.HotKey" "ouroboros-consensus-protocol-0.3.1.0-inplace" 'False) (C1 ('MetaCons "KESInfo" 'PrefixI 'True) (S1 ('MetaSel ('Just "kesStartPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KESPeriod) :: (S1 ('MetaSel ('Just "kesEndPeriod") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KESPeriod) :: S1 ('MetaSel ('Just "kesEvolution") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 KESEvolution))))

Return the absolute KES period

KES Status

Constructors

BeforeKESStart	The given period is before the start period of the KES key.
Fields KESPeriod Given period KESPeriod Start period of the KES key
InKESRange KESEvolution	Relative period or evolution corresponding to the given absolute period
AfterKESEnd	The given period is after the end period of the KES key.
Fields KESPeriod Given period KESPeriod End period of the KES key

Return the evolution of the given KES period, when it falls within the range of the HotKey ([hkStart, hkEnd)).

Note that the upper bound is exclusive, the spec says: > c0 <= kesPeriod s < c0 + MaxKESEvo

API to interact with the key.

Constructors

Fields

evolve ∷ KESPeriod → m KESEvolutionInfo
Evolve the KES signing key to the given absolute KES period.
When the key cannot evolve anymore, we poison it.
getInfo ∷ m KESInfo
Return KESInfo of the signing key.
isPoisoned ∷ m Bool
Return True when the signing key is poisoned because it expired.
sign_ ∷ ∀ toSign. (KESignable c toSign, HasCallStack) ⇒ toSign → m (SignedKES c toSign)
Sign the given toSign with the current signing key.
PRECONDITION: the key is not poisoned.
POSTCONDITION: the signature is in normal form.

Failed to evolve the KES key.

Constructors

KESCouldNotEvolve KESInfo KESPeriod	The KES key could not be evolved to the target period.
KESKeyAlreadyPoisoned KESInfo KESPeriod	Target period outside the range of the current KES key. Typically the current KES period according to the wallclock slot.

Instances details

Show KESEvolutionError Source #
Instance details Defined in Ouroboros.Consensus.Protocol.Ledger.HotKey Methods showsPrec ∷ Int → KESEvolutionError → ShowS Source # show ∷ KESEvolutionError → String Source # showList ∷ [KESEvolutionError] → ShowS Source #

Result of evolving the KES key.

Arguments

sign ∷ (KESignable c toSign, HasCallStack) ⇒ HotKey c m → toSign → m (SignedKES c toSign) Source #