Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Cardano.Ledger.Api.Tx.AuxData
Synopsis
- class (Era era, Eq (TxAuxData era), EqRaw (TxAuxData era), Show (TxAuxData era), NoThunks (TxAuxData era), ToCBOR (TxAuxData era), EncCBOR (TxAuxData era), DecCBOR (Annotator (TxAuxData era)), HashAnnotated (TxAuxData era) EraIndependentTxAuxData) ⇒ EraTxAuxData era where
- mkBasicTxAuxData ∷ EraTxAuxData era ⇒ TxAuxData era
- metadataTxAuxDataL ∷ EraTxAuxData era ⇒ Lens' (TxAuxData era) (Map Word64 Metadatum)
- hashTxAuxData ∷ EraTxAuxData era ⇒ TxAuxData era → TxAuxDataHash
- validateTxAuxData ∷ EraTxAuxData era ⇒ ProtVer → TxAuxData era → Bool
- class EraTxAuxData era ⇒ AnyEraTxAuxData era where
- nativeScriptsTxAuxDataG ∷ SimpleGetter (TxAuxData era) (Maybe (StrictSeq (NativeScript era)))
- plutusScriptsTxAuxDataG ∷ SimpleGetter (TxAuxData era) (Maybe (Map Language (NonEmpty PlutusBinary)))
- newtype ShelleyTxAuxData era where
- MkShelleyTxAuxData (MemoBytes (ShelleyTxAuxDataRaw era))
- pattern ShelleyTxAuxData ∷ Era era ⇒ Map Word64 Metadatum → ShelleyTxAuxData era
- data Metadatum
- class EraTxAuxData era ⇒ AllegraEraTxAuxData era
- nativeScriptsTxAuxDataL ∷ AllegraEraTxAuxData era ⇒ Lens' (TxAuxData era) (StrictSeq (NativeScript era))
- newtype AllegraTxAuxData era where
- MkAlegraTxAuxData (MemoBytes (AllegraTxAuxDataRaw era))
- pattern AllegraTxAuxData ∷ (Era era, EncCBOR (NativeScript era)) ⇒ Map Word64 Metadatum → StrictSeq (NativeScript era) → AllegraTxAuxData era
- class AllegraEraTxAuxData era ⇒ AlonzoEraTxAuxData era
- plutusScriptsTxAuxDataL ∷ AlonzoEraTxAuxData era ⇒ Lens' (TxAuxData era) (Map Language (NonEmpty PlutusBinary))
- data Language
- newtype PlutusBinary = PlutusBinary {}
- newtype AlonzoTxAuxData era where
- MkAlonzoTxAuxData (MemoBytes (AlonzoTxAuxDataRaw era))
- pattern AlonzoTxAuxData ∷ (HasCallStack, AlonzoEraScript era) ⇒ Map Word64 Metadatum → StrictSeq (NativeScript era) → Map Language (NonEmpty PlutusBinary) → AlonzoTxAuxData era
- pattern AlonzoTxAuxData' ∷ Map Word64 Metadatum → StrictSeq (NativeScript era) → Map Language (NonEmpty PlutusBinary) → AlonzoTxAuxData era
- mkAlonzoTxAuxData ∷ (Foldable f, AlonzoEraScript era) ⇒ Map Word64 Metadatum → f (AlonzoScript era) → AlonzoTxAuxData era
- getAlonzoTxAuxDataScripts ∷ AlonzoEraScript era ⇒ AlonzoTxAuxData era → StrictSeq (AlonzoScript era)
- binaryUpgradeTxAuxData ∷ (Era era, ToCBOR (TxAuxData (PreviousEra era)), DecCBOR (Annotator (TxAuxData era))) ⇒ TxAuxData (PreviousEra era) → Except DecoderError (TxAuxData era)
- upgradeTxAuxData ∷ (EraApi era, EraTxAuxData (PreviousEra era)) ⇒ TxAuxData (PreviousEra era) → TxAuxData era
Documentation
class (Era era, Eq (TxAuxData era), EqRaw (TxAuxData era), Show (TxAuxData era), NoThunks (TxAuxData era), ToCBOR (TxAuxData era), EncCBOR (TxAuxData era), DecCBOR (Annotator (TxAuxData era)), HashAnnotated (TxAuxData era) EraIndependentTxAuxData) ⇒ EraTxAuxData era Source #
TxAuxData which may be attached to a transaction
Minimal complete definition
mkBasicTxAuxData ∷ EraTxAuxData era ⇒ TxAuxData era Source #
metadataTxAuxDataL ∷ EraTxAuxData era ⇒ Lens' (TxAuxData era) (Map Word64 Metadatum) Source #
hashTxAuxData ∷ EraTxAuxData era ⇒ TxAuxData era → TxAuxDataHash Source #
Compute a hash of TxAuxData
validateTxAuxData ∷ EraTxAuxData era ⇒ ProtVer → TxAuxData era → Bool Source #
Any era
class EraTxAuxData era ⇒ AnyEraTxAuxData era where Source #
Minimal complete definition
Nothing
Methods
nativeScriptsTxAuxDataG ∷ SimpleGetter (TxAuxData era) (Maybe (StrictSeq (NativeScript era))) Source #
default nativeScriptsTxAuxDataG ∷ AllegraEraTxAuxData era ⇒ SimpleGetter (TxAuxData era) (Maybe (StrictSeq (NativeScript era))) Source #
plutusScriptsTxAuxDataG ∷ SimpleGetter (TxAuxData era) (Maybe (Map Language (NonEmpty PlutusBinary))) Source #
default plutusScriptsTxAuxDataG ∷ AlonzoEraTxAuxData era ⇒ SimpleGetter (TxAuxData era) (Maybe (Map Language (NonEmpty PlutusBinary))) Source #
Instances
AnyEraTxAuxData AllegraEra Source # | |
Defined in Cardano.Ledger.Api.Tx.AuxData | |
AnyEraTxAuxData AlonzoEra Source # | |
Defined in Cardano.Ledger.Api.Tx.AuxData | |
AnyEraTxAuxData BabbageEra Source # | |
Defined in Cardano.Ledger.Api.Tx.AuxData | |
AnyEraTxAuxData ConwayEra Source # | |
Defined in Cardano.Ledger.Api.Tx.AuxData | |
AnyEraTxAuxData DijkstraEra Source # | |
Defined in Cardano.Ledger.Api.Tx.AuxData | |
AnyEraTxAuxData MaryEra Source # | |
Defined in Cardano.Ledger.Api.Tx.AuxData | |
AnyEraTxAuxData ShelleyEra Source # | |
Defined in Cardano.Ledger.Api.Tx.AuxData |
Shelley
newtype ShelleyTxAuxData era Source #
Constructors
MkShelleyTxAuxData (MemoBytes (ShelleyTxAuxDataRaw era)) |
Bundled Patterns
pattern ShelleyTxAuxData ∷ Era era ⇒ Map Word64 Metadatum → ShelleyTxAuxData era |
Instances
A generic metadatum type.
Instances
Allegra
class EraTxAuxData era ⇒ AllegraEraTxAuxData era Source #
Minimal complete definition
Instances
AllegraEraTxAuxData AllegraEra | |
Defined in Cardano.Ledger.Allegra.TxAuxData Methods nativeScriptsTxAuxDataL ∷ Lens' (TxAuxData AllegraEra) (StrictSeq (NativeScript AllegraEra)) Source # |
nativeScriptsTxAuxDataL ∷ AllegraEraTxAuxData era ⇒ Lens' (TxAuxData era) (StrictSeq (NativeScript era)) Source #
newtype AllegraTxAuxData era Source #
Constructors
MkAlegraTxAuxData (MemoBytes (AllegraTxAuxDataRaw era)) |
Bundled Patterns
pattern AllegraTxAuxData ∷ (Era era, EncCBOR (NativeScript era)) ⇒ Map Word64 Metadatum → StrictSeq (NativeScript era) → AllegraTxAuxData era |
Instances
Alonzo
class AllegraEraTxAuxData era ⇒ AlonzoEraTxAuxData era Source #
Minimal complete definition
Instances
AlonzoEraTxAuxData AlonzoEra | |
Defined in Cardano.Ledger.Alonzo.TxAuxData Methods plutusScriptsTxAuxDataL ∷ Lens' (TxAuxData AlonzoEra) (Map Language (NonEmpty PlutusBinary)) Source # |
plutusScriptsTxAuxDataL ∷ AlonzoEraTxAuxData era ⇒ Lens' (TxAuxData era) (Map Language (NonEmpty PlutusBinary)) Source #
Non-Native Plutus Script language. This is expected to be an open type. We will add new Constuctors to this type as additional Plutus language versions as are added. We use an enumerated type for two reasons.
- We can write total functions by case analysis over the constructors
- We use DataKinds to make some datatypes indexed by Language.
Note that the the serialization of Language
depends on the ordering.
Instances
newtype PlutusBinary Source #
Binary representation of a Plutus script.
Constructors
PlutusBinary | |
Fields |
Instances
newtype AlonzoTxAuxData era Source #
Constructors
MkAlonzoTxAuxData (MemoBytes (AlonzoTxAuxDataRaw era)) |
Bundled Patterns
pattern AlonzoTxAuxData ∷ (HasCallStack, AlonzoEraScript era) ⇒ Map Word64 Metadatum → StrictSeq (NativeScript era) → Map Language (NonEmpty PlutusBinary) → AlonzoTxAuxData era | Construct auxiliary data. Make sure not to supply plutus script versions that are not
supported in this era, because it will result in a runtime exception. Use
|
pattern AlonzoTxAuxData' ∷ Map Word64 Metadatum → StrictSeq (NativeScript era) → Map Language (NonEmpty PlutusBinary) → AlonzoTxAuxData era |
Instances
mkAlonzoTxAuxData ∷ (Foldable f, AlonzoEraScript era) ⇒ Map Word64 Metadatum → f (AlonzoScript era) → AlonzoTxAuxData era Source #
Helper function that will construct Auxiliary data from Metadatum map and a list of scripts.
Note that the relative order of same type scripts will be preserved.
getAlonzoTxAuxDataScripts ∷ AlonzoEraScript era ⇒ AlonzoTxAuxData era → StrictSeq (AlonzoScript era) Source #
Upgrade
binaryUpgradeTxAuxData ∷ (Era era, ToCBOR (TxAuxData (PreviousEra era)), DecCBOR (Annotator (TxAuxData era))) ⇒ TxAuxData (PreviousEra era) → Except DecoderError (TxAuxData era) Source #
Translate tx auxData through its binary representation from previous to current era.
upgradeTxAuxData ∷ (EraApi era, EraTxAuxData (PreviousEra era)) ⇒ TxAuxData (PreviousEra era) → TxAuxData era Source #
Upgrade txAuxData from the previous era.
Warning - This may not preserve the underlying binary representation.
Use binaryUpgradeTxAuxData
instead, if you need to preserve the serialised form.