Safe Haskell	Safe-Inferred
Language	Haskell2010

Cooked.Skeleton.Datum

Contents

Type constraints
Data types
Optics

Description

This module exposes the datum constructs used in payments of a TxSkel. Smart constructors for datums can be found in the Payable structure meant to build payments.

Synopsis

type DatumConstrs datum = (Show datum, PrettyCooked datum, ToData datum, FromData datum, Eq datum, Typeable datum)
data DatumResolved
- = NotResolved
- | Resolved
data DatumKind
- = Inline
- | Hashed DatumResolved
data TxSkelOutDatum where
- NoTxSkelOutDatum :: TxSkelOutDatum
- SomeTxSkelOutDatum :: DatumConstrs dat => dat -> DatumKind -> TxSkelOutDatum
datumKindResolvedP :: Prism' DatumKind DatumResolved
txSkelOutDatumKindAT :: AffineTraversal' TxSkelOutDatum DatumKind
txSkelOutDatumResolvedAT :: AffineTraversal' TxSkelOutDatum DatumResolved
txSkelOutDatumTypedAT :: (DatumConstrs a, DatumConstrs b) => AffineTraversal TxSkelOutDatum TxSkelOutDatum a b
txSkelOutDatumDatumAF :: AffineFold TxSkelOutDatum Datum
txSkelOutDatumDatumHashAF :: AffineFold TxSkelOutDatum DatumHash
txSkelOutDatumOutputDatumG :: Getter TxSkelOutDatum OutputDatum

Type constraints

type DatumConstrs datum = (Show datum, PrettyCooked datum, ToData datum, FromData datum, Eq datum, Typeable datum) Source #

Type constraints that must be satisfied by the datum content

Data types

data DatumResolved Source #

Whether the datum should be resolved in the transaction

Constructors

NotResolved	Do not resolve the datum (absent from `txInfoData`)
Resolved	Resolve the datum (present from `txInfoData`)

Instances

Instances details

Show DatumResolved Source #
Instance details Defined in Cooked.Skeleton.Datum Methods showsPrec :: Int -> DatumResolved -> ShowS # show :: DatumResolved -> String # showList :: [DatumResolved] -> ShowS #
Eq DatumResolved Source #
Instance details Defined in Cooked.Skeleton.Datum Methods (==) :: DatumResolved -> DatumResolved -> Bool # (/=) :: DatumResolved -> DatumResolved -> Bool #
Ord DatumResolved Source #
Instance details Defined in Cooked.Skeleton.Datum Methods compare :: DatumResolved -> DatumResolved -> Ordering # (<) :: DatumResolved -> DatumResolved -> Bool # (<=) :: DatumResolved -> DatumResolved -> Bool # (>) :: DatumResolved -> DatumResolved -> Bool # (>=) :: DatumResolved -> DatumResolved -> Bool # max :: DatumResolved -> DatumResolved -> DatumResolved # min :: DatumResolved -> DatumResolved -> DatumResolved #

data DatumKind Source #

Options on how to include the datum in the transaction

Constructors

Inline	Include the full datum in the UTxO
Hashed DatumResolved	Only include the datum hash in the UTxO. Resolve, or do not resolve, the full datum in the transaction body.

Instances

Instances details

Show DatumKind Source #
Instance details Defined in Cooked.Skeleton.Datum Methods showsPrec :: Int -> DatumKind -> ShowS # show :: DatumKind -> String # showList :: [DatumKind] -> ShowS #
Eq DatumKind Source #
Instance details Defined in Cooked.Skeleton.Datum Methods (==) :: DatumKind -> DatumKind -> Bool # (/=) :: DatumKind -> DatumKind -> Bool #
Ord DatumKind Source #
Instance details Defined in Cooked.Skeleton.Datum Methods compare :: DatumKind -> DatumKind -> Ordering # (<) :: DatumKind -> DatumKind -> Bool # (<=) :: DatumKind -> DatumKind -> Bool # (>) :: DatumKind -> DatumKind -> Bool # (>=) :: DatumKind -> DatumKind -> Bool # max :: DatumKind -> DatumKind -> DatumKind # min :: DatumKind -> DatumKind -> DatumKind #

data TxSkelOutDatum where Source #

Datums to be placed in TxSkel outputs, which are either empty, or composed of a datum content and its placement

Constructors

NoTxSkelOutDatum :: TxSkelOutDatum	use no datum
SomeTxSkelOutDatum :: DatumConstrs dat => dat -> DatumKind -> TxSkelOutDatum	use some datum content and associated placement

Instances

Instances details

Show TxSkelOutDatum Source #
Instance details Defined in Cooked.Skeleton.Datum Methods showsPrec :: Int -> TxSkelOutDatum -> ShowS # show :: TxSkelOutDatum -> String # showList :: [TxSkelOutDatum] -> ShowS #
PrettyCookedMaybe TxSkelOutDatum Source #	Prints a `TxSkelOutDatum` when different from `NoTxSkelOutDatum`
Instance details Defined in Cooked.Pretty.Skeleton Methods prettyCookedOptMaybe :: PrettyCookedOpts -> TxSkelOutDatum -> Maybe DocCooked Source # prettyCookedMaybe :: TxSkelOutDatum -> Maybe DocCooked Source #
Eq TxSkelOutDatum Source #
Instance details Defined in Cooked.Skeleton.Datum Methods (==) :: TxSkelOutDatum -> TxSkelOutDatum -> Bool # (/=) :: TxSkelOutDatum -> TxSkelOutDatum -> Bool #
Ord TxSkelOutDatum Source #
Instance details Defined in Cooked.Skeleton.Datum Methods compare :: TxSkelOutDatum -> TxSkelOutDatum -> Ordering # (<) :: TxSkelOutDatum -> TxSkelOutDatum -> Bool # (<=) :: TxSkelOutDatum -> TxSkelOutDatum -> Bool # (>) :: TxSkelOutDatum -> TxSkelOutDatum -> Bool # (>=) :: TxSkelOutDatum -> TxSkelOutDatum -> Bool # max :: TxSkelOutDatum -> TxSkelOutDatum -> TxSkelOutDatum # min :: TxSkelOutDatum -> TxSkelOutDatum -> TxSkelOutDatum #
ToOutputDatum TxSkelOutDatum Source #
Instance details Defined in Cooked.Skeleton.Datum Methods toOutputDatum :: TxSkelOutDatum -> OutputDatum #

Optics

datumKindResolvedP :: Prism' DatumKind DatumResolved Source #

Builds or retrieves the DatumResolved of a DatumKind

txSkelOutDatumKindAT :: AffineTraversal' TxSkelOutDatum DatumKind Source #

Focuses on the optional DatumKind of a TxSkelOutDatum

txSkelOutDatumResolvedAT :: AffineTraversal' TxSkelOutDatum DatumResolved Source #

Focuses on the optional DatumResolved of a TxSkelOutDatum

txSkelOutDatumTypedAT :: (DatumConstrs a, DatumConstrs b) => AffineTraversal TxSkelOutDatum TxSkelOutDatum a b Source #

Extracts, or sets, the typed datum of a TxSkelOutDatum. This is attempted in two ways: first, we try to simply cast the content, and then, if it fails, we serialise the content and then attempt to deserialise it to the right type. This second case is specifically useful when the current content is an BuiltinData itself directly, but it can also be used in the cornercase when both types have compatible serialized representation.

txSkelOutDatumDatumAF :: AffineFold TxSkelOutDatum Datum Source #

Retrieves the optional Datum of a TxSkelOutDatum

txSkelOutDatumDatumHashAF :: AffineFold TxSkelOutDatum DatumHash Source #

Retrieves the optional DatumHash of a TxSkelOutDatum

txSkelOutDatumOutputDatumG :: Getter TxSkelOutDatum OutputDatum Source #

Retrieves the OutputDatum of a TxSkelOutDatum