Safe Haskell	Safe-Inferred
Language	Haskell2010

Ouroboros.Consensus.Shelley.ShelleyHFC

Contents

Orphan instances

Description

This module is the Shelley Hard Fork Combinator

Synopsis

type ProtocolShelley = HardForkProtocol '[ShelleyBlock (TPraos StandardCrypto) StandardShelley]
type ShelleyBlockHFC proto era = HardForkBlock '[ShelleyBlock proto era]
data ShelleyPartialLedgerConfig era = ShelleyPartialLedgerConfig {
- shelleyLedgerConfig ∷ !(ShelleyLedgerConfig era)
- shelleyTriggerHardFork ∷ !TriggerHardFork
}
crossEraForecastAcrossShelley ∷ ∀ eraFrom eraTo protoFrom protoTo. (TranslateProto protoFrom protoTo, LedgerSupportsProtocol (ShelleyBlock protoFrom eraFrom)) ⇒ RequiringBoth WrapLedgerConfig (CrossEraForecaster LedgerState WrapLedgerView) (ShelleyBlock protoFrom eraFrom) (ShelleyBlock protoTo eraTo)
forecastAcrossShelley ∷ ∀ protoFrom protoTo eraFrom eraTo. (TranslateProto protoFrom protoTo, LedgerSupportsProtocol (ShelleyBlock protoFrom eraFrom)) ⇒ ShelleyLedgerConfig eraFrom → ShelleyLedgerConfig eraTo → Bound → SlotNo → LedgerState (ShelleyBlock protoFrom eraFrom) → Except OutsideForecastRange (WrapLedgerView (ShelleyBlock protoTo eraTo))
translateChainDepStateAcrossShelley ∷ ∀ eraFrom eraTo protoFrom protoTo. TranslateProto protoFrom protoTo ⇒ RequiringBoth WrapConsensusConfig (Translate WrapChainDepState) (ShelleyBlock protoFrom eraFrom) (ShelleyBlock protoTo eraTo)

Documentation

type ProtocolShelley = HardForkProtocol '[ShelleyBlock (TPraos StandardCrypto) StandardShelley] Source #

type ShelleyBlockHFC proto era = HardForkBlock '[ShelleyBlock proto era] Source #

Shelley as the single era in the hard fork combinator

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) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.ShelleyHFC Associated Types type Rep (ShelleyPartialLedgerConfig era) ∷ Type → Type # Methods from ∷ ShelleyPartialLedgerConfig era → Rep (ShelleyPartialLedgerConfig era) x # to ∷ Rep (ShelleyPartialLedgerConfig era) x → ShelleyPartialLedgerConfig era #
(NoThunks (TranslationContext era), Era era) ⇒ NoThunks (ShelleyPartialLedgerConfig era) Source #
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) Source #
Instance details Defined in Ouroboros.Consensus.Shelley.ShelleyHFC type Rep (ShelleyPartialLedgerConfig era) = D1 ('MetaData "ShelleyPartialLedgerConfig" "Ouroboros.Consensus.Shelley.ShelleyHFC" "ouroboros-consensus-cardano-0.16.0.0-inplace" '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)))

crossEraForecastAcrossShelley ∷ ∀ eraFrom eraTo protoFrom protoTo. (TranslateProto protoFrom protoTo, LedgerSupportsProtocol (ShelleyBlock protoFrom eraFrom)) ⇒ RequiringBoth WrapLedgerConfig (CrossEraForecaster LedgerState WrapLedgerView) (ShelleyBlock protoFrom eraFrom) (ShelleyBlock protoTo eraTo) Source #

forecastAcrossShelley Source #

Arguments

∷ ∀ protoFrom protoTo eraFrom eraTo. (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 (WrapLedgerView (ShelleyBlock protoTo eraTo))

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

translateChainDepStateAcrossShelley ∷ ∀ eraFrom eraTo protoFrom protoTo. TranslateProto protoFrom protoTo ⇒ RequiringBoth WrapConsensusConfig (Translate WrapChainDepState) (ShelleyBlock protoFrom eraFrom) (ShelleyBlock protoTo eraTo) Source #

Orphan instances

(ShelleyBasedEra era, ShelleyBasedEra (PreviousEra era), Era (PreviousEra era), EraCrypto (PreviousEra era) ~ EraCrypto era) ⇒ TranslateEra era (ShelleyTip proto) Source #
Instance details Associated Types type TranslationError era (ShelleyTip proto) Source # Methods translateEra ∷ TranslationContext era → ShelleyTip proto (PreviousEra era) → Except (TranslationError era (ShelleyTip proto)) (ShelleyTip proto era) Source #
(ShelleyBasedEra era, TranslateEra era (ShelleyTip proto), TranslateEra era NewEpochState, TranslationError era NewEpochState ~ Void) ⇒ TranslateEra era (LedgerState :.: ShelleyBlock proto) Source #
Instance details Associated Types type TranslationError era (LedgerState :.: ShelleyBlock proto) Source # Methods translateEra ∷ TranslationContext era → (LedgerState :.: ShelleyBlock proto) (PreviousEra era) → Except (TranslationError era (LedgerState :.: ShelleyBlock proto)) ((LedgerState :.: ShelleyBlock proto) era) Source #
(ShelleyBasedEra era, TranslateEra era WrapTx) ⇒ TranslateEra era (GenTx :.: ShelleyBlock proto) Source #
Instance details Associated Types type TranslationError era (GenTx :.: ShelleyBlock proto) Source # Methods translateEra ∷ TranslationContext era → (GenTx :.: ShelleyBlock proto) (PreviousEra era) → Except (TranslationError era (GenTx :.: ShelleyBlock proto)) ((GenTx :.: ShelleyBlock proto) era) Source #
(ShelleyBasedEra era, TranslateEra era WrapTx) ⇒ TranslateEra era (WrapValidatedGenTx :.: ShelleyBlock proto) Source #
Instance details Associated Types type TranslationError era (WrapValidatedGenTx :.: ShelleyBlock proto) Source # Methods translateEra ∷ TranslationContext era → (WrapValidatedGenTx :.: ShelleyBlock proto) (PreviousEra era) → Except (TranslationError era (WrapValidatedGenTx :.: ShelleyBlock proto)) ((WrapValidatedGenTx :.: ShelleyBlock proto) era) Source #
PraosCrypto c ⇒ HasPartialConsensusConfig (Praos c) Source #
Instance details Associated Types type PartialConsensusConfig (Praos c) Source # Methods completeConsensusConfig ∷ proxy (Praos c) → EpochInfo (Except PastHorizonException) → PartialConsensusConfig (Praos c) → ConsensusConfig (Praos c) Source # toPartialConsensusConfig ∷ proxy (Praos c) → ConsensusConfig (Praos c) → PartialConsensusConfig (Praos c) Source #
PraosCrypto c ⇒ HasPartialConsensusConfig (TPraos c) Source #
Instance details Associated Types type PartialConsensusConfig (TPraos c) Source # Methods completeConsensusConfig ∷ proxy (TPraos c) → EpochInfo (Except PastHorizonException) → PartialConsensusConfig (TPraos c) → ConsensusConfig (TPraos c) Source # toPartialConsensusConfig ∷ proxy (TPraos c) → ConsensusConfig (TPraos c) → PartialConsensusConfig (TPraos c) Source #
(ShelleyCompatible proto era, LedgerSupportsProtocol (ShelleyBlock proto era)) ⇒ NoHardForks (ShelleyBlock proto era) Source #
Instance details Methods getEraParams ∷ TopLevelConfig (ShelleyBlock proto era) → EraParams Source # toPartialLedgerConfig ∷ proxy (ShelleyBlock proto era) → LedgerConfig (ShelleyBlock proto era) → PartialLedgerConfig (ShelleyBlock proto era) Source #
(ShelleyCompatible proto era, LedgerSupportsProtocol (ShelleyBlock proto era)) ⇒ SingleEraBlock (ShelleyBlock proto era) Source #
Instance details Methods singleEraTransition ∷ PartialLedgerConfig (ShelleyBlock proto era) → EraParams → Bound → LedgerState (ShelleyBlock proto era) → Maybe EpochNo Source # singleEraInfo ∷ proxy (ShelleyBlock proto era) → SingleEraInfo (ShelleyBlock proto era) Source #
ShelleyCompatible proto era ⇒ HasPartialLedgerConfig (ShelleyBlock proto era) Source #
Instance details Associated Types type PartialLedgerConfig (ShelleyBlock proto era) Source # Methods completeLedgerConfig ∷ proxy (ShelleyBlock proto era) → EpochInfo (Except PastHorizonException) → PartialLedgerConfig (ShelleyBlock proto era) → LedgerConfig (ShelleyBlock proto era) Source #
(ShelleyCompatible proto era, LedgerSupportsProtocol (ShelleyBlock proto era)) ⇒ SerialiseConstraintsHFC (ShelleyBlock proto era) Source #
Instance details
(ShelleyCompatible proto era, LedgerSupportsProtocol (ShelleyBlock proto era)) ⇒ SupportedNetworkProtocolVersion (ShelleyBlockHFC proto era) Source #	Forward to the ShelleyBlock instance. Only supports `HardForkNodeToNodeDisabled`, which is compatible with nodes running with `ShelleyBlock`.
Instance details Methods supportedNodeToNodeVersions ∷ Proxy (ShelleyBlockHFC proto era) → Map NodeToNodeVersion (BlockNodeToNodeVersion (ShelleyBlockHFC proto era)) Source # supportedNodeToClientVersions ∷ Proxy (ShelleyBlockHFC proto era) → Map NodeToClientVersion (BlockNodeToClientVersion (ShelleyBlockHFC proto era)) Source # latestReleasedNodeVersion ∷ Proxy (ShelleyBlockHFC proto era) → (Maybe NodeToNodeVersion, Maybe NodeToClientVersion) Source #
(ShelleyCompatible proto era, LedgerSupportsProtocol (ShelleyBlock proto era)) ⇒ SerialiseHFC '[ShelleyBlock proto era] Source #	Use the default implementations. This means the serialisation of blocks includes an era wrapper. Each block should do this from the start to be prepared for future hard forks without having to do any bit twiddling.
Instance details Methods encodeDiskHfcBlock ∷ CodecConfig (HardForkBlock '[ShelleyBlock proto era]) → HardForkBlock '[ShelleyBlock proto era] → Encoding Source # decodeDiskHfcBlock ∷ CodecConfig (HardForkBlock '[ShelleyBlock proto era]) → ∀ s. Decoder s (ByteString → HardForkBlock '[ShelleyBlock proto era]) Source # reconstructHfcPrefixLen ∷ proxy (Header (HardForkBlock '[ShelleyBlock proto era])) → PrefixLen Source # reconstructHfcNestedCtxt ∷ proxy (Header (HardForkBlock '[ShelleyBlock proto era])) → ShortByteString → SizeInBytes → SomeSecond (NestedCtxt Header) (HardForkBlock '[ShelleyBlock proto era]) Source # getHfcBinaryBlockInfo ∷ HardForkBlock '[ShelleyBlock proto era] → BinaryBlockInfo Source # estimateHfcBlockSize ∷ Header (HardForkBlock '[ShelleyBlock proto era]) → SizeInBytes Source #