Safe Haskell	Safe-Inferred
Language	GHC2021

Hydra.Chain.Direct.TimeHandle

Description

Module to deal with time in direct cardano chain layer. Defines the type for a PointInTime and a means to acquire one via a TimeHandle and queryTimeHandle.

Synopsis

type PointInTime = (SlotNo, UTCTime)
data TimeHandle = TimeHandle {
- currentPointInTime :: Either Text PointInTime
- slotFromUTCTime :: UTCTime -> Either Text SlotNo
- slotToUTCTime :: SlotNo -> Either Text UTCTime
}
data TimeHandleParams = TimeHandleParams {
- systemStart :: SystemStart
- eraHistory :: EraHistory
- horizonSlot :: SlotNo
- currentSlot :: SlotNo
}
genTimeParams :: Gen TimeHandleParams
mkTimeHandle :: HasCallStack => SlotNo -> SystemStart -> EraHistory -> TimeHandle
queryTimeHandle :: NetworkId -> SocketPath -> IO TimeHandle

Documentation

type PointInTime = (SlotNo, UTCTime) Source #

data TimeHandle Source #

Constructors

TimeHandle
Fields currentPointInTime :: Either Text PointInTime Get the current `PointInTime` slotFromUTCTime :: UTCTime -> Either Text SlotNo Lookup slot number given a `UTCTime`. This will fail if the time is outside the "safe zone". slotToUTCTime :: SlotNo -> Either Text UTCTime Convert a slot number to a `UTCTime` using the stored epoch info. This will fail if the slot is outside the "safe zone".

Instances

Instances details

Arbitrary TimeHandle Source #
Instance details Defined in Hydra.Chain.Direct.TimeHandle Methods arbitrary :: Gen TimeHandle shrink :: TimeHandle -> [TimeHandle]

data TimeHandleParams Source #

Constructors

TimeHandleParams
Fields systemStart :: SystemStart eraHistory :: EraHistory horizonSlot :: SlotNo currentSlot :: SlotNo

genTimeParams :: Gen TimeHandleParams Source #

Generate consistent values for SystemStart and EraHistory which has a horizon at the returned SlotNo as well as some UTCTime before that

mkTimeHandle :: HasCallStack => SlotNo -> SystemStart -> EraHistory -> TimeHandle Source #

Construct a time handle using current slot and given chain parameters. See queryTimeHandle to create one by querying a cardano-node.

queryTimeHandle :: NetworkId -> SocketPath -> IO TimeHandle Source #

Query node for system start and era history before constructing a TimeHandle using the slot at the tip of the network.