However we opt for a single type level tag SimpleScript' as the second version of of the language introduced in the Allegra era is a superset of the language introduced in the Shelley era.

Place holder type to show what the pattern is to extend to multiple languages, not just multiple versions of a single language.

Instances

Instances details

HasTypeProxy PlutusScriptV1 Source #

Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType PlutusScriptV1
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV1 = AsPlutusScriptV1

Methods

proxyToAsType :: Proxy PlutusScriptV1 -> AsType PlutusScriptV1 Source #

IsPlutusScriptLanguage PlutusScriptV1 Source #

Instance details

Defined in Cardano.Api.Script

Methods

plutusScriptVersion :: PlutusScriptVersion PlutusScriptV1 Source #

IsScriptLanguage PlutusScriptV1 Source #

Instance details

Defined in Cardano.Api.Script

Methods

scriptLanguage :: ScriptLanguage PlutusScriptV1 Source #

HasScriptLanguageInEra PlutusScriptV1 AlonzoEra Source #

Instance details

Defined in Cardano.Api.Script

Methods

scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV1 AlonzoEra Source #

HasScriptLanguageInEra PlutusScriptV1 BabbageEra Source #

Instance details

Defined in Cardano.Api.Script

Methods

scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV1 BabbageEra Source #

HasScriptLanguageInEra PlutusScriptV1 ConwayEra Source #

Instance details

Defined in Cardano.Api.Script

Methods

scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV1 ConwayEra Source #

ToAlonzoScript PlutusScriptV1 BabbageEra Source #

Instance details

Defined in Cardano.Api.Script

Methods

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

ToAlonzoScript PlutusScriptV1 ConwayEra Source #

Instance details

Defined in Cardano.Api.Script

Methods

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

data AsType PlutusScriptV1 Source #

Instance details

Defined in Cardano.Api.Script

data AsType PlutusScriptV1 = AsPlutusScriptV1

data PlutusScriptV2 Source #

Instances

Instances details

HasTypeProxy PlutusScriptV2 Source #

Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType PlutusScriptV2
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV2 = AsPlutusScriptV2

Methods

proxyToAsType :: Proxy PlutusScriptV2 -> AsType PlutusScriptV2 Source #

IsPlutusScriptLanguage PlutusScriptV2 Source #

Instance details

Defined in Cardano.Api.Script

Methods

plutusScriptVersion :: PlutusScriptVersion PlutusScriptV2 Source #

IsScriptLanguage PlutusScriptV2 Source #

Instance details

Defined in Cardano.Api.Script

Methods

scriptLanguage :: ScriptLanguage PlutusScriptV2 Source #

HasScriptLanguageInEra PlutusScriptV2 BabbageEra Source #

Instance details

Defined in Cardano.Api.Script

Methods

scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV2 BabbageEra Source #

HasScriptLanguageInEra PlutusScriptV2 ConwayEra Source #

Instance details

Defined in Cardano.Api.Script

Methods

scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV2 ConwayEra Source #

ToAlonzoScript PlutusScriptV2 BabbageEra Source #

Instance details

Defined in Cardano.Api.Script

Methods

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

ToAlonzoScript PlutusScriptV2 ConwayEra Source #

Instance details

Defined in Cardano.Api.Script

Methods

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

data AsType PlutusScriptV2 Source #

Instance details

Defined in Cardano.Api.Script

data AsType PlutusScriptV2 = AsPlutusScriptV2

data PlutusScriptV3 Source #

Instances

Instances details

HasTypeProxy PlutusScriptV3 Source #

Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType PlutusScriptV3
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV3 = AsPlutusScriptV3

Methods

proxyToAsType :: Proxy PlutusScriptV3 -> AsType PlutusScriptV3 Source #

IsPlutusScriptLanguage PlutusScriptV3 Source #

Instance details

Defined in Cardano.Api.Script

Methods

plutusScriptVersion :: PlutusScriptVersion PlutusScriptV3 Source #

IsScriptLanguage PlutusScriptV3 Source #

Instance details

Defined in Cardano.Api.Script

Methods

scriptLanguage :: ScriptLanguage PlutusScriptV3 Source #

HasScriptLanguageInEra PlutusScriptV3 ConwayEra Source #

Instance details

Defined in Cardano.Api.Script

Methods

scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV3 ConwayEra Source #

ToAlonzoScript PlutusScriptV3 ConwayEra Source #

Instance details

Defined in Cardano.Api.Script

Methods

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

data AsType PlutusScriptV3 Source #

Instance details

Defined in Cardano.Api.Script

data AsType PlutusScriptV3 = AsPlutusScriptV3

data ScriptLanguage lang where Source #

Constructors

SimpleScriptLanguage :: ScriptLanguage SimpleScript'
PlutusScriptLanguage :: forall lang. IsPlutusScriptLanguage lang => PlutusScriptVersion lang -> ScriptLanguage lang

Instances

Instances details

TestEquality ScriptLanguage Source #
Instance details Defined in Cardano.Api.Script Methods testEquality :: ScriptLanguage a -> ScriptLanguage b -> Maybe (a :~: b) Source #
Show (ScriptLanguage lang) Source #
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> ScriptLanguage lang -> ShowS Source # show :: ScriptLanguage lang -> String Source # showList :: [ScriptLanguage lang] -> ShowS Source #
Eq (ScriptLanguage lang) Source #
Instance details Defined in Cardano.Api.Script Methods (==) :: ScriptLanguage lang -> ScriptLanguage lang -> Bool Source # (/=) :: ScriptLanguage lang -> ScriptLanguage lang -> Bool Source #

data PlutusScriptVersion lang where Source #

Constructors

PlutusScriptV1 :: PlutusScriptVersion PlutusScriptV1
PlutusScriptV2 :: PlutusScriptVersion PlutusScriptV2
PlutusScriptV3 :: PlutusScriptVersion PlutusScriptV3

Instances

Instances details

TestEquality PlutusScriptVersion Source #
Instance details Defined in Cardano.Api.Script Methods testEquality :: PlutusScriptVersion a -> PlutusScriptVersion b -> Maybe (a :~: b) Source #
Show (PlutusScriptVersion lang) Source #
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> PlutusScriptVersion lang -> ShowS Source # show :: PlutusScriptVersion lang -> String Source # showList :: [PlutusScriptVersion lang] -> ShowS Source #
Eq (PlutusScriptVersion lang) Source #
Instance details Defined in Cardano.Api.Script Methods (==) :: PlutusScriptVersion lang -> PlutusScriptVersion lang -> Bool Source # (/=) :: PlutusScriptVersion lang -> PlutusScriptVersion lang -> Bool Source #

data AnyScriptLanguage where Source #

Constructors

AnyScriptLanguage :: forall lang. ScriptLanguage lang -> AnyScriptLanguage

Instances

Instances details

Bounded AnyScriptLanguage Source #
Instance details Defined in Cardano.Api.Script Methods minBound :: AnyScriptLanguage Source # maxBound :: AnyScriptLanguage Source #
Enum AnyScriptLanguage Source #
Instance details Defined in Cardano.Api.Script Methods succ :: AnyScriptLanguage -> AnyScriptLanguage Source # pred :: AnyScriptLanguage -> AnyScriptLanguage Source # toEnum :: Int -> AnyScriptLanguage Source # fromEnum :: AnyScriptLanguage -> Int Source # enumFrom :: AnyScriptLanguage -> [AnyScriptLanguage] Source # enumFromThen :: AnyScriptLanguage -> AnyScriptLanguage -> [AnyScriptLanguage] Source # enumFromTo :: AnyScriptLanguage -> AnyScriptLanguage -> [AnyScriptLanguage] Source # enumFromThenTo :: AnyScriptLanguage -> AnyScriptLanguage -> AnyScriptLanguage -> [AnyScriptLanguage] Source #
Show AnyScriptLanguage Source #
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> AnyScriptLanguage -> ShowS Source # show :: AnyScriptLanguage -> String Source # showList :: [AnyScriptLanguage] -> ShowS Source #
Eq AnyScriptLanguage Source #
Instance details Defined in Cardano.Api.Script Methods (==) :: AnyScriptLanguage -> AnyScriptLanguage -> Bool Source # (/=) :: AnyScriptLanguage -> AnyScriptLanguage -> Bool Source #
Ord AnyScriptLanguage Source #
Instance details Defined in Cardano.Api.Script Methods compare :: AnyScriptLanguage -> AnyScriptLanguage -> Ordering Source # (<) :: AnyScriptLanguage -> AnyScriptLanguage -> Bool Source # (<=) :: AnyScriptLanguage -> AnyScriptLanguage -> Bool Source # (>) :: AnyScriptLanguage -> AnyScriptLanguage -> Bool Source # (>=) :: AnyScriptLanguage -> AnyScriptLanguage -> Bool Source # max :: AnyScriptLanguage -> AnyScriptLanguage -> AnyScriptLanguage Source # min :: AnyScriptLanguage -> AnyScriptLanguage -> AnyScriptLanguage Source #

data AnyPlutusScriptVersion where Source #

Constructors

AnyPlutusScriptVersion :: forall lang. IsPlutusScriptLanguage lang => PlutusScriptVersion lang -> AnyPlutusScriptVersion

Instances

Instances details

FromJSON AnyPlutusScriptVersion Source #
Instance details Defined in Cardano.Api.Script Methods parseJSON :: Value -> Parser AnyPlutusScriptVersion # parseJSONList :: Value -> Parser [AnyPlutusScriptVersion] # omittedField :: Maybe AnyPlutusScriptVersion #
FromJSONKey AnyPlutusScriptVersion Source #
Instance details Defined in Cardano.Api.Script Methods fromJSONKey :: FromJSONKeyFunction AnyPlutusScriptVersion fromJSONKeyList :: FromJSONKeyFunction [AnyPlutusScriptVersion]
ToJSON AnyPlutusScriptVersion Source #
Instance details Defined in Cardano.Api.Script Methods toJSON :: AnyPlutusScriptVersion -> Value # toEncoding :: AnyPlutusScriptVersion -> Encoding # toJSONList :: [AnyPlutusScriptVersion] -> Value # toEncodingList :: [AnyPlutusScriptVersion] -> Encoding # omitField :: AnyPlutusScriptVersion -> Bool #
ToJSONKey AnyPlutusScriptVersion Source #
Instance details Defined in Cardano.Api.Script Methods toJSONKey :: ToJSONKeyFunction AnyPlutusScriptVersion toJSONKeyList :: ToJSONKeyFunction [AnyPlutusScriptVersion]
Bounded AnyPlutusScriptVersion Source #
Instance details Defined in Cardano.Api.Script Methods minBound :: AnyPlutusScriptVersion Source # maxBound :: AnyPlutusScriptVersion Source #
Enum AnyPlutusScriptVersion Source #
Instance details Defined in Cardano.Api.Script Methods succ :: AnyPlutusScriptVersion -> AnyPlutusScriptVersion Source # pred :: AnyPlutusScriptVersion -> AnyPlutusScriptVersion Source # toEnum :: Int -> AnyPlutusScriptVersion Source # fromEnum :: AnyPlutusScriptVersion -> Int Source # enumFrom :: AnyPlutusScriptVersion -> [AnyPlutusScriptVersion] Source # enumFromThen :: AnyPlutusScriptVersion -> AnyPlutusScriptVersion -> [AnyPlutusScriptVersion] Source # enumFromTo :: AnyPlutusScriptVersion -> AnyPlutusScriptVersion -> [AnyPlutusScriptVersion] Source # enumFromThenTo :: AnyPlutusScriptVersion -> AnyPlutusScriptVersion -> AnyPlutusScriptVersion -> [AnyPlutusScriptVersion] Source #
Show AnyPlutusScriptVersion Source #
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> AnyPlutusScriptVersion -> ShowS Source # show :: AnyPlutusScriptVersion -> String Source # showList :: [AnyPlutusScriptVersion] -> ShowS Source #
FromCBOR AnyPlutusScriptVersion Source #
Instance details Defined in Cardano.Api.Script Methods fromCBOR :: Decoder s AnyPlutusScriptVersion Source # label :: Proxy AnyPlutusScriptVersion -> Text Source #
ToCBOR AnyPlutusScriptVersion Source #
Instance details Defined in Cardano.Api.Script Methods toCBOR :: AnyPlutusScriptVersion -> Encoding Source # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy AnyPlutusScriptVersion -> Size Source # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [AnyPlutusScriptVersion] -> Size Source #
Eq AnyPlutusScriptVersion Source #
Instance details Defined in Cardano.Api.Script Methods (==) :: AnyPlutusScriptVersion -> AnyPlutusScriptVersion -> Bool Source # (/=) :: AnyPlutusScriptVersion -> AnyPlutusScriptVersion -> Bool Source #
Ord AnyPlutusScriptVersion Source #
Instance details Defined in Cardano.Api.Script Methods compare :: AnyPlutusScriptVersion -> AnyPlutusScriptVersion -> Ordering Source # (<) :: AnyPlutusScriptVersion -> AnyPlutusScriptVersion -> Bool Source # (<=) :: AnyPlutusScriptVersion -> AnyPlutusScriptVersion -> Bool Source # (>) :: AnyPlutusScriptVersion -> AnyPlutusScriptVersion -> Bool Source # (>=) :: AnyPlutusScriptVersion -> AnyPlutusScriptVersion -> Bool Source # max :: AnyPlutusScriptVersion -> AnyPlutusScriptVersion -> AnyPlutusScriptVersion Source # min :: AnyPlutusScriptVersion -> AnyPlutusScriptVersion -> AnyPlutusScriptVersion Source #

class IsScriptLanguage lang => IsPlutusScriptLanguage lang where Source #

Methods

plutusScriptVersion :: PlutusScriptVersion lang Source #

Instances

Instances details

IsPlutusScriptLanguage PlutusScriptV1 Source #
Instance details Defined in Cardano.Api.Script Methods plutusScriptVersion :: PlutusScriptVersion PlutusScriptV1 Source #
IsPlutusScriptLanguage PlutusScriptV2 Source #
Instance details Defined in Cardano.Api.Script Methods plutusScriptVersion :: PlutusScriptVersion PlutusScriptV2 Source #
IsPlutusScriptLanguage PlutusScriptV3 Source #
Instance details Defined in Cardano.Api.Script Methods plutusScriptVersion :: PlutusScriptVersion PlutusScriptV3 Source #

class HasTypeProxy lang => IsScriptLanguage lang where Source #

Methods

scriptLanguage :: ScriptLanguage lang Source #

Instances

Instances details

IsScriptLanguage PlutusScriptV1 Source #
Instance details Defined in Cardano.Api.Script Methods scriptLanguage :: ScriptLanguage PlutusScriptV1 Source #
IsScriptLanguage PlutusScriptV2 Source #
Instance details Defined in Cardano.Api.Script Methods scriptLanguage :: ScriptLanguage PlutusScriptV2 Source #
IsScriptLanguage PlutusScriptV3 Source #
Instance details Defined in Cardano.Api.Script Methods scriptLanguage :: ScriptLanguage PlutusScriptV3 Source #
IsScriptLanguage SimpleScript' Source #
Instance details Defined in Cardano.Api.Script Methods scriptLanguage :: ScriptLanguage SimpleScript' Source #

Scripts in a specific language

data Script lang where Source #

A script in a particular language.

See also ScriptInAnyLang for a script in any of the known languages.

See also ScriptInEra for a script in a language that is available within a particular era.

Note that some but not all scripts have an external JSON syntax, hence this type has no JSON serialisation instances. The SimpleScript family of languages do have a JSON syntax and thus have ToJSON/FromJSON instances.

Constructors

SimpleScript :: !SimpleScript -> Script SimpleScript'
PlutusScript :: forall lang. IsPlutusScriptLanguage lang => !(PlutusScriptVersion lang) -> !(PlutusScript lang) -> Script lang

Instances

Instances details

Show (Script lang) Source #

Instance details

Defined in Cardano.Api.Script

Methods

showsPrec :: Int -> Script lang -> ShowS Source #

show :: Script lang -> String Source #

showList :: [Script lang] -> ShowS Source #

HasTypeProxy lang => HasTypeProxy (Script lang) Source #

Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType (Script lang)
Instance details Defined in Cardano.Api.Script data AsType (Script lang) = AsScript (AsType lang)

Methods

proxyToAsType :: Proxy (Script lang) -> AsType (Script lang) Source #

IsScriptLanguage lang => SerialiseAsCBOR (Script lang) Source #

Instance details

Defined in Cardano.Api.Script

Methods

serialiseToCBOR :: Script lang -> ByteString Source #

deserialiseFromCBOR :: AsType (Script lang) -> ByteString -> Either DecoderError (Script lang) Source #

IsScriptLanguage lang => HasTextEnvelope (Script lang) Source #

Instance details

Defined in Cardano.Api.Script

Methods

textEnvelopeType :: AsType (Script lang) -> TextEnvelopeType Source #

textEnvelopeDefaultDescr :: Script lang -> TextEnvelopeDescr Source #

Eq (Script lang) Source #

Instance details

Defined in Cardano.Api.Script

Methods

(==) :: Script lang -> Script lang -> Bool Source #

(/=) :: Script lang -> Script lang -> Bool Source #

data AsType (Script lang) Source #

Instance details

Defined in Cardano.Api.Script

data AsType (Script lang) = AsScript (AsType lang)

Scripts in any language

data ScriptInAnyLang where Source #

Sometimes it is necessary to handle all languages without making static type distinctions between languages. For example, when reading external input, or before the era context is known.

Use toScriptInEra to convert to a script in the context of an era.

Constructors

ScriptInAnyLang :: forall lang. ScriptLanguage lang -> Script lang -> ScriptInAnyLang

Instances

Instances details

FromJSON ScriptInAnyLang Source #

Instance details

Defined in Cardano.Api.Script

Methods

parseJSON :: Value -> Parser ScriptInAnyLang #

parseJSONList :: Value -> Parser [ScriptInAnyLang] #

omittedField :: Maybe ScriptInAnyLang #

ToJSON ScriptInAnyLang Source #

Instance details

Defined in Cardano.Api.Script

Methods

toJSON :: ScriptInAnyLang -> Value #

toEncoding :: ScriptInAnyLang -> Encoding #

toJSONList :: [ScriptInAnyLang] -> Value #

toEncodingList :: [ScriptInAnyLang] -> Encoding #

omitField :: ScriptInAnyLang -> Bool #

Show ScriptInAnyLang Source #

Instance details

Defined in Cardano.Api.Script

Methods

showsPrec :: Int -> ScriptInAnyLang -> ShowS Source #

show :: ScriptInAnyLang -> String Source #

showList :: [ScriptInAnyLang] -> ShowS Source #

HasTypeProxy ScriptInAnyLang Source #

Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType ScriptInAnyLang
Instance details Defined in Cardano.Api.Script data AsType ScriptInAnyLang = AsScriptInAnyLang

Methods

proxyToAsType :: Proxy ScriptInAnyLang -> AsType ScriptInAnyLang Source #

Eq ScriptInAnyLang Source #

Instance details

Defined in Cardano.Api.Script

Methods

(==) :: ScriptInAnyLang -> ScriptInAnyLang -> Bool Source #

(/=) :: ScriptInAnyLang -> ScriptInAnyLang -> Bool Source #

data AsType ScriptInAnyLang Source #

Instance details

Defined in Cardano.Api.Script

data AsType ScriptInAnyLang = AsScriptInAnyLang

toScriptInAnyLang :: Script lang -> ScriptInAnyLang Source #

Convert a script in a specific statically-known language to a ScriptInAnyLang.

No inverse to this is provided, just do case analysis on the ScriptLanguage field within the ScriptInAnyLang constructor.

Scripts in an era

data ScriptInEra era where Source #

Constructors

ScriptInEra :: forall lang era. ScriptLanguageInEra lang era -> Script lang -> ScriptInEra era

Instances

Instances details

Show (ScriptInEra era) Source #

Instance details

Defined in Cardano.Api.Script

Methods

showsPrec :: Int -> ScriptInEra era -> ShowS Source #

show :: ScriptInEra era -> String Source #

showList :: [ScriptInEra era] -> ShowS Source #

HasTypeProxy era => HasTypeProxy (ScriptInEra era) Source #

Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType (ScriptInEra era)
Instance details Defined in Cardano.Api.Script data AsType (ScriptInEra era) = AsScriptInEra (AsType era)

Methods

proxyToAsType :: Proxy (ScriptInEra era) -> AsType (ScriptInEra era) Source #

Eq (ScriptInEra era) Source #

Instance details

Defined in Cardano.Api.Script

Methods

(==) :: ScriptInEra era -> ScriptInEra era -> Bool Source #

(/=) :: ScriptInEra era -> ScriptInEra era -> Bool Source #

data AsType (ScriptInEra era) Source #

Instance details

Defined in Cardano.Api.Script

data AsType (ScriptInEra era) = AsScriptInEra (AsType era)

toScriptInEra :: ShelleyBasedEra era -> ScriptInAnyLang -> Maybe (ScriptInEra era) Source #

Given a target era and a script in some language, check if the language is supported in that era, and if so return a ScriptInEra.

eraOfScriptInEra :: ScriptInEra era -> ShelleyBasedEra era Source #

class HasScriptLanguageInEra lang era where Source #

Smart-constructor for ScriptLanguageInEra to write functions manipulating scripts that do not commit to a particular era.

Methods

scriptLanguageInEra :: ScriptLanguageInEra lang era Source #

Instances

Instances details

HasScriptLanguageInEra PlutusScriptV1 AlonzoEra Source #
Instance details Defined in Cardano.Api.Script Methods scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV1 AlonzoEra Source #
HasScriptLanguageInEra PlutusScriptV1 BabbageEra Source #
Instance details Defined in Cardano.Api.Script Methods scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV1 BabbageEra Source #
HasScriptLanguageInEra PlutusScriptV1 ConwayEra Source #
Instance details Defined in Cardano.Api.Script Methods scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV1 ConwayEra Source #
HasScriptLanguageInEra PlutusScriptV2 BabbageEra Source #
Instance details Defined in Cardano.Api.Script Methods scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV2 BabbageEra Source #
HasScriptLanguageInEra PlutusScriptV2 ConwayEra Source #
Instance details Defined in Cardano.Api.Script Methods scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV2 ConwayEra Source #
HasScriptLanguageInEra PlutusScriptV3 ConwayEra Source #
Instance details Defined in Cardano.Api.Script Methods scriptLanguageInEra :: ScriptLanguageInEra PlutusScriptV3 ConwayEra Source #

class ToAlonzoScript lang era where Source #

Methods

toLedgerScript :: PlutusScript lang -> AlonzoScript (ShelleyLedgerEra era) Source #

Instances

Instances details

ToAlonzoScript PlutusScriptV1 BabbageEra Source #
Instance details Defined in Cardano.Api.Script Methods toLedgerScript :: PlutusScript PlutusScriptV1 -> AlonzoScript (ShelleyLedgerEra BabbageEra) Source #
ToAlonzoScript PlutusScriptV1 ConwayEra Source #
Instance details Defined in Cardano.Api.Script Methods toLedgerScript :: PlutusScript PlutusScriptV1 -> AlonzoScript (ShelleyLedgerEra ConwayEra) Source #
ToAlonzoScript PlutusScriptV2 BabbageEra Source #
Instance details Defined in Cardano.Api.Script Methods toLedgerScript :: PlutusScript PlutusScriptV2 -> AlonzoScript (ShelleyLedgerEra BabbageEra) Source #
ToAlonzoScript PlutusScriptV2 ConwayEra Source #
Instance details Defined in Cardano.Api.Script Methods toLedgerScript :: PlutusScript PlutusScriptV2 -> AlonzoScript (ShelleyLedgerEra ConwayEra) Source #
ToAlonzoScript PlutusScriptV3 ConwayEra Source #
Instance details Defined in Cardano.Api.Script Methods toLedgerScript :: PlutusScript PlutusScriptV3 -> AlonzoScript (ShelleyLedgerEra ConwayEra) Source #

Reference scripts

data ReferenceScript era where Source #

A reference scripts is a script that can exist at a transaction output. This greatly reduces the size of transactions that use scripts as the script no longer has to be added to the transaction, they can now be referenced via a transaction output.

Constructors

ReferenceScript :: forall era. BabbageEraOnwards era -> ScriptInAnyLang -> ReferenceScript era
ReferenceScriptNone :: forall era. ReferenceScript era

Instances

Instances details

IsCardanoEra era => FromJSON (ReferenceScript era) Source #
Instance details Defined in Cardano.Api.Script Methods parseJSON :: Value -> Parser (ReferenceScript era) # parseJSONList :: Value -> Parser [ReferenceScript era] # omittedField :: Maybe (ReferenceScript era) #
IsCardanoEra era => ToJSON (ReferenceScript era) Source #
Instance details Defined in Cardano.Api.Script Methods toJSON :: ReferenceScript era -> Value # toEncoding :: ReferenceScript era -> Encoding # toJSONList :: [ReferenceScript era] -> Value # toEncodingList :: [ReferenceScript era] -> Encoding # omitField :: ReferenceScript era -> Bool #
Show (ReferenceScript era) Source #
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> ReferenceScript era -> ShowS Source # show :: ReferenceScript era -> String Source # showList :: [ReferenceScript era] -> ShowS Source #
Eq (ReferenceScript era) Source #
Instance details Defined in Cardano.Api.Script Methods (==) :: ReferenceScript era -> ReferenceScript era -> Bool Source # (/=) :: ReferenceScript era -> ReferenceScript era -> Bool Source #

refScriptToShelleyScript :: ShelleyBasedEra era -> ReferenceScript era -> StrictMaybe (Script (ShelleyLedgerEra era)) Source #

Use of a script in an era as a witness

data WitCtxTxIn Source #

A tag type for the context in which a script is used in a transaction.

This type tags the context as being to witness a transaction input.

Instances

Instances details

IsScriptWitnessInCtx WitCtxTxIn Source #
Instance details Defined in Cardano.Api.Script Methods scriptWitnessInCtx :: ScriptWitnessInCtx WitCtxTxIn Source #

data WitCtxMint Source #

A tag type for the context in which a script is used in a transaction.

This type tags the context as being to witness minting.

Instances

Instances details

IsScriptWitnessInCtx WitCtxMint Source #
Instance details Defined in Cardano.Api.Script Methods scriptWitnessInCtx :: ScriptWitnessInCtx WitCtxMint Source #

data WitCtxStake Source #

A tag type for the context in which a script is used in a transaction.

This type tags the context as being to witness the use of stake addresses in certificates, withdrawals, voting and proposals.

Instances

Instances details

IsScriptWitnessInCtx WitCtxStake Source #
Instance details Defined in Cardano.Api.Script Methods scriptWitnessInCtx :: ScriptWitnessInCtx WitCtxStake Source #

data WitCtx witctx where Source #

This GADT provides a value-level representation of all the witness contexts. This enables pattern matching on the context to allow them to be treated in a non-uniform way.

Constructors

WitCtxTxIn :: WitCtx WitCtxTxIn
WitCtxMint :: WitCtx WitCtxMint
WitCtxStake :: WitCtx WitCtxStake

data ScriptWitness witctx era where Source #

A use of a script within a transaction body to witness that something is being used in an authorised manner. That can be

spending a transaction input
minting tokens
using a certificate (stake address certs specifically)
withdrawing from a reward account

For simple script languages, the use of the script is the same in all contexts. For Plutus scripts, using a script involves supplying a redeemer. In addition, Plutus scripts used for spending inputs must also supply the datum value used when originally creating the TxOut that is now being spent.

Constructors

SimpleScriptWitness :: forall era witctx. ScriptLanguageInEra SimpleScript' era -> SimpleScriptOrReferenceInput SimpleScript' -> ScriptWitness witctx era
PlutusScriptWitness :: forall lang era witctx. IsPlutusScriptLanguage lang => ScriptLanguageInEra lang era -> PlutusScriptVersion lang -> PlutusScriptOrReferenceInput lang -> ScriptDatum witctx -> ScriptRedeemer -> ExecutionUnits -> ScriptWitness witctx era

Instances

Instances details

Show (ScriptWitness witctx era) Source #
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> ScriptWitness witctx era -> ShowS Source # show :: ScriptWitness witctx era -> String Source # showList :: [ScriptWitness witctx era] -> ShowS Source #
Eq (ScriptWitness witctx era) Source #
Instance details Defined in Cardano.Api.Script Methods (==) :: ScriptWitness witctx era -> ScriptWitness witctx era -> Bool Source # (/=) :: ScriptWitness witctx era -> ScriptWitness witctx era -> Bool Source #

getScriptWitnessReferenceInput :: ScriptWitness witctx era -> Maybe TxIn Source #

getScriptWitnessScript :: ScriptWitness witctx era -> Maybe (ScriptInEra era) Source #

getScriptWitnessReferenceInputOrScript :: ScriptWitness witctx era -> Either (ScriptInEra era) TxIn Source #

We cannot always extract a script from a script witness due to reference scripts. Reference scripts exist in the UTxO, so without access to the UTxO we cannot retrieve the script. So in the cases for script reference, the result contains Right TxIn.

data Witness witctx era where Source #

Constructors

KeyWitness :: forall witctx era. KeyWitnessInCtx witctx -> Witness witctx era
ScriptWitness :: forall witctx era. ScriptWitnessInCtx witctx -> ScriptWitness witctx era -> Witness witctx era

Instances

Instances details

Show (Witness witctx era) Source #
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> Witness witctx era -> ShowS Source # show :: Witness witctx era -> String Source # showList :: [Witness witctx era] -> ShowS Source #
Eq (Witness witctx era) Source #
Instance details Defined in Cardano.Api.Script Methods (==) :: Witness witctx era -> Witness witctx era -> Bool Source # (/=) :: Witness witctx era -> Witness witctx era -> Bool Source #

data KeyWitnessInCtx witctx where Source #

Constructors

KeyWitnessForSpending :: KeyWitnessInCtx WitCtxTxIn
KeyWitnessForStakeAddr :: KeyWitnessInCtx WitCtxStake

Instances

Instances details

Show (KeyWitnessInCtx witctx) Source #
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> KeyWitnessInCtx witctx -> ShowS Source # show :: KeyWitnessInCtx witctx -> String Source # showList :: [KeyWitnessInCtx witctx] -> ShowS Source #
Eq (KeyWitnessInCtx witctx) Source #
Instance details Defined in Cardano.Api.Script Methods (==) :: KeyWitnessInCtx witctx -> KeyWitnessInCtx witctx -> Bool Source # (/=) :: KeyWitnessInCtx witctx -> KeyWitnessInCtx witctx -> Bool Source #

data ScriptWitnessInCtx witctx where Source #

Constructors

ScriptWitnessForSpending :: ScriptWitnessInCtx WitCtxTxIn
ScriptWitnessForMinting :: ScriptWitnessInCtx WitCtxMint
ScriptWitnessForStakeAddr :: ScriptWitnessInCtx WitCtxStake

Instances

Instances details

Show (ScriptWitnessInCtx witctx) Source #
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> ScriptWitnessInCtx witctx -> ShowS Source # show :: ScriptWitnessInCtx witctx -> String Source # showList :: [ScriptWitnessInCtx witctx] -> ShowS Source #
Eq (ScriptWitnessInCtx witctx) Source #
Instance details Defined in Cardano.Api.Script Methods (==) :: ScriptWitnessInCtx witctx -> ScriptWitnessInCtx witctx -> Bool Source # (/=) :: ScriptWitnessInCtx witctx -> ScriptWitnessInCtx witctx -> Bool Source #

class IsScriptWitnessInCtx ctx where Source #

Methods

scriptWitnessInCtx :: ScriptWitnessInCtx ctx Source #

Instances

Instances details

IsScriptWitnessInCtx WitCtxMint Source #
Instance details Defined in Cardano.Api.Script Methods scriptWitnessInCtx :: ScriptWitnessInCtx WitCtxMint Source #
IsScriptWitnessInCtx WitCtxStake Source #
Instance details Defined in Cardano.Api.Script Methods scriptWitnessInCtx :: ScriptWitnessInCtx WitCtxStake Source #
IsScriptWitnessInCtx WitCtxTxIn Source #
Instance details Defined in Cardano.Api.Script Methods scriptWitnessInCtx :: ScriptWitnessInCtx WitCtxTxIn Source #

data ScriptDatum witctx where Source #

Constructors

ScriptDatumForTxIn :: Maybe HashableScriptData -> ScriptDatum WitCtxTxIn
InlineScriptDatum :: ScriptDatum WitCtxTxIn
NoScriptDatumForMint :: ScriptDatum WitCtxMint
NoScriptDatumForStake :: ScriptDatum WitCtxStake

Instances

Instances details

Show (ScriptDatum witctx) Source #
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> ScriptDatum witctx -> ShowS Source # show :: ScriptDatum witctx -> String Source # showList :: [ScriptDatum witctx] -> ShowS Source #
Eq (ScriptDatum witctx) Source #
Instance details Defined in Cardano.Api.Script Methods (==) :: ScriptDatum witctx -> ScriptDatum witctx -> Bool Source # (/=) :: ScriptDatum witctx -> ScriptDatum witctx -> Bool Source #

type ScriptRedeemer = HashableScriptData Source #

Languages supported in each era

data ScriptLanguageInEra lang era where Source #

Constructors

SimpleScriptInShelley :: ScriptLanguageInEra SimpleScript' ShelleyEra
SimpleScriptInAllegra :: ScriptLanguageInEra SimpleScript' AllegraEra
SimpleScriptInMary :: ScriptLanguageInEra SimpleScript' MaryEra
SimpleScriptInAlonzo :: ScriptLanguageInEra SimpleScript' AlonzoEra
SimpleScriptInBabbage :: ScriptLanguageInEra SimpleScript' BabbageEra
SimpleScriptInConway :: ScriptLanguageInEra SimpleScript' ConwayEra
PlutusScriptV1InAlonzo :: ScriptLanguageInEra PlutusScriptV1 AlonzoEra
PlutusScriptV1InBabbage :: ScriptLanguageInEra PlutusScriptV1 BabbageEra
PlutusScriptV1InConway :: ScriptLanguageInEra PlutusScriptV1 ConwayEra
PlutusScriptV2InBabbage :: ScriptLanguageInEra PlutusScriptV2 BabbageEra
PlutusScriptV2InConway :: ScriptLanguageInEra PlutusScriptV2 ConwayEra
PlutusScriptV3InConway :: ScriptLanguageInEra PlutusScriptV3 ConwayEra

Instances

Instances details

ToJSON (ScriptLanguageInEra lang era) Source #
Instance details Defined in Cardano.Api.Script Methods toJSON :: ScriptLanguageInEra lang era -> Value # toEncoding :: ScriptLanguageInEra lang era -> Encoding # toJSONList :: [ScriptLanguageInEra lang era] -> Value # toEncodingList :: [ScriptLanguageInEra lang era] -> Encoding # omitField :: ScriptLanguageInEra lang era -> Bool #
Show (ScriptLanguageInEra lang era) Source #
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> ScriptLanguageInEra lang era -> ShowS Source # show :: ScriptLanguageInEra lang era -> String Source # showList :: [ScriptLanguageInEra lang era] -> ShowS Source #
Eq (ScriptLanguageInEra lang era) Source #
Instance details Defined in Cardano.Api.Script Methods (==) :: ScriptLanguageInEra lang era -> ScriptLanguageInEra lang era -> Bool Source # (/=) :: ScriptLanguageInEra lang era -> ScriptLanguageInEra lang era -> Bool Source #

scriptLanguageSupportedInEra :: ShelleyBasedEra era -> ScriptLanguage lang -> Maybe (ScriptLanguageInEra lang era) Source #

Check if a given script language is supported in a given era, and if so return the evidence.

sbeToSimpleScriptLanguageInEra :: ShelleyBasedEra era -> ScriptLanguageInEra SimpleScript' era Source #

languageOfScriptLanguageInEra :: ScriptLanguageInEra lang era -> ScriptLanguage lang Source #

eraOfScriptLanguageInEra :: ScriptLanguageInEra lang era -> ShelleyBasedEra era Source #

The simple script language

data SimpleScript Source #

Constructors

RequireSignature !(Hash PaymentKey)
RequireTimeBefore !SlotNo
RequireTimeAfter !SlotNo
RequireAllOf ![SimpleScript]
RequireAnyOf ![SimpleScript]
RequireMOf !Int ![SimpleScript]

Instances

Instances details

FromJSON SimpleScript Source #
Instance details Defined in Cardano.Api.Script Methods parseJSON :: Value -> Parser SimpleScript # parseJSONList :: Value -> Parser [SimpleScript] # omittedField :: Maybe SimpleScript #
ToJSON SimpleScript Source #
Instance details Defined in Cardano.Api.Script Methods toJSON :: SimpleScript -> Value # toEncoding :: SimpleScript -> Encoding # toJSONList :: [SimpleScript] -> Value # toEncodingList :: [SimpleScript] -> Encoding # omitField :: SimpleScript -> Bool #
Show SimpleScript Source #
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> SimpleScript -> ShowS Source # show :: SimpleScript -> String Source # showList :: [SimpleScript] -> ShowS Source #
Eq SimpleScript Source #
Instance details Defined in Cardano.Api.Script Methods (==) :: SimpleScript -> SimpleScript -> Bool Source # (/=) :: SimpleScript -> SimpleScript -> Bool Source #

data SimpleScriptOrReferenceInput lang Source #

Constructors

SScript SimpleScript
SReferenceScript TxIn

Instances

Instances details

Show (SimpleScriptOrReferenceInput lang) Source #
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> SimpleScriptOrReferenceInput lang -> ShowS Source # show :: SimpleScriptOrReferenceInput lang -> String Source # showList :: [SimpleScriptOrReferenceInput lang] -> ShowS Source #
Eq (SimpleScriptOrReferenceInput lang) Source #
Instance details Defined in Cardano.Api.Script Methods (==) :: SimpleScriptOrReferenceInput lang -> SimpleScriptOrReferenceInput lang -> Bool Source # (/=) :: SimpleScriptOrReferenceInput lang -> SimpleScriptOrReferenceInput lang -> Bool Source #

The Plutus script language

data PlutusScript lang where Source #

Plutus scripts.

Note that Plutus scripts have a binary serialisation but no JSON serialisation.

Constructors

PlutusScriptSerialised :: forall lang. ShortByteString -> PlutusScript lang

Instances

Instances details

Show (PlutusScript lang) Source #

Instance details

Defined in Cardano.Api.Script

Methods

showsPrec :: Int -> PlutusScript lang -> ShowS Source #

show :: PlutusScript lang -> String Source #

showList :: [PlutusScript lang] -> ShowS Source #

HasTypeProxy lang => HasTypeProxy (PlutusScript lang) Source #

Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType (PlutusScript lang)
Instance details Defined in Cardano.Api.Script data AsType (PlutusScript lang) = AsPlutusScript (AsType lang)

Methods

proxyToAsType :: Proxy (PlutusScript lang) -> AsType (PlutusScript lang) Source #

HasTypeProxy lang => SerialiseAsCBOR (PlutusScript lang) Source #

Instance details

Defined in Cardano.Api.Script

Methods

serialiseToCBOR :: PlutusScript lang -> ByteString Source #

deserialiseFromCBOR :: AsType (PlutusScript lang) -> ByteString -> Either DecoderError (PlutusScript lang) Source #

HasTypeProxy lang => SerialiseAsRawBytes (PlutusScript lang) Source #

Instance details

Defined in Cardano.Api.Script

Methods

serialiseToRawBytes :: PlutusScript lang -> ByteString Source #

deserialiseFromRawBytes :: AsType (PlutusScript lang) -> ByteString -> Either SerialiseAsRawBytesError (PlutusScript lang) Source #

IsPlutusScriptLanguage lang => HasTextEnvelope (PlutusScript lang) Source #

Instance details

Defined in Cardano.Api.Script

Methods

textEnvelopeType :: AsType (PlutusScript lang) -> TextEnvelopeType Source #

textEnvelopeDefaultDescr :: PlutusScript lang -> TextEnvelopeDescr Source #

HasTypeProxy lang => FromCBOR (PlutusScript lang) Source #

Instance details

Defined in Cardano.Api.Script

Methods

fromCBOR :: Decoder s (PlutusScript lang) Source #

label :: Proxy (PlutusScript lang) -> Text Source #

HasTypeProxy lang => ToCBOR (PlutusScript lang) Source #

Instance details

Defined in Cardano.Api.Script

Methods

toCBOR :: PlutusScript lang -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (PlutusScript lang) -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [PlutusScript lang] -> Size Source #

Eq (PlutusScript lang) Source #

Instance details

Defined in Cardano.Api.Script

Methods

(==) :: PlutusScript lang -> PlutusScript lang -> Bool Source #

(/=) :: PlutusScript lang -> PlutusScript lang -> Bool Source #

Ord (PlutusScript lang) Source #

Instance details

Defined in Cardano.Api.Script

Methods

compare :: PlutusScript lang -> PlutusScript lang -> Ordering Source #

(<) :: PlutusScript lang -> PlutusScript lang -> Bool Source #

(<=) :: PlutusScript lang -> PlutusScript lang -> Bool Source #

(>) :: PlutusScript lang -> PlutusScript lang -> Bool Source #

(>=) :: PlutusScript lang -> PlutusScript lang -> Bool Source #

max :: PlutusScript lang -> PlutusScript lang -> PlutusScript lang Source #

min :: PlutusScript lang -> PlutusScript lang -> PlutusScript lang Source #

data AsType (PlutusScript lang) Source #

Instance details

Defined in Cardano.Api.Script

data AsType (PlutusScript lang) = AsPlutusScript (AsType lang)

data PlutusScriptOrReferenceInput lang Source #

Scripts can now exist in the UTxO at a transaction output. We can reference these scripts via specification of a reference transaction input in order to witness spending inputs, withdrawals, certificates or to mint tokens. This datatype encapsulates this concept.

Constructors

PScript (PlutusScript lang)
PReferenceScript TxIn

Instances

Instances details

Show (PlutusScriptOrReferenceInput lang) Source #
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> PlutusScriptOrReferenceInput lang -> ShowS Source # show :: PlutusScriptOrReferenceInput lang -> String Source # showList :: [PlutusScriptOrReferenceInput lang] -> ShowS Source #
Eq (PlutusScriptOrReferenceInput lang) Source #
Instance details Defined in Cardano.Api.Script Methods (==) :: PlutusScriptOrReferenceInput lang -> PlutusScriptOrReferenceInput lang -> Bool Source # (/=) :: PlutusScriptOrReferenceInput lang -> PlutusScriptOrReferenceInput lang -> Bool Source #

examplePlutusScriptAlwaysSucceeds :: WitCtx witctx -> PlutusScript PlutusScriptV1 Source #

An example Plutus script that always succeeds, irrespective of inputs.

For example, if one were to use this for a payment address then it would allow anyone to spend from it.

The exact script depends on the context in which it is to be used.

examplePlutusScriptAlwaysFails :: WitCtx witctx -> PlutusScript PlutusScriptV1 Source #

An example Plutus script that always fails, irrespective of inputs.

For example, if one were to use this for a payment address then it would be impossible for anyone to ever spend from it.

The exact script depends on the context in which it is to be used.

Script data

data ScriptData Source #

Constructors

ScriptDataConstructor
Fields Integer Tag for the constructor [ScriptData] Constructor arguments
ScriptDataMap [(ScriptData, ScriptData)]	Key value pairs
ScriptDataList [ScriptData]	Elements
ScriptDataNumber Integer
ScriptDataBytes ByteString

Instances

Instances details

Show ScriptData Source #

Instance details

Defined in Cardano.Api.ScriptData

Methods

showsPrec :: Int -> ScriptData -> ShowS Source #

show :: ScriptData -> String Source #

showList :: [ScriptData] -> ShowS Source #

HasTypeProxy ScriptData Source #

Instance details

Defined in Cardano.Api.ScriptData

Associated Types

data AsType ScriptData
Instance details Defined in Cardano.Api.ScriptData data AsType ScriptData = AsScriptData

Methods

proxyToAsType :: Proxy ScriptData -> AsType ScriptData Source #

SerialiseAsCBOR ScriptData Source #

Instance details

Defined in Cardano.Api.ScriptData

Methods

serialiseToCBOR :: ScriptData -> ByteString Source #

deserialiseFromCBOR :: AsType ScriptData -> ByteString -> Either DecoderError ScriptData Source #

FromCBOR ScriptData Source #

Instance details

Defined in Cardano.Api.ScriptData

Methods

fromCBOR :: Decoder s ScriptData Source #

label :: Proxy ScriptData -> Text Source #

ToCBOR ScriptData Source #

Instance details

Defined in Cardano.Api.ScriptData

Methods

toCBOR :: ScriptData -> Encoding Source #

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy ScriptData -> Size Source #

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [ScriptData] -> Size Source #

Eq ScriptData Source #

Instance details

Defined in Cardano.Api.ScriptData

Methods

(==) :: ScriptData -> ScriptData -> Bool Source #

(/=) :: ScriptData -> ScriptData -> Bool Source #

Ord ScriptData Source #

Instance details

Defined in Cardano.Api.ScriptData

Methods

compare :: ScriptData -> ScriptData -> Ordering Source #

(<) :: ScriptData -> ScriptData -> Bool Source #

(<=) :: ScriptData -> ScriptData -> Bool Source #

(>) :: ScriptData -> ScriptData -> Bool Source #

(>=) :: ScriptData -> ScriptData -> Bool Source #

max :: ScriptData -> ScriptData -> ScriptData Source #

min :: ScriptData -> ScriptData -> ScriptData Source #

FromJSON (Hash ScriptData) Source #

Instance details

Defined in Cardano.Api.ScriptData

Methods

parseJSON :: Value -> Parser (Hash ScriptData) #

parseJSONList :: Value -> Parser [Hash ScriptData] #

omittedField :: Maybe (Hash ScriptData) #

FromJSONKey (Hash ScriptData) Source #

Instance details

Defined in Cardano.Api.ScriptData

Methods

fromJSONKey :: FromJSONKeyFunction (Hash ScriptData)

fromJSONKeyList :: FromJSONKeyFunction [Hash ScriptData]

ToJSON (Hash ScriptData) Source #

Instance details

Defined in Cardano.Api.ScriptData

Methods

toJSON :: Hash ScriptData -> Value #

toEncoding :: Hash ScriptData -> Encoding #

toJSONList :: [Hash ScriptData] -> Value #

toEncodingList :: [Hash ScriptData] -> Encoding #

omitField :: Hash ScriptData -> Bool #

ToJSONKey (Hash ScriptData) Source #

Instance details

Defined in Cardano.Api.ScriptData

Methods

toJSONKey :: ToJSONKeyFunction (Hash ScriptData)

toJSONKeyList :: ToJSONKeyFunction [Hash ScriptData]

IsString (Hash ScriptData) Source #

Instance details

Defined in Cardano.Api.ScriptData

Methods

fromString :: String -> Hash ScriptData Source #

Show (Hash ScriptData) Source #

Instance details

Defined in Cardano.Api.ScriptData

Methods

showsPrec :: Int -> Hash ScriptData -> ShowS Source #

show :: Hash ScriptData -> String Source #

showList :: [Hash ScriptData] -> ShowS Source #

SerialiseAsRawBytes (Hash ScriptData) Source #

Instance details

Defined in Cardano.Api.ScriptData

Methods

serialiseToRawBytes :: Hash ScriptData -> ByteString Source #

deserialiseFromRawBytes :: AsType (Hash ScriptData) -> ByteString -> Either SerialiseAsRawBytesError (Hash ScriptData) Source #

Eq (Hash ScriptData) Source #

Instance details

Defined in Cardano.Api.ScriptData

Methods

(==) :: Hash ScriptData -> Hash ScriptData -> Bool Source #

(/=) :: Hash ScriptData -> Hash ScriptData -> Bool Source #

Ord (Hash ScriptData) Source #

Instance details

Defined in Cardano.Api.ScriptData

Methods

compare :: Hash ScriptData -> Hash ScriptData -> Ordering Source #

(<) :: Hash ScriptData -> Hash ScriptData -> Bool Source #

(<=) :: Hash ScriptData -> Hash ScriptData -> Bool Source #

(>) :: Hash ScriptData -> Hash ScriptData -> Bool Source #

(>=) :: Hash ScriptData -> Hash ScriptData -> Bool Source #

max :: Hash ScriptData -> Hash ScriptData -> Hash ScriptData Source #

min :: Hash ScriptData -> Hash ScriptData -> Hash ScriptData Source #

data AsType ScriptData Source #

Instance details

Defined in Cardano.Api.ScriptData

data AsType ScriptData = AsScriptData

newtype Hash ScriptData Source #

Instance details

Defined in Cardano.Api.ScriptData

newtype Hash ScriptData = ScriptDataHash (DataHash StandardCrypto)

Script execution units

data ExecutionUnits Source #

The units for how long a script executes for and how much memory it uses. This is used to declare the resources used by a particular use of a script.

This type is also used to describe the limits for the maximum overall execution units per transaction or per block.

Constructors

ExecutionUnits
Fields executionSteps :: Natural This corresponds roughly to the time to execute a script. executionMemory :: Natural This corresponds roughly to the peak memory used during script execution.

Instances

Instances details

FromJSON ExecutionUnits Source #
Instance details Defined in Cardano.Api.Script Methods parseJSON :: Value -> Parser ExecutionUnits # parseJSONList :: Value -> Parser [ExecutionUnits] # omittedField :: Maybe ExecutionUnits #
ToJSON ExecutionUnits Source #
Instance details Defined in Cardano.Api.Script Methods toJSON :: ExecutionUnits -> Value # toEncoding :: ExecutionUnits -> Encoding # toJSONList :: [ExecutionUnits] -> Value # toEncodingList :: [ExecutionUnits] -> Encoding # omitField :: ExecutionUnits -> Bool #
Show ExecutionUnits Source #
Instance details Defined in Cardano.Api.Script Methods showsPrec :: Int -> ExecutionUnits -> ShowS Source # show :: ExecutionUnits -> String Source # showList :: [ExecutionUnits] -> ShowS Source #
FromCBOR ExecutionUnits Source #
Instance details Defined in Cardano.Api.Script Methods fromCBOR :: Decoder s ExecutionUnits Source # label :: Proxy ExecutionUnits -> Text Source #
ToCBOR ExecutionUnits Source #
Instance details Defined in Cardano.Api.Script Methods toCBOR :: ExecutionUnits -> Encoding Source # encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy ExecutionUnits -> Size Source # encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [ExecutionUnits] -> Size Source #
Eq ExecutionUnits Source #
Instance details Defined in Cardano.Api.Script Methods (==) :: ExecutionUnits -> ExecutionUnits -> Bool Source # (/=) :: ExecutionUnits -> ExecutionUnits -> Bool Source #

Script hashes

newtype ScriptHash Source #

We have this type separate from the Hash type to avoid the script hash type being parametrised by the era. The representation is era independent, and there are many places where we want to use a script hash where we don't want things to be era-parametrised.

Constructors

ScriptHash (ScriptHash StandardCrypto)

Instances

Instances details

FromJSON ScriptHash Source #

Instance details

Defined in Cardano.Api.Script

Methods

parseJSON :: Value -> Parser ScriptHash #

parseJSONList :: Value -> Parser [ScriptHash] #

omittedField :: Maybe ScriptHash #

ToJSON ScriptHash Source #

Instance details

Defined in Cardano.Api.Script

Methods

toJSON :: ScriptHash -> Value #

toEncoding :: ScriptHash -> Encoding #

toJSONList :: [ScriptHash] -> Value #

toEncodingList :: [ScriptHash] -> Encoding #

omitField :: ScriptHash -> Bool #

IsString ScriptHash Source #

Instance details

Defined in Cardano.Api.Script

Methods

fromString :: String -> ScriptHash Source #

Show ScriptHash Source #

Instance details

Defined in Cardano.Api.Script

Methods

showsPrec :: Int -> ScriptHash -> ShowS Source #

show :: ScriptHash -> String Source #

showList :: [ScriptHash] -> ShowS Source #

HasTypeProxy ScriptHash Source #

Instance details

Defined in Cardano.Api.Script

Associated Types

data AsType ScriptHash
Instance details Defined in Cardano.Api.Script data AsType ScriptHash = AsScriptHash

Methods

proxyToAsType :: Proxy ScriptHash -> AsType ScriptHash Source #

SerialiseAsRawBytes ScriptHash Source #

Instance details

Defined in Cardano.Api.Script

Methods

serialiseToRawBytes :: ScriptHash -> ByteString Source #

deserialiseFromRawBytes :: AsType ScriptHash -> ByteString -> Either SerialiseAsRawBytesError ScriptHash Source #

Eq ScriptHash Source #

Instance details

Defined in Cardano.Api.Script

Methods

(==) :: ScriptHash -> ScriptHash -> Bool Source #

(/=) :: ScriptHash -> ScriptHash -> Bool Source #

Ord ScriptHash Source #

Instance details

Defined in Cardano.Api.Script

Methods

compare :: ScriptHash -> ScriptHash -> Ordering Source #

(<) :: ScriptHash -> ScriptHash -> Bool Source #

(<=) :: ScriptHash -> ScriptHash -> Bool Source #

(>) :: ScriptHash -> ScriptHash -> Bool Source #

(>=) :: ScriptHash -> ScriptHash -> Bool Source #

max :: ScriptHash -> ScriptHash -> ScriptHash Source #

min :: ScriptHash -> ScriptHash -> ScriptHash Source #

data AsType ScriptHash Source #

Instance details

Defined in Cardano.Api.Script

data AsType ScriptHash = AsScriptHash

hashScript :: Script lang -> ScriptHash Source #

Internal conversion functions

toShelleyScript :: ScriptInEra era -> Script (ShelleyLedgerEra era) Source #

fromShelleyBasedScript :: ShelleyBasedEra era -> Script (ShelleyLedgerEra era) -> ScriptInEra era Source #

toShelleyMultiSig :: SimpleScript -> Either MultiSigError (MultiSig (ShelleyLedgerEra ShelleyEra)) Source #

Conversion for the MultiSig language used by the Shelley era.

fromShelleyMultiSig :: MultiSig (ShelleyLedgerEra ShelleyEra) -> SimpleScript Source #

Conversion for the MultiSig language used by the Shelley era.

toAllegraTimelock :: (AllegraEraScript era, EraCrypto era ~ StandardCrypto, NativeScript era ~ Timelock era) => SimpleScript -> NativeScript era Source #

Conversion for the Timelock language that is shared between the Allegra and Mary eras.

fromAllegraTimelock :: (AllegraEraScript era, EraCrypto era ~ StandardCrypto) => NativeScript era -> SimpleScript Source #

Conversion for the Timelock language that is shared between the Allegra and Mary eras.

toAlonzoExUnits :: ExecutionUnits -> ExUnits Source #

fromAlonzoExUnits :: ExUnits -> ExecutionUnits Source #

toShelleyScriptHash :: ScriptHash -> ScriptHash StandardCrypto Source #

fromShelleyScriptHash :: ScriptHash StandardCrypto -> ScriptHash Source #

toPlutusData :: ScriptData -> Data Source #

fromPlutusData :: Data -> ScriptData Source #

toAlonzoData :: Era ledgerera => HashableScriptData -> Data ledgerera Source #

fromAlonzoData :: Data ledgerera -> HashableScriptData Source #

toAlonzoLanguage :: AnyPlutusScriptVersion -> Language Source #

fromAlonzoLanguage :: Language -> AnyPlutusScriptVersion Source #

fromShelleyScriptToReferenceScript :: ShelleyBasedEra era -> Script (ShelleyLedgerEra era) -> ReferenceScript era Source #

scriptInEraToRefScript :: ScriptInEra era -> ReferenceScript era Source #

Data family instances

data family AsType t Source #

A family of singleton types used in this API to indicate which type to use where it would otherwise be ambiguous or merely unclear.

Values of this type are passed to deserialisation functions for example.

Instances

Instances details

data AsType AddressAny Source #
Instance details Defined in Cardano.Api.Address data AsType AddressAny = AsAddressAny
data AsType ByronAddr Source #
Instance details Defined in Cardano.Api.Address data AsType ByronAddr = AsByronAddr
data AsType ShelleyAddr Source #
Instance details Defined in Cardano.Api.Address data AsType ShelleyAddr = AsShelleyAddr
data AsType StakeAddress Source #
Instance details Defined in Cardano.Api.Address data AsType StakeAddress = AsStakeAddress
data AsType BlockHeader Source #
Instance details Defined in Cardano.Api.Block data AsType BlockHeader = AsBlockHeader
data AsType DRepMetadata Source #
Instance details Defined in Cardano.Api.DRepMetadata data AsType DRepMetadata = AsDRepMetadata
data AsType AllegraEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType AllegraEra = AsAllegraEra
data AsType AlonzoEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType AlonzoEra = AsAlonzoEra
data AsType BabbageEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType BabbageEra = AsBabbageEra
data AsType ByronEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType ByronEra = AsByronEra
data AsType ConwayEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType ConwayEra = AsConwayEra
data AsType MaryEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType MaryEra = AsMaryEra
data AsType ShelleyEra Source #
Instance details Defined in Cardano.Api.Eras.Core data AsType ShelleyEra = AsShelleyEra
data AsType GovernancePoll Source #
Instance details Defined in Cardano.Api.Governance.Poll data AsType GovernancePoll = AsGovernancePoll
data AsType GovernancePollAnswer Source #
Instance details Defined in Cardano.Api.Governance.Poll data AsType GovernancePollAnswer = AsGovernancePollAnswer
data AsType ByronKey Source #
Instance details Defined in Cardano.Api.Keys.Byron data AsType ByronKey = AsByronKey
data AsType ByronKeyLegacy Source #
Instance details Defined in Cardano.Api.Keys.Byron data AsType ByronKeyLegacy = AsByronKeyLegacy
data AsType KesKey Source #
Instance details Defined in Cardano.Api.Keys.Praos data AsType KesKey = AsKesKey
data AsType VrfKey Source #
Instance details Defined in Cardano.Api.Keys.Praos data AsType VrfKey = AsVrfKey
data AsType CommitteeColdExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType CommitteeColdExtendedKey = AsCommitteeColdExtendedKey
data AsType CommitteeColdKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType CommitteeColdKey = AsCommitteeColdKey
data AsType CommitteeHotExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType CommitteeHotExtendedKey = AsCommitteeHotExtendedKey
data AsType CommitteeHotKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType CommitteeHotKey = AsCommitteeHotKey
data AsType DRepExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType DRepExtendedKey = AsDRepExtendedKey
data AsType DRepKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType DRepKey = AsDRepKey
data AsType GenesisDelegateExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisDelegateExtendedKey = AsGenesisDelegateExtendedKey
data AsType GenesisDelegateKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisDelegateKey = AsGenesisDelegateKey
data AsType GenesisExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisExtendedKey = AsGenesisExtendedKey
data AsType GenesisKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisKey = AsGenesisKey
data AsType GenesisUTxOKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType GenesisUTxOKey = AsGenesisUTxOKey
data AsType PaymentExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType PaymentExtendedKey = AsPaymentExtendedKey
data AsType PaymentKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType PaymentKey = AsPaymentKey
data AsType StakeExtendedKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakeExtendedKey = AsStakeExtendedKey
data AsType StakeKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakeKey = AsStakeKey
data AsType StakePoolKey Source #
Instance details Defined in Cardano.Api.Keys.Shelley data AsType StakePoolKey = AsStakePoolKey
data AsType OperationalCertificate Source #
Instance details Defined in Cardano.Api.OperationalCertificate data AsType OperationalCertificate = AsOperationalCertificate
data AsType OperationalCertificateIssueCounter Source #
Instance details Defined in Cardano.Api.OperationalCertificate data AsType OperationalCertificateIssueCounter = AsOperationalCertificateIssueCounter
data AsType PraosNonce Source #
Instance details Defined in Cardano.Api.ProtocolParameters data AsType PraosNonce = AsPraosNonce
data AsType UpdateProposal Source #
Instance details Defined in Cardano.Api.ProtocolParameters data AsType UpdateProposal = AsUpdateProposal
data AsType PlutusScriptV1 Source #
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV1 = AsPlutusScriptV1
data AsType PlutusScriptV2 Source #
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV2 = AsPlutusScriptV2
data AsType PlutusScriptV3 Source #
Instance details Defined in Cardano.Api.Script data AsType PlutusScriptV3 = AsPlutusScriptV3
data AsType ScriptHash Source #
Instance details Defined in Cardano.Api.Script data AsType ScriptHash = AsScriptHash
data AsType ScriptInAnyLang Source #
Instance details Defined in Cardano.Api.Script data AsType ScriptInAnyLang = AsScriptInAnyLang
data AsType SimpleScript' Source #
Instance details Defined in Cardano.Api.Script data AsType SimpleScript' = AsSimpleScript
data AsType HashableScriptData Source #
Instance details Defined in Cardano.Api.ScriptData data AsType HashableScriptData = AsHashableScriptData
data AsType ScriptData Source #
Instance details Defined in Cardano.Api.ScriptData data AsType ScriptData = AsScriptData
data AsType TextEnvelope Source #
Instance details Defined in Cardano.Api.SerialiseTextEnvelope data AsType TextEnvelope = AsTextEnvelope
data AsType ByronUpdateProposal Source #
Instance details Defined in Cardano.Api.SpecialByron data AsType ByronUpdateProposal = AsByronUpdateProposal
data AsType ByronVote Source #
Instance details Defined in Cardano.Api.SpecialByron data AsType ByronVote = AsByronVote
data AsType StakePoolMetadata Source #
Instance details Defined in Cardano.Api.StakePoolMetadata data AsType StakePoolMetadata = AsStakePoolMetadata
data AsType TxId Source #
Instance details Defined in Cardano.Api.TxIn data AsType TxId = AsTxId
data AsType TxMetadata Source #
Instance details Defined in Cardano.Api.TxMetadata data AsType TxMetadata = AsTxMetadata
data AsType AssetName Source #
Instance details Defined in Cardano.Api.Value data AsType AssetName = AsAssetName
data AsType PolicyId Source #
Instance details Defined in Cardano.Api.Value data AsType PolicyId = AsPolicyId
data AsType (Address addrtype) Source #
Instance details Defined in Cardano.Api.Address data AsType (Address addrtype) = AsAddress (AsType addrtype)
data AsType (AddressInEra era) Source #
Instance details Defined in Cardano.Api.Address data AsType (AddressInEra era) = AsAddressInEra (AsType era)
data AsType (Certificate era) Source #
Instance details Defined in Cardano.Api.Certificate data AsType (Certificate era) = AsCertificate
data AsType (Proposal era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.ProposalProcedure data AsType (Proposal era) = AsProposal
data AsType (VotingProcedure era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure data AsType (VotingProcedure era) = AsVote
data AsType (VotingProcedures era) Source #
Instance details Defined in Cardano.Api.Governance.Actions.VotingProcedure data AsType (VotingProcedures era) = AsVotingProcedures
data AsType (Hash a) Source #
Instance details Defined in Cardano.Api.Hash data AsType (Hash a) = AsHash (AsType a)
data AsType (SigningKey a) Source #
Instance details Defined in Cardano.Api.Keys.Class data AsType (SigningKey a) = AsSigningKey (AsType a)
data AsType (VerificationKey a) Source #
Instance details Defined in Cardano.Api.Keys.Class data AsType (VerificationKey a) = AsVerificationKey (AsType a)
data AsType (PlutusScript lang) Source #
Instance details Defined in Cardano.Api.Script data AsType (PlutusScript lang) = AsPlutusScript (AsType lang)
data AsType (Script lang) Source #
Instance details Defined in Cardano.Api.Script data AsType (Script lang) = AsScript (AsType lang)
data AsType (ScriptInEra era) Source #
Instance details Defined in Cardano.Api.Script data AsType (ScriptInEra era) = AsScriptInEra (AsType era)
data AsType (KeyWitness era) Source #
Instance details Defined in Cardano.Api.Tx.Sign data AsType (KeyWitness era) = AsKeyWitness (AsType era)
data AsType (Tx era) Source #
Instance details Defined in Cardano.Api.Tx.Sign data AsType (Tx era) = AsTx (AsType era)
data AsType (TxBody era) Source #
Instance details Defined in Cardano.Api.Tx.Sign data AsType (TxBody era) = AsTxBody (AsType era)

data family Hash keyrole Source #

Instances

Instances details

FromJSON (Hash BlockHeader) Source #

Instance details

Defined in Cardano.Api.Block

Methods

parseJSON :: Value -> Parser (Hash BlockHeader) #

parseJSONList :: Value -> Parser [Hash BlockHeader] #

omittedField :: Maybe (Hash BlockHeader) #

FromJSON (Hash DRepKey) Source #

Instance details