Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.BlockchainTime.API

Synopsis

data BlockchainTime (m ∷ Type → Type) = BlockchainTime {
- getCurrentSlot ∷ STM m CurrentSlot
}
data CurrentSlot
- = CurrentSlot !SlotNo
- | CurrentSlotUnknown
knownSlotWatcher ∷ IOLike m ⇒ BlockchainTime m → (SlotNo → m ()) → Watcher m SlotNo SlotNo

Documentation

data BlockchainTime (m ∷ Type → Type) Source #

Blockchain time

When we run the blockchain, there is a single, global time. We abstract over this here to allow to query this time (in terms of the current slot), and execute an action each time we advance a slot.

Constructors

BlockchainTime
Fields getCurrentSlot ∷ STM m CurrentSlot Get current slot

Instances

Instances details

NoThunks (BlockchainTime m) Source #
Instance details Defined in Ouroboros.Consensus.BlockchainTime.API Methods noThunks ∷ Context → BlockchainTime m → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → BlockchainTime m → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (BlockchainTime m) → String Source #

data CurrentSlot Source #

Constructors

CurrentSlot !SlotNo

The current slot is known

CurrentSlotUnknown

The current slot is not yet known

This only happens when the tip of the ledger is so far behind that we lack the information necessary to translate the current UTCTime into a SlotNo. This should only be the case during syncing.

Instances

Instances details

Generic CurrentSlot Source #

Instance details

Defined in Ouroboros.Consensus.BlockchainTime.API

Associated Types

type Rep CurrentSlot

Instance details

Defined in Ouroboros.Consensus.BlockchainTime.API

type Rep CurrentSlot = D1 ('MetaData "CurrentSlot" "Ouroboros.Consensus.BlockchainTime.API" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "CurrentSlot" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SlotNo)) :+: C1 ('MetaCons "CurrentSlotUnknown" 'PrefixI 'False) (U1 ∷ Type → Type))

Methods

from ∷ CurrentSlot → Rep CurrentSlot x #

to ∷ Rep CurrentSlot x → CurrentSlot #

Show CurrentSlot Source #

Instance details

Defined in Ouroboros.Consensus.BlockchainTime.API

Methods

showsPrec ∷ Int → CurrentSlot → ShowS #

show ∷ CurrentSlot → String #

showList ∷ [CurrentSlot] → ShowS #

NoThunks CurrentSlot Source #

Instance details

Defined in Ouroboros.Consensus.BlockchainTime.API

Methods

noThunks ∷ Context → CurrentSlot → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → CurrentSlot → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy CurrentSlot → String Source #

type Rep CurrentSlot Source #

Instance details

Defined in Ouroboros.Consensus.BlockchainTime.API

type Rep CurrentSlot = D1 ('MetaData "CurrentSlot" "Ouroboros.Consensus.BlockchainTime.API" "ouroboros-consensus-0.26.0.0-inplace" 'False) (C1 ('MetaCons "CurrentSlot" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SlotNo)) :+: C1 ('MetaCons "CurrentSlotUnknown" 'PrefixI 'False) (U1 ∷ Type → Type))

knownSlotWatcher Source #

Arguments

∷ IOLike m
⇒ BlockchainTime m
→ (SlotNo → m ())	Action to execute
→ Watcher m SlotNo SlotNo

Watches for changes in the current slot

The action will not be called until the current slot becomes known (if the tip of our ledger is too far away from the current wallclock time, we may not know what the current SlotNo is).