| Copyright | (c) 2023 GYELD GMBH |
|---|---|
| License | Apache 2.0 |
| Maintainer | [email protected] |
| Stability | develop |
| Safe Haskell | Safe-Inferred |
| Language | GHC2021 |
GeniusYield.Types.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 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)
- 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
- writeScript ∷ ∀ v. FilePath → GYScript v → IO ()
- readScript ∷ ∀ v. SingPlutusVersionI v ⇒ FilePath → IO (GYScript v)
Validator
data GYValidator v #
Instances
validatorFromPlutus ∷ ∀ v. SingPlutusVersionI v ⇒ CompiledCode (BuiltinData → BuiltinData → BuiltinData → ()) → GYValidator v #
validatorFromSerialisedScript ∷ ∀ v. SingPlutusVersionI v ⇒ SerialisedScript → GYValidator v #
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
data GYValidatorHash #
Instances
validatorHashFromPlutus ∷ ScriptHash → Either PlutusToCardanoError GYValidatorHash #
>>>validatorHashFromPlutus "cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0"Right (GYValidatorHash "cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7d0")
>>>validatorHashFromPlutus "cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7"Left (DeserialiseRawBytesError {ptceTag = "validatorHashFromPlutus: cabdd19b58d4299fde05b53c2c0baf978bf9ade734b490fc0cc8b7, error: SerialiseAsRawBytesError {unSerialiseAsRawBytesError = \"Enable to deserialise ScriptHash\"}"})
ScriptHash
data GYScriptHash #
Instances
MintingPolicy
data GYMintingPolicy v #
Instances
mintingPolicyFromPlutus ∷ ∀ v. SingPlutusVersionI v ⇒ CompiledCode (BuiltinData → BuiltinData → ()) → GYMintingPolicy v #
mintingPolicyFromSerialisedScript ∷ ∀ v. SingPlutusVersionI v ⇒ SerialisedScript → GYMintingPolicy v #
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 |
|
| GYMintReference ∷ !GYTxOutRef → !(GYScript 'PlutusV2) → GYMintScript 'PlutusV2 | Reference inputs can be only used in V2 transactions. |
Instances
| Show (GYMintScript v) # | |
Defined in GeniusYield.Types.Script | |
| Eq (GYMintScript v) # | |
Defined in GeniusYield.Types.Script Methods (==) ∷ GYMintScript v → GYMintScript v → Bool Source # (/=) ∷ GYMintScript v → GYMintScript v → Bool Source # | |
| Ord (GYMintScript v) # | |
Defined in GeniusYield.Types.Script Methods compare ∷ GYMintScript v → GYMintScript v → Ordering Source # (<) ∷ GYMintScript v → GYMintScript v → Bool Source # (<=) ∷ GYMintScript v → GYMintScript v → Bool Source # (>) ∷ GYMintScript v → GYMintScript v → Bool Source # (>=) ∷ GYMintScript v → GYMintScript v → Bool Source # max ∷ GYMintScript v → GYMintScript v → GYMintScript v Source # min ∷ GYMintScript v → GYMintScript v → GYMintScript v Source # | |
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
MintingPolicyId
data GYMintingPolicyId #
Minting policy identifier, also a currency symbol.
Instances
mintingPolicyIdFromCurrencySymbol ∷ CurrencySymbol → Either PlutusToCardanoError GYMintingPolicyId #
>>>mintingPolicyIdFromCurrencySymbol $ mintingPolicyIdToCurrencySymbol "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef"Right "ff80aaaf03a273b8f5c558168dc0e2377eea810badbae6eceefc14ef"
mintingPolicyIdCurrencySymbol ∷ GYMintingPolicyId → CurrencySymbol #
Deprecated: Use mintingPolicyIdToCurrencySymbol.
Script
data GYScript (v ∷ PlutusVersion) #
Plutus script
Instances
| GCompare GYScript # | |
| GEq GYScript # | |
| GShow GYScript # | |
Defined in GeniusYield.Types.Script | |
| Show (GYScript v) # | |
| Eq (GYScript v) # | Equality and comparison are on script hash. As hash is cryptographicly strong, and |
| Ord (GYScript v) # | |
Defined in GeniusYield.Types.Script | |
scriptVersion ∷ GYScript v → SingPlutusVersion v #
validatorToScript ∷ GYValidator 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 #
scriptApiHash ∷ GYScript v → ScriptHash #
scriptPlutusHash ∷ GYScript v → ScriptHash #
someScriptFromReferenceApi ∷ ReferenceScript era → Maybe (Some GYScript) #
Note: Simple scripts are converted to Nothing.
referenceScriptToApiPlutusScriptWitness ∷ GYTxOutRef → GYScript 'PlutusV2 → ScriptDatum witctx → ScriptRedeemer → ExecutionUnits → ScriptWitness witctx BabbageEra #
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.