After a hard fork takes place, the era on mainnet before the hard fork is deprecated and, after a deprecation period, removed from cardano-api. During the deprecation period, cardano-api users should update their codebase to the new mainnet era.

Constructors

ConwayEra :: Era ConwayEra

The currently active era on the Cardano mainnet.

Instances

Instances details

Eon Era Source #	A temporary compatibility instance for easier conversion between the experimental and old APIs.
Instance details Defined in Cardano.Api.Experimental.Era Methods inEonForEra :: a -> (Era era -> a) -> CardanoEra era -> a Source #
ToCardanoEra Era Source #	A temporary compatibility instance for easier conversion between the experimental and old APIs.
Instance details Defined in Cardano.Api.Experimental.Era Methods toCardanoEra :: Era era -> CardanoEra era Source #
TestEquality Era Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods testEquality :: Era a -> Era b -> Maybe (a :~: b) Source #
Convert ConwayEraOnwards Era Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods convert :: ConwayEraOnwards era -> Era era Source #
Convert Era CardanoEra Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods convert :: Era era -> CardanoEra era Source #
Convert Era AlonzoEraOnwards Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods convert :: Era era -> AlonzoEraOnwards era Source #
Convert Era BabbageEraOnwards Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods convert :: Era era -> BabbageEraOnwards era Source #
Convert Era ConwayEraOnwards Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods convert :: Era era -> ConwayEraOnwards era Source #
Convert Era MaryEraOnwards Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods convert :: Era era -> MaryEraOnwards era Source #
Convert Era ShelleyBasedEra Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods convert :: Era era -> ShelleyBasedEra era Source #
ToJSON (Era era) Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods toJSON :: Era era -> Value # toEncoding :: Era era -> Encoding # toJSONList :: [Era era] -> Value # toEncodingList :: [Era era] -> Encoding # omitField :: Era era -> Bool #
Show (Era era) Source #
Instance details Defined in Cardano.Api.Experimental.Era 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.Era Methods (==) :: Era era -> Era era -> Bool Source # (/=) :: Era era -> Era era -> Bool Source #
Pretty (Era era) Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods pretty :: Era era -> Doc ann # prettyList :: [Era era] -> Doc ann #
FromJSON (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Era 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.Era 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.Era Methods minBound :: Some Era Source # maxBound :: Some Era Source #
Enum (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Era 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 Era) Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods showsPrec :: Int -> Some Era -> ShowS Source # show :: Some Era -> String Source # showList :: [Some Era] -> ShowS Source #
Eq (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods (==) :: Some Era -> Some Era -> Bool Source # (/=) :: Some Era -> Some Era -> Bool Source #
Ord (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Era 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.Era 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 ConwayEra Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods useEra :: Era ConwayEra Source #

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

An existential wrapper for types of kind k -> Type. It can hold any era, for example, Some Era. The era witness can be brought 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 {k} (f :: k -> Type) (a :: k). (Typeable a, Typeable (f a)) => f a -> Some f

Instances

Instances details

FromJSON (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Era 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.Era 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.Era Methods minBound :: Some Era Source # maxBound :: Some Era Source #
Enum (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Era 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 Era) Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods showsPrec :: Int -> Some Era -> ShowS Source # show :: Some Era -> String Source # showList :: [Some Era] -> ShowS Source #
Eq (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods (==) :: Some Era -> Some Era -> Bool Source # (/=) :: Some Era -> Some Era -> Bool Source #
Ord (Some Era) Source #
Instance details Defined in Cardano.Api.Experimental.Era 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.Era Methods pretty :: Some Era -> Doc ann # prettyList :: [Some Era] -> Doc ann #

class Inject t s where Source #

Methods

inject :: t -> s Source #

Instances

Instances details

Inject Coin DeltaCoin
Instance details Defined in Cardano.Ledger.Coin Methods inject :: Coin -> DeltaCoin Source #
Inject Coin MaryValue
Instance details Defined in Cardano.Ledger.Mary.Value Methods inject :: Coin -> MaryValue Source #
Inject a a
Instance details Defined in Cardano.Ledger.BaseTypes Methods inject :: a -> a Source #
Inject (BabbageContextError era) (ConwayContextError era)
Instance details Defined in Cardano.Ledger.Conway.TxInfo Methods inject :: BabbageContextError era -> ConwayContextError era Source #
Inject (AlonzoContextError era) (BabbageContextError era)
Instance details Defined in Cardano.Ledger.Babbage.TxInfo Methods inject :: AlonzoContextError era -> BabbageContextError era Source #
Inject (AlonzoContextError era) (ConwayContextError era)
Instance details Defined in Cardano.Ledger.Conway.TxInfo Methods inject :: AlonzoContextError era -> ConwayContextError era Source #

class Convert (f :: a -> Type) (g :: a -> Type) where Source #

The Convert class is aimed at exposing a single interface that lets us convert between eons. However this is generalizable to any injective relationship between types.

Methods

convert :: forall (era :: a). f era -> g era Source #

Instances

Instances details

Convert AllegraEraOnwards CardanoEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.AllegraEraOnwards Methods convert :: AllegraEraOnwards era -> CardanoEra era Source #
Convert AllegraEraOnwards ShelleyBasedEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.AllegraEraOnwards Methods convert :: AllegraEraOnwards era -> ShelleyBasedEra era Source #
Convert AlonzoEraOnwards CardanoEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.AlonzoEraOnwards Methods convert :: AlonzoEraOnwards era -> CardanoEra era Source #
Convert AlonzoEraOnwards ShelleyBasedEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.AlonzoEraOnwards Methods convert :: AlonzoEraOnwards era -> ShelleyBasedEra era Source #
Convert BabbageEraOnwards CardanoEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.BabbageEraOnwards Methods convert :: BabbageEraOnwards era -> CardanoEra era Source #
Convert BabbageEraOnwards AlonzoEraOnwards Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.BabbageEraOnwards Methods convert :: BabbageEraOnwards era -> AlonzoEraOnwards era Source #
Convert BabbageEraOnwards MaryEraOnwards Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.BabbageEraOnwards Methods convert :: BabbageEraOnwards era -> MaryEraOnwards era Source #
Convert BabbageEraOnwards ShelleyBasedEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.BabbageEraOnwards Methods convert :: BabbageEraOnwards era -> ShelleyBasedEra era Source #
Convert ByronToAlonzoEra CardanoEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.ByronToAlonzoEra Methods convert :: ByronToAlonzoEra era -> CardanoEra era Source #
Convert ConwayEraOnwards CardanoEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.ConwayEraOnwards Methods convert :: ConwayEraOnwards era -> CardanoEra era Source #
Convert ConwayEraOnwards AllegraEraOnwards Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.ConwayEraOnwards Methods convert :: ConwayEraOnwards era -> AllegraEraOnwards era Source #
Convert ConwayEraOnwards BabbageEraOnwards Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.ConwayEraOnwards Methods convert :: ConwayEraOnwards era -> BabbageEraOnwards era Source #
Convert ConwayEraOnwards ShelleyBasedEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.ConwayEraOnwards Methods convert :: ConwayEraOnwards era -> ShelleyBasedEra era Source #
Convert ConwayEraOnwards Era Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods convert :: ConwayEraOnwards era -> Era era Source #
Convert MaryEraOnwards CardanoEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.MaryEraOnwards Methods convert :: MaryEraOnwards era -> CardanoEra era Source #
Convert MaryEraOnwards ShelleyBasedEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.MaryEraOnwards Methods convert :: MaryEraOnwards era -> ShelleyBasedEra era Source #
Convert ShelleyBasedEra CardanoEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.ShelleyBasedEra Methods convert :: ShelleyBasedEra era -> CardanoEra era Source #
Convert ShelleyEraOnly CardanoEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.ShelleyEraOnly Methods convert :: ShelleyEraOnly era -> CardanoEra era Source #
Convert ShelleyEraOnly ShelleyBasedEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.ShelleyEraOnly Methods convert :: ShelleyEraOnly era -> ShelleyBasedEra era Source #
Convert ShelleyToAllegraEra CardanoEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.ShelleyToAllegraEra Methods convert :: ShelleyToAllegraEra era -> CardanoEra era Source #
Convert ShelleyToAllegraEra ShelleyBasedEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.ShelleyToAllegraEra Methods convert :: ShelleyToAllegraEra era -> ShelleyBasedEra era Source #
Convert ShelleyToAlonzoEra CardanoEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.ShelleyToAlonzoEra Methods convert :: ShelleyToAlonzoEra era -> CardanoEra era Source #
Convert ShelleyToAlonzoEra ShelleyBasedEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.ShelleyToAlonzoEra Methods convert :: ShelleyToAlonzoEra era -> ShelleyBasedEra era Source #
Convert ShelleyToBabbageEra CardanoEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.ShelleyToBabbageEra Methods convert :: ShelleyToBabbageEra era -> CardanoEra era Source #
Convert ShelleyToBabbageEra ShelleyBasedEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.ShelleyToBabbageEra Methods convert :: ShelleyToBabbageEra era -> ShelleyBasedEra era Source #
Convert ShelleyToMaryEra CardanoEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.ShelleyToMaryEra Methods convert :: ShelleyToMaryEra era -> CardanoEra era Source #
Convert ShelleyToMaryEra ShelleyBasedEra Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.ShelleyToMaryEra Methods convert :: ShelleyToMaryEra era -> ShelleyBasedEra era Source #
Convert Era CardanoEra Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods convert :: Era era -> CardanoEra era Source #
Convert Era AlonzoEraOnwards Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods convert :: Era era -> AlonzoEraOnwards era Source #
Convert Era BabbageEraOnwards Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods convert :: Era era -> BabbageEraOnwards era Source #
Convert Era ConwayEraOnwards Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods convert :: Era era -> ConwayEraOnwards era Source #
Convert Era MaryEraOnwards Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods convert :: Era era -> MaryEraOnwards era Source #
Convert Era ShelleyBasedEra Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods convert :: Era era -> ShelleyBasedEra era Source #
Convert (a2 :: a1 -> Type) (a2 :: a1 -> Type) Source #
Instance details Defined in Cardano.Api.Era.Internal.Eon.Convert Methods convert :: forall (era :: a1). a2 era -> a2 era Source #

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. Therefore, protocol versions are limited to the current mainnet era and the next (upcoming) era.

Equations

LedgerEra ConwayEra = ConwayEra

newtype DeprecatedEra era Source #

Constructors

DeprecatedEra (ShelleyBasedEra era)

Instances

Instances details

Error (DeprecatedEra era) Source #
Instance details Defined in Cardano.Api.Experimental.Era Methods prettyError :: DeprecatedEra era -> Doc ann Source #
Show (DeprecatedEra era) Source #
Instance details Defined in Cardano.Api.Experimental.Era 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.Era Methods pretty :: DeprecatedEra era -> Doc ann # prettyList :: [DeprecatedEra era] -> Doc ann #

type EraCommonConstraints era = (AllegraEraScript (LedgerEra era), AlonzoEraTx (LedgerEra era), BabbageEraPParams (LedgerEra era), BabbageEraTxBody (LedgerEra era), ConwayEraTxCert (LedgerEra era), TxCert (LedgerEra era) ~ ConwayTxCert (LedgerEra era), Era (LedgerEra era), EraScript (LedgerEra era), EraTx (LedgerEra era), EraTxCert (LedgerEra era), EraTxOut (LedgerEra era), EraUTxO (LedgerEra era), FromCBOR (ChainDepState (ConsensusProtocol era)), NativeScript (LedgerEra era) ~ Timelock (LedgerEra era), PraosProtocolSupportsNode (ConsensusProtocol era), ShelleyEraTxCert (LedgerEra era), ShelleyLedgerEra era ~ LedgerEra era, ToJSON (ChainDepState (ConsensusProtocol era)), HashAnnotated (TxBody (LedgerEra era)) EraIndependentTxBody, IsCardanoEra era, IsShelleyBasedEra era, IsEra era) Source #

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

eraToSbe :: Era era -> ShelleyBasedEra era Source #

Deprecated: Use convert instead.

How to deprecate an era:

Add the DEPRECATED pragma to the era type tag and constructor at the same time:

{-# DEPRECATED BabbageEra "BabbageEra no longer supported, use ConwayEra" #-}
data BabbageEra

Update the Haddock documentation for the constructor of the deprecated era, mentioning the 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 a 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

eraToBabbageEraOnwards :: Era era -> BabbageEraOnwards era Source #

Deprecated: Use convert instead.

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