Modulekes-agent-crypto-1.2.0.0Haskell2010

Cardano.KESAgent.KES.Evolution

Functionality for handling key evolution within a KES agent or KES agent client.

1 type
9 values

Packagekes-agent-crypto-1.2.0.0
Exports10
LanguageHaskell2010
LicenceApache-2.0
SourceEvolution.hs

datadata EvolutionConfig

Evolution parameters used to determine which evolution of a given key is current, and when a key should evolve. Fields are named after the matching fields of the genesis JSON file.

Constructors

EvolutionConfig
- slotLength :: Int
- slotsPerKESPeriod :: Int
- systemStart :: UTCTime

Instances5Eq, Ord, Show, FromJSON, ToJSON

Eq EvolutionConfigDefined in kes-agent-crypto-1.2.0.0 · Cardano.KESAgent.KES.Evolution
Ord EvolutionConfigDefined in kes-agent-crypto-1.2.0.0 · Cardano.KESAgent.KES.Evolution
Show EvolutionConfigDefined in kes-agent-crypto-1.2.0.0 · Cardano.KESAgent.KES.Evolution
FromJSON EvolutionConfigDefined in kes-agent-crypto-1.2.0.0 · Cardano.KESAgent.KES.Evolution
ToJSON EvolutionConfigDefined in kes-agent-crypto-1.2.0.0 · Cardano.KESAgent.KES.Evolution

valuedefEvolutionConfig :: EvolutionConfig

Default evolution parameters, based on the parameters used on the real-world production ledger at the time of writing.

valueevolutionConfigFromGenesisFile

:: FilePath
-> IO (Either String EvolutionConfig)

Load evolution parameters from a genesis JSON file.

valuegetCurrentKESPeriod :: MonadTime m => EvolutionConfig -> m KESPeriod

Determine the current KES period from the local host's RTC.

valuegetCurrentKESPeriodAt :: UTCTime -> EvolutionConfig -> KESPeriod

Determine the current KES period from the local host's RTC, based on the given evolution parameters.

valuegetTimeToNextKESPeriod :: MonadTime m => EvolutionConfig -> m Int

valuegetTimeToNextKESPeriodAt :: UTCTime -> EvolutionConfig -> Int

valuegetKESPeriodTimes :: EvolutionConfig -> KESPeriod -> (UTCTime, UTCTime)

Get the start and end times of the give KES period, based on the given evolution parameters

valueupdateKESToCurrent

:: (KESAlgorithm (KES v), MonadTime m, MonadST m, MonadThrow m)
=> EvolutionConfig
-> ContextKES (KES v)
-> OCert v
-> SignKeyWithPeriodKES (KES v)
-> m (Maybe (SignKeyWithPeriodKES (KES v)))

Evolve a KES key to the current period. The old key will be released as appropriate. If the current period exceeds the key's available evolutions, return Nothing. If the specified period is before the key's current evolution, return Just the key at its current evolution.

valueupdateKESTo

:: (KESAlgorithm (KES v), MonadST m, MonadThrow m)
=> ContextKES (KES v)
-> KESPeriod
-> OCert v
-> SignKeyWithPeriodKES (KES v)
-> m (Maybe (SignKeyWithPeriodKES (KES v)))

Evolve a KES key to the specified period. The old key will be released as appropriate. If the specified period exceeds the key's available evolutions, return Nothing. If the specified period is before the key's current evolution, return Just the key at its current evolution.