Contract.PlutusData

getDatumByHash :: DataHash -> Contract (Maybe PlutusData)

Retrieve the full resolved datum associated to a given datum hash.

getDatumsByHashes :: Array DataHash -> Contract (Map DataHash PlutusData)

Retrieve full resolved datums associated with given datum hashes. The resulting Map will only contain datums that have been successfully resolved.

getDatumsByHashesWithErrors :: Array DataHash -> Contract (Map DataHash (Either String PlutusData))

Retrieve full resolved datums associated with given datum hashes. Errors are returned per datum.

unitDatum :: Warn (Text "Deprecated: unitDatum. use Cardano.Types.PlutusData.unit") => PlutusData

unitRedeemer :: Warn (Text "Deprecated: unitRedeemer. use Cardano.Types.RedeemerDatum.unit") => RedeemerDatum

type Datum = PlutusData

DEPRECATED. Use Cardano.Types.PlutusData

type Redeemer = RedeemerDatum

DEPRECATED. Use Contract.PlutusData.RedeemerDatum

data FromDataError

Errors

Constructors

• ArgsWantedButGot String Int (Array PlutusData)
• FromDataFailed String PlutusData
• BigNumToIntFailed String BigNum
• IndexWantedButGot String Int Int
• WantedConstrGot String PlutusData

Instances

• Generic FromDataError _
• Show FromDataError

class FromData a  where

Classes

Members

• fromData :: PlutusData -> Maybe a

Instances

• FromData Void

  Base FromData instances

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

class FromDataArgs :: Type -> Symbol -> Type -> Constraintclass FromDataArgs t c a  where

Members

• fromDataArgs :: IsSymbol c => Proxy t -> Proxy c -> Array PlutusData -> Either FromDataError { head :: a, tail :: Array PlutusData }

Instances

• FromDataArgs t c NoArguments

  FromDataArgs instance for Data.Generic.Rep

• (FromDataArgsRL t constr rList row, HasPlutusSchema t schema, ValidPlutusSchema schema rrList, GetWithLabel constr rrList rList) => FromDataArgs t constr (Argument (Record row))
• (FromData a) => FromDataArgs t constr (Argument a)
• (FromDataArgs t c a, FromDataArgs t c b) => FromDataArgs t c (Product a b)

class FromDataArgsRL :: Type -> Symbol -> RowList Type -> Row Type -> Constraintclass FromDataArgsRL t constr list row | t constr list -> row where

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

The second argument is a symbol which represents the name of a record constructor.

The third argument to the class is a RowList.

Members

• fromDataArgsRec :: forall (rlproxy :: RowList Type -> Type). IsSymbol constr => Proxy t -> Proxy constr -> rlproxy list -> Array PlutusData -> Either FromDataError { head :: Record row, tail :: Array PlutusData }

Instances

• FromDataArgsRL t constr Nil ()

  FromDataArgsRL instances

• (FromData a, FromDataArgsRL t constr rListRest rowRest, Lacks key rowRest, Cons key a rowRest rowFull, IsSymbol key) => FromDataArgsRL t constr (Cons key a rListRest) rowFull

class FromDataWithSchema t a  where

Replacement for 'FromDataWithIndex'. This converts a type into its Plutus Data representation with the help of a Plutus Data Schema (see TypeLevel.DataSchema) We cannot require that the first type argument 't' is an instance of 'HasPlutusSchema' but in practice instances of this class must have a 't' with a 'HasPlutusSchema' instance as well.

Members

• fromDataWithSchema :: Proxy t -> Proxy a -> PlutusData -> Either FromDataError a

Instances

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

  FromDataWithSchema instances for Data.Generic.Rep See https://purescript-simple-json.readthedocs.io/en/latest/generics-rep.html

• (IsSymbol constr, HasPlutusSchema t schema, ValidPlutusSchema schema rList, GetIndexWithLabel constr rList ix, FromDataArgs t constr args, KnownNat ix) => FromDataWithSchema t (Constructor constr args)
• (FromDataWithSchema t a) => FromDataWithSchema t (Argument a)

genericFromData :: forall (t :: Type) (rep :: Type). Generic t rep => FromDataWithSchema t rep => PlutusData -> Maybe t

data PSchema :: forall (k :: Type). k -> Typedata PSchema k

A kind (never exists as a term). This is the kind of @PCons@ and @PNil@.

data PNil :: forall (k :: Type). PSchema kdata PNil

Listlike constructors for the PSchema kind.

Instances

• SchemaToRowList PNil Nil
• PlutusSchemaToRowListI PNil NilI

data PCons :: forall (k :: Type). Field k -> PSchema k -> PSchema kdata PCons t0 t1

Instances

• (SchemaToRowList xs xs') => SchemaToRowList (PCons (MkField l (I k)) xs) (Cons l k xs')
• (PlutusSchemaToRowListI xs xs', SchemaToRowList a a') => PlutusSchemaToRowListI (PCons (MkField l (MkIxK n a)) xs) (ConsI l a' n xs')

type MkIxK_ :: forall k1. k1 -> Nat -> IxK k1type MkIxK_ k n = MkIxK n k

Syntactic sugar which allows us to represent MkIxK as a type operator

data MkIxK :: forall (k :: Type). Nat -> k -> IxK kdata MkIxK t0 t1

A data type of Kind (IxK k n) for some k and n

Instances

• (PlutusSchemaToRowListI xs xs', SchemaToRowList a a') => PlutusSchemaToRowListI (PCons (MkField l (MkIxK n a)) xs) (ConsI l a' n xs')

type MkField_ :: forall (f :: Type -> Type) (k :: Type). Symbol -> f k -> Field ktype MkField_ lbl ixty = MkField lbl ixty

Type synonym used to represent MkField as a type operator.

data MkField :: forall (k :: Type) (f :: Type -> Type). Symbol -> f k -> Field kdata MkField t0 t1

A data type of Kind (Field k)

Instances

• (SchemaToRowList xs xs') => SchemaToRowList (PCons (MkField l (I k)) xs) (Cons l k xs')
• (PlutusSchemaToRowListI xs xs', SchemaToRowList a a') => PlutusSchemaToRowListI (PCons (MkField l (MkIxK n a)) xs) (ConsI l a' n xs')

data IxK :: forall (k :: Type). k -> Typedata IxK k

Indexed kind. A kind representing a type @k@ indexed by a type level natural number @n@.

data Id :: forall (k :: Type). k -> Typedata Id k

FooB {fooo :: Bool, foo :: Bool} A type level Identity "functor kind". This is mainly used to overload the ':=' type operator.

data I :: forall (k :: Type). k -> Id kdata I t0

Instances

• (SchemaToRowList xs xs') => SchemaToRowList (PCons (MkField l (I k)) xs) (Cons l k xs')

data Field :: forall (k :: Type). k -> Typedata Field k

A kind which is used to represent pairs of Symbols and IxKs. A fancy type level tuple, more or less.

type ApPCons :: forall (k :: Type). Field k -> PSchema k -> PSchema ktype ApPCons x xs = PCons x xs

Type synonym which is used to provide syntatic sugar to PCons. You can think of :+ as a type level version of : for PSchema

class AllUnique2 :: forall (k :: Type). RowListI (RowList k) -> Constraintclass AllUnique2 rList 

A class which ensures that the Nat indices of the RowListI are unique & that the Symbol labels of both the RowListI and RowList in a RowListI (RowList k) all contain unique labels (relative to their "level", i.e., two record arguments of different constructors can have overlapping labels, but constructor names cannot overlap, nor can two labels or indices of the same record)

Instances

• AllUnique2 NilI
• (AllUniqueLabels a, AllUniqueLabelsI (ConsI l a n xs), UniqueIndices (ConsI l a n xs), AllUnique2 xs) => AllUnique2 (ConsI l a n xs)

class HasPlutusSchema :: Type -> PlutusSchema -> Constraintclass HasPlutusSchema t schema | t -> schema

A class used to associate types with a Plutus Data Schema. The fundeps should guarantee that only one schema can exist for each type. This allows us to make the compiler select the schema associated with a particular type.

class PlutusSchemaToRowListI :: PlutusSchema -> RowListI (RowList Type) -> Constraintclass PlutusSchemaToRowListI schema list | schema -> list

Instances

• PlutusSchemaToRowListI PNil NilI
• (PlutusSchemaToRowListI xs xs', SchemaToRowList a a') => PlutusSchemaToRowListI (PCons (MkField l (MkIxK n a)) xs) (ConsI l a' n xs')

class SchemaToRowList :: forall (k :: Type). PSchema k -> RowList k -> Constraintclass SchemaToRowList schema list | schema -> list

Helper type classes used to convert a PlutusSchema to a RowListI (RowList k). Should not need to be used outside of this module.

Instances

• SchemaToRowList PNil Nil
• (SchemaToRowList xs xs') => SchemaToRowList (PCons (MkField l (I k)) xs) (Cons l k xs')

class ValidPlutusSchema :: PlutusSchema -> RowListI (RowList Type) -> Constraintclass (PlutusSchemaToRowListI schema list, AllUnique2 list) <= ValidPlutusSchema schema list | schema -> list

The class which validates a Plutus Schema. To make use of genericFromData / genericToData, a type must have an associated Plutus Data schema which satisfies this constraint.

Instances

• (PlutusSchemaToRowListI schema list, AllUnique2 list) => ValidPlutusSchema schema list

Operator alias for Cardano.Plutus.DataSchema.MkIxK_ (right-associative / precedence 9)

Operator alias for Cardano.Plutus.DataSchema.MkField_ (right-associative / precedence 8)

Operator alias for Cardano.Plutus.DataSchema.ApPCons (right-associative / precedence 0)

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 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

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)

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

data PlutusData

Constructors

• Constr BigNum (Array PlutusData)
• Map (Array (Tuple PlutusData PlutusData))
• List (Array PlutusData)
• Integer BigInt
• Bytes ByteArray

Instances

• Eq PlutusData
• Ord PlutusData
• Generic PlutusData _
• Show PlutusData
• DecodeAeson PlutusData
• EncodeAeson PlutusData
• AsCbor PlutusData
• Arbitrary PlutusData

newtype DataHash

Constructors

• DataHash DataHash

Instances

• Generic DataHash _
• Newtype DataHash _
• Eq DataHash
• AsCbor DataHash
• EncodeAeson DataHash
• DecodeAeson DataHash
• Ord DataHash
• Show DataHash
• FromData DataHash
• ToData DataHash
• Arbitrary DataHash
• Coarbitrary DataHash

data OutputDatum

Constructors

• OutputDatumHash DataHash
• OutputDatum PlutusData

Instances

• Generic OutputDatum _
• Eq OutputDatum
• Ord OutputDatum
• Show OutputDatum
• HasPlutusSchema OutputDatum (ApPCons (MkField_ "OutputDatumHash" (MkIxK_ PNil Z)) (ApPCons (MkField_ "OutputDatum" (MkIxK_ PNil (S Z))) PNil))
• ToData OutputDatum
• FromData OutputDatum
• EncodeAeson OutputDatum
• DecodeAeson OutputDatum
• Arbitrary OutputDatum

newtype RedeemerDatum

Redeemer without ExUnits, tag or index - just a plain wrapper over PlutusData

Constructors

• RedeemerDatum PlutusData

Instances

• Generic RedeemerDatum _
• Newtype RedeemerDatum _
• Eq RedeemerDatum
• FromData RedeemerDatum
• Ord RedeemerDatum
• ToData RedeemerDatum
• Show RedeemerDatum