cardano-ledger-api-1.7.0.1: Public API for the cardano ledger codebase
Safe HaskellSafe-Inferred
LanguageHaskell2010

Cardano.Ledger.Api.Tx.AuxData

Synopsis

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)), ToExpr (TxAuxData era), HashAnnotated (TxAuxData era) EraIndependentTxAuxData (EraCrypto era)) => EraTxAuxData era #

Minimal complete definition

upgradeTxAuxData, hashTxAuxData, validateTxAuxData

Associated Types

type TxAuxData era = (r :: Type) | r -> era #

hashTxAuxData :: EraTxAuxData era => TxAuxData era -> AuxiliaryDataHash (EraCrypto era) #

validateTxAuxData :: EraTxAuxData era => ProtVer -> TxAuxData era -> Bool #

Shelley

data ShelleyTxAuxData era where #

Bundled Patterns

pattern ShelleyTxAuxData :: Era era => Map Word64 Metadatum -> ShelleyTxAuxData era 

Instances

Instances details
Generic (ShelleyTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Associated Types

type Rep (ShelleyTxAuxData era) :: Type -> Type Source #

Show (ShelleyTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Typeable era => ToCBOR (ShelleyTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Methods

toCBOR :: ShelleyTxAuxData era -> Encoding

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (ShelleyTxAuxData era) -> Size

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [ShelleyTxAuxData era] -> Size

Typeable era => DecCBOR (Annotator (ShelleyTxAuxData era)) 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Methods

decCBOR :: Decoder s (Annotator (ShelleyTxAuxData era))

dropCBOR :: Proxy (Annotator (ShelleyTxAuxData era)) -> Decoder s ()

label :: Proxy (Annotator (ShelleyTxAuxData era)) -> Text

Era era => EncCBOR (ShelleyTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Methods

encCBOR :: ShelleyTxAuxData era -> Encoding

encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy (ShelleyTxAuxData era) -> Size

encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [ShelleyTxAuxData era] -> Size

EqRaw (ShelleyTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

SafeToHash (ShelleyTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Methods

originalBytes :: ShelleyTxAuxData era -> ByteString

makeHashWithExplicitProxys :: HashAlgorithm (HASH c) => Proxy c -> Proxy index -> ShelleyTxAuxData era -> SafeHash c index

NFData (ShelleyTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Methods

rnf :: ShelleyTxAuxData era -> () Source #

Eq (ShelleyTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Ord (ShelleyTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Typeable era => NoThunks (ShelleyTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Methods

noThunks :: Context -> ShelleyTxAuxData era -> IO (Maybe ThunkInfo)

wNoThunks :: Context -> ShelleyTxAuxData era -> IO (Maybe ThunkInfo)

showTypeOf :: Proxy (ShelleyTxAuxData era) -> String

ToExpr (ShelleyTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Methods

toExpr :: ShelleyTxAuxData era -> Expr

listToExpr :: [ShelleyTxAuxData era] -> Expr

c ~ EraCrypto era => HashAnnotated (ShelleyTxAuxData era) EraIndependentTxAuxData c 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Methods

indexProxy :: ShelleyTxAuxData era -> Proxy EraIndependentTxAuxData

hashAnnotated :: ShelleyTxAuxData era -> SafeHash c EraIndependentTxAuxData

type Rep (ShelleyTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

type Rep (ShelleyTxAuxData era) = D1 ('MetaData "ShelleyTxAuxData" "Cardano.Ledger.Shelley.TxAuxData" "cardano-ledger-shelley-1.8.0.0-K8MVzOrWEQEOdl6Q57XMq" 'False) (C1 ('MetaCons "ShelleyTxAuxData'" 'PrefixI 'True) (S1 ('MetaSel ('Just "mdMap") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Map Word64 Metadatum)) :*: S1 ('MetaSel ('Just "mdBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString)))

data Metadatum #

Constructors

Map ![(Metadatum, Metadatum)] 
List ![Metadatum] 
I !Integer 
B !ByteString 
S !Text 

Instances

Instances details
Generic Metadatum 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Associated Types

type Rep Metadatum :: Type -> Type Source #

Show Metadatum 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

DecCBOR Metadatum 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Methods

decCBOR :: Decoder s Metadatum

dropCBOR :: Proxy Metadatum -> Decoder s ()

label :: Proxy Metadatum -> Text

EncCBOR Metadatum 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Methods

encCBOR :: Metadatum -> Encoding

encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy Metadatum -> Size

encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [Metadatum] -> Size

NFData Metadatum 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Methods

rnf :: Metadatum -> () Source #

Eq Metadatum 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Ord Metadatum 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

NoThunks Metadatum 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Methods

noThunks :: Context -> Metadatum -> IO (Maybe ThunkInfo)

wNoThunks :: Context -> Metadatum -> IO (Maybe ThunkInfo)

showTypeOf :: Proxy Metadatum -> String

ToExpr Metadatum 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Methods

toExpr :: Metadatum -> Expr

listToExpr :: [Metadatum] -> Expr

type Rep Metadatum 
Instance details

Defined in Cardano.Ledger.Shelley.TxAuxData

Allegra

data AllegraTxAuxData era where #

Bundled Patterns

pattern AllegraTxAuxData :: Era era => Map Word64 Metadatum -> StrictSeq (Timelock era) -> AllegraTxAuxData era 

Instances

Instances details
Memoized AllegraTxAuxData 
Instance details

Defined in Cardano.Ledger.Allegra.TxAuxData

Associated Types

type RawType AllegraTxAuxData = (r :: Type -> Type)

Methods

getMemoBytes :: AllegraTxAuxData era -> MemoBytes (RawType AllegraTxAuxData) era

wrapMemoBytes :: MemoBytes (RawType AllegraTxAuxData) era -> AllegraTxAuxData era

Generic (AllegraTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Allegra.TxAuxData

Associated Types

type Rep (AllegraTxAuxData era) :: Type -> Type Source #

HashAlgorithm (HASH (EraCrypto era)) => Show (AllegraTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Allegra.TxAuxData

Typeable era => ToCBOR (AllegraTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Allegra.TxAuxData

Methods

toCBOR :: AllegraTxAuxData era -> Encoding

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (AllegraTxAuxData era) -> Size

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [AllegraTxAuxData era] -> Size

Era era => DecCBOR (Annotator (AllegraTxAuxData era)) 
Instance details

Defined in Cardano.Ledger.Allegra.TxAuxData

Methods

decCBOR :: Decoder s (Annotator (AllegraTxAuxData era))

dropCBOR :: Proxy (Annotator (AllegraTxAuxData era)) -> Decoder s ()

label :: Proxy (Annotator (AllegraTxAuxData era)) -> Text

Era era => EncCBOR (AllegraTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Allegra.TxAuxData

Methods

encCBOR :: AllegraTxAuxData era -> Encoding

encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy (AllegraTxAuxData era) -> Size

encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [AllegraTxAuxData era] -> Size

EqRaw (AllegraTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Allegra.TxAuxData

SafeToHash (AllegraTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Allegra.TxAuxData

Methods

originalBytes :: AllegraTxAuxData era -> ByteString

makeHashWithExplicitProxys :: HashAlgorithm (HASH c) => Proxy c -> Proxy index -> AllegraTxAuxData era -> SafeHash c index

NFData (AllegraTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Allegra.TxAuxData

Methods

rnf :: AllegraTxAuxData era -> () Source #

Eq (AllegraTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Allegra.TxAuxData

Era era => NoThunks (AllegraTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Allegra.TxAuxData

Methods

noThunks :: Context -> AllegraTxAuxData era -> IO (Maybe ThunkInfo)

wNoThunks :: Context -> AllegraTxAuxData era -> IO (Maybe ThunkInfo)

showTypeOf :: Proxy (AllegraTxAuxData era) -> String

ToExpr (AllegraTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Allegra.TxAuxData

Methods

toExpr :: AllegraTxAuxData era -> Expr

listToExpr :: [AllegraTxAuxData era] -> Expr

c ~ EraCrypto era => HashAnnotated (AllegraTxAuxData era) EraIndependentTxAuxData c 
Instance details

Defined in Cardano.Ledger.Allegra.TxAuxData

Methods

indexProxy :: AllegraTxAuxData era -> Proxy EraIndependentTxAuxData

hashAnnotated :: AllegraTxAuxData era -> SafeHash c EraIndependentTxAuxData

type RawType AllegraTxAuxData 
Instance details

Defined in Cardano.Ledger.Allegra.TxAuxData

type RawType AllegraTxAuxData = AllegraTxAuxDataRaw
type Rep (AllegraTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Allegra.TxAuxData

type Rep (AllegraTxAuxData era) = D1 ('MetaData "AllegraTxAuxData" "Cardano.Ledger.Allegra.TxAuxData" "cardano-ledger-allegra-1.2.5.0-24qA9GSu3xXIRUxpGuTGnh" 'True) (C1 ('MetaCons "AuxiliaryDataWithBytes" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MemoBytes AllegraTxAuxDataRaw era))))
type TranslationError (MaryEra c) AllegraTxAuxData 
Instance details

Defined in Cardano.Ledger.Mary.Translation

type TranslationError (MaryEra c) AllegraTxAuxData = Void

Alonzo

data AlonzoTxAuxData era where #

Bundled Patterns

pattern AlonzoTxAuxData :: Era era => Map Word64 Metadatum -> StrictSeq (Timelock era) -> Map Language (NonEmpty BinaryPlutus) -> AlonzoTxAuxData era 

Instances

Instances details
Memoized AlonzoTxAuxData 
Instance details

Defined in Cardano.Ledger.Alonzo.TxAuxData

Associated Types

type RawType AlonzoTxAuxData = (r :: Type -> Type)

Methods

getMemoBytes :: AlonzoTxAuxData era -> MemoBytes (RawType AlonzoTxAuxData) era

wrapMemoBytes :: MemoBytes (RawType AlonzoTxAuxData) era -> AlonzoTxAuxData era

Generic (AlonzoTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Alonzo.TxAuxData

Associated Types

type Rep (AlonzoTxAuxData era) :: Type -> Type Source #

HashAlgorithm (HASH (EraCrypto era)) => Show (AuxiliaryData era) 
Instance details

Defined in Cardano.Ledger.Alonzo.TxAuxData

Methods

showsPrec :: Int -> AuxiliaryData era -> ShowS Source #

show :: AuxiliaryData era -> String Source #

showList :: [AuxiliaryData era] -> ShowS Source #

Typeable era => ToCBOR (AlonzoTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Alonzo.TxAuxData

Methods

toCBOR :: AlonzoTxAuxData era -> Encoding

encodedSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy (AlonzoTxAuxData era) -> Size

encodedListSizeExpr :: (forall t. ToCBOR t => Proxy t -> Size) -> Proxy [AlonzoTxAuxData era] -> Size

Era era => DecCBOR (Annotator (AuxiliaryData era)) 
Instance details

Defined in Cardano.Ledger.Alonzo.TxAuxData

Methods

decCBOR :: Decoder s (Annotator (AuxiliaryData era))

dropCBOR :: Proxy (Annotator (AuxiliaryData era)) -> Decoder s ()

label :: Proxy (Annotator (AuxiliaryData era)) -> Text

Era era => EncCBOR (AlonzoTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Alonzo.TxAuxData

Methods

encCBOR :: AlonzoTxAuxData era -> Encoding

encodedSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy (AlonzoTxAuxData era) -> Size

encodedListSizeExpr :: (forall t. EncCBOR t => Proxy t -> Size) -> Proxy [AlonzoTxAuxData era] -> Size

EqRaw (AlonzoTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Alonzo.TxAuxData

Methods

eqRaw :: AlonzoTxAuxData era -> AlonzoTxAuxData era -> Bool

SafeToHash (AlonzoTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Alonzo.TxAuxData

Methods

originalBytes :: AlonzoTxAuxData era -> ByteString

makeHashWithExplicitProxys :: HashAlgorithm (HASH c) => Proxy c -> Proxy index -> AlonzoTxAuxData era -> SafeHash c index

NFData (AuxiliaryData era) 
Instance details

Defined in Cardano.Ledger.Alonzo.TxAuxData

Methods

rnf :: AuxiliaryData era -> () Source #

Eq (AuxiliaryData era) 
Instance details

Defined in Cardano.Ledger.Alonzo.TxAuxData

Methods

(==) :: AuxiliaryData era -> AuxiliaryData era -> Bool Source #

(/=) :: AuxiliaryData era -> AuxiliaryData era -> Bool Source #

NoThunks (AuxiliaryData era) 
Instance details

Defined in Cardano.Ledger.Alonzo.TxAuxData

Methods

noThunks :: Context -> AuxiliaryData era -> IO (Maybe ThunkInfo)

wNoThunks :: Context -> AuxiliaryData era -> IO (Maybe ThunkInfo)

showTypeOf :: Proxy (AuxiliaryData era) -> String

ToExpr (AlonzoTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Alonzo.TxAuxData

Methods

toExpr :: AlonzoTxAuxData era -> Expr

listToExpr :: [AlonzoTxAuxData era] -> Expr

EraCrypto era ~ c => HashAnnotated (AuxiliaryData era) EraIndependentTxAuxData c 
Instance details

Defined in Cardano.Ledger.Alonzo.TxAuxData

Methods

indexProxy :: AuxiliaryData era -> Proxy EraIndependentTxAuxData

hashAnnotated :: AuxiliaryData era -> SafeHash c EraIndependentTxAuxData

type RawType AlonzoTxAuxData 
Instance details

Defined in Cardano.Ledger.Alonzo.TxAuxData

type RawType AlonzoTxAuxData = AlonzoTxAuxDataRaw
type Rep (AlonzoTxAuxData era) 
Instance details

Defined in Cardano.Ledger.Alonzo.TxAuxData

type Rep (AlonzoTxAuxData era) = D1 ('MetaData "AlonzoTxAuxData" "Cardano.Ledger.Alonzo.TxAuxData" "cardano-ledger-alonzo-1.5.1.0-1MT8TTvKeeyGoJw1KVxcth" 'True) (C1 ('MetaCons "AuxiliaryDataConstr" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (MemoBytes AlonzoTxAuxDataRaw era))))

mkAlonzoTxAuxData :: (Foldable f, Era era) => Map Word64 Metadatum -> f (AlonzoScript era) -> AlonzoTxAuxData era #

getAlonzoTxAuxDataScripts :: Era era => AlonzoTxAuxData era -> StrictSeq (AlonzoScript era) #