Safe Haskell	None
Language	Haskell2010

Ouroboros.Consensus.Cardano.CanHardFork

Contents

Re-exports of Shelley code
Orphan instances

Synopsis

data ByronPartialLedgerConfig = ByronPartialLedgerConfig {
- byronLedgerConfig :: !( LedgerConfig ByronBlock )
- byronTriggerHardFork :: ! TriggerHardFork
}
type CardanoHardForkConstraints c = ( PraosCrypto c, PraosCrypto c, TranslateProto ( TPraos c) ( Praos c), ShelleyCompatible ( TPraos c) ( ShelleyEra c), LedgerSupportsProtocol ( ShelleyBlock ( TPraos c) ( ShelleyEra c)), ShelleyCompatible ( TPraos c) ( AllegraEra c), LedgerSupportsProtocol ( ShelleyBlock ( TPraos c) ( AllegraEra c)), ShelleyCompatible ( TPraos c) ( MaryEra c), LedgerSupportsProtocol ( ShelleyBlock ( TPraos c) ( MaryEra c)), ShelleyCompatible ( TPraos c) ( AlonzoEra c), LedgerSupportsProtocol ( ShelleyBlock ( TPraos c) ( AlonzoEra c)), ShelleyCompatible ( Praos c) ( BabbageEra c), LedgerSupportsProtocol ( ShelleyBlock ( Praos c) ( BabbageEra c)), HASH c ~ Blake2b_256 , ADDRHASH c ~ Blake2b_224 , DSIGN c ~ Ed25519DSIGN )
data TriggerHardFork
- = TriggerHardForkAtVersion ! Word16
- | TriggerHardForkAtEpoch ! EpochNo
- | TriggerHardForkNever
data ShelleyPartialLedgerConfig era = ShelleyPartialLedgerConfig {
- shelleyLedgerConfig :: !( ShelleyLedgerConfig era)
- shelleyTriggerHardFork :: ! TriggerHardFork
}
forecastAcrossShelley :: ( TranslateProto protoFrom protoTo, LedgerSupportsProtocol ( ShelleyBlock protoFrom eraFrom)) => ShelleyLedgerConfig eraFrom -> ShelleyLedgerConfig eraTo -> Bound -> SlotNo -> LedgerState ( ShelleyBlock protoFrom eraFrom) -> Except OutsideForecastRange ( Ticked ( WrapLedgerView ( ShelleyBlock protoTo eraTo)))
translateChainDepStateAcrossShelley :: forall eraFrom eraTo protoFrom protoTo. TranslateProto protoFrom protoTo => RequiringBoth WrapConsensusConfig ( Translate WrapChainDepState ) ( ShelleyBlock protoFrom eraFrom) ( ShelleyBlock protoTo eraTo)

Documentation

data ByronPartialLedgerConfig Source #

When Byron is part of the hard-fork combinator, we use the partial ledger config. Standalone Byron uses the regular ledger config. This means that the partial ledger config is the perfect place to store the trigger condition for the hard fork to Shelley, as we don't have to modify the ledger config for standalone Byron.

Constructors

ByronPartialLedgerConfig
Fields byronLedgerConfig :: !( LedgerConfig ByronBlock ) byronTriggerHardFork :: ! TriggerHardFork

Instances

Instances details

Generic ByronPartialLedgerConfig Source #
Instance details Defined in Ouroboros.Consensus.Cardano.CanHardFork Associated Types type Rep ByronPartialLedgerConfig :: Type -> Type Source # Methods from :: ByronPartialLedgerConfig -> Rep ByronPartialLedgerConfig x Source # to :: Rep ByronPartialLedgerConfig x -> ByronPartialLedgerConfig Source #
NoThunks ByronPartialLedgerConfig Source #
Instance details Defined in Ouroboros.Consensus.Cardano.CanHardFork Methods noThunks :: Context -> ByronPartialLedgerConfig -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> ByronPartialLedgerConfig -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ByronPartialLedgerConfig -> String Source #
type Rep ByronPartialLedgerConfig Source #
Instance details Defined in Ouroboros.Consensus.Cardano.CanHardFork type Rep ByronPartialLedgerConfig = D1 (' MetaData "ByronPartialLedgerConfig" "Ouroboros.Consensus.Cardano.CanHardFork" "ouroboros-consensus-cardano-0.1.0.1-3AwOJsg5eTrDZBA8Dc5gHR" ' False ) ( C1 (' MetaCons "ByronPartialLedgerConfig" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "byronLedgerConfig") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( LedgerConfig ByronBlock )) :*: S1 (' MetaSel (' Just "byronTriggerHardFork") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 TriggerHardFork )))

type CardanoHardForkConstraints c = ( PraosCrypto c, PraosCrypto c, TranslateProto ( TPraos c) ( Praos c), ShelleyCompatible ( TPraos c) ( ShelleyEra c), LedgerSupportsProtocol ( ShelleyBlock ( TPraos c) ( ShelleyEra c)), ShelleyCompatible ( TPraos c) ( AllegraEra c), LedgerSupportsProtocol ( ShelleyBlock ( TPraos c) ( AllegraEra c)), ShelleyCompatible ( TPraos c) ( MaryEra c), LedgerSupportsProtocol ( ShelleyBlock ( TPraos c) ( MaryEra c)), ShelleyCompatible ( TPraos c) ( AlonzoEra c), LedgerSupportsProtocol ( ShelleyBlock ( TPraos c) ( AlonzoEra c)), ShelleyCompatible ( Praos c) ( BabbageEra c), LedgerSupportsProtocol ( ShelleyBlock ( Praos c) ( BabbageEra c)), HASH c ~ Blake2b_256 , ADDRHASH c ~ Blake2b_224 , DSIGN c ~ Ed25519DSIGN ) Source #

data TriggerHardFork Source #

The trigger condition that will cause the hard fork transition.

Constructors

TriggerHardForkAtVersion ! Word16	Trigger the transition when the on-chain protocol major version (from the ledger state) reaches this number.
TriggerHardForkAtEpoch ! EpochNo	For testing only, trigger the transition at a specific hard-coded epoch, irrespective of the ledger state.
TriggerHardForkNever	Never trigger a hard fork

Instances

Instances details

Show TriggerHardFork
Instance details Defined in Ouroboros.Consensus.HardFork.Simple Methods showsPrec :: Int -> TriggerHardFork -> ShowS Source # show :: TriggerHardFork -> String Source # showList :: [ TriggerHardFork ] -> ShowS Source #
Generic TriggerHardFork
Instance details Defined in Ouroboros.Consensus.HardFork.Simple Associated Types type Rep TriggerHardFork :: Type -> Type Source # Methods from :: TriggerHardFork -> Rep TriggerHardFork x Source # to :: Rep TriggerHardFork x -> TriggerHardFork Source #
NoThunks TriggerHardFork
Instance details Defined in Ouroboros.Consensus.HardFork.Simple Methods noThunks :: Context -> TriggerHardFork -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> TriggerHardFork -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy TriggerHardFork -> String Source #
type Rep TriggerHardFork
Instance details Defined in Ouroboros.Consensus.HardFork.Simple type Rep TriggerHardFork = D1 (' MetaData "TriggerHardFork" "Ouroboros.Consensus.HardFork.Simple" "ouroboros-consensus-0.1.0.1-DT4Cvwf63DZKctsEvaJqCU" ' False ) ( C1 (' MetaCons "TriggerHardForkAtVersion" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' SourceStrict ' DecidedUnpack ) ( Rec0 Word16 )) :+: ( C1 (' MetaCons "TriggerHardForkAtEpoch" ' PrefixI ' False ) ( S1 (' MetaSel (' Nothing :: Maybe Symbol ) ' NoSourceUnpackedness ' SourceStrict ' DecidedUnpack ) ( Rec0 EpochNo )) :+: C1 (' MetaCons "TriggerHardForkNever" ' PrefixI ' False ) ( U1 :: Type -> Type )))

Re-exports of Shelley code

data ShelleyPartialLedgerConfig era Source #

Constructors

ShelleyPartialLedgerConfig

Fields

shelleyLedgerConfig :: !( ShelleyLedgerConfig era)

We cache the non-partial ledger config containing a dummy EpochInfo that needs to be replaced with the correct one.

We do this to avoid recomputing the ledger config each time completeLedgerConfig is called, as mkShelleyLedgerConfig does some rather expensive computations that shouldn't be repeated too often (e.g., sgActiveSlotCoeff ).
shelleyTriggerHardFork :: ! TriggerHardFork

Instances

Instances details

Generic ( ShelleyPartialLedgerConfig era)
Instance details Defined in Ouroboros.Consensus.Shelley.ShelleyHFC Associated Types type Rep ( ShelleyPartialLedgerConfig era) :: Type -> Type Source # Methods from :: ShelleyPartialLedgerConfig era -> Rep ( ShelleyPartialLedgerConfig era) x Source # to :: Rep ( ShelleyPartialLedgerConfig era) x -> ShelleyPartialLedgerConfig era Source #
ShelleyBasedEra era => NoThunks ( ShelleyPartialLedgerConfig era)
Instance details Defined in Ouroboros.Consensus.Shelley.ShelleyHFC Methods noThunks :: Context -> ShelleyPartialLedgerConfig era -> IO ( Maybe ThunkInfo ) Source # wNoThunks :: Context -> ShelleyPartialLedgerConfig era -> IO ( Maybe ThunkInfo ) Source # showTypeOf :: Proxy ( ShelleyPartialLedgerConfig era) -> String Source #
type Rep ( ShelleyPartialLedgerConfig era)
Instance details Defined in Ouroboros.Consensus.Shelley.ShelleyHFC type Rep ( ShelleyPartialLedgerConfig era) = D1 (' MetaData "ShelleyPartialLedgerConfig" "Ouroboros.Consensus.Shelley.ShelleyHFC" "ouroboros-consensus-shelley-0.1.0.1-Kwox0dapAHUG8fY5XKE0pO" ' False ) ( C1 (' MetaCons "ShelleyPartialLedgerConfig" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "shelleyLedgerConfig") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 ( ShelleyLedgerConfig era)) :*: S1 (' MetaSel (' Just "shelleyTriggerHardFork") ' NoSourceUnpackedness ' SourceStrict ' DecidedStrict ) ( Rec0 TriggerHardFork )))

forecastAcrossShelley Source #

Arguments

:: ( TranslateProto protoFrom protoTo, LedgerSupportsProtocol ( ShelleyBlock protoFrom eraFrom))
=> ShelleyLedgerConfig eraFrom
-> ShelleyLedgerConfig eraTo
-> Bound	Transition between the two eras
-> SlotNo	Forecast for this slot
-> LedgerState ( ShelleyBlock protoFrom eraFrom)
-> Except OutsideForecastRange ( Ticked ( WrapLedgerView ( ShelleyBlock protoTo eraTo)))

Forecast from a Shelley-based era to the next Shelley-based era.

translateChainDepStateAcrossShelley :: forall eraFrom eraTo protoFrom protoTo. TranslateProto protoFrom protoTo => RequiringBoth WrapConsensusConfig ( Translate WrapChainDepState ) ( ShelleyBlock protoFrom eraFrom) ( ShelleyBlock protoTo eraTo) Source #

Orphan instances

SingleEraBlock ByronBlock Source #
Instance details Methods singleEraTransition :: PartialLedgerConfig ByronBlock -> EraParams -> Bound -> LedgerState ByronBlock -> Maybe EpochNo Source # singleEraInfo :: proxy ByronBlock -> SingleEraInfo ByronBlock Source #
HasPartialLedgerConfig ByronBlock Source #
Instance details Associated Types type PartialLedgerConfig ByronBlock Source # Methods completeLedgerConfig :: proxy ByronBlock -> EpochInfo ( Except PastHorizonException ) -> PartialLedgerConfig ByronBlock -> LedgerConfig ByronBlock Source #
CardanoHardForkConstraints c => CanHardFork ( CardanoEras c) Source #
Instance details Methods hardForkEraTranslation :: EraTranslation ( CardanoEras c) Source # hardForkChainSel :: Tails AcrossEraSelection ( CardanoEras c) Source # hardForkInjectTxs :: InPairs ( RequiringBoth WrapLedgerConfig ( Product2 InjectTx InjectValidatedTx )) ( CardanoEras c) Source #
PBftCrypto bc => HasPartialConsensusConfig ( PBft bc) Source #
Instance details Associated Types type PartialConsensusConfig ( PBft bc) Source # Methods completeConsensusConfig :: proxy ( PBft bc) -> EpochInfo ( Except PastHorizonException ) -> PartialConsensusConfig ( PBft bc) -> ConsensusConfig ( PBft bc) Source # toPartialConsensusConfig :: proxy ( PBft bc) -> ConsensusConfig ( PBft bc) -> PartialConsensusConfig ( PBft bc) Source #