atlas-cardano
Copyright(c) 2023 GYELD GMBH
LicenseApache 2.0
Maintainer[email protected]
Stabilitydevelop
Safe HaskellNone
LanguageGHC2021

GeniusYield.Types.Datum

Description

 
Synopsis

Docspec setup

>>> :set -XOverloadedStrings -XTypeApplications
>>> import qualified Data.Aeson                 as Aeson
>>> import qualified Data.ByteString.Char8      as BS8
>>> import qualified Data.ByteString.Lazy       as BSL
>>> import qualified Web.HttpApiData            as Web
>>>

Datum

data GYDatum #

Datum

In the GY system we always include datums in transactions so this simple type is sufficient.

Instances

Instances details
FromJSON GYDatum #

Datums use cardano-api's detailed schema for JSON representation.

>>> Aeson.decode @GYDatum "{\"constructor\":0,\"fields\":[{\"int\":42},{\"list\":[{\"bytes\":\"\"}]}]}"
Just (GYDatum Constr 0 [I 42,List [B ""]])
Instance details

Defined in GeniusYield.Types.Datum

Methods

parseJSON :: Value -> Parser GYDatum #

parseJSONList :: Value -> Parser [GYDatum] #

omittedField :: Maybe GYDatum #

ToJSON GYDatum #
>>> BSL.putStr . Aeson.encode . datumFromPlutus' . PlutusTx.dataToBuiltinData $ PlutusTx.Constr 0 [ PlutusTx.I 42, PlutusTx.List [ PlutusTx.B "" ] ]
{"constructor":0,"fields":[{"int":42},{"list":[{"bytes":""}]}]}
Instance details

Defined in GeniusYield.Types.Datum

Methods

toJSON :: GYDatum -> Value #

toEncoding :: GYDatum -> Encoding #

toJSONList :: [GYDatum] -> Value #

toEncodingList :: [GYDatum] -> Encoding #

omitField :: GYDatum -> Bool #

Show GYDatum # 
Instance details

Defined in GeniusYield.Types.Datum

Methods

showsPrec :: Int -> GYDatum -> ShowS #

show :: GYDatum -> String #

showList :: [GYDatum] -> ShowS #

Eq GYDatum # 
Instance details

Defined in GeniusYield.Types.Datum

Methods

(==) :: GYDatum -> GYDatum -> Bool #

(/=) :: GYDatum -> GYDatum -> Bool #

Ord GYDatum # 
Instance details

Defined in GeniusYield.Types.Datum

Methods

compare :: GYDatum -> GYDatum -> Ordering #

(<) :: GYDatum -> GYDatum -> Bool #

(<=) :: GYDatum -> GYDatum -> Bool #

(>) :: GYDatum -> GYDatum -> Bool #

(>=) :: GYDatum -> GYDatum -> Bool #

max :: GYDatum -> GYDatum -> GYDatum #

min :: GYDatum -> GYDatum -> GYDatum #

FromData GYDatum # 
Instance details

Defined in GeniusYield.Types.Datum

Methods

fromBuiltinData :: BuiltinData -> Maybe GYDatum #

ToData GYDatum # 
Instance details

Defined in GeniusYield.Types.Datum

Methods

toBuiltinData :: GYDatum -> BuiltinData #

datumToApi' :: GYDatum -> HashableScriptData #

Convert a GYDatum to HashableScriptData from Cardano Api.

NOTE: This function is to be used only when generating for new outputs in a transaction as doing datumFromApi' followed by datumToApi' does not guarantee same low level CBOR representation of the high level data type.

datumFromApi' :: HashableScriptData -> GYDatum #

Get a GYDatum from a Cardano Api ScriptData

datumToPlutus :: GYDatum -> Datum #

Convert a GYDatum to Datum from Plutus

datumToPlutus' :: GYDatum -> BuiltinData #

Convert a GYDatum to BuiltinData from Plutus

datumFromPlutus :: Datum -> GYDatum #

Get a GYDatum from a Plutus Datum

datumFromPlutus' :: BuiltinData -> GYDatum #

Get a GYDatum from a Plutus BuiltinData

datumFromPlutusData :: ToData a => a -> GYDatum #

Get a GYDatum from any Plutus ToData type.

unitDatum :: GYDatum #

Unit datum

datumFromPlutusData ().

hashDatum :: GYDatum -> GYDatumHash #

Returns the GYDatumHash of the given GYDatum

Datum hash

data GYDatumHash #

Instances

Instances details
FromJSON GYDatumHash # 
Instance details

Defined in GeniusYield.Types.Datum

Methods

parseJSON :: Value -> Parser GYDatumHash #

parseJSONList :: Value -> Parser [GYDatumHash] #

omittedField :: Maybe GYDatumHash #

ToJSON GYDatumHash # 
Instance details

Defined in GeniusYield.Types.Datum

Methods

toJSON :: GYDatumHash -> Value #

toEncoding :: GYDatumHash -> Encoding #

toJSONList :: [GYDatumHash] -> Value #

toEncodingList :: [GYDatumHash] -> Encoding #

omitField :: GYDatumHash -> Bool #

IsString GYDatumHash # 
Instance details

Defined in GeniusYield.Types.Datum

Methods

fromString :: String -> GYDatumHash #

Show GYDatumHash # 
Instance details

Defined in GeniusYield.Types.Datum

Methods

showsPrec :: Int -> GYDatumHash -> ShowS #

show :: GYDatumHash -> String #

showList :: [GYDatumHash] -> ShowS #

Eq GYDatumHash # 
Instance details

Defined in GeniusYield.Types.Datum

Methods

(==) :: GYDatumHash -> GYDatumHash -> Bool #

(/=) :: GYDatumHash -> GYDatumHash -> Bool #

Ord GYDatumHash # 
Instance details

Defined in GeniusYield.Types.Datum

Methods

compare :: GYDatumHash -> GYDatumHash -> Ordering #

(<) :: GYDatumHash -> GYDatumHash -> Bool #

(<=) :: GYDatumHash -> GYDatumHash -> Bool #

(>) :: GYDatumHash -> GYDatumHash -> Bool #

(>=) :: GYDatumHash -> GYDatumHash -> Bool #

max :: GYDatumHash -> GYDatumHash -> GYDatumHash #

min :: GYDatumHash -> GYDatumHash -> GYDatumHash #

ToHttpApiData GYDatumHash # 
Instance details

Defined in GeniusYield.Types.Datum

Methods

toUrlPiece :: GYDatumHash -> Text #

toEncodedUrlPiece :: GYDatumHash -> Builder #

toHeader :: GYDatumHash -> ByteString #

toQueryParam :: GYDatumHash -> Text #

toEncodedQueryParam :: GYDatumHash -> Builder #

FromField GYDatumHash # 
Instance details

Defined in GeniusYield.Types.Datum

Methods

fromField :: FieldParser GYDatumHash #

ToField GYDatumHash # 
Instance details

Defined in GeniusYield.Types.Datum

Methods

toField :: GYDatumHash -> Action #

datumHashFromHex :: String -> Maybe GYDatumHash #

datumHashFromHexE :: String -> Either String GYDatumHash #

datumHashFromPlutus :: DatumHash -> Either PlutusToCardanoError GYDatumHash #

unsafeDatumHashFromPlutus :: DatumHash -> GYDatumHash #

datumHashToPlutus :: GYDatumHash -> DatumHash #

datumHashFromApi :: Hash ScriptData -> GYDatumHash #

datumHashToApi :: GYDatumHash -> Hash ScriptData #