Cardano.ToData

class ToData a  where

Classes

Members

• toData :: a -> PlutusData

Instances

• ToData Void

  Base ToData instances

• ToData Unit
• ToData Boolean
• (ToData a) => ToData (Maybe a)
• (ToData a, ToData b) => ToData (Either a b)
• (Fail (Text "Int is not supported, use BigInt instead")) => ToData Int
• ToData BigInt
• ToData BigNum
• ToData UInt
• (ToData a) => ToData (Array a)
• (Foldable f, ToData a) => ToData (NonEmpty f a)
• (ToData a) => ToData (List a)
• (ToData a, ToData b) => ToData (Tuple a b)
• (ToData a) => ToData (Ratio a)
• ToData ByteArray
• ToData CborBytes
• ToData RawBytes
• ToData String
• ToData PlutusData
• ToData Uint8Array

class ToDataArgs :: Type -> Symbol -> Type -> Constraintclass (IsSymbol constr) <= ToDataArgs t constr a  where

As explained in https://harry.garrood.me/blog/write-your-own-generics/ this is just a neat pattern that flattens a skewed Product of Products

Members

• toDataArgs :: Proxy t -> Proxy constr -> a -> Array (PlutusData)

Instances

• (IsSymbol constr) => ToDataArgs a constr NoArguments

  ToDataArgs instances for Data.Generic.Rep

• (ToDataArgs t constr (Record row)) => ToDataArgs t constr (Argument (Record row))
• (ToData a, IsSymbol constr) => ToDataArgs x constr (Argument a)
• (IsSymbol constr, ToDataArgsRL t constr list row, RowToList row list) => ToDataArgs t constr (Record row)
• (ToDataArgs x constr a, ToDataArgs x constr b) => ToDataArgs x constr (Product a b)

class ToDataWithSchema t a  where

A class which converts a type to its PlutusData representation with the help of a generated or user-defined Plutus Data Schema (see TypeLevel.DataSchema.purs). We cannot express the constraint that the first type argument have an instance of @HasPlutusSchema@ with a superclass, but in practice every instance of this class will have an instance of that class as well.

Members

• toDataWithSchema :: Proxy t -> a -> PlutusData

Instances

• (ToDataWithSchema t l, ToDataWithSchema t r) => ToDataWithSchema t (Sum l r)

  ToDataWithIndex instances for Data.Generic.Rep

• (IsSymbol constr, ToDataArgs t constr arg, HasPlutusSchema t schema, ValidPlutusSchema schema list, GetIndexWithLabel constr list index, KnownNat index) => ToDataWithSchema t (Constructor constr arg)

class ToDataArgsRL :: forall (k :: Type). Type -> Symbol -> RowList k -> Row Type -> Constraintclass (ToDataArgsRLHelper t constr list row) <= ToDataArgsRL t constr list row | t constr list -> row where

A helper typeclass to implement ToDataArgs for records. Adapted from https://github.com/purescript/purescript-quickcheck/blob/v7.1.0/src/Test/QuickCheck/Arbitrary.purs#L247

The Symbol argument represents the name of a constructor. To account for Sum types where multiple variants of the sum have records with the same name, we have to know the name of the constructor (at the type level). See TypeLevel.DataSchema for a more in depth explanation.

Members

• toDataArgsRec :: Proxy t -> Proxy constr -> Proxy list -> Record row -> Array PlutusData

Instances

• (ToDataArgsRLHelper t constr list row) => ToDataArgsRL t constr list row

class ToDataArgsRLHelper :: forall (k :: Type). Type -> Symbol -> RowList k -> Row Type -> Constraintclass ToDataArgsRLHelper t constr list row | t constr list -> row where

A helper class used to implement ToDataArgsRL. This mainly exists for performance / ergonomic reasons; specifically, it allows us to only sort once (and not have to worry about maintaing the correct order as we go, which reduces the potential for errors)

Members

• toDataArgsRec' :: Proxy t -> Proxy constr -> Proxy list -> Record row -> Array (Tuple Int PlutusData)

Instances

• ToDataArgsRLHelper t symbol Nil ()

  ToDataArgsRL instances

• (ToData a, ToDataArgsRLHelper t constr listRest rowRest, Lacks label rowRest, Cons label a rowRest rowFull, RowToList rowFull (Cons label a listRest), IsSymbol label, IsSymbol constr, HasPlutusSchema t schema, ValidPlutusSchema schema rList, GetWithLabel constr rList rec, GetLabelIndex label rec n, KnownNat n) => ToDataArgsRLHelper t constr (Cons label a listRest) rowFull

genericToData :: forall (t :: Type) (rep :: Type). Generic t rep => ToDataWithSchema t rep => t -> PlutusData