type Rep SystemStart
Instance details Defined in Cardano.Slotting.Time type Rep SystemStart = D1 ('MetaData "SystemStart" "Cardano.Slotting.Time" "cardano-slotting-0.2.1.0-07100409ee47709d5a70aa9944824dc8255e5cbe1b1f0ced97640bd26d62ab07" 'True) (C1 ('MetaCons "SystemStart" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSystemStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))

Methods

from ∷ SystemStart → Rep SystemStart x #

to ∷ Rep SystemStart x → SystemStart #

Show SystemStart Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

showsPrec ∷ Int → SystemStart → ShowS #

show ∷ SystemStart → String #

showList ∷ [SystemStart] → ShowS #

NoThunks SystemStart Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

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

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

showTypeOf ∷ Proxy SystemStart → String Source #

Serialise SystemStart Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

encode ∷ SystemStart → Encoding Source #

decode ∷ Decoder s SystemStart Source #

encodeList ∷ [SystemStart] → Encoding Source #

decodeList ∷ Decoder s [SystemStart] Source #

type Rep SystemStart Source #

Instance details

Defined in Cardano.Slotting.Time

type Rep SystemStart = D1 ('MetaData "SystemStart" "Cardano.Slotting.Time" "cardano-slotting-0.2.1.0-07100409ee47709d5a70aa9944824dc8255e5cbe1b1f0ced97640bd26d62ab07" 'True) (C1 ('MetaCons "SystemStart" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSystemStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))

Relative time

newtype RelativeTime Source #

RelativeTime is time relative to the SystemStart

Precision is in picoseconds

Constructors

RelativeTime
Fields getRelativeTime ∷ NominalDiffTime

Instances

Instances details

FromJSON RelativeTime Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

parseJSON ∷ Value → Parser RelativeTime Source #

parseJSONList ∷ Value → Parser [RelativeTime] Source #

omittedField ∷ Maybe RelativeTime Source #

ToJSON RelativeTime Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

toJSON ∷ RelativeTime → Value Source #

toEncoding ∷ RelativeTime → Encoding Source #

toJSONList ∷ [RelativeTime] → Value Source #

toEncodingList ∷ [RelativeTime] → Encoding Source #

omitField ∷ RelativeTime → Bool Source #

FromCBOR RelativeTime Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

fromCBOR ∷ Decoder s RelativeTime Source #

label ∷ Proxy RelativeTime → Text Source #

ToCBOR RelativeTime Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

toCBOR ∷ RelativeTime → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy RelativeTime → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [RelativeTime] → Size Source #

Eq RelativeTime Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

(==) ∷ RelativeTime → RelativeTime → Bool #

(/=) ∷ RelativeTime → RelativeTime → Bool #

Ord RelativeTime Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

compare ∷ RelativeTime → RelativeTime → Ordering #

(<) ∷ RelativeTime → RelativeTime → Bool #

(<=) ∷ RelativeTime → RelativeTime → Bool #

(>) ∷ RelativeTime → RelativeTime → Bool #

(>=) ∷ RelativeTime → RelativeTime → Bool #

max ∷ RelativeTime → RelativeTime → RelativeTime #

min ∷ RelativeTime → RelativeTime → RelativeTime #

Generic RelativeTime Source #

Instance details

Defined in Cardano.Slotting.Time

Associated Types

type Rep RelativeTime
Instance details Defined in Cardano.Slotting.Time type Rep RelativeTime = D1 ('MetaData "RelativeTime" "Cardano.Slotting.Time" "cardano-slotting-0.2.1.0-07100409ee47709d5a70aa9944824dc8255e5cbe1b1f0ced97640bd26d62ab07" 'True) (C1 ('MetaCons "RelativeTime" 'PrefixI 'True) (S1 ('MetaSel ('Just "getRelativeTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NominalDiffTime)))

Methods

from ∷ RelativeTime → Rep RelativeTime x #

to ∷ Rep RelativeTime x → RelativeTime #

Show RelativeTime Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

showsPrec ∷ Int → RelativeTime → ShowS #

show ∷ RelativeTime → String #

showList ∷ [RelativeTime] → ShowS #

NoThunks RelativeTime Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

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

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

showTypeOf ∷ Proxy RelativeTime → String Source #

Serialise RelativeTime Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

encode ∷ RelativeTime → Encoding Source #

decode ∷ Decoder s RelativeTime Source #

encodeList ∷ [RelativeTime] → Encoding Source #

decodeList ∷ Decoder s [RelativeTime] Source #

type Rep RelativeTime Source #

Instance details

Defined in Cardano.Slotting.Time

type Rep RelativeTime = D1 ('MetaData "RelativeTime" "Cardano.Slotting.Time" "cardano-slotting-0.2.1.0-07100409ee47709d5a70aa9944824dc8255e5cbe1b1f0ced97640bd26d62ab07" 'True) (C1 ('MetaCons "RelativeTime" 'PrefixI 'True) (S1 ('MetaSel ('Just "getRelativeTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NominalDiffTime)))

addRelTime ∷ NominalDiffTime → RelativeTime → RelativeTime Source #

diffRelTime ∷ RelativeTime → RelativeTime → NominalDiffTime Source #

fromRelativeTime ∷ SystemStart → RelativeTime → UTCTime Source #

toRelativeTime ∷ SystemStart → UTCTime → RelativeTime Source #

Get current time (as `RelativeTime`)

data SystemTime (m ∷ Type → Type) Source #

System time

Slots are counted from the system start.

Constructors

SystemTime

Fields

systemTimeCurrent ∷ m RelativeTime
Get current time (as a RelativeTime)
For real deployment, this will take the current UTCTime and then subtract the SystemStart (see defaultSystemTime). Tests don't bother with a UTCTime and just work entirely in RelativeTime.
systemTimeWait ∷ m ()
Wait for SystemStart
For the real deployment, this waits for the current UTCTime to reach SystemStart. In tests this does nothing.

Instances

Instances details

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

Attach an arrival time (as `RelativeTime`) to an object

data WithArrivalTime a Source #

WithArrivalTime

Constructors

WithArrivalTime
Fields getArrivalTime ∷ !RelativeTime The time at which the object arrived forgetArrivalTime ∷ !a The object without its arrival time

Instances

Instances details

Eq a ⇒ Eq (WithArrivalTime a) Source #

Instance details

Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types

Methods

(==) ∷ WithArrivalTime a → WithArrivalTime a → Bool #

(/=) ∷ WithArrivalTime a → WithArrivalTime a → Bool #

Ord a ⇒ Ord (WithArrivalTime a) Source #

Instance details

Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types

Methods

compare ∷ WithArrivalTime a → WithArrivalTime a → Ordering #

(<) ∷ WithArrivalTime a → WithArrivalTime a → Bool #

(<=) ∷ WithArrivalTime a → WithArrivalTime a → Bool #

(>) ∷ WithArrivalTime a → WithArrivalTime a → Bool #

(>=) ∷ WithArrivalTime a → WithArrivalTime a → Bool #

max ∷ WithArrivalTime a → WithArrivalTime a → WithArrivalTime a #

min ∷ WithArrivalTime a → WithArrivalTime a → WithArrivalTime a #

Generic (WithArrivalTime a) Source #

Instance details

Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types

Associated Types

type Rep (WithArrivalTime a)

Instance details

Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types

type Rep (WithArrivalTime a) = D1 ('MetaData "WithArrivalTime" "Ouroboros.Consensus.BlockchainTime.WallClock.Types" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "WithArrivalTime" 'PrefixI 'True) (S1 ('MetaSel ('Just "getArrivalTime") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RelativeTime) :*: S1 ('MetaSel ('Just "forgetArrivalTime") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)))

Methods

from ∷ WithArrivalTime a → Rep (WithArrivalTime a) x #

to ∷ Rep (WithArrivalTime a) x → WithArrivalTime a #

Show a ⇒ Show (WithArrivalTime a) Source #

Instance details

Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types

Methods

showsPrec ∷ Int → WithArrivalTime a → ShowS #

show ∷ WithArrivalTime a → String #

showList ∷ [WithArrivalTime a] → ShowS #

NoThunks a ⇒ NoThunks (WithArrivalTime a) Source #

Instance details

Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types

Methods

noThunks ∷ Context → WithArrivalTime a → IO (Maybe ThunkInfo) Source #

wNoThunks ∷ Context → WithArrivalTime a → IO (Maybe ThunkInfo) Source #

showTypeOf ∷ Proxy (WithArrivalTime a) → String Source #

IsPerasCert cert blk ⇒ IsPerasCert (WithArrivalTime cert) blk Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Cert.Class

Methods

getPerasCertRound ∷ WithArrivalTime cert → PerasRoundNo Source #

getPerasCertBlock ∷ WithArrivalTime cert → BoostedBlock (WithArrivalTime cert) Source #

getPerasCertPoint ∷ WithArrivalTime cert → Point blk Source #

IsPerasVote vote blk ⇒ IsPerasVote (WithArrivalTime vote) blk Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Vote.Class

Methods

getPerasVoteRound ∷ WithArrivalTime vote → PerasRoundNo Source #

getPerasVoteBlock ∷ WithArrivalTime vote → BoostedBlock (WithArrivalTime vote) Source #

getPerasVoteSeatIndex ∷ WithArrivalTime vote → PerasSeatIndex Source #

getPerasVotePoint ∷ WithArrivalTime vote → Point blk Source #

type Rep (WithArrivalTime a) Source #

Instance details

Defined in Ouroboros.Consensus.BlockchainTime.WallClock.Types

type Rep (WithArrivalTime a) = D1 ('MetaData "WithArrivalTime" "Ouroboros.Consensus.BlockchainTime.WallClock.Types" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "WithArrivalTime" 'PrefixI 'True) (S1 ('MetaSel ('Just "getArrivalTime") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 RelativeTime) :*: S1 ('MetaSel ('Just "forgetArrivalTime") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a)))

type BoostedBlock (WithArrivalTime voteOrCert) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Types

type BoostedBlock (WithArrivalTime voteOrCert) = BoostedBlock voteOrCert

addArrivalTime ∷ Monad m ⇒ SystemTime m → a → m (WithArrivalTime a) Source #

Add an arrival time to an object

Slot length

getSlotLength ∷ SlotLength → NominalDiffTime Source #

mkSlotLength ∷ NominalDiffTime → SlotLength Source #

Constructor for SlotLength

Conversions

slotLengthFromMillisec ∷ Integer → SlotLength Source #

slotLengthFromSec ∷ Integer → SlotLength Source #

slotLengthToMillisec ∷ SlotLength → Integer Source #

slotLengthToSec ∷ SlotLength → Integer Source #

opaque

data SlotLength Source #

Slot length

Precision is in milliseconds

Instances

Instances details

FromCBOR SlotLength Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

fromCBOR ∷ Decoder s SlotLength Source #

label ∷ Proxy SlotLength → Text Source #

ToCBOR SlotLength Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

toCBOR ∷ SlotLength → Encoding Source #

encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy SlotLength → Size Source #

encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [SlotLength] → Size Source #

Eq SlotLength Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

(==) ∷ SlotLength → SlotLength → Bool #

(/=) ∷ SlotLength → SlotLength → Bool #

Generic SlotLength Source #

Instance details

Defined in Cardano.Slotting.Time

Associated Types

type Rep SlotLength
Instance details Defined in Cardano.Slotting.Time type Rep SlotLength = D1 ('MetaData "SlotLength" "Cardano.Slotting.Time" "cardano-slotting-0.2.1.0-07100409ee47709d5a70aa9944824dc8255e5cbe1b1f0ced97640bd26d62ab07" 'True) (C1 ('MetaCons "SlotLength" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSlotLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NominalDiffTime)))

Methods

from ∷ SlotLength → Rep SlotLength x #

to ∷ Rep SlotLength x → SlotLength #

Show SlotLength Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

showsPrec ∷ Int → SlotLength → ShowS #

show ∷ SlotLength → String #

showList ∷ [SlotLength] → ShowS #

NoThunks SlotLength Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

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

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

showTypeOf ∷ Proxy SlotLength → String Source #

Serialise SlotLength Source #

Instance details

Defined in Cardano.Slotting.Time

Methods

encode ∷ SlotLength → Encoding Source #

decode ∷ Decoder s SlotLength Source #

encodeList ∷ [SlotLength] → Encoding Source #

decodeList ∷ Decoder s [SlotLength] Source #

type Rep SlotLength Source #

Instance details

Defined in Cardano.Slotting.Time

type Rep SlotLength = D1 ('MetaData "SlotLength" "Cardano.Slotting.Time" "cardano-slotting-0.2.1.0-07100409ee47709d5a70aa9944824dc8255e5cbe1b1f0ced97640bd26d62ab07" 'True) (C1 ('MetaCons "SlotLength" 'PrefixI 'True) (S1 ('MetaSel ('Just "getSlotLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NominalDiffTime)))

System time

Instances

Relative time

Instances

Get current time (as RelativeTime)

Instances

Attach an arrival time (as RelativeTime) to an object

Instances

Slot length

Conversions

opaque

Instances

Get current time (as `RelativeTime`)

Attach an arrival time (as `RelativeTime`) to an object