Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.HardFork.Combinator.State.Types

Contents

Main types
Supporting types

Synopsis

data Current f blk = Current {
- currentStart ∷ !Bound
- currentState ∷ !(f blk)
}
newtype HardForkState f xs = HardForkState {
- getHardForkState ∷ Telescope (K Past) (Current f) xs
}
data Past = Past {
- pastStart ∷ !Bound
- pastEnd ∷ !Bound
}
sequenceHardForkState ∷ ∀ m f xs. (All Top xs, Functor m) ⇒ HardForkState (m :.: f) xs → m (HardForkState f xs)
data TransitionInfo
- = TransitionUnknown !(WithOrigin SlotNo)
- | TransitionKnown !EpochNo
- | TransitionImpossible
newtype Translate f x y = Translate {
- translateWith ∷ EpochNo → f x → f y
}
newtype TranslateForecast f g x y = TranslateForecast {
- translateForecastWith ∷ Bound → SlotNo → f x → Except OutsideForecastRange (Ticked (g y))
}

Main types

data Current f blk Source #

Information about the current era

Constructors

Current
Fields currentStart ∷ !Bound currentState ∷ !(f blk)

Instances

Instances details

Eq (f blk) ⇒ Eq (Current f blk) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances Methods (==) ∷ Current f blk → Current f blk → Bool Source # (/=) ∷ Current f blk → Current f blk → Bool Source #
Show (f blk) ⇒ Show (Current f blk) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances Methods showsPrec ∷ Int → Current f blk → ShowS Source # show ∷ Current f blk → String Source # showList ∷ [Current f blk] → ShowS Source #
Generic (Current f blk) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Types Associated Types type Rep (Current f blk) ∷ Type → Type Source # Methods from ∷ Current f blk → Rep (Current f blk) x Source # to ∷ Rep (Current f blk) x → Current f blk Source #
Serialise (f blk) ⇒ Serialise (Current f blk) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances Methods encode ∷ Current f blk → Encoding # decode ∷ Decoder s (Current f blk) # encodeList ∷ [Current f blk] → Encoding # decodeList ∷ Decoder s [Current f blk] #
NoThunks (f blk) ⇒ NoThunks (Current f blk) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances Methods noThunks ∷ Context → Current f blk → IO (Maybe ThunkInfo) # wNoThunks ∷ Context → Current f blk → IO (Maybe ThunkInfo) # showTypeOf ∷ Proxy (Current f blk) → String #
type Rep (Current f blk) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Types type Rep (Current f blk) = D1 ('MetaData "Current" "Ouroboros.Consensus.HardFork.Combinator.State.Types" "ouroboros-consensus-0.3.1.0-inplace" 'False) (C1 ('MetaCons "Current" 'PrefixI 'True) (S1 ('MetaSel ('Just "currentStart") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bound) :*: S1 ('MetaSel ('Just "currentState") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (f blk))))

newtype HardForkState f xs Source #

Generic hard fork state

This is used both for the consensus state and the ledger state.

Constructors

HardForkState
Fields getHardForkState ∷ Telescope (K Past) (Current f) xs

Instances

Instances details

SerialiseHFC xs ⇒ DecodeDisk (HardForkBlock xs) (HardForkChainDepState xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods decodeDisk ∷ CodecConfig (HardForkBlock xs) → ∀ s. Decoder s (HardForkChainDepState xs) Source #
SerialiseHFC xs ⇒ EncodeDisk (HardForkBlock xs) (HardForkChainDepState xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Serialisation.SerialiseDisk Methods encodeDisk ∷ CodecConfig (HardForkBlock xs) → HardForkChainDepState xs → Encoding Source #
HAp HardForkState Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances Methods hap ∷ ∀ (f ∷ k → Type) (g ∷ k → Type) (xs ∷ l). Prod HardForkState (f -.-> g) xs → HardForkState f xs → HardForkState g xs #
HCollapse HardForkState Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances Methods hcollapse ∷ ∀ (xs ∷ l) a. SListIN HardForkState xs ⇒ HardForkState (K a) xs → CollapseTo HardForkState a #
HSequence HardForkState Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances Methods hsequence' ∷ ∀ (xs ∷ l) f (g ∷ k → Type). (SListIN HardForkState xs, Applicative f) ⇒ HardForkState (f :.: g) xs → f (HardForkState g xs) # hctraverse' ∷ ∀ c (xs ∷ l) g proxy f f'. (AllN HardForkState c xs, Applicative g) ⇒ proxy c → (∀ (a ∷ k). c a ⇒ f a → g (f' a)) → HardForkState f xs → g (HardForkState f' xs) # htraverse' ∷ ∀ (xs ∷ l) g f f'. (SListIN HardForkState xs, Applicative g) ⇒ (∀ (a ∷ k). f a → g (f' a)) → HardForkState f xs → g (HardForkState f' xs) #
(All SingleEraBlock xs, ∀ blk. SingleEraBlock blk ⇒ Eq (f blk)) ⇒ Eq (HardForkState f xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances Methods (==) ∷ HardForkState f xs → HardForkState f xs → Bool Source # (/=) ∷ HardForkState f xs → HardForkState f xs → Bool Source #
(All SingleEraBlock xs, ∀ blk. SingleEraBlock blk ⇒ Show (f blk)) ⇒ Show (HardForkState f xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances Methods showsPrec ∷ Int → HardForkState f xs → ShowS Source # show ∷ HardForkState f xs → String Source # showList ∷ [HardForkState f xs] → ShowS Source #
(All SingleEraBlock xs, ∀ blk. SingleEraBlock blk ⇒ NoThunks (f blk)) ⇒ NoThunks (HardForkState f xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances Methods noThunks ∷ Context → HardForkState f xs → IO (Maybe ThunkInfo) # wNoThunks ∷ Context → HardForkState f xs → IO (Maybe ThunkInfo) # showTypeOf ∷ Proxy (HardForkState f xs) → String #
data Ticked (HardForkChainDepState xs) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.Protocol data Ticked (HardForkChainDepState xs) = TickedHardForkChainDepState { tickedHardForkChainDepStatePerEra ∷ HardForkState (Ticked :.: WrapChainDepState) xs tickedHardForkChainDepStateEpochInfo ∷ EpochInfo (Except PastHorizonException) }
type Prod HardForkState Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances type Prod HardForkState = NP ∷ (Type → Type) → [Type] → Type
type SListIN HardForkState
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances type SListIN HardForkState = SListI ∷ [Type] → Constraint
type CollapseTo HardForkState a Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances type CollapseTo HardForkState a = a
type AllN HardForkState (c ∷ Type → Constraint) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances type AllN HardForkState (c ∷ Type → Constraint) = All c

data Past Source #

Information about a past era

Constructors

Past
Fields pastStart ∷ !Bound pastEnd ∷ !Bound

Instances

Instances details

Eq Past Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Types Methods (==) ∷ Past → Past → Bool Source # (/=) ∷ Past → Past → Bool Source #
Show Past Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Types Methods showsPrec ∷ Int → Past → ShowS Source # show ∷ Past → String Source # showList ∷ [Past] → ShowS Source #
Generic Past Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Types Associated Types type Rep Past ∷ Type → Type Source # Methods from ∷ Past → Rep Past x Source # to ∷ Rep Past x → Past Source #
Serialise Past Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances Methods encode ∷ Past → Encoding # decode ∷ Decoder s Past # encodeList ∷ [Past] → Encoding # decodeList ∷ Decoder s [Past] #
NoThunks Past Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Types Methods noThunks ∷ Context → Past → IO (Maybe ThunkInfo) # wNoThunks ∷ Context → Past → IO (Maybe ThunkInfo) # showTypeOf ∷ Proxy Past → String #
type Rep Past Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Types type Rep Past = D1 ('MetaData "Past" "Ouroboros.Consensus.HardFork.Combinator.State.Types" "ouroboros-consensus-0.3.1.0-inplace" 'False) (C1 ('MetaCons "Past" 'PrefixI 'True) (S1 ('MetaSel ('Just "pastStart") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bound) :*: S1 ('MetaSel ('Just "pastEnd") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bound)))

sequenceHardForkState ∷ ∀ m f xs. (All Top xs, Functor m) ⇒ HardForkState (m :.: f) xs → m (HardForkState f xs) Source #

Thin wrapper around sequence

Supporting types

data TransitionInfo Source #

Knowledge in a particular era of the transition to the next era

Constructors

TransitionUnknown !(WithOrigin SlotNo)

No transition is yet known for this era We instead record the ledger tip (which must be in this era)

NOTE: If we are forecasting, this will be set to the slot number of the (past) ledger state in which the forecast was created. This means that when we construct an EpochInfo using a HardForkLedgerView, the range of that EpochInfo will extend a safe zone from that past ledger state.

TransitionKnown !EpochNo

Transition to the next era is known to happen at this EpochNo

TransitionImpossible

The transition is impossible

This can be due to one of two reasons:

We are in the final era
This era has not actually begun yet (we are forecasting). In this case, we cannot look past the safe zone of this era and hence, by definition, the transition to the next era cannot happen.

Instances

Instances details

Show TransitionInfo Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Types Methods showsPrec ∷ Int → TransitionInfo → ShowS Source # show ∷ TransitionInfo → String Source # showList ∷ [TransitionInfo] → ShowS Source #
Generic TransitionInfo Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Types Associated Types type Rep TransitionInfo ∷ Type → Type Source # Methods from ∷ TransitionInfo → Rep TransitionInfo x Source # to ∷ Rep TransitionInfo x → TransitionInfo Source #
NoThunks TransitionInfo Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Types Methods noThunks ∷ Context → TransitionInfo → IO (Maybe ThunkInfo) # wNoThunks ∷ Context → TransitionInfo → IO (Maybe ThunkInfo) # showTypeOf ∷ Proxy TransitionInfo → String #
type Rep TransitionInfo Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Types type Rep TransitionInfo = D1 ('MetaData "TransitionInfo" "Ouroboros.Consensus.HardFork.Combinator.State.Types" "ouroboros-consensus-0.3.1.0-inplace" 'False) (C1 ('MetaCons "TransitionUnknown" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (WithOrigin SlotNo))) :+: (C1 ('MetaCons "TransitionKnown" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 EpochNo)) :+: C1 ('MetaCons "TransitionImpossible" 'PrefixI 'False) (U1 ∷ Type → Type)))

newtype Translate f x y Source #

Translate f x to f y across an era transition

Typically f will be LedgerState or WrapChainDepState.

Constructors

Translate
Fields translateWith ∷ EpochNo → f x → f y

newtype TranslateForecast f g x y Source #

Translate (a forecast of) f x to (a forecast of) f y across an era transition.

Typically f will be WrapLedgerView.

In addition to the Bound of the transition, this is also told the SlotNo we're constructing a forecast for. This enables the translation function to take into account any scheduled changes that the final ledger view in the preceding era might have.

Constructors

TranslateForecast
Fields translateForecastWith ∷ Bound → SlotNo → f x → Except OutsideForecastRange (Ticked (g y))