Safe Haskell	None
Language	Haskell2010

Cardano.Api.Experimental

Contents

Creating transactions
Contents
- Transaction-related
- Era-related

Description

This module provides an experimental library interface intended to replace the existing API. It is subject to significant changes. Please, use it with caution.

Synopsis

newtype UnsignedTx era = UnsignedTx (Tx (LedgerEra era))
newtype UnsignedTxError = UnsignedTxError TxBodyError
makeUnsignedTx :: Era era -> TxBodyContent BuildTx era -> Either TxBodyError (UnsignedTx era)
makeKeyWitness :: Era era -> UnsignedTx era -> ShelleyWitnessSigningKey -> WitVKey 'Witness StandardCrypto
signTx :: Era era -> [BootstrapWitness StandardCrypto] -> [WitVKey 'Witness StandardCrypto] -> UnsignedTx era -> Tx (LedgerEra era)
convertTxBodyToUnsignedTx :: HasCallStack => ShelleyBasedEra era -> TxBody era -> UnsignedTx era
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)
obtainCommonConstraints :: Era era -> (EraCommonConstraints era => a) -> a
hashTxBody :: HashAnnotated (TxBody era) EraIndependentTxBody StandardCrypto => TxBody era -> Hash StandardCrypto EraIndependentTxBody
evaluateTransactionExecutionUnitsShelley :: ShelleyBasedEra era -> SystemStart -> LedgerEpochInfo -> LedgerProtocolParameters era -> UTxO era -> Tx (ShelleyLedgerEra era) -> Either (TransactionValidityError era) (Map ScriptWitnessIndex (Either ScriptExecutionError (EvalTxExecutionUnitsLog, ExecutionUnits)))
data BabbageEra
data ConwayEra
data Era era where
- BabbageEra :: Era BabbageEra
- ConwayEra :: Era ConwayEra
class IsEra era where
- useEra :: Era era
data Some (f :: k -> Type) where
- Some :: forall {k} (f :: k -> Type) (a :: k). (Typeable a, Typeable (f a)) => f a -> Some f
type family LedgerEra era = (r :: Type) | r -> era where ...
newtype DeprecatedEra era = DeprecatedEra (ShelleyBasedEra era)
eraToSbe :: Era era -> ShelleyBasedEra era
babbageEraOnwardsToEra :: BabbageEraOnwards era -> Era era
eraToBabbageEraOnwards :: Era era -> BabbageEraOnwards era
sbeToEra :: MonadError (DeprecatedEra era) m => ShelleyBasedEra era -> m (Era era)

Creating transactions

For details and an example of creating a transaction using the experimental API, see the Cardano.Api.Internal.Experimental.Tx documentation.

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 #

hashTxBody :: HashAnnotated (TxBody era) EraIndependentTxBody StandardCrypto => TxBody era -> Hash StandardCrypto EraIndependentTxBody Source #

evaluateTransactionExecutionUnitsShelley :: ShelleyBasedEra era -> SystemStart -> LedgerEpochInfo -> LedgerProtocolParameters era -> UTxO era -> Tx (ShelleyLedgerEra era) -> Either (TransactionValidityError era) (Map ScriptWitnessIndex (Either ScriptExecutionError (EvalTxExecutionUnitsLog, ExecutionUnits))) Source #

Era-related

data BabbageEra Source #

A type used as a tag to distinguish the Babbage era.

Instances

Instances details

IsAllegraBasedEra BabbageEra Source #

Instance details

Defined in Cardano.Api.Internal.Eon.AllegraEraOnwards

Methods

allegraBasedEra :: AllegraEraOnwards BabbageEra Source #

IsAlonzoBasedEra BabbageEra Source #

Instance details

Defined in Cardano.Api.Internal.Eon.AlonzoEraOnwards

Methods

alonzoBasedEra :: AlonzoEraOnwards BabbageEra Source #

IsBabbageBasedEra BabbageEra Source #

Instance details

Defined in Cardano.Api.Internal.Eon.BabbageEraOnwards

Methods

babbageBasedEra :: BabbageEraOnwards BabbageEra Source #

IsMaryBasedEra BabbageEra Source #

Instance details

Defined in Cardano.Api.Internal.Eon.MaryEraOnwards

Methods

maryBasedEra :: MaryEraOnwards BabbageEra Source #

IsShelleyBasedEra BabbageEra Source #

Instance details

Defined in Cardano.Api.Internal.Eon.ShelleyBasedEra

Methods

shelleyBasedEra :: ShelleyBasedEra BabbageEra Source #

IsCardanoEra BabbageEra Source #

Instance details

Defined in Cardano.Api.Internal.Eras.Core

Methods

cardanoEra :: CardanoEra BabbageEra Source #

IsEra BabbageEra Source #

Instance details

Defined in Cardano.Api.Internal.Experimental.Eras

Methods

useEra :: Era BabbageEra Source #

HasTypeProxy BabbageEra Source #

Instance details

Defined in Cardano.Api.Internal.Eras.Core

Associated Types

data AsType BabbageEra
Instance details Defined in Cardano.Api.Internal.Eras.Core data AsType BabbageEra = AsBabbageEra

Methods

proxyToAsType :: Proxy BabbageEra -> AsType BabbageEra Source #

HasScriptLanguageInEra PlutusScriptV1 BabbageEra Source #

Instance details

Defined in Cardano.Api.Internal.Script

Methods

scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV1 BabbageEra Source #

HasScriptLanguageInEra PlutusScriptV2 BabbageEra Source #

Instance details

Defined in Cardano.Api.Internal.Script

Methods

scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV2 BabbageEra Source #

ToAlonzoScript PlutusScriptV1 BabbageEra Source #

Instance details

Defined in Cardano.Api.Internal.Script

Methods

toLedgerScript :: PlutusScript PlutusScriptV1 -> AlonzoScript (ShelleyLedgerEra BabbageEra) Source #

ToAlonzoScript PlutusScriptV2 BabbageEra Source #

Instance details

Defined in Cardano.Api.Internal.Script

Methods

toLedgerScript :: PlutusScript PlutusScriptV2 -> AlonzoScript (ShelleyLedgerEra BabbageEra) Source #

data AsType BabbageEra Source #

Instance details

Defined in Cardano.Api.Internal.Eras.Core

data AsType BabbageEra = AsBabbageEra

data ConwayEra Source #

A type used as a tag to distinguish the Conway era.

Instances

Instances details

IsAllegraBasedEra ConwayEra Source #

Instance details

Defined in Cardano.Api.Internal.Eon.AllegraEraOnwards

Methods

allegraBasedEra :: AllegraEraOnwards ConwayEra Source #

IsAlonzoBasedEra ConwayEra Source #

Instance details

Defined in Cardano.Api.Internal.Eon.AlonzoEraOnwards

Methods

alonzoBasedEra :: AlonzoEraOnwards ConwayEra Source #

IsBabbageBasedEra ConwayEra Source #

Instance details

Defined in Cardano.Api.Internal.Eon.BabbageEraOnwards

Methods

babbageBasedEra :: BabbageEraOnwards ConwayEra Source #

IsConwayBasedEra ConwayEra Source #

Instance details

Defined in Cardano.Api.Internal.Eon.ConwayEraOnwards

Methods

conwayBasedEra :: ConwayEraOnwards ConwayEra Source #

IsMaryBasedEra ConwayEra Source #

Instance details

Defined in Cardano.Api.Internal.Eon.MaryEraOnwards

Methods

maryBasedEra :: MaryEraOnwards ConwayEra Source #

IsShelleyBasedEra ConwayEra Source #

Instance details

Defined in Cardano.Api.Internal.Eon.ShelleyBasedEra

Methods

shelleyBasedEra :: ShelleyBasedEra ConwayEra Source #

IsCardanoEra ConwayEra Source #

Instance details

Defined in Cardano.Api.Internal.Eras.Core

Methods

cardanoEra :: CardanoEra ConwayEra Source #

IsEra ConwayEra Source #

Instance details

Defined in Cardano.Api.Internal.Experimental.Eras

Methods

useEra :: Era ConwayEra Source #

HasTypeProxy ConwayEra Source #

Instance details

Defined in Cardano.Api.Internal.Eras.Core

Associated Types

data AsType ConwayEra
Instance details Defined in Cardano.Api.Internal.Eras.Core data AsType ConwayEra = AsConwayEra

Methods

proxyToAsType :: Proxy ConwayEra -> AsType ConwayEra Source #

HasScriptLanguageInEra PlutusScriptV1 ConwayEra Source #

Instance details

Defined in Cardano.Api.Internal.Script

Methods

scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV1 ConwayEra Source #

HasScriptLanguageInEra PlutusScriptV2 ConwayEra Source #

Instance details

Defined in Cardano.Api.Internal.Script

Methods

scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV2 ConwayEra Source #

HasScriptLanguageInEra PlutusScriptV3 ConwayEra Source #

Instance details

Defined in Cardano.Api.Internal.Script

Methods

scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV3 ConwayEra Source #

ToAlonzoScript PlutusScriptV1 ConwayEra Source #

Instance details

Defined in Cardano.Api.Internal.Script

Methods

toLedgerScript :: PlutusScript PlutusScriptV1 -> AlonzoScript (ShelleyLedgerEra ConwayEra) Source #

ToAlonzoScript PlutusScriptV2 ConwayEra Source #

Instance details

Defined in Cardano.Api.Internal.Script

Methods

toLedgerScript :: PlutusScript PlutusScriptV2 -> AlonzoScript (ShelleyLedgerEra ConwayEra) Source #

ToAlonzoScript PlutusScriptV3 ConwayEra Source #

Instance details

Defined in Cardano.Api.Internal.Script

Methods

toLedgerScript :: PlutusScript PlutusScriptV3 -> AlonzoScript (ShelleyLedgerEra ConwayEra) Source #

data AsType ConwayEra Source #

Instance details

Defined in Cardano.Api.Internal.Eras.Core

data AsType ConwayEra = AsConwayEra

data Era era where Source #

Represents the latest Cardano blockchain eras, including the one currently on mainnet and the upcoming one.

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

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

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.Internal.Experimental.Eras Methods inEonForEra :: a -> (Era era -> a) -> CardanoEra era -> a Source #
TestEquality Era Source #
Instance details Defined in Cardano.Api.Internal.Experimental.Eras Methods testEquality :: Era a -> Era b -> Maybe (a :~: b) Source #
Convert BabbageEraOnwards Era Source #
Instance details Defined in Cardano.Api.Internal.Experimental.Eras Methods convert :: BabbageEraOnwards era -> Era era Source #
Convert Era BabbageEraOnwards Source #
Instance details Defined in Cardano.Api.Internal.Experimental.Eras Methods convert :: Era era -> BabbageEraOnwards era Source #
Convert Era ShelleyBasedEra Source #
Instance details Defined in Cardano.Api.Internal.Experimental.Eras Methods convert :: Era era -> ShelleyBasedEra era Source #
Convert Era CardanoEra Source #
Instance details Defined in Cardano.Api.Internal.Experimental.Eras Methods convert :: Era era -> CardanoEra era Source #
ToJSON (Era era) Source #
Instance details Defined in Cardano.Api.Internal.Experimental.Eras 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.Internal.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.Internal.Experimental.Eras Methods (==) :: Era era -> Era era -> Bool Source # (/=) :: Era era -> Era era -> Bool Source #
Pretty (Era era) Source #
Instance details Defined in Cardano.Api.Internal.Experimental.Eras Methods pretty :: Era era -> Doc ann # prettyList :: [Era era] -> Doc ann #
FromJSON (Some Era) Source #
Instance details Defined in Cardano.Api.Internal.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.Internal.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.Internal.Experimental.Eras Methods minBound :: Some Era Source # maxBound :: Some Era Source #
Enum (Some Era) Source #
Instance details Defined in Cardano.Api.Internal.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 Era) Source #
Instance details Defined in Cardano.Api.Internal.Experimental.Eras 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.Internal.Experimental.Eras Methods (==) :: Some Era -> Some Era -> Bool Source # (/=) :: Some Era -> Some Era -> Bool Source #
Ord (Some Era) Source #
Instance details Defined in Cardano.Api.Internal.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.Internal.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.Internal.Experimental.Eras Methods useEra :: Era BabbageEra Source #
IsEra ConwayEra Source #
Instance details Defined in Cardano.Api.Internal.Experimental.Eras 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.Internal.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.Internal.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.Internal.Experimental.Eras Methods minBound :: Some Era Source # maxBound :: Some Era Source #
Enum (Some Era) Source #
Instance details Defined in Cardano.Api.Internal.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 Era) Source #
Instance details Defined in Cardano.Api.Internal.Experimental.Eras 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.Internal.Experimental.Eras Methods (==) :: Some Era -> Some Era -> Bool Source # (/=) :: Some Era -> Some Era -> Bool Source #
Ord (Some Era) Source #
Instance details Defined in Cardano.Api.Internal.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.Internal.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. Therefore, protocol versions are limited to the current mainnet era and the next (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.Internal.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.Internal.Experimental.Eras Methods pretty :: DeprecatedEra era -> Doc ann # prettyList :: [DeprecatedEra era] -> Doc ann #

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

babbageEraOnwardsToEra :: BabbageEraOnwards era -> Era era Source #

Deprecated: Use convert instead.

eraToBabbageEraOnwards :: Era era -> BabbageEraOnwards era Source #

Deprecated: Use convert instead.

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

IsEra era => Show (UnsignedTx era) Source #
Instance details Defined in Cardano.Api.Internal.Experimental.Tx Methods showsPrec :: Int -> UnsignedTx era -> ShowS Source # show :: UnsignedTx era -> String Source # showList :: [UnsignedTx era] -> ShowS Source #

Creating transactions

Contents

Transaction-related

Instances

Era-related

Instances

Instances

Instances

Instances

Instances

Instances