NOTE: The EpochInfo provided will have limited range, any attempt to look past its horizon will result in a pure PastHorizonException . The horizon is determined by the tip of the ledger state (not view) from which the EpochInfo is derived.

default completeLedgerConfig :: PartialLedgerConfig blk ~ LedgerConfig blk => proxy blk -> EpochInfo ( Except PastHorizonException ) -> PartialLedgerConfig blk -> LedgerConfig blk Source #

Newtype wrappers

newtype WrapPartialConsensusConfig blk Source #

Constructors

WrapPartialConsensusConfig
Fields unwrapPartialConsensusConfig :: PartialConsensusConfig ( BlockProtocol blk)

Instances

Instances details

NoThunks ( PartialConsensusConfig ( BlockProtocol blk)) => NoThunks ( WrapPartialConsensusConfig blk) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.PartialConfig Methods noThunks :: Context -> WrapPartialConsensusConfig blk -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> WrapPartialConsensusConfig blk -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( WrapPartialConsensusConfig blk) -> String Source #

newtype WrapPartialLedgerConfig blk Source #

Constructors

WrapPartialLedgerConfig
Fields unwrapPartialLedgerConfig :: PartialLedgerConfig blk

Instances

Instances details

NoThunks ( PartialLedgerConfig blk) => NoThunks ( WrapPartialLedgerConfig blk) Source #
Instance details Defined in Ouroboros.Consensus.HardFork.Combinator.PartialConfig Methods noThunks :: Context -> WrapPartialLedgerConfig blk -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> WrapPartialLedgerConfig blk -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( WrapPartialLedgerConfig blk) -> String Source #

Convenience re-exports

data EpochInfo (m :: Type -> Type ) Source #

Information about epochs

Different epochs may have different sizes and different slot lengths. This information is encapsulated by EpochInfo . It is parameterized over a monad m because the information about how long each epoch is may depend on information derived from the blockchain itself. It ultimately requires acess to state, and so either uses the monad for that or uses the monad to reify failure due to cached state information being too stale for the current query.

Constructors

EpochInfo

Fields

epochInfoSize_ :: HasCallStack => EpochNo -> m EpochSize

Return the size of the given epoch as a number of slots

Note that the number of slots does not bound the number of blocks, since the EBB and a regular block share a slot number.
epochInfoFirst_ :: HasCallStack => EpochNo -> m SlotNo

First slot in the specified epoch

See also epochInfoRange
epochInfoEpoch_ :: HasCallStack => SlotNo -> m EpochNo
Epoch containing the given slot

We should have the property that
```
s `inRange` epochInfoRange (epochInfoEpoch s)
```
epochInfoSlotToRelativeTime_ :: HasCallStack => SlotNo -> m RelativeTime

The RelativeTime of the start of the given slot

This calculation depends on the varying slot lengths of the relevant epochs.

See also epochInfoSlotToUTCTime .
epochInfoSlotLength_ :: HasCallStack => SlotNo -> m SlotLength

Return the length of the specified slot.

Instances

Instances details

Show ( EpochInfo f)	Unhelpful instance, but this type occurs in records (eg `Shelley.Globals` ) that we want to be able to `show`
Instance details Defined in Cardano.Slotting.EpochInfo.API Methods showsPrec :: Int -> EpochInfo f -> ShowS Source # show :: EpochInfo f -> String Source # showList :: [ EpochInfo f] -> ShowS Source #
NoThunks ( EpochInfo m)
Instance details Defined in Cardano.Slotting.EpochInfo.API Methods noThunks :: Context -> EpochInfo m -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> EpochInfo m -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( EpochInfo m) -> String Source #

type Except e = ExceptT e Identity Source #

The parameterizable exception monad.

Computations are either exceptions or normal values.

The return function returns a normal value, while >>= exits on the first exception. For a variant that continues after an error and collects all the errors, see Errors .

data PastHorizonException Source #

We tried to convert something that is past the horizon

That is, we tried to convert something that is past the point in time beyond which we lack information due to uncertainty about the next hard fork.

Instances

Instances details

Show PastHorizonException Source #
Instance details Defined in Ouroboros.Consensus.HardFork.History.Qry Methods showsPrec :: Int -> PastHorizonException -> ShowS Source # show :: PastHorizonException -> String Source # showList :: [ PastHorizonException ] -> ShowS Source #
Exception PastHorizonException Source #
Instance details Defined in Ouroboros.Consensus.HardFork.History.Qry Methods toException :: PastHorizonException -> SomeException Source # fromException :: SomeException -> Maybe PastHorizonException Source # displayException :: PastHorizonException -> String Source #