Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Slotting.EpochInfo.API

Contents

Utility

Synopsis

data EpochInfo m = EpochInfo {
- epochInfoSize_ ∷ HasCallStack ⇒ EpochNo → m EpochSize
- epochInfoFirst_ ∷ HasCallStack ⇒ EpochNo → m SlotNo
- epochInfoEpoch_ ∷ HasCallStack ⇒ SlotNo → m EpochNo
- epochInfoSlotToRelativeTime_ ∷ HasCallStack ⇒ SlotNo → m RelativeTime
- epochInfoSlotLength_ ∷ HasCallStack ⇒ SlotNo → m SlotLength
}
epochInfoSize ∷ HasCallStack ⇒ EpochInfo m → EpochNo → m EpochSize
epochInfoFirst ∷ HasCallStack ⇒ EpochInfo m → EpochNo → m SlotNo
epochInfoEpoch ∷ HasCallStack ⇒ EpochInfo m → SlotNo → m EpochNo
epochInfoRange ∷ Monad m ⇒ EpochInfo m → EpochNo → m (SlotNo, SlotNo)
epochInfoSlotToRelativeTime ∷ HasCallStack ⇒ EpochInfo m → SlotNo → m RelativeTime
epochInfoSlotToUTCTime ∷ (HasCallStack, Monad m) ⇒ EpochInfo m → SystemStart → SlotNo → m UTCTime
epochInfoSlotLength ∷ HasCallStack ⇒ EpochInfo m → SlotNo → m SlotLength
hoistEpochInfo ∷ (∀ a. m a → n a) → EpochInfo m → EpochInfo n
generalizeEpochInfo ∷ Monad m ⇒ EpochInfo Identity → EpochInfo m

Documentation

data EpochInfo m Source #

Information about epochs

Different epochs may have different sizes and different slot lengths. This information is encapsulated by EpochInfo. It is parameterized over a monad m because the information about how long each epoch is may depend on information derived from the blockchain itself. It ultimately requires acess to state, and so either uses the monad for that or uses the monad to reify failure due to cached state information being too stale for the current query.

Constructors

EpochInfo

Fields

epochInfoSize_ ∷ HasCallStack ⇒ EpochNo → m EpochSize
Return the size of the given epoch as a number of slots
Note that the number of slots does not bound the number of blocks, since the EBB and a regular block share a slot number.
epochInfoFirst_ ∷ HasCallStack ⇒ EpochNo → m SlotNo
First slot in the specified epoch
See also epochInfoRange
epochInfoEpoch_ ∷ HasCallStack ⇒ SlotNo → m EpochNo
Epoch containing the given slot
We should have the property that
```
s `inRange` epochInfoRange (epochInfoEpoch s)
```
epochInfoSlotToRelativeTime_ ∷ HasCallStack ⇒ SlotNo → m RelativeTime
The RelativeTime of the start of the given slot
This calculation depends on the varying slot lengths of the relevant epochs.
See also epochInfoSlotToUTCTime.
epochInfoSlotLength_ ∷ HasCallStack ⇒ SlotNo → m SlotLength
Return the length of the specified slot.

Instances

Instances details

Show (EpochInfo f) Source #	Unhelpful instance, but this type occurs in records (eg `Shelley.Globals`) that we want to be able to `show`
Instance details Defined in Cardano.Slotting.EpochInfo.API Methods showsPrec ∷ Int → EpochInfo f → ShowS Source # show ∷ EpochInfo f → String Source # showList ∷ [EpochInfo f] → ShowS Source #
NoThunks (EpochInfo m) Source #
Instance details Defined in Cardano.Slotting.EpochInfo.API Methods noThunks ∷ Context → EpochInfo m → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → EpochInfo m → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (EpochInfo m) → String Source #

epochInfoSize ∷ HasCallStack ⇒ EpochInfo m → EpochNo → m EpochSize Source #

epochInfoFirst ∷ HasCallStack ⇒ EpochInfo m → EpochNo → m SlotNo Source #

epochInfoEpoch ∷ HasCallStack ⇒ EpochInfo m → SlotNo → m EpochNo Source #

epochInfoRange ∷ Monad m ⇒ EpochInfo m → EpochNo → m (SlotNo, SlotNo) Source #

epochInfoSlotToRelativeTime ∷ HasCallStack ⇒ EpochInfo m → SlotNo → m RelativeTime Source #

epochInfoSlotToUTCTime ∷ (HasCallStack, Monad m) ⇒ EpochInfo m → SystemStart → SlotNo → m UTCTime Source #

The start of the given slot

epochInfoSlotLength ∷ HasCallStack ⇒ EpochInfo m → SlotNo → m SlotLength Source #

Utility

hoistEpochInfo ∷ (∀ a. m a → n a) → EpochInfo m → EpochInfo n Source #

generalizeEpochInfo ∷ Monad m ⇒ EpochInfo Identity → EpochInfo m Source #