Safe Haskell	Safe-Inferred
Language	Haskell2010

Cardano.Ledger.Api.Scripts.Data

Contents

Plutus Data
Inline Datum
- BinaryData

Synopsis

data Data era where
- pattern Data ∷ Era era ⇒ Data → Data era
getPlutusData ∷ Data era → Data
type DataHash c = SafeHash c EraIndependentData
hashData ∷ Era era ⇒ Data era → DataHash (EraCrypto era)
data Datum era
- = NoDatum
- | DatumHash !(DataHash (EraCrypto era))
- | Datum !(BinaryData era)
datumDataHash ∷ Era era ⇒ Datum era → StrictMaybe (DataHash (EraCrypto era))
data BinaryData era
makeBinaryData ∷ Era era ⇒ ShortByteString → Either String (BinaryData era)
hashBinaryData ∷ Era era ⇒ BinaryData era → DataHash (EraCrypto era)
binaryDataToData ∷ Era era ⇒ BinaryData era → Data era
dataToBinaryData ∷ Era era ⇒ Data era → BinaryData era

Plutus Data

data Data era where Source #

Bundled Patterns

pattern Data ∷ Era era ⇒ Data → Data era

Instances

Instances details

Memoized Data
Instance details Defined in Cardano.Ledger.Plutus.Data Associated Types type RawType Data = (r ∷ Type → Type) Source # Methods getMemoBytes ∷ Data era → MemoBytes (RawType Data) era wrapMemoBytes ∷ MemoBytes (RawType Data) era → Data era
Generic (Data era)
Instance details Defined in Cardano.Ledger.Plutus.Data Associated Types type Rep (Data era) ∷ Type → Type Source # Methods from ∷ Data era → Rep (Data era) x Source # to ∷ Rep (Data era) x → Data era Source #
HashAlgorithm (HASH (EraCrypto era)) ⇒ Show (Data era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods showsPrec ∷ Int → Data era → ShowS Source # show ∷ Data era → String Source # showList ∷ [Data era] → ShowS Source #
Typeable era ⇒ ToCBOR (Data era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods toCBOR ∷ Data era → Encoding Source # encodedSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy (Data era) → Size Source # encodedListSizeExpr ∷ (∀ t. ToCBOR t ⇒ Proxy t → Size) → Proxy [Data era] → Size Source #
Era era ⇒ DecCBOR (Annotator (Data era))
Instance details Defined in Cardano.Ledger.Plutus.Data Methods decCBOR ∷ Decoder s (Annotator (Data era)) Source # dropCBOR ∷ Proxy (Annotator (Data era)) → Decoder s () Source # label ∷ Proxy (Annotator (Data era)) → Text Source #
Typeable era ⇒ EncCBOR (Data era)	Encodes memoized bytes created upon construction.
Instance details Defined in Cardano.Ledger.Plutus.Data Methods encCBOR ∷ Data era → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (Data era) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Data era] → Size Source #
SafeToHash (Data era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods originalBytes ∷ Data era → ByteString Source # originalBytesSize ∷ Data era → Int Source # makeHashWithExplicitProxys ∷ HashAlgorithm (HASH c) ⇒ Proxy c → Proxy index → Data era → SafeHash c index Source #
NFData (Data era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods rnf ∷ Data era → () Source #
Eq (Data era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods (==) ∷ Data era → Data era → Bool Source # (/=) ∷ Data era → Data era → Bool Source #
Typeable era ⇒ NoThunks (Data era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods noThunks ∷ Context → Data era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Data era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (Data era) → String Source #
EraCrypto era ~ c ⇒ HashAnnotated (Data era) EraIndependentData c
Instance details Defined in Cardano.Ledger.Plutus.Data Methods indexProxy ∷ Data era → Proxy EraIndependentData Source # hashAnnotated ∷ Data era → SafeHash c EraIndependentData Source #
type RawType Data
Instance details Defined in Cardano.Ledger.Plutus.Data type RawType Data = PlutusData
type Rep (Data era)
Instance details Defined in Cardano.Ledger.Plutus.Data type Rep (Data era) = D1 ('MetaData "Data" "Cardano.Ledger.Plutus.Data" "cardano-ledger-core-1.16.0.0-inplace" 'True) (C1 ('MetaCons "DataConstr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MemoBytes PlutusData era))))

getPlutusData ∷ Data era → Data Source #

type DataHash c = SafeHash c EraIndependentData Source #

hashData ∷ Era era ⇒ Data era → DataHash (EraCrypto era) Source #

Inline Datum

data Datum era Source #

Datum can be described by a either a data hash or binary data, but not both. It can also be neither one of them.

Constructors

NoDatum
DatumHash !(DataHash (EraCrypto era))
Datum !(BinaryData era)

Instances

Instances details

Era era ⇒ ToJSON (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods toJSON ∷ Datum era → Value Source # toEncoding ∷ Datum era → Encoding Source # toJSONList ∷ [Datum era] → Value Source # toEncodingList ∷ [Datum era] → Encoding Source # omitField ∷ Datum era → Bool Source #
Generic (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data Associated Types type Rep (Datum era) ∷ Type → Type Source # Methods from ∷ Datum era → Rep (Datum era) x Source # to ∷ Rep (Datum era) x → Datum era Source #
Show (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods showsPrec ∷ Int → Datum era → ShowS Source # show ∷ Datum era → String Source # showList ∷ [Datum era] → ShowS Source #
Era era ⇒ DecCBOR (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods decCBOR ∷ Decoder s (Datum era) Source # dropCBOR ∷ Proxy (Datum era) → Decoder s () Source # label ∷ Proxy (Datum era) → Text Source #
Era era ⇒ EncCBOR (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods encCBOR ∷ Datum era → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (Datum era) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [Datum era] → Size Source #
Eq (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods (==) ∷ Datum era → Datum era → Bool Source # (/=) ∷ Datum era → Datum era → Bool Source #
Ord (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods compare ∷ Datum era → Datum era → Ordering Source # (<) ∷ Datum era → Datum era → Bool Source # (<=) ∷ Datum era → Datum era → Bool Source # (>) ∷ Datum era → Datum era → Bool Source # (>=) ∷ Datum era → Datum era → Bool Source # max ∷ Datum era → Datum era → Datum era Source # min ∷ Datum era → Datum era → Datum era Source #
NoThunks (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods noThunks ∷ Context → Datum era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → Datum era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (Datum era) → String Source #
type Rep (Datum era)
Instance details Defined in Cardano.Ledger.Plutus.Data type Rep (Datum era) = D1 ('MetaData "Datum" "Cardano.Ledger.Plutus.Data" "cardano-ledger-core-1.16.0.0-inplace" 'False) (C1 ('MetaCons "NoDatum" 'PrefixI 'False) (U1 ∷ Type → Type) :+: (C1 ('MetaCons "DatumHash" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (DataHash (EraCrypto era)))) :+: C1 ('MetaCons "Datum" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedUnpack) (Rec0 (BinaryData era)))))

datumDataHash ∷ Era era ⇒ Datum era → StrictMaybe (DataHash (EraCrypto era)) Source #

Get the Hash of the datum.

BinaryData

data BinaryData era Source #

Inlined data must be stored in the most compact form because it contributes to the memory overhead of the ledger state. Constructor is intentionally not exported, in order to prevent invalid creation of data from arbitrary binary data. Use makeBinaryData for smart construction.

Instances

Instances details

Generic (BinaryData era)
Instance details Defined in Cardano.Ledger.Plutus.Data Associated Types type Rep (BinaryData era) ∷ Type → Type Source # Methods from ∷ BinaryData era → Rep (BinaryData era) x Source # to ∷ Rep (BinaryData era) x → BinaryData era Source #
Show (BinaryData era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods showsPrec ∷ Int → BinaryData era → ShowS Source # show ∷ BinaryData era → String Source # showList ∷ [BinaryData era] → ShowS Source #
Era era ⇒ DecCBOR (BinaryData era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods decCBOR ∷ Decoder s (BinaryData era) Source # dropCBOR ∷ Proxy (BinaryData era) → Decoder s () Source # label ∷ Proxy (BinaryData era) → Text Source #
Typeable era ⇒ EncCBOR (BinaryData era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods encCBOR ∷ BinaryData era → Encoding Source # encodedSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy (BinaryData era) → Size Source # encodedListSizeExpr ∷ (∀ t. EncCBOR t ⇒ Proxy t → Size) → Proxy [BinaryData era] → Size Source #
SafeToHash (BinaryData era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods originalBytes ∷ BinaryData era → ByteString Source # originalBytesSize ∷ BinaryData era → Int Source # makeHashWithExplicitProxys ∷ HashAlgorithm (HASH c) ⇒ Proxy c → Proxy index → BinaryData era → SafeHash c index Source #
Eq (BinaryData era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods (==) ∷ BinaryData era → BinaryData era → Bool Source # (/=) ∷ BinaryData era → BinaryData era → Bool Source #
Ord (BinaryData era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods compare ∷ BinaryData era → BinaryData era → Ordering Source # (<) ∷ BinaryData era → BinaryData era → Bool Source # (<=) ∷ BinaryData era → BinaryData era → Bool Source # (>) ∷ BinaryData era → BinaryData era → Bool Source # (>=) ∷ BinaryData era → BinaryData era → Bool Source # max ∷ BinaryData era → BinaryData era → BinaryData era Source # min ∷ BinaryData era → BinaryData era → BinaryData era Source #
NoThunks (BinaryData era)
Instance details Defined in Cardano.Ledger.Plutus.Data Methods noThunks ∷ Context → BinaryData era → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → BinaryData era → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy (BinaryData era) → String Source #
EraCrypto era ~ c ⇒ HashAnnotated (BinaryData era) EraIndependentData c
Instance details Defined in Cardano.Ledger.Plutus.Data Methods indexProxy ∷ BinaryData era → Proxy EraIndependentData Source # hashAnnotated ∷ BinaryData era → SafeHash c EraIndependentData Source #
type Rep (BinaryData era)
Instance details Defined in Cardano.Ledger.Plutus.Data type Rep (BinaryData era) = D1 ('MetaData "BinaryData" "Cardano.Ledger.Plutus.Data" "cardano-ledger-core-1.16.0.0-inplace" 'True) (C1 ('MetaCons "BinaryData" 'PrefixI 'False) (S1 ('MetaSel ('Nothing ∷ Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortByteString)))

makeBinaryData ∷ Era era ⇒ ShortByteString → Either String (BinaryData era) Source #

Construct BinaryData from a buffer of bytes, while ensuring that it can be later safely converted to Data with binaryDataToData

hashBinaryData ∷ Era era ⇒ BinaryData era → DataHash (EraCrypto era) Source #

binaryDataToData ∷ Era era ⇒ BinaryData era → Data era Source #

It is safe to convert BinaryData to Data because the only way to construct BinaryData is through the smart constructor makeBinaryData that takes care of validation.

dataToBinaryData ∷ Era era ⇒ Data era → BinaryData era Source #