Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.HardFork.History.EraParams

Contents

API
Defaults

Synopsis

data EraParams = EraParams {
- eraEpochSize ∷ !EpochSize
- eraSlotLength ∷ !SlotLength
- eraSafeZone ∷ !SafeZone
- eraGenesisWin ∷ !GenesisWindow
- eraPerasRoundLength ∷ !(PerasEnabled PerasRoundLength)
}
data SafeZone
- = StandardSafeZone !Word64
- | UnsafeIndefiniteSafeZone
data PerasEnabled a
pattern PerasEnabled ∷ a → PerasEnabled a
pattern NoPerasEnabled ∷ PerasEnabled a
newtype PerasEnabledT (m ∷ Type → Type) a = PerasEnabledT {
- runPerasEnabledT ∷ m (PerasEnabled a)
}
fromPerasEnabled ∷ a → PerasEnabled a → a
perasEnabledToMaybe ∷ PerasEnabled a → Maybe a
defaultEraParams ∷ SecurityParam → SlotLength → PerasEnabled () → EraParams

API

data EraParams Source #

Parameters that can vary across hard forks

Constructors

EraParams
Fields eraEpochSize ∷ !EpochSize eraSlotLength ∷ !SlotLength eraSafeZone ∷ !SafeZone eraGenesisWin ∷ !GenesisWindow eraPerasRoundLength ∷ !(PerasEnabled PerasRoundLength) Optional, as not every era will be Peras-enabled

Instances

Instances details

Eq EraParams Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.History.EraParams

Methods

(==) ∷ EraParams → EraParams → Bool #

(/=) ∷ EraParams → EraParams → Bool #

Generic EraParams Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.History.EraParams

Associated Types

type Rep EraParams

Instance details

Defined in Ouroboros.Consensus.HardFork.History.EraParams

type Rep EraParams = D1 ('MetaData "EraParams" "Ouroboros.Consensus.HardFork.History.EraParams" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "EraParams" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eraEpochSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 EpochSize) :*: S1 ('MetaSel ('Just "eraSlotLength") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SlotLength)) :*: (S1 ('MetaSel ('Just "eraSafeZone") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SafeZone) :*: (S1 ('MetaSel ('Just "eraGenesisWin") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GenesisWindow) :*: S1 ('MetaSel ('Just "eraPerasRoundLength") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PerasEnabled PerasRoundLength))))))

Methods

from ∷ EraParams → Rep EraParams x #

to ∷ Rep EraParams x → EraParams #

Show EraParams Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.History.EraParams

Methods

showsPrec ∷ Int → EraParams → ShowS #

show ∷ EraParams → String #

showList ∷ [EraParams] → ShowS #

NoThunks EraParams Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.History.EraParams

Methods

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

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

showTypeOf ∷ Proxy EraParams → String Source #

Serialise EraParams Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.History.EraParams

Methods

encode ∷ EraParams → Encoding Source #

decode ∷ Decoder s EraParams Source #

encodeList ∷ [EraParams] → Encoding Source #

decodeList ∷ Decoder s [EraParams] Source #

type Rep EraParams Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.History.EraParams

type Rep EraParams = D1 ('MetaData "EraParams" "Ouroboros.Consensus.HardFork.History.EraParams" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "EraParams" 'PrefixI 'True) ((S1 ('MetaSel ('Just "eraEpochSize") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 EpochSize) :*: S1 ('MetaSel ('Just "eraSlotLength") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SlotLength)) :*: (S1 ('MetaSel ('Just "eraSafeZone") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 SafeZone) :*: (S1 ('MetaSel ('Just "eraGenesisWin") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 GenesisWindow) :*: S1 ('MetaSel ('Just "eraPerasRoundLength") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (PerasEnabled PerasRoundLength))))))

data SafeZone Source #

Zone in which it is guaranteed that no hard fork can take place

Constructors

StandardSafeZone !Word64

Standard safe zone

We record

Number of slots from the tip of the ledger. This should be (at least) the number of slots in which we are guaranteed to have k blocks.

UnsafeIndefiniteSafeZone

Pretend the transition to the next era will not take place.

This constructor is marked as unsafe because it effectively extends the safe zone of this era indefinitely into the future. This means that we might reach invalid conclusions when doing

slot to time conversions for blocks that are past the actual safe zone
time to slot conversions for the current time, when behind in syncing

This is safe when the code is simply not yet ready to transition to the next era, because in that case, we can be sure that blocks that come in are still from this era. It also means that we can always produce a block, no matter how far ahead of the current ledger we are.

If the code is ready for the transition, just awaiting an update proposal, then LowerBound can be used instead.

This constructor can be regarded as an " extreme " version of LowerBound, and can be used for similar reasons.

Instances

Instances details

Eq SafeZone Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.History.EraParams

Methods

(==) ∷ SafeZone → SafeZone → Bool #

(/=) ∷ SafeZone → SafeZone → Bool #

Generic SafeZone Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.History.EraParams

Associated Types

type Rep SafeZone

Instance details

Defined in Ouroboros.Consensus.HardFork.History.EraParams

type Rep SafeZone = D1 ('MetaData "SafeZone" "Ouroboros.Consensus.HardFork.History.EraParams" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "StandardSafeZone" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64)) :+: C1 ('MetaCons "UnsafeIndefiniteSafeZone" 'PrefixI 'False) (U1 ∷ Type → Type))

Methods

from ∷ SafeZone → Rep SafeZone x #

to ∷ Rep SafeZone x → SafeZone #

Show SafeZone Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.History.EraParams

Methods

showsPrec ∷ Int → SafeZone → ShowS #

show ∷ SafeZone → String #

showList ∷ [SafeZone] → ShowS #

NoThunks SafeZone Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.History.EraParams

Methods

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

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

showTypeOf ∷ Proxy SafeZone → String Source #

Serialise SafeZone Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.History.EraParams

Methods

encode ∷ SafeZone → Encoding Source #

decode ∷ Decoder s SafeZone Source #

encodeList ∷ [SafeZone] → Encoding Source #

decodeList ∷ Decoder s [SafeZone] Source #

type Rep SafeZone Source #

Instance details

Defined in Ouroboros.Consensus.HardFork.History.EraParams

type Rep SafeZone = D1 ('MetaData "SafeZone" "Ouroboros.Consensus.HardFork.History.EraParams" "ouroboros-consensus-4.0.0.0-inplace" 'False) (C1 ('MetaCons "StandardSafeZone" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Word64)) :+: C1 ('MetaCons "UnsafeIndefiniteSafeZone" 'PrefixI 'False) (U1 ∷ Type → Type))

data PerasEnabled a Source #

A marker for Peras-specific values that are not present in all eras

Instances

Instances details

Applicative PerasEnabled Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Params

Methods

pure ∷ a → PerasEnabled a #

(<*>) ∷ PerasEnabled (a → b) → PerasEnabled a → PerasEnabled b #

liftA2 ∷ (a → b → c) → PerasEnabled a → PerasEnabled b → PerasEnabled c #

(*>) ∷ PerasEnabled a → PerasEnabled b → PerasEnabled b #

(<*) ∷ PerasEnabled a → PerasEnabled b → PerasEnabled a #

Functor PerasEnabled Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Params

Methods

fmap ∷ (a → b) → PerasEnabled a → PerasEnabled b #

(<$) ∷ a → PerasEnabled b → PerasEnabled a #

Monad PerasEnabled Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Params

Methods

(>>=) ∷ PerasEnabled a → (a → PerasEnabled b) → PerasEnabled b #

(>>) ∷ PerasEnabled a → PerasEnabled b → PerasEnabled b #

return ∷ a → PerasEnabled a #

FromCBOR a ⇒ FromCBOR (PerasEnabled a) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Params

Methods

fromCBOR ∷ Decoder s (PerasEnabled a) Source #

label ∷ Proxy (PerasEnabled a) → Text Source #

ToCBOR a ⇒ ToCBOR (PerasEnabled a) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Params

Methods

toCBOR ∷ PerasEnabled a → Encoding Source #

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

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

Eq a ⇒ Eq (PerasEnabled a) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Params

Methods

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

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

Ord a ⇒ Ord (PerasEnabled a) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Params

Methods

compare ∷ PerasEnabled a → PerasEnabled a → Ordering #

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

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

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

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

max ∷ PerasEnabled a → PerasEnabled a → PerasEnabled a #

min ∷ PerasEnabled a → PerasEnabled a → PerasEnabled a #

Generic (PerasEnabled a) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Params

Associated Types

type Rep (PerasEnabled a)
Instance details Defined in Ouroboros.Consensus.Peras.Params type Rep (PerasEnabled a) = D1 ('MetaData "PerasEnabled" "Ouroboros.Consensus.Peras.Params" "ouroboros-consensus-4.0.0.0-inplace" 'True) (C1 ('MetaCons "MkPerasEnabled" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe a))))

Methods

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

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

Show a ⇒ Show (PerasEnabled a) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Params

Methods

showsPrec ∷ Int → PerasEnabled a → ShowS #

show ∷ PerasEnabled a → String #

showList ∷ [PerasEnabled a] → ShowS #

NoThunks a ⇒ NoThunks (PerasEnabled a) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Params

Methods

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

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

showTypeOf ∷ Proxy (PerasEnabled a) → String Source #

type Rep (PerasEnabled a) Source #

Instance details

Defined in Ouroboros.Consensus.Peras.Params

type Rep (PerasEnabled a) = D1 ('MetaData "PerasEnabled" "Ouroboros.Consensus.Peras.Params" "ouroboros-consensus-4.0.0.0-inplace" 'True) (C1 ('MetaCons "MkPerasEnabled" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe a))))

pattern PerasEnabled ∷ a → PerasEnabled a Source #

pattern NoPerasEnabled ∷ PerasEnabled a Source #

newtype PerasEnabledT (m ∷ Type → Type) a Source #

A MaybeT-like monad transformer.

Used solely for the Peras-related hard fork combinator queries, see Qry.

Constructors

PerasEnabledT
Fields runPerasEnabledT ∷ m (PerasEnabled a)

Instances

Instances details

MonadTrans PerasEnabledT Source #
Instance details Defined in Ouroboros.Consensus.Peras.Params Methods lift ∷ Monad m ⇒ m a → PerasEnabledT m a #
(Functor m, Monad m) ⇒ Applicative (PerasEnabledT m) Source #
Instance details Defined in Ouroboros.Consensus.Peras.Params Methods pure ∷ a → PerasEnabledT m a # (<>) ∷ PerasEnabledT m (a → b) → PerasEnabledT m a → PerasEnabledT m b # liftA2 ∷ (a → b → c) → PerasEnabledT m a → PerasEnabledT m b → PerasEnabledT m c # (>) ∷ PerasEnabledT m a → PerasEnabledT m b → PerasEnabledT m b # (<*) ∷ PerasEnabledT m a → PerasEnabledT m b → PerasEnabledT m a #
Functor m ⇒ Functor (PerasEnabledT m) Source #
Instance details Defined in Ouroboros.Consensus.Peras.Params Methods fmap ∷ (a → b) → PerasEnabledT m a → PerasEnabledT m b # (<$) ∷ a → PerasEnabledT m b → PerasEnabledT m a #
Monad m ⇒ Monad (PerasEnabledT m) Source #
Instance details Defined in Ouroboros.Consensus.Peras.Params Methods (>>=) ∷ PerasEnabledT m a → (a → PerasEnabledT m b) → PerasEnabledT m b # (>>) ∷ PerasEnabledT m a → PerasEnabledT m b → PerasEnabledT m b # return ∷ a → PerasEnabledT m a #

fromPerasEnabled ∷ a → PerasEnabled a → a Source #

A fromMaybe-like eliminator for PerasEnabled

perasEnabledToMaybe ∷ PerasEnabled a → Maybe a Source #

Return the underlying Maybe of a PerasEnabled value.

Defaults

defaultEraParams ∷ SecurityParam → SlotLength → PerasEnabled () → EraParams Source #

Default EraParams

We set

epoch size to 10*k slots
the safe zone to 2*k slots
the upper bound to NoLowerBound
the Peras Round Length is set to 2*k slots if peras is enabled (because it must be a divisor of the epoch size)

This is primarily useful for tests.