Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.HardFork.Combinator.State

Contents

Support for defining instances
Serialisation support
EpochInfo
Ledger specific functionality

Description

Intended for qualified import

import Ouroboros.Consensus.HardFork.Combinator.State (HardForkState(..))
import qualified Ouroboros.Consensus.HardFork.Combinator.State as State

Synopsis

data TransitionInfo
- = TransitionUnknown !( WithOrigin SlotNo )
- | TransitionKnown ! EpochNo
- | TransitionImpossible
newtype TranslateForecast f g x y = TranslateForecast {
- translateForecastWith :: Bound -> SlotNo -> f x -> Except OutsideForecastRange ( Ticked (g y))
}
newtype Translate f x y = Translate {
- translateWith :: EpochNo -> f x -> f y
}
data Past = Past {
- pastStart :: ! Bound
- pastEnd :: ! Bound
}
data Current f blk = Current {
- currentStart :: ! Bound
- currentState :: !(f blk)
}
newtype HardForkState f xs = HardForkState {
- getHardForkState :: Telescope ( K Past ) ( Current f) xs
}
sequenceHardForkState :: forall m f xs. ( All Top xs, Functor m) => HardForkState (m :.: f) xs -> m ( HardForkState f xs)
data Situated h f xs where
- SituatedCurrent :: Current f x -> h x -> Situated h f (x ': xs)
- SituatedNext :: Current f x -> h y -> Situated h f (x ': (y ': xs))
- SituatedFuture :: Current f x -> NS h xs -> Situated h f (x ': (y ': xs))
- SituatedPast :: K Past x -> h x -> Situated h f (x ': xs)
- SituatedShift :: Situated h f xs -> Situated h f (x ': xs)
initHardForkState :: f x -> HardForkState f (x ': xs)
tip :: SListI xs => HardForkState f xs -> NS f xs
match :: SListI xs => NS h xs -> HardForkState f xs -> Either ( Mismatch h ( Current f) xs) ( HardForkState ( Product h f) xs)
sequence :: forall f m xs. ( SListI xs, Functor m) => HardForkState (m :.: f) xs -> m ( HardForkState f xs)
fromTZ :: HardForkState f '[blk] -> f blk
situate :: NS h xs -> HardForkState f xs -> Situated h f xs
align :: forall xs f f' f''. All SingleEraBlock xs => InPairs ( Translate f) xs -> NP (f' -.-> (f -.-> f'')) xs -> HardForkState f' xs -> HardForkState f xs -> HardForkState f'' xs
reconstructSummary :: Shape xs -> TransitionInfo -> HardForkState f xs -> Summary xs
getTip :: forall f xs. CanHardFork xs => ( forall blk. SingleEraBlock blk => f blk -> Point blk) -> HardForkState f xs -> Point ( HardForkBlock xs)
recover :: forall f xs. CanHardFork xs => Telescope ( K Past ) f xs -> HardForkState f xs
epochInfoLedger :: All SingleEraBlock xs => HardForkLedgerConfig xs -> HardForkState LedgerState xs -> EpochInfo ( Except PastHorizonException )
epochInfoPrecomputedTransitionInfo :: Shape xs -> TransitionInfo -> HardForkState f xs -> EpochInfo ( Except PastHorizonException )
mostRecentTransitionInfo :: All SingleEraBlock xs => HardForkLedgerConfig xs -> HardForkState LedgerState xs -> TransitionInfo
reconstructSummaryLedger :: All SingleEraBlock xs => HardForkLedgerConfig xs -> HardForkState LedgerState xs -> Summary xs
extendToSlot :: forall xs. CanHardFork xs => HardForkLedgerConfig xs -> SlotNo -> HardForkState LedgerState xs -> HardForkState LedgerState xs

Documentation

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 ) Source # wNoThunks :: Context -> TransitionInfo -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy TransitionInfo -> String Source #
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.1.0.1-DT4Cvwf63DZKctsEvaJqCU" ' 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 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))

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

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 #
NoThunks Past Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Types Methods noThunks :: Context -> Past -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> Past -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy Past -> String Source #
Serialise Past Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances Methods encode :: Past -> Encoding Source # decode :: Decoder s Past Source # encodeList :: [ Past ] -> Encoding Source # decodeList :: Decoder s [ Past ] Source #
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.1.0.1-DT4Cvwf63DZKctsEvaJqCU" ' False ) ( C1 (' MetaCons "Past" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "pastStart") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Bound ) :*: S1 (' MetaSel (' Just "pastEnd") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 Bound )))

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 #
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 ) Source # wNoThunks :: Context -> Current f blk -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( Current f blk) -> String 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 Source # decode :: Decoder s ( Current f blk) Source # encodeList :: [ Current f blk] -> Encoding Source # decodeList :: Decoder s [ Current f blk] Source #
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.1.0.1-DT4Cvwf63DZKctsEvaJqCU" ' 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) -> forall 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 :: forall (f :: k -> Type ) (g :: k -> Type ) (xs :: l). Prod HardForkState (f -.-> g) xs -> HardForkState f xs -> HardForkState g xs Source #
HCollapse HardForkState Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances Methods hcollapse :: forall (xs :: l) a. SListIN HardForkState xs => HardForkState ( K a) xs -> CollapseTo HardForkState a Source #
HSequence HardForkState Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.State.Instances Methods hsequence' :: forall (xs :: l) f (g :: k -> Type ). ( SListIN HardForkState xs, Applicative f) => HardForkState (f :.: g) xs -> f ( HardForkState g xs) Source # hctraverse' :: forall c (xs :: l) g proxy f f'. ( AllN HardForkState c xs, Applicative g) => proxy c -> ( forall (a :: k). c a => f a -> g (f' a)) -> HardForkState f xs -> g ( HardForkState f' xs) Source # htraverse' :: forall (xs :: l) g f f'. ( SListIN HardForkState xs, Applicative g) => ( forall (a :: k). f a -> g (f' a)) -> HardForkState f xs -> g ( HardForkState f' xs) Source #
( All SingleEraBlock xs, forall 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, forall 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, forall 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 ) Source # wNoThunks :: Context -> HardForkState f xs -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( HardForkState f xs) -> String Source #
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 Source #
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

sequenceHardForkState :: forall m f xs. ( All Top xs, Functor m) => HardForkState (m :.: f) xs -> m ( HardForkState f xs) Source #

Thin wrapper around sequence

data Situated h f xs where Source #

A h situated in time

Constructors

SituatedCurrent :: Current f x -> h x -> Situated h f (x ': xs)
SituatedNext :: Current f x -> h y -> Situated h f (x ': (y ': xs))
SituatedFuture :: Current f x -> NS h xs -> Situated h f (x ': (y ': xs))
SituatedPast :: K Past x -> h x -> Situated h f (x ': xs)
SituatedShift :: Situated h f xs -> Situated h f (x ': xs)

initHardForkState :: f x -> HardForkState f (x ': xs) Source #

tip :: SListI xs => HardForkState f xs -> NS f xs Source #

match :: SListI xs => NS h xs -> HardForkState f xs -> Either ( Mismatch h ( Current f) xs) ( HardForkState ( Product h f) xs) Source #

sequence :: forall f m xs. ( SListI xs, Functor m) => HardForkState (m :.: f) xs -> m ( HardForkState f xs) Source #

fromTZ :: HardForkState f '[blk] -> f blk Source #

situate :: NS h xs -> HardForkState f xs -> Situated h f xs Source #

align Source #

Arguments

:: forall xs f f' f''. All SingleEraBlock xs
=> InPairs ( Translate f) xs
-> NP (f' -.-> (f -.-> f'')) xs
-> HardForkState f' xs	State we are aligning with
-> HardForkState f xs	State we are aligning
-> HardForkState f'' xs

reconstructSummary Source #

Arguments

:: Shape xs
-> TransitionInfo	At the tip
-> HardForkState f xs
-> Summary xs

Support for defining instances

getTip :: forall f xs. CanHardFork xs => ( forall blk. SingleEraBlock blk => f blk -> Point blk) -> HardForkState f xs -> Point ( HardForkBlock xs) Source #

Serialisation support

recover :: forall f xs. CanHardFork xs => Telescope ( K Past ) f xs -> HardForkState f xs Source #

Recover HardForkState from partial information

The primary goal of this is to make sure that for the current state we really only need to store the underlying f . It is not strictly essential that this is possible but it helps with the unary hardfork case, and it may in general help with binary compatibility.

EpochInfo

epochInfoLedger :: All SingleEraBlock xs => HardForkLedgerConfig xs -> HardForkState LedgerState xs -> EpochInfo ( Except PastHorizonException ) Source #

Construct EpochInfo from the ledger state

NOTE: The resulting EpochInfo is a snapshot only, with a limited range. It should not be stored.

epochInfoPrecomputedTransitionInfo :: Shape xs -> TransitionInfo -> HardForkState f xs -> EpochInfo ( Except PastHorizonException ) Source #

Construct EpochInfo given precomputed TransitionInfo

The transition and state arguments are acquired either from a ticked ledger state or a ticked ledger view.

mostRecentTransitionInfo :: All SingleEraBlock xs => HardForkLedgerConfig xs -> HardForkState LedgerState xs -> TransitionInfo Source #

reconstructSummaryLedger :: All SingleEraBlock xs => HardForkLedgerConfig xs -> HardForkState LedgerState xs -> Summary xs Source #

Ledger specific functionality

extendToSlot :: forall xs. CanHardFork xs => HardForkLedgerConfig xs -> SlotNo -> HardForkState LedgerState xs -> HardForkState LedgerState xs Source #

Extend the telescope until the specified slot is within the era at the tip