Copyright	(c) 2023 GYELD GMBH
License	Apache 2.0
Maintainer	[email protected]
Stability	develop
Safe Haskell	Safe-Inferred
Language	GHC2021

GeniusYield.Types.Script

Contents

Validator
- File operations
- Selectors
ValidatorHash
ScriptHash
MintingPolicy
Witness for Minting Policy
- File operations
- Selectors
MintingPolicyId
StakeValidator
Witness for stake validator
- Stake validator selectors
StakeValidatorHash
- File operations
Script
- File operations
Any Script
Simple Script

Description

Synopsis

data GYValidator v
validatorFromPlutus ∷ ∀ v. SingPlutusVersionI v ⇒ CompiledCode (BuiltinData → BuiltinData → BuiltinData → ()) → GYValidator v
validatorFromSerialisedScript ∷ ∀ v. SingPlutusVersionI v ⇒ SerialisedScript → GYValidator v
validatorToSerialisedScript ∷ GYValidator v → SerialisedScript
validatorToApi ∷ GYValidator v → PlutusScript (PlutusVersionToApi v)
validatorFromApi ∷ ∀ v. SingPlutusVersionI v ⇒ PlutusScript (PlutusVersionToApi v) → GYValidator v
validatorToApiPlutusScriptWitness ∷ GYValidator v → ScriptDatum WitCtxTxIn → ScriptRedeemer → ExecutionUnits → ScriptWitness WitCtxTxIn BabbageEra
writeValidator ∷ FilePath → GYValidator v → IO ()
readValidator ∷ SingPlutusVersionI v ⇒ FilePath → IO (GYValidator v)
validatorHash ∷ GYValidator v → GYValidatorHash
validatorPlutusHash ∷ GYValidator v → ScriptHash
validatorApiHash ∷ GYValidator v → ScriptHash
validatorVersion ∷ GYValidator v → SingPlutusVersion v
data GYValidatorHash
validatorHashToApi ∷ GYValidatorHash → ScriptHash
validatorHashToPlutus ∷ GYValidatorHash → ScriptHash
validatorHashFromApi ∷ ScriptHash → GYValidatorHash
validatorHashFromPlutus ∷ ScriptHash → Either PlutusToCardanoError GYValidatorHash
data GYScriptHash
scriptHashFromApi ∷ ScriptHash → GYScriptHash
scriptHashToApi ∷ GYScriptHash → ScriptHash
data GYMintingPolicy v
mintingPolicyId ∷ GYMintingPolicy v → GYMintingPolicyId
mintingPolicyVersion ∷ GYMintingPolicy v → SingPlutusVersion v
mintingPolicyVersionFromWitness ∷ GYMintScript v → PlutusVersion
mintingPolicyFromPlutus ∷ ∀ v. SingPlutusVersionI v ⇒ CompiledCode (BuiltinData → BuiltinData → ()) → GYMintingPolicy v
mintingPolicyFromSerialisedScript ∷ ∀ v. SingPlutusVersionI v ⇒ SerialisedScript → GYMintingPolicy v
mintingPolicyToSerialisedScript ∷ GYMintingPolicy v → SerialisedScript
mintingPolicyToApi ∷ GYMintingPolicy v → PlutusScript (PlutusVersionToApi v)
mintingPolicyIdToText ∷ GYMintingPolicyId → Text
mintingPolicyIdFromText ∷ Text → Either String GYMintingPolicyId
mintingPolicyFromApi ∷ ∀ v. SingPlutusVersionI v ⇒ PlutusScript (PlutusVersionToApi v) → GYMintingPolicy v
mintingPolicyToApiPlutusScriptWitness ∷ GYMintingPolicy v → ScriptRedeemer → ExecutionUnits → ScriptWitness WitCtxMint BabbageEra
data GYMintScript (u ∷ PlutusVersion) where
- GYMintScript ∷ v `VersionIsGreaterOrEqual` u ⇒ GYMintingPolicy v → GYMintScript u
- GYMintReference ∷ !GYTxOutRef → !(GYScript 'PlutusV2) → GYMintScript 'PlutusV2
mintingPolicyIdFromWitness ∷ GYMintScript v → GYMintingPolicyId
gyMintScriptToSerialisedScript ∷ GYMintScript u → SerialisedScript
gyMintingScriptWitnessToApiPlutusSW ∷ GYMintScript u → ScriptRedeemer → ExecutionUnits → ScriptWitness WitCtxMint BabbageEra
writeMintingPolicy ∷ FilePath → GYMintingPolicy v → IO ()
readMintingPolicy ∷ SingPlutusVersionI v ⇒ FilePath → IO (GYMintingPolicy v)
mintingPolicyCurrencySymbol ∷ GYMintingPolicy v → CurrencySymbol
mintingPolicyApiId ∷ GYMintingPolicy v → PolicyId
mintingPolicyApiIdFromWitness ∷ GYMintScript v → PolicyId
data GYMintingPolicyId
mintingPolicyIdToApi ∷ GYMintingPolicyId → PolicyId
mintingPolicyIdFromApi ∷ PolicyId → GYMintingPolicyId
mintingPolicyIdToCurrencySymbol ∷ GYMintingPolicyId → CurrencySymbol
mintingPolicyIdFromCurrencySymbol ∷ CurrencySymbol → Either PlutusToCardanoError GYMintingPolicyId
mintingPolicyIdCurrencySymbol ∷ GYMintingPolicyId → CurrencySymbol
data GYStakeValidator v
stakeValidatorVersion ∷ GYStakeValidator v → SingPlutusVersion v
stakeValidatorVersionFromWitness ∷ GYStakeValScript v → PlutusVersion
stakeValidatorFromPlutus ∷ ∀ v. SingPlutusVersionI v ⇒ CompiledCode (BuiltinData → BuiltinData → ()) → GYStakeValidator v
stakeValidatorFromSerialisedScript ∷ ∀ v. SingPlutusVersionI v ⇒ SerialisedScript → GYStakeValidator v
stakeValidatorToSerialisedScript ∷ GYStakeValidator v → SerialisedScript
stakeValidatorToApi ∷ GYStakeValidator v → PlutusScript (PlutusVersionToApi v)
stakeValidatorFromApi ∷ ∀ v. SingPlutusVersionI v ⇒ PlutusScript (PlutusVersionToApi v) → GYStakeValidator v
stakeValidatorToApiPlutusScriptWitness ∷ GYStakeValidator v → ScriptRedeemer → ExecutionUnits → ScriptWitness WitCtxStake BabbageEra
data GYStakeValScript (u ∷ PlutusVersion) where
- GYStakeValScript ∷ v `VersionIsGreaterOrEqual` u ⇒ GYStakeValidator v → GYStakeValScript u
- GYStakeValReference ∷ !GYTxOutRef → !(GYScript 'PlutusV2) → GYStakeValScript 'PlutusV2
gyStakeValScriptToSerialisedScript ∷ GYStakeValScript u → SerialisedScript
gyStakeValScriptWitnessToApiPlutusSW ∷ GYStakeValScript u → ScriptRedeemer → ExecutionUnits → ScriptWitness WitCtxStake BabbageEra
stakeValidatorHash ∷ GYStakeValidator v → GYStakeValidatorHash
stakeValidatorPlutusHash ∷ GYStakeValidator v → ScriptHash
stakeValidatorApiHash ∷ GYStakeValidator v → ScriptHash
data GYStakeValidatorHash
stakeValidatorHashToApi ∷ GYStakeValidatorHash → ScriptHash
stakeValidatorHashToPlutus ∷ GYStakeValidatorHash → ScriptHash
stakeValidatorHashFromApi ∷ ScriptHash → GYStakeValidatorHash
stakeValidatorHashFromPlutus ∷ ScriptHash → Either PlutusToCardanoError GYStakeValidatorHash
writeStakeValidator ∷ FilePath → GYStakeValidator v → IO ()
readStakeValidator ∷ SingPlutusVersionI v ⇒ FilePath → IO (GYStakeValidator v)
data GYScript (v ∷ PlutusVersion)
scriptVersion ∷ GYScript v → SingPlutusVersion v
validatorToScript ∷ GYValidator v → GYScript v
mintingPolicyToScript ∷ GYMintingPolicy v → GYScript v
stakeValidatorToScript ∷ GYStakeValidator v → GYScript v
scriptToApi ∷ GYScript v → PlutusScript (PlutusVersionToApi v)
scriptFromCBOR ∷ ∀ v. SingPlutusVersionI v ⇒ Text → Maybe (GYScript v)
scriptFromCBOR' ∷ ∀ v. SingPlutusVersionI v ⇒ ByteString → Maybe (GYScript v)
scriptFromPlutus ∷ ∀ v a. SingPlutusVersionI v ⇒ CompiledCode a → GYScript v
scriptFromSerialisedScript ∷ ∀ v. SingPlutusVersionI v ⇒ SerialisedScript → GYScript v
scriptToSerialisedScript ∷ GYScript v → ShortByteString
scriptApiHash ∷ GYScript v → ScriptHash
scriptPlutusHash ∷ GYScript v → ScriptHash
someScriptPlutusHash ∷ Some GYScript → ScriptHash
someScriptToReferenceApi ∷ Some GYScript → ReferenceScript BabbageEra
someScriptFromReferenceApi ∷ ReferenceScript era → Maybe (Some GYScript)
referenceScriptToApiPlutusScriptWitness ∷ GYTxOutRef → GYScript 'PlutusV2 → ScriptDatum witctx → ScriptRedeemer → ExecutionUnits → ScriptWitness witctx BabbageEra
apiHashToPlutus ∷ ScriptHash → ScriptHash
writeScript ∷ ∀ v. FilePath → GYScript v → IO ()
readScript ∷ ∀ v. SingPlutusVersionI v ⇒ FilePath → IO (GYScript v)
data GYAnyScript where
- GYSimpleScript ∷ !GYSimpleScript → GYAnyScript
- GYPlutusScript ∷ ∀ v. !(GYScript v) → GYAnyScript
module GeniusYield.Types.Script.SimpleScript

Validator

data GYValidator v #

Instances

Instances details

GCompare GYValidator #
Instance details Defined in GeniusYield.Types.Script Methods gcompare ∷ ∀ (a ∷ k) (b ∷ k). GYValidator a → GYValidator b → GOrdering a b #
GEq GYValidator #
Instance details Defined in GeniusYield.Types.Script Methods geq ∷ ∀ (a ∷ k) (b ∷ k). GYValidator a → GYValidator b → Maybe (a :~: b) #
GShow GYValidator #
Instance details Defined in GeniusYield.Types.Script Methods gshowsPrec ∷ ∀ (a ∷ k). Int → GYValidator a → ShowS #
Show (GYValidator v) #
Instance details Defined in GeniusYield.Types.Script Methods showsPrec ∷ Int → GYValidator v → ShowS # show ∷ GYValidator v → String # showList ∷ [GYValidator v] → ShowS #
Eq (GYValidator v) #
Instance details Defined in GeniusYield.Types.Script Methods (==) ∷ GYValidator v → GYValidator v → Bool # (/=) ∷ GYValidator v → GYValidator v → Bool #
Ord (GYValidator v) #
Instance details Defined in GeniusYield.Types.Script Methods compare ∷ GYValidator v → GYValidator v → Ordering # (<) ∷ GYValidator v → GYValidator v → Bool # (<=) ∷ GYValidator v → GYValidator v → Bool # (>) ∷ GYValidator v → GYValidator v → Bool # (>=) ∷ GYValidator v → GYValidator v → Bool # max ∷ GYValidator v → GYValidator v → GYValidator v # min ∷ GYValidator v → GYValidator v → GYValidator v #

validatorFromPlutus ∷ ∀ v. SingPlutusVersionI v ⇒ CompiledCode (BuiltinData → BuiltinData → BuiltinData → ()) → GYValidator v #

validatorFromSerialisedScript ∷ ∀ v. SingPlutusVersionI v ⇒ SerialisedScript → GYValidator v #

validatorToSerialisedScript ∷ GYValidator v → SerialisedScript #

validatorToApi ∷ GYValidator v → PlutusScript (PlutusVersionToApi v) #

validatorFromApi ∷ ∀ v. SingPlutusVersionI v ⇒ PlutusScript (PlutusVersionToApi v) → GYValidator v #

validatorToApiPlutusScriptWitness ∷ GYValidator v → ScriptDatum WitCtxTxIn → ScriptRedeemer → ExecutionUnits → ScriptWitness WitCtxTxIn BabbageEra #

File operations

writeValidator ∷ FilePath → GYValidator v → IO () #

Writes a validator to a file.

readValidator ∷ SingPlutusVersionI v ⇒ FilePath → IO (GYValidator v) #

Reads a validator from a file.

Selectors

validatorHash ∷ GYValidator v → GYValidatorHash #

validatorPlutusHash ∷ GYValidator v → ScriptHash #

validatorApiHash ∷ GYValidator v → ScriptHash #

validatorVersion ∷ GYValidator v → SingPlutusVersion v #

ValidatorHash

data GYValidatorHash #

Instances

Instances details

IsString GYValidatorHash #	`>>>` `"cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0" :: GYValidatorHash`GYValidatorHash "cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0"
Instance details Defined in GeniusYield.Types.Script Methods fromString ∷ String → GYValidatorHash #
Show GYValidatorHash #
Instance details Defined in GeniusYield.Types.Script Methods showsPrec ∷ Int → GYValidatorHash → ShowS # show ∷ GYValidatorHash → String # showList ∷ [GYValidatorHash] → ShowS #
PrintfArg GYValidatorHash #	`>>>` `printf "%s" ("cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0" :: GYValidatorHash)`cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0
Instance details Defined in GeniusYield.Types.Script Methods formatArg ∷ GYValidatorHash → FieldFormatter # parseFormat ∷ GYValidatorHash → ModifierParser #
Eq GYValidatorHash #
Instance details Defined in GeniusYield.Types.Script Methods (==) ∷ GYValidatorHash → GYValidatorHash → Bool # (/=) ∷ GYValidatorHash → GYValidatorHash → Bool #
Ord GYValidatorHash #
Instance details Defined in GeniusYield.Types.Script Methods compare ∷ GYValidatorHash → GYValidatorHash → Ordering # (<) ∷ GYValidatorHash → GYValidatorHash → Bool # (<=) ∷ GYValidatorHash → GYValidatorHash → Bool # (>) ∷ GYValidatorHash → GYValidatorHash → Bool # (>=) ∷ GYValidatorHash → GYValidatorHash → Bool # max ∷ GYValidatorHash → GYValidatorHash → GYValidatorHash # min ∷ GYValidatorHash → GYValidatorHash → GYValidatorHash #

validatorHashToApi ∷ GYValidatorHash → ScriptHash #

validatorHashToPlutus ∷ GYValidatorHash → ScriptHash #

validatorHashFromApi ∷ ScriptHash → GYValidatorHash #

validatorHashFromPlutus ∷ ScriptHash → Either PlutusToCardanoError GYValidatorHash #

>>> validatorHashFromPlutus "cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0"
Right (GYValidatorHash "cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0")

>>> validatorHashFromPlutus "cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7"
Left (DeserialiseRawBytesError {ptceTag = "validatorHashFromPlutus: cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7, error: SerialiseAsRawBytesError {unSerialiseAsRawBytesError = \"Unable to deserialise ScriptHash\"}"})

ScriptHash

data GYScriptHash #

Instances

Instances details

FromJSON GYScriptHash #
Instance details Defined in GeniusYield.Types.Script.ScriptHash Methods parseJSON ∷ Value → Parser GYScriptHash # parseJSONList ∷ Value → Parser [GYScriptHash] # omittedField ∷ Maybe GYScriptHash #
ToJSON GYScriptHash #
Instance details Defined in GeniusYield.Types.Script.ScriptHash Methods toJSON ∷ GYScriptHash → Value # toEncoding ∷ GYScriptHash → Encoding # toJSONList ∷ [GYScriptHash] → Value # toEncodingList ∷ [GYScriptHash] → Encoding # omitField ∷ GYScriptHash → Bool #
IsString GYScriptHash #	`>>>` `"cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0" :: GYScriptHash`GYScriptHash "cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0"
Instance details Defined in GeniusYield.Types.Script.ScriptHash Methods fromString ∷ String → GYScriptHash #
Show GYScriptHash #
Instance details Defined in GeniusYield.Types.Script.ScriptHash Methods showsPrec ∷ Int → GYScriptHash → ShowS # show ∷ GYScriptHash → String # showList ∷ [GYScriptHash] → ShowS #
PrintfArg GYScriptHash #	`>>>` `printf "%s" ("cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0" :: GYScriptHash)`cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0
Instance details Defined in GeniusYield.Types.Script.ScriptHash Methods formatArg ∷ GYScriptHash → FieldFormatter # parseFormat ∷ GYScriptHash → ModifierParser #
Eq GYScriptHash #
Instance details Defined in GeniusYield.Types.Script.ScriptHash Methods (==) ∷ GYScriptHash → GYScriptHash → Bool # (/=) ∷ GYScriptHash → GYScriptHash → Bool #
Ord GYScriptHash #
Instance details Defined in GeniusYield.Types.Script.ScriptHash Methods compare ∷ GYScriptHash → GYScriptHash → Ordering # (<) ∷ GYScriptHash → GYScriptHash → Bool # (<=) ∷ GYScriptHash → GYScriptHash → Bool # (>) ∷ GYScriptHash → GYScriptHash → Bool # (>=) ∷ GYScriptHash → GYScriptHash → Bool # max ∷ GYScriptHash → GYScriptHash → GYScriptHash # min ∷ GYScriptHash → GYScriptHash → GYScriptHash #
ToHttpApiData GYScriptHash #
Instance details Defined in GeniusYield.Types.Script.ScriptHash Methods toUrlPiece ∷ GYScriptHash → Text # toEncodedUrlPiece ∷ GYScriptHash → Builder # toHeader ∷ GYScriptHash → ByteString # toQueryParam ∷ GYScriptHash → Text # toEncodedQueryParam ∷ GYScriptHash → Builder #

scriptHashFromApi ∷ ScriptHash → GYScriptHash #

scriptHashToApi ∷ GYScriptHash → ScriptHash #

MintingPolicy

data GYMintingPolicy v #

Instances

Instances details

GCompare GYMintingPolicy #
Instance details Defined in GeniusYield.Types.Script Methods gcompare ∷ ∀ (a ∷ k) (b ∷ k). GYMintingPolicy a → GYMintingPolicy b → GOrdering a b #
GEq GYMintingPolicy #
Instance details Defined in GeniusYield.Types.Script Methods geq ∷ ∀ (a ∷ k) (b ∷ k). GYMintingPolicy a → GYMintingPolicy b → Maybe (a :~: b) #
GShow GYMintingPolicy #
Instance details Defined in GeniusYield.Types.Script Methods gshowsPrec ∷ ∀ (a ∷ k). Int → GYMintingPolicy a → ShowS #
Show (GYMintingPolicy v) #
Instance details Defined in GeniusYield.Types.Script Methods showsPrec ∷ Int → GYMintingPolicy v → ShowS # show ∷ GYMintingPolicy v → String # showList ∷ [GYMintingPolicy v] → ShowS #
Eq (GYMintingPolicy v) #
Instance details Defined in GeniusYield.Types.Script Methods (==) ∷ GYMintingPolicy v → GYMintingPolicy v → Bool # (/=) ∷ GYMintingPolicy v → GYMintingPolicy v → Bool #
Ord (GYMintingPolicy v) #
Instance details Defined in GeniusYield.Types.Script Methods compare ∷ GYMintingPolicy v → GYMintingPolicy v → Ordering # (<) ∷ GYMintingPolicy v → GYMintingPolicy v → Bool # (<=) ∷ GYMintingPolicy v → GYMintingPolicy v → Bool # (>) ∷ GYMintingPolicy v → GYMintingPolicy v → Bool # (>=) ∷ GYMintingPolicy v → GYMintingPolicy v → Bool # max ∷ GYMintingPolicy v → GYMintingPolicy v → GYMintingPolicy v # min ∷ GYMintingPolicy v → GYMintingPolicy v → GYMintingPolicy v #

mintingPolicyId ∷ GYMintingPolicy v → GYMintingPolicyId #

mintingPolicyVersion ∷ GYMintingPolicy v → SingPlutusVersion v #

mintingPolicyVersionFromWitness ∷ GYMintScript v → PlutusVersion #

mintingPolicyFromPlutus ∷ ∀ v. SingPlutusVersionI v ⇒ CompiledCode (BuiltinData → BuiltinData → ()) → GYMintingPolicy v #

mintingPolicyFromSerialisedScript ∷ ∀ v. SingPlutusVersionI v ⇒ SerialisedScript → GYMintingPolicy v #

mintingPolicyToSerialisedScript ∷ GYMintingPolicy v → SerialisedScript #

mintingPolicyToApi ∷ GYMintingPolicy v → PlutusScript (PlutusVersionToApi v) #

mintingPolicyIdToText ∷ GYMintingPolicyId → Text #

mintingPolicyIdFromText ∷ Text → Either String GYMintingPolicyId #

mintingPolicyFromApi ∷ ∀ v. SingPlutusVersionI v ⇒ PlutusScript (PlutusVersionToApi v) → GYMintingPolicy v #

mintingPolicyToApiPlutusScriptWitness ∷ GYMintingPolicy v → ScriptRedeemer → ExecutionUnits → ScriptWitness WitCtxMint BabbageEra #

Witness for Minting Policy

data GYMintScript (u ∷ PlutusVersion) where #

Constructors

GYMintScript ∷ v `VersionIsGreaterOrEqual` u ⇒ GYMintingPolicy v → GYMintScript u	`VersionIsGreaterOrEqual` restricts which version scripts can be used in this transaction.
GYMintReference ∷ !GYTxOutRef → !(GYScript 'PlutusV2) → GYMintScript 'PlutusV2	Reference inputs can be only used in V2 transactions.

Instances

Instances details

Show (GYMintScript v) #
Instance details Defined in GeniusYield.Types.Script Methods showsPrec ∷ Int → GYMintScript v → ShowS # show ∷ GYMintScript v → String # showList ∷ [GYMintScript v] → ShowS #
Eq (GYMintScript v) #
Instance details Defined in GeniusYield.Types.Script Methods (==) ∷ GYMintScript v → GYMintScript v → Bool # (/=) ∷ GYMintScript v → GYMintScript v → Bool #
Ord (GYMintScript v) #
Instance details Defined in GeniusYield.Types.Script Methods compare ∷ GYMintScript v → GYMintScript v → Ordering # (<) ∷ GYMintScript v → GYMintScript v → Bool # (<=) ∷ GYMintScript v → GYMintScript v → Bool # (>) ∷ GYMintScript v → GYMintScript v → Bool # (>=) ∷ GYMintScript v → GYMintScript v → Bool # max ∷ GYMintScript v → GYMintScript v → GYMintScript v # min ∷ GYMintScript v → GYMintScript v → GYMintScript v #

mintingPolicyIdFromWitness ∷ GYMintScript v → GYMintingPolicyId #

gyMintScriptToSerialisedScript ∷ GYMintScript u → SerialisedScript #

gyMintingScriptWitnessToApiPlutusSW ∷ GYMintScript u → ScriptRedeemer → ExecutionUnits → ScriptWitness WitCtxMint BabbageEra #

File operations

writeMintingPolicy ∷ FilePath → GYMintingPolicy v → IO () #

Writes a minting policy to a file.

readMintingPolicy ∷ SingPlutusVersionI v ⇒ FilePath → IO (GYMintingPolicy v) #

Reads a minting policy from a file.

Selectors

mintingPolicyCurrencySymbol ∷ GYMintingPolicy v → CurrencySymbol #

mintingPolicyApiId ∷ GYMintingPolicy v → PolicyId #

mintingPolicyApiIdFromWitness ∷ GYMintScript v → PolicyId #

MintingPolicyId

data GYMintingPolicyId #

Minting policy identifier, also a currency symbol.

Instances

Instances details

FromJSON GYMintingPolicyId #
Instance details Defined in GeniusYield.Types.Script Methods parseJSON ∷ Value → Parser GYMintingPolicyId # parseJSONList ∷ Value → Parser [GYMintingPolicyId] # omittedField ∷ Maybe GYMintingPolicyId #
FromJSONKey GYMintingPolicyId #
Instance details Defined in GeniusYield.Types.Script Methods fromJSONKey ∷ FromJSONKeyFunction GYMintingPolicyId # fromJSONKeyList ∷ FromJSONKeyFunction [GYMintingPolicyId] #
ToJSON GYMintingPolicyId #
Instance details Defined in GeniusYield.Types.Script Methods toJSON ∷ GYMintingPolicyId → Value # toEncoding ∷ GYMintingPolicyId → Encoding # toJSONList ∷ [GYMintingPolicyId] → Value # toEncodingList ∷ [GYMintingPolicyId] → Encoding # omitField ∷ GYMintingPolicyId → Bool #
ToJSONKey GYMintingPolicyId #
Instance details Defined in GeniusYield.Types.Script Methods toJSONKey ∷ ToJSONKeyFunction GYMintingPolicyId # toJSONKeyList ∷ ToJSONKeyFunction [GYMintingPolicyId] #
IsString GYMintingPolicyId #	`>>>` `fromString "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef" :: GYMintingPolicyId`"ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef"
Instance details Defined in GeniusYield.Types.Script Methods fromString ∷ String → GYMintingPolicyId #
Show GYMintingPolicyId #
Instance details Defined in GeniusYield.Types.Script Methods showsPrec ∷ Int → GYMintingPolicyId → ShowS # show ∷ GYMintingPolicyId → String # showList ∷ [GYMintingPolicyId] → ShowS #
Eq GYMintingPolicyId #
Instance details Defined in GeniusYield.Types.Script Methods (==) ∷ GYMintingPolicyId → GYMintingPolicyId → Bool # (/=) ∷ GYMintingPolicyId → GYMintingPolicyId → Bool #
Ord GYMintingPolicyId #
Instance details Defined in GeniusYield.Types.Script Methods compare ∷ GYMintingPolicyId → GYMintingPolicyId → Ordering # (<) ∷ GYMintingPolicyId → GYMintingPolicyId → Bool # (<=) ∷ GYMintingPolicyId → GYMintingPolicyId → Bool # (>) ∷ GYMintingPolicyId → GYMintingPolicyId → Bool # (>=) ∷ GYMintingPolicyId → GYMintingPolicyId → Bool # max ∷ GYMintingPolicyId → GYMintingPolicyId → GYMintingPolicyId # min ∷ GYMintingPolicyId → GYMintingPolicyId → GYMintingPolicyId #
FromHttpApiData GYMintingPolicyId #
Instance details Defined in GeniusYield.Types.Script Methods parseUrlPiece ∷ Text → Either Text GYMintingPolicyId # parseHeader ∷ ByteString → Either Text GYMintingPolicyId # parseQueryParam ∷ Text → Either Text GYMintingPolicyId #
ToHttpApiData GYMintingPolicyId #
Instance details Defined in GeniusYield.Types.Script Methods toUrlPiece ∷ GYMintingPolicyId → Text # toEncodedUrlPiece ∷ GYMintingPolicyId → Builder # toHeader ∷ GYMintingPolicyId → ByteString # toQueryParam ∷ GYMintingPolicyId → Text # toEncodedQueryParam ∷ GYMintingPolicyId → Builder #
ToParamSchema GYMintingPolicyId #
Instance details Defined in GeniusYield.Types.Script Methods toParamSchema ∷ ∀ (t ∷ SwaggerKind Type). Proxy GYMintingPolicyId → ParamSchema t #
ToSchema GYMintingPolicyId #
Instance details Defined in GeniusYield.Types.Script Methods declareNamedSchema ∷ Proxy GYMintingPolicyId → Declare (Definitions Schema) NamedSchema #

mintingPolicyIdToApi ∷ GYMintingPolicyId → PolicyId #

mintingPolicyIdFromApi ∷ PolicyId → GYMintingPolicyId #

mintingPolicyIdToCurrencySymbol ∷ GYMintingPolicyId → CurrencySymbol #

mintingPolicyIdFromCurrencySymbol ∷ CurrencySymbol → Either PlutusToCardanoError GYMintingPolicyId #

>>> mintingPolicyIdFromCurrencySymbol $ mintingPolicyIdToCurrencySymbol "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef"
Right "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef"

mintingPolicyIdCurrencySymbol ∷ GYMintingPolicyId → CurrencySymbol #

Deprecated: Use mintingPolicyIdToCurrencySymbol.

StakeValidator

data GYStakeValidator v #

Instances

Instances details

GCompare GYStakeValidator #
Instance details Defined in GeniusYield.Types.Script Methods gcompare ∷ ∀ (a ∷ k) (b ∷ k). GYStakeValidator a → GYStakeValidator b → GOrdering a b #
GEq GYStakeValidator #
Instance details Defined in GeniusYield.Types.Script Methods geq ∷ ∀ (a ∷ k) (b ∷ k). GYStakeValidator a → GYStakeValidator b → Maybe (a :~: b) #
GShow GYStakeValidator #
Instance details Defined in GeniusYield.Types.Script Methods gshowsPrec ∷ ∀ (a ∷ k). Int → GYStakeValidator a → ShowS #
Show (GYStakeValidator v) #
Instance details Defined in GeniusYield.Types.Script Methods showsPrec ∷ Int → GYStakeValidator v → ShowS # show ∷ GYStakeValidator v → String # showList ∷ [GYStakeValidator v] → ShowS #
Eq (GYStakeValidator v) #
Instance details Defined in GeniusYield.Types.Script Methods (==) ∷ GYStakeValidator v → GYStakeValidator v → Bool # (/=) ∷ GYStakeValidator v → GYStakeValidator v → Bool #
Ord (GYStakeValidator v) #
Instance details Defined in GeniusYield.Types.Script Methods compare ∷ GYStakeValidator v → GYStakeValidator v → Ordering # (<) ∷ GYStakeValidator v → GYStakeValidator v → Bool # (<=) ∷ GYStakeValidator v → GYStakeValidator v → Bool # (>) ∷ GYStakeValidator v → GYStakeValidator v → Bool # (>=) ∷ GYStakeValidator v → GYStakeValidator v → Bool # max ∷ GYStakeValidator v → GYStakeValidator v → GYStakeValidator v # min ∷ GYStakeValidator v → GYStakeValidator v → GYStakeValidator v #

stakeValidatorVersion ∷ GYStakeValidator v → SingPlutusVersion v #

stakeValidatorVersionFromWitness ∷ GYStakeValScript v → PlutusVersion #

stakeValidatorFromPlutus ∷ ∀ v. SingPlutusVersionI v ⇒ CompiledCode (BuiltinData → BuiltinData → ()) → GYStakeValidator v #

stakeValidatorFromSerialisedScript ∷ ∀ v. SingPlutusVersionI v ⇒ SerialisedScript → GYStakeValidator v #

stakeValidatorToSerialisedScript ∷ GYStakeValidator v → SerialisedScript #

stakeValidatorToApi ∷ GYStakeValidator v → PlutusScript (PlutusVersionToApi v) #

stakeValidatorFromApi ∷ ∀ v. SingPlutusVersionI v ⇒ PlutusScript (PlutusVersionToApi v) → GYStakeValidator v #

stakeValidatorToApiPlutusScriptWitness ∷ GYStakeValidator v → ScriptRedeemer → ExecutionUnits → ScriptWitness WitCtxStake BabbageEra #

Witness for stake validator

data GYStakeValScript (u ∷ PlutusVersion) where #

Constructors

GYStakeValScript ∷ v `VersionIsGreaterOrEqual` u ⇒ GYStakeValidator v → GYStakeValScript u	`VersionIsGreaterOrEqual` restricts which version scripts can be used in this transaction.
GYStakeValReference ∷ !GYTxOutRef → !(GYScript 'PlutusV2) → GYStakeValScript 'PlutusV2	Reference inputs can be only used in V2 transactions.

Instances

Instances details

Show (GYStakeValScript v) #
Instance details Defined in GeniusYield.Types.Script Methods showsPrec ∷ Int → GYStakeValScript v → ShowS # show ∷ GYStakeValScript v → String # showList ∷ [GYStakeValScript v] → ShowS #
Eq (GYStakeValScript v) #
Instance details Defined in GeniusYield.Types.Script Methods (==) ∷ GYStakeValScript v → GYStakeValScript v → Bool # (/=) ∷ GYStakeValScript v → GYStakeValScript v → Bool #
Ord (GYStakeValScript v) #
Instance details Defined in GeniusYield.Types.Script Methods compare ∷ GYStakeValScript v → GYStakeValScript v → Ordering # (<) ∷ GYStakeValScript v → GYStakeValScript v → Bool # (<=) ∷ GYStakeValScript v → GYStakeValScript v → Bool # (>) ∷ GYStakeValScript v → GYStakeValScript v → Bool # (>=) ∷ GYStakeValScript v → GYStakeValScript v → Bool # max ∷ GYStakeValScript v → GYStakeValScript v → GYStakeValScript v # min ∷ GYStakeValScript v → GYStakeValScript v → GYStakeValScript v #

gyStakeValScriptToSerialisedScript ∷ GYStakeValScript u → SerialisedScript #

gyStakeValScriptWitnessToApiPlutusSW ∷ GYStakeValScript u → ScriptRedeemer → ExecutionUnits → ScriptWitness WitCtxStake BabbageEra #

Stake validator selectors

stakeValidatorHash ∷ GYStakeValidator v → GYStakeValidatorHash #

stakeValidatorPlutusHash ∷ GYStakeValidator v → ScriptHash #

stakeValidatorApiHash ∷ GYStakeValidator v → ScriptHash #

StakeValidatorHash

data GYStakeValidatorHash #

Instances

Instances details

IsString GYStakeValidatorHash #	`>>>` `"cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0" :: GYStakeValidatorHash`GYStakeValidatorHash "cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0"
Instance details Defined in GeniusYield.Types.Script Methods fromString ∷ String → GYStakeValidatorHash #
Show GYStakeValidatorHash #
Instance details Defined in GeniusYield.Types.Script Methods showsPrec ∷ Int → GYStakeValidatorHash → ShowS # show ∷ GYStakeValidatorHash → String # showList ∷ [GYStakeValidatorHash] → ShowS #
PrintfArg GYStakeValidatorHash #	`>>>` `printf "%s" ("cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0" :: GYStakeValidatorHash)`cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0
Instance details Defined in GeniusYield.Types.Script Methods formatArg ∷ GYStakeValidatorHash → FieldFormatter # parseFormat ∷ GYStakeValidatorHash → ModifierParser #
Eq GYStakeValidatorHash #
Instance details Defined in GeniusYield.Types.Script Methods (==) ∷ GYStakeValidatorHash → GYStakeValidatorHash → Bool # (/=) ∷ GYStakeValidatorHash → GYStakeValidatorHash → Bool #
Ord GYStakeValidatorHash #
Instance details Defined in GeniusYield.Types.Script Methods compare ∷ GYStakeValidatorHash → GYStakeValidatorHash → Ordering # (<) ∷ GYStakeValidatorHash → GYStakeValidatorHash → Bool # (<=) ∷ GYStakeValidatorHash → GYStakeValidatorHash → Bool # (>) ∷ GYStakeValidatorHash → GYStakeValidatorHash → Bool # (>=) ∷ GYStakeValidatorHash → GYStakeValidatorHash → Bool # max ∷ GYStakeValidatorHash → GYStakeValidatorHash → GYStakeValidatorHash # min ∷ GYStakeValidatorHash → GYStakeValidatorHash → GYStakeValidatorHash #

stakeValidatorHashToApi ∷ GYStakeValidatorHash → ScriptHash #

stakeValidatorHashToPlutus ∷ GYStakeValidatorHash → ScriptHash #

stakeValidatorHashFromApi ∷ ScriptHash → GYStakeValidatorHash #

stakeValidatorHashFromPlutus ∷ ScriptHash → Either PlutusToCardanoError GYStakeValidatorHash #

>>> stakeValidatorHashFromPlutus "cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0"
Right (GYStakeValidatorHash "cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0")

>>> stakeValidatorHashFromPlutus "cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7"
Left (DeserialiseRawBytesError {ptceTag = "stakeValidatorHashFromPlutus: cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7, error: SerialiseAsRawBytesError {unSerialiseAsRawBytesError = \"Unable to deserialise ScriptHash\"}"})

File operations

writeStakeValidator ∷ FilePath → GYStakeValidator v → IO () #

Writes a stake validator to a file.

readStakeValidator ∷ SingPlutusVersionI v ⇒ FilePath → IO (GYStakeValidator v) #

Reads a stake validator from a file.

Script

data GYScript (v ∷ PlutusVersion) #

Plutus script

Instances

Instances details

GCompare GYScript #
Instance details Defined in GeniusYield.Types.Script Methods gcompare ∷ ∀ (a ∷ k) (b ∷ k). GYScript a → GYScript b → GOrdering a b #
GEq GYScript #
Instance details Defined in GeniusYield.Types.Script Methods geq ∷ ∀ (a ∷ k) (b ∷ k). GYScript a → GYScript b → Maybe (a :~: b) #
GShow GYScript #
Instance details Defined in GeniusYield.Types.Script Methods gshowsPrec ∷ ∀ (a ∷ k). Int → GYScript a → ShowS #
Show (GYScript v) #
Instance details Defined in GeniusYield.Types.Script Methods showsPrec ∷ Int → GYScript v → ShowS # show ∷ GYScript v → String # showList ∷ [GYScript v] → ShowS #
Eq (GYScript v) #	Equality and comparison are on script hash. As hash is cryptographicly strong, and `GYScript` constructor is not exposed, this works great.
Instance details Defined in GeniusYield.Types.Script Methods (==) ∷ GYScript v → GYScript v → Bool # (/=) ∷ GYScript v → GYScript v → Bool #
Ord (GYScript v) #
Instance details Defined in GeniusYield.Types.Script Methods compare ∷ GYScript v → GYScript v → Ordering # (<) ∷ GYScript v → GYScript v → Bool # (<=) ∷ GYScript v → GYScript v → Bool # (>) ∷ GYScript v → GYScript v → Bool # (>=) ∷ GYScript v → GYScript v → Bool # max ∷ GYScript v → GYScript v → GYScript v # min ∷ GYScript v → GYScript v → GYScript v #

scriptVersion ∷ GYScript v → SingPlutusVersion v #

validatorToScript ∷ GYValidator v → GYScript v #

mintingPolicyToScript ∷ GYMintingPolicy v → GYScript v #

stakeValidatorToScript ∷ GYStakeValidator v → GYScript v #

scriptToApi ∷ GYScript v → PlutusScript (PlutusVersionToApi v) #

scriptFromCBOR ∷ ∀ v. SingPlutusVersionI v ⇒ Text → Maybe (GYScript v) #

scriptFromCBOR' ∷ ∀ v. SingPlutusVersionI v ⇒ ByteString → Maybe (GYScript v) #

scriptFromPlutus ∷ ∀ v a. SingPlutusVersionI v ⇒ CompiledCode a → GYScript v #

scriptFromSerialisedScript ∷ ∀ v. SingPlutusVersionI v ⇒ SerialisedScript → GYScript v #

scriptToSerialisedScript ∷ GYScript v → ShortByteString #

scriptApiHash ∷ GYScript v → ScriptHash #

scriptPlutusHash ∷ GYScript v → ScriptHash #

someScriptPlutusHash ∷ Some GYScript → ScriptHash #

someScriptToReferenceApi ∷ Some GYScript → ReferenceScript BabbageEra #

someScriptFromReferenceApi ∷ ReferenceScript era → Maybe (Some GYScript) #

Note: Simple scripts are converted to Nothing.

referenceScriptToApiPlutusScriptWitness ∷ GYTxOutRef → GYScript 'PlutusV2 → ScriptDatum witctx → ScriptRedeemer → ExecutionUnits → ScriptWitness witctx BabbageEra #

apiHashToPlutus ∷ ScriptHash → ScriptHash #

File operations

writeScript ∷ ∀ v. FilePath → GYScript v → IO () #

Writes a script to a file.

readScript ∷ ∀ v. SingPlutusVersionI v ⇒ FilePath → IO (GYScript v) #

Reads a script from a file.

Any Script

data GYAnyScript where #

Type encapsulating both simple and plutus scripts.

Constructors

GYSimpleScript ∷ !GYSimpleScript → GYAnyScript
GYPlutusScript ∷ ∀ v. !(GYScript v) → GYAnyScript

Instances

Instances details

Show GYAnyScript #
Instance details Defined in GeniusYield.Types.Script Methods showsPrec ∷ Int → GYAnyScript → ShowS # show ∷ GYAnyScript → String # showList ∷ [GYAnyScript] → ShowS #
Eq GYAnyScript #
Instance details Defined in GeniusYield.Types.Script Methods (==) ∷ GYAnyScript → GYAnyScript → Bool # (/=) ∷ GYAnyScript → GYAnyScript → Bool #

Simple Script

module GeniusYield.Types.Script.SimpleScript