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

GeniusYield.Types.Script

Contents

Validator
- File operations
- Selectors
ValidatorHash
MintingPolicy
- File operations
- Selectors
MintingPolicyId
Script
- File operations

Description

Synopsis

data GYValidator v
validatorFromPlutus ∷ ∀ v. SingPlutusVersionI v ⇒ Validator → GYValidator v
validatorToPlutus ∷ GYValidator v → Validator
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 → ValidatorHash
validatorApiHash ∷ GYValidator v → ScriptHash
validatorVersion ∷ GYValidator v → SingPlutusVersion v
data GYValidatorHash
validatorHashToApi ∷ GYValidatorHash → ScriptHash
validatorHashToPlutus ∷ GYValidatorHash → ValidatorHash
validatorHashFromApi ∷ ScriptHash → GYValidatorHash
validatorHashFromPlutus ∷ ValidatorHash → Either PlutusToCardanoError GYValidatorHash
data GYMintingPolicy v
mintingPolicyId ∷ GYMintingPolicy v → GYMintingPolicyId
mintingPolicyVersion ∷ GYMintingPolicy v → SingPlutusVersion v
mintingPolicyFromPlutus ∷ ∀ v. SingPlutusVersionI v ⇒ MintingPolicy → GYMintingPolicy v
mintingPolicyToPlutus ∷ GYMintingPolicy v → MintingPolicy
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
writeMintingPolicy ∷ FilePath → GYMintingPolicy v → IO ()
readMintingPolicy ∷ SingPlutusVersionI v ⇒ FilePath → IO (GYMintingPolicy v)
mintingPolicyCurrencySymbol ∷ GYMintingPolicy v → CurrencySymbol
mintingPolicyApiId ∷ GYMintingPolicy v → PolicyId
data GYMintingPolicyId
mintingPolicyIdToApi ∷ GYMintingPolicyId → PolicyId
mintingPolicyIdFromApi ∷ PolicyId → GYMintingPolicyId
mintingPolicyIdCurrencySymbol ∷ GYMintingPolicyId → CurrencySymbol
data GYScript (v ∷ PlutusVersion)
scriptVersion ∷ GYScript v → SingPlutusVersion v
validatorToScript ∷ GYValidator v → GYScript v
mintingPolicyToScript ∷ GYMintingPolicy 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)
scriptToPlutus ∷ GYScript v → Script
scriptFromPlutus ∷ ∀ v. SingPlutusVersionI v ⇒ Script → GYScript v
someScriptToPlutus ∷ Some GYScript → Script
scriptApiHash ∷ GYScript v → ScriptHash
scriptPlutusHash ∷ GYScript v → ScriptHash
someScriptPlutusHash ∷ Some GYScript → ScriptHash
someScriptToReferenceApi ∷ Some GYScript → ReferenceScript BabbageEra
someScriptFromReferenceApi ∷ ReferenceScript era → Maybe (Some GYScript)
writeScript ∷ ∀ v. FilePath → GYScript v → IO ()
readScript ∷ ∀ v. SingPlutusVersionI v ⇒ FilePath → IO (GYScript v)

Validator

data GYValidator v #

Instances

Instances details

GShow GYValidator #
Instance details Defined in GeniusYield.Types.Script Methods gshowsPrec ∷ ∀ (a ∷ k). Int → GYValidator a → ShowS
GEq GYValidator #
Instance details Defined in GeniusYield.Types.Script Methods geq ∷ ∀ (a ∷ k) (b ∷ k). GYValidator a → GYValidator b → Maybe (a :~: b)
GCompare GYValidator #
Instance details Defined in GeniusYield.Types.Script Methods gcompare ∷ ∀ (a ∷ k) (b ∷ k). GYValidator a → GYValidator b → GOrdering a b
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 #
Show (GYValidator v) #
Instance details Defined in GeniusYield.Types.Script Methods showsPrec ∷ Int → GYValidator v → ShowS # show ∷ GYValidator v → String # showList ∷ [GYValidator v] → ShowS #

validatorFromPlutus ∷ ∀ v. SingPlutusVersionI v ⇒ Validator → GYValidator v #

validatorToPlutus ∷ GYValidator v → Validator #

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 → ValidatorHash #

validatorApiHash ∷ GYValidator v → ScriptHash #

validatorVersion ∷ GYValidator v → SingPlutusVersion v #

ValidatorHash

data GYValidatorHash #

Instances

Instances details

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 #
Show GYValidatorHash #
Instance details Defined in GeniusYield.Types.Script Methods showsPrec ∷ Int → GYValidatorHash → ShowS # show ∷ GYValidatorHash → String # showList ∷ [GYValidatorHash] → ShowS #
IsString GYValidatorHash #	`>>>` `"cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0" :: GYValidatorHash`GYValidatorHash "cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0"
Instance details Defined in GeniusYield.Types.Script Methods fromString ∷ String → GYValidatorHash #
PrintfArg GYValidatorHash #	`>>>` `printf "%s" ("cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0" :: GYValidatorHash)`cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0
Instance details Defined in GeniusYield.Types.Script Methods formatArg ∷ GYValidatorHash → FieldFormatter # parseFormat ∷ GYValidatorHash → ModifierParser #

validatorHashToApi ∷ GYValidatorHash → ScriptHash #

validatorHashToPlutus ∷ GYValidatorHash → ValidatorHash #

validatorHashFromApi ∷ ScriptHash → GYValidatorHash #

validatorHashFromPlutus ∷ ValidatorHash → Either PlutusToCardanoError GYValidatorHash #

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

>>> validatorHashFromPlutus "cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7"
Left (DeserialiseRawBytesError {ptceTag = "validatorHashFromPlutus: cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7"})

MintingPolicy

data GYMintingPolicy v #

Instances

Instances details

GShow GYMintingPolicy #
Instance details Defined in GeniusYield.Types.Script Methods gshowsPrec ∷ ∀ (a ∷ k). Int → GYMintingPolicy a → ShowS
GEq GYMintingPolicy #
Instance details Defined in GeniusYield.Types.Script Methods geq ∷ ∀ (a ∷ k) (b ∷ k). GYMintingPolicy a → GYMintingPolicy b → Maybe (a :~: b)
GCompare GYMintingPolicy #
Instance details Defined in GeniusYield.Types.Script Methods gcompare ∷ ∀ (a ∷ k) (b ∷ k). GYMintingPolicy a → GYMintingPolicy b → GOrdering a b
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 #
Show (GYMintingPolicy v) #
Instance details Defined in GeniusYield.Types.Script Methods showsPrec ∷ Int → GYMintingPolicy v → ShowS # show ∷ GYMintingPolicy v → String # showList ∷ [GYMintingPolicy v] → ShowS #

mintingPolicyId ∷ GYMintingPolicy v → GYMintingPolicyId #

mintingPolicyVersion ∷ GYMintingPolicy v → SingPlutusVersion v #

mintingPolicyFromPlutus ∷ ∀ v. SingPlutusVersionI v ⇒ MintingPolicy → GYMintingPolicy v #

mintingPolicyToPlutus ∷ GYMintingPolicy v → MintingPolicy #

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 #

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 #

MintingPolicyId

data GYMintingPolicyId #

Minting policy identifier, also a currency symbol.

Instances

Instances details

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 #
Show GYMintingPolicyId #
Instance details Defined in GeniusYield.Types.Script Methods showsPrec ∷ Int → GYMintingPolicyId → ShowS # show ∷ GYMintingPolicyId → String # showList ∷ [GYMintingPolicyId] → ShowS #
IsString GYMintingPolicyId #	`>>>` `fromString "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef" :: GYMintingPolicyId`"ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef"
Instance details Defined in GeniusYield.Types.Script Methods fromString ∷ String → GYMintingPolicyId #
FromJSON GYMintingPolicyId #
Instance details Defined in GeniusYield.Types.Script Methods parseJSON ∷ Value → Parser GYMintingPolicyId # parseJSONList ∷ Value → Parser [GYMintingPolicyId] #
ToJSON GYMintingPolicyId #
Instance details Defined in GeniusYield.Types.Script Methods toJSON ∷ GYMintingPolicyId → Value # toEncoding ∷ GYMintingPolicyId → Encoding # toJSONList ∷ [GYMintingPolicyId] → Value # toEncodingList ∷ [GYMintingPolicyId] → Encoding #
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
ToSchema GYMintingPolicyId #
Instance details Defined in GeniusYield.Types.Script Methods declareNamedSchema ∷ Proxy GYMintingPolicyId → Declare (Definitions Schema) NamedSchema

mintingPolicyIdToApi ∷ GYMintingPolicyId → PolicyId #

mintingPolicyIdFromApi ∷ PolicyId → GYMintingPolicyId #

mintingPolicyIdCurrencySymbol ∷ GYMintingPolicyId → CurrencySymbol #

Script

data GYScript (v ∷ PlutusVersion) #

Plutus script

Instances

Instances details

GShow GYScript #
Instance details Defined in GeniusYield.Types.Script Methods gshowsPrec ∷ ∀ (a ∷ k). Int → GYScript a → ShowS
GEq GYScript #
Instance details Defined in GeniusYield.Types.Script Methods geq ∷ ∀ (a ∷ k) (b ∷ k). GYScript a → GYScript b → Maybe (a :~: b)
GCompare GYScript #
Instance details Defined in GeniusYield.Types.Script Methods gcompare ∷ ∀ (a ∷ k) (b ∷ k). GYScript a → GYScript b → GOrdering a b
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 #
Show (GYScript v) #
Instance details Defined in GeniusYield.Types.Script Methods showsPrec ∷ Int → GYScript v → ShowS # show ∷ GYScript v → String # showList ∷ [GYScript v] → ShowS #