Safe Haskell	None
Language	Haskell2010

Cardano.Api.Experimental

Contents

Tx related

Description

This module provides an experimental library interface that is intended to replace the existing api. It is subject to dramatic changes so use 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 :: Type -> Type) where
- Some :: forall (f :: Type -> Type) a. (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)

Tx related

newtype UnsignedTx era #

Constructors

UnsignedTx (Tx (LedgerEra era))

Instances

Instances details

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

newtype UnsignedTxError #

Constructors

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 #

Instances

Instances details

IsAllegraBasedEra BabbageEra

Instance details

Defined in Cardano.Api.Eon.AllegraEraOnwards

Methods

allegraBasedEra :: AllegraEraOnwards BabbageEra #

IsAlonzoBasedEra BabbageEra

Instance details

Defined in Cardano.Api.Eon.AlonzoEraOnwards

Methods

alonzoBasedEra :: AlonzoEraOnwards BabbageEra #

IsBabbageBasedEra BabbageEra

Instance details

Defined in Cardano.Api.Eon.BabbageEraOnwards

Methods

babbageBasedEra :: BabbageEraOnwards BabbageEra #

IsMaryBasedEra BabbageEra

Instance details

Defined in Cardano.Api.Eon.MaryEraOnwards

Methods

maryBasedEra :: MaryEraOnwards BabbageEra #

IsShelleyBasedEra BabbageEra

Instance details

Defined in Cardano.Api.Eon.ShelleyBasedEra

Methods

shelleyBasedEra :: ShelleyBasedEra BabbageEra #

IsCardanoEra BabbageEra

Instance details

Defined in Cardano.Api.Eras.Core

Methods

cardanoEra :: CardanoEra BabbageEra #

IsEra BabbageEra

Instance details

Defined in Cardano.Api.Experimental.Eras

Methods

useEra :: Era BabbageEra #

HasTypeProxy BabbageEra

Instance details

Defined in Cardano.Api.Eras.Core

Associated Types

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

Methods

proxyToAsType :: Proxy BabbageEra -> AsType BabbageEra #

HasScriptLanguageInEra PlutusScriptV1 BabbageEra

Instance details

Defined in Cardano.Api.Script

Methods

scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV1 BabbageEra #

HasScriptLanguageInEra PlutusScriptV2 BabbageEra

Instance details

Defined in Cardano.Api.Script

Methods

scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV2 BabbageEra #

ToAlonzoScript PlutusScriptV1 BabbageEra

Instance details

Defined in Cardano.Api.Script

Methods

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

ToAlonzoScript PlutusScriptV2 BabbageEra

Instance details

Defined in Cardano.Api.Script

Methods

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

data AsType BabbageEra

Instance details

Defined in Cardano.Api.Eras.Core

data AsType BabbageEra = AsBabbageEra

data ConwayEra #

Instances

Instances details

IsAllegraBasedEra ConwayEra

Instance details

Defined in Cardano.Api.Eon.AllegraEraOnwards

Methods

allegraBasedEra :: AllegraEraOnwards ConwayEra #

IsAlonzoBasedEra ConwayEra

Instance details

Defined in Cardano.Api.Eon.AlonzoEraOnwards

Methods

alonzoBasedEra :: AlonzoEraOnwards ConwayEra #

IsBabbageBasedEra ConwayEra

Instance details

Defined in Cardano.Api.Eon.BabbageEraOnwards

Methods

babbageBasedEra :: BabbageEraOnwards ConwayEra #

IsConwayBasedEra ConwayEra

Instance details

Defined in Cardano.Api.Eon.ConwayEraOnwards

Methods

conwayBasedEra :: ConwayEraOnwards ConwayEra #

IsMaryBasedEra ConwayEra

Instance details

Defined in Cardano.Api.Eon.MaryEraOnwards

Methods

maryBasedEra :: MaryEraOnwards ConwayEra #

IsShelleyBasedEra ConwayEra

Instance details

Defined in Cardano.Api.Eon.ShelleyBasedEra

Methods

shelleyBasedEra :: ShelleyBasedEra ConwayEra #

IsCardanoEra ConwayEra

Instance details

Defined in Cardano.Api.Eras.Core

Methods

cardanoEra :: CardanoEra ConwayEra #

IsEra ConwayEra

Instance details

Defined in Cardano.Api.Experimental.Eras

Methods

useEra :: Era ConwayEra #

HasTypeProxy ConwayEra

Instance details

Defined in Cardano.Api.Eras.Core

Associated Types

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

Methods

proxyToAsType :: Proxy ConwayEra -> AsType ConwayEra #

HasScriptLanguageInEra PlutusScriptV1 ConwayEra

Instance details

Defined in Cardano.Api.Script

Methods

scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV1 ConwayEra #

HasScriptLanguageInEra PlutusScriptV2 ConwayEra

Instance details

Defined in Cardano.Api.Script

Methods

scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV2 ConwayEra #

HasScriptLanguageInEra PlutusScriptV3 ConwayEra

Instance details

Defined in Cardano.Api.Script

Methods

scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV3 ConwayEra #

ToAlonzoScript PlutusScriptV1 ConwayEra

Instance details

Defined in Cardano.Api.Script

Methods

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

ToAlonzoScript PlutusScriptV2 ConwayEra

Instance details

Defined in Cardano.Api.Script

Methods

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

ToAlonzoScript PlutusScriptV3 ConwayEra

Instance details

Defined in Cardano.Api.Script

Methods

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

data AsType ConwayEra

Instance details

Defined in Cardano.Api.Eras.Core

data AsType ConwayEra = AsConwayEra

data Era era where #

Constructors

BabbageEra :: Era BabbageEra
ConwayEra :: Era ConwayEra

Instances

Instances details

Eon Era
Instance details Defined in Cardano.Api.Experimental.Eras Methods inEonForEra :: a -> (Era era -> a) -> CardanoEra era -> a #
TestEquality Era
Instance details Defined in Cardano.Api.Experimental.Eras Methods testEquality :: Era a -> Era b -> Maybe (a :~: b) Source #
FromJSON (Some Era)
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)
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)
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)
Instance details Defined in Cardano.Api.Experimental.Eras Methods minBound :: Some Era Source # maxBound :: Some Era Source #
Enum (Some Era)
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)
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)
Instance details Defined in Cardano.Api.Experimental.Eras Methods (==) :: Era era -> Era era -> Bool Source # (/=) :: Era era -> Era era -> Bool Source #
Ord (Some Era)
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)
Instance details Defined in Cardano.Api.Experimental.Eras Methods pretty :: Era era -> Doc ann # prettyList :: [Era era] -> Doc ann #
Pretty (Some Era)
Instance details Defined in Cardano.Api.Experimental.Eras Methods pretty :: Some Era -> Doc ann # prettyList :: [Some Era] -> Doc ann #

class IsEra era where #

Methods

useEra :: Era era #

Instances

Instances details

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

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

Constructors

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

Instances

Instances details

FromJSON (Some Era)
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)
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)
Instance details Defined in Cardano.Api.Experimental.Eras Methods minBound :: Some Era Source # maxBound :: Some Era Source #
Enum (Some Era)
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)
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)
Instance details Defined in Cardano.Api.Experimental.Eras Methods (==) :: Some f -> Some f -> Bool Source # (/=) :: Some f -> Some f -> Bool Source #
Ord (Some Era)
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)
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 ... #

Equations

LedgerEra BabbageEra = Babbage
LedgerEra ConwayEra = Conway

newtype DeprecatedEra era #

Constructors

DeprecatedEra (ShelleyBasedEra era)

Instances

Instances details

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

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) #