After a hardfork, the era from which we hardfork from gets deprecated and after deprecation period, gets removed. During deprecation period, consumers of cardano-api should update their codebase to the mainnet era.

Constructors

BabbageEra :: Era BabbageEra	The era currently active on Cardano's mainnet.
ConwayEra :: Era ConwayEra	The upcoming era in development.

Instances

Instances details

Eon Era Source #	A temporary compatibility instance, for easier conversion between experimental and old API.
Instance details Defined in Cardano.Api.Experimental.Eras Methods inEonForEra :: a -> (Era era -> a) -> CardanoEra era -> a Source #
TestEquality Era Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods testEquality :: Era a -> Era b -> Maybe (a :~: b) Source #
FromJSON (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods parseJSON :: Value -> Parser (Some Era) # parseJSONList :: Value -> Parser [Some Era] # omittedField :: Maybe (Some Era) #
ToJSON (Era era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods toJSON :: Era era -> Value # toEncoding :: Era era -> Encoding # toJSONList :: [Era era] -> Value # toEncodingList :: [Era era] -> Encoding # omitField :: Era era -> Bool #
ToJSON (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods toJSON :: Some Era -> Value # toEncoding :: Some Era -> Encoding # toJSONList :: [Some Era] -> Value # toEncodingList :: [Some Era] -> Encoding # omitField :: Some Era -> Bool #
Bounded (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods minBound :: Some Era Source # maxBound :: Some Era Source #
Enum (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods succ :: Some Era -> Some Era Source # pred :: Some Era -> Some Era Source # toEnum :: Int -> Some Era Source # fromEnum :: Some Era -> Int Source # enumFrom :: Some Era -> [Some Era] Source # enumFromThen :: Some Era -> Some Era -> [Some Era] Source # enumFromTo :: Some Era -> Some Era -> [Some Era] Source # enumFromThenTo :: Some Era -> Some Era -> Some Era -> [Some Era] Source #
Show (Era era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods showsPrec :: Int -> Era era -> ShowS Source # show :: Era era -> String Source # showList :: [Era era] -> ShowS Source #
Eq (Era era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods (==) :: Era era -> Era era -> Bool Source # (/=) :: Era era -> Era era -> Bool Source #
Ord (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods compare :: Some Era -> Some Era -> Ordering Source # (<) :: Some Era -> Some Era -> Bool Source # (<=) :: Some Era -> Some Era -> Bool Source # (>) :: Some Era -> Some Era -> Bool Source # (>=) :: Some Era -> Some Era -> Bool Source # max :: Some Era -> Some Era -> Some Era Source # min :: Some Era -> Some Era -> Some Era Source #
Pretty (Era era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods pretty :: Era era -> Doc ann # prettyList :: [Era era] -> Doc ann #
Pretty (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods pretty :: Some Era -> Doc ann # prettyList :: [Some Era] -> Doc ann #

class IsEra era where Source #

Type class interface for the Era type.

Methods

useEra :: Era era Source #

Instances

Instances details

IsEra BabbageEra Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods useEra :: Era BabbageEra Source #
IsEra ConwayEra Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods useEra :: Era ConwayEra Source #

data Some (f :: Type -> Type) where Source #

An existential type for singleton types. Use to hold any era e.g. Some Era. One can then bring the era witness back into scope for example using this pattern: anyEra = Some ConwayEra -- then later in the code Some era <- pure anyEra obtainCommonConstraints era foo

Constructors

Some :: forall (f :: Type -> Type) a. (Typeable a, Typeable (f a)) => f a -> Some f

Instances

Instances details

FromJSON (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods parseJSON :: Value -> Parser (Some Era) # parseJSONList :: Value -> Parser [Some Era] # omittedField :: Maybe (Some Era) #
ToJSON (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods toJSON :: Some Era -> Value # toEncoding :: Some Era -> Encoding # toJSONList :: [Some Era] -> Value # toEncodingList :: [Some Era] -> Encoding # omitField :: Some Era -> Bool #
Bounded (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods minBound :: Some Era Source # maxBound :: Some Era Source #
Enum (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods succ :: Some Era -> Some Era Source # pred :: Some Era -> Some Era Source # toEnum :: Int -> Some Era Source # fromEnum :: Some Era -> Int Source # enumFrom :: Some Era -> [Some Era] Source # enumFromThen :: Some Era -> Some Era -> [Some Era] Source # enumFromTo :: Some Era -> Some Era -> [Some Era] Source # enumFromThenTo :: Some Era -> Some Era -> Some Era -> [Some Era] Source #
Show (Some f) Source #	Assumes that `f` is a singleton
Instance details Defined in Cardano.Api.Experimental.Eras Methods showsPrec :: Int -> Some f -> ShowS Source # show :: Some f -> String Source # showList :: [Some f] -> ShowS Source #
TestEquality f => Eq (Some f) Source #	Assumes that `f` is a singleton
Instance details Defined in Cardano.Api.Experimental.Eras Methods (==) :: Some f -> Some f -> Bool Source # (/=) :: Some f -> Some f -> Bool Source #
Ord (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods compare :: Some Era -> Some Era -> Ordering Source # (<) :: Some Era -> Some Era -> Bool Source # (<=) :: Some Era -> Some Era -> Bool Source # (>) :: Some Era -> Some Era -> Bool Source # (>=) :: Some Era -> Some Era -> Bool Source # max :: Some Era -> Some Era -> Some Era Source # min :: Some Era -> Some Era -> Some Era Source #
Pretty (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods pretty :: Some Era -> Doc ann # prettyList :: [Some Era] -> Doc ann #

type family LedgerEra era = (r :: Type) | r -> era where ... Source #

Users typically interact with the latest features on the mainnet or experiment with features from the upcoming era. Hence, the protocol versions are limited to the current mainnet era and the next era (upcoming era).

Equations

LedgerEra BabbageEra = Babbage
LedgerEra ConwayEra = Conway

newtype DeprecatedEra era Source #

Constructors

DeprecatedEra (ShelleyBasedEra era)

Instances

Instances details

Show (DeprecatedEra era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods showsPrec :: Int -> DeprecatedEra era -> ShowS Source # show :: DeprecatedEra era -> String Source # showList :: [DeprecatedEra era] -> ShowS Source #
Pretty (DeprecatedEra era) Source #
Instance details Defined in Cardano.Api.Experimental.Eras Methods pretty :: DeprecatedEra era -> Doc ann # prettyList :: [DeprecatedEra era] -> Doc ann #

type EraCommonConstraints era = (AlonzoEraTx (LedgerEra era), BabbageEraTxBody (LedgerEra era), EraTx (LedgerEra era), EraUTxO (LedgerEra era), EraCrypto (LedgerEra era) ~ StandardCrypto, ShelleyLedgerEra era ~ LedgerEra era, HashAnnotated (TxBody (LedgerEra era)) EraIndependentTxBody StandardCrypto, IsEra era) Source #

obtainCommonConstraints :: Era era -> (EraCommonConstraints era => a) -> a Source #

eraToSbe :: Era era -> ShelleyBasedEra era Source #

How to deprecate an era

Add DEPRECATED pragma to the era type tag and the era constructor at the same time: {-# DEPRECATED BabbageEra "BabbageEra no longer supported, use ConwayEra" #-} data BabbageEra
Update haddock for the constructor of the deprecated era, mentioning deprecation.

data Era era where
  {-# DEPRECATED BabbageEra "BabbageEra no longer supported, use ConwayEra" #-}
  BabbageEra :: Era BabbageEra
  -- | The era currently active on Cardano's mainnet.
  ConwayEra :: Era ConwayEra

Add new IsEra instance and update the deprecated era instance to produce a compile-time error: @ instance TypeError ('Text "IsEra BabbageEra: Deprecated. Update to ConwayEra") => IsEra BabbageEra where useEra = error "unreachable"

instance IsEra ConwayEra where useEra = ConwayEra @

babbageEraOnwardsToEra :: BabbageEraOnwards era -> Era era Source #

eraToBabbageEraOnwards :: Era era -> BabbageEraOnwards era Source #

sbeToEra :: MonadError (DeprecatedEra era) m => ShelleyBasedEra era -> m (Era era) Source #