HORIZON HASKELLDocslts/ghc-9.14.xd82dee82026-10-12Search names, modules, packages, or :: a typeCtrl K

GHC 9.14.1 · lts/ghc-9.14.x · d82dee8 · 2026-10-12

Modulecardano-api-11.7.0.0

Cardano.Api

  • 374 types
  • 45 classes
  • 755 values
valueintoFile
  1. :: File content 'Out
  2. -> content
  3. -> File content 'Out -> stream -> result
  4. -> content -> stream
  5. -> result
#
valuegetTxBody :: Tx era -> TxBody era
#

Deprecated. Use UnsignedTx from Cardano.Api.Experimental instead.

value(<+>) :: Doc ann -> Doc ann -> Doc ann
#

(x <+> y) concatenates document x and y with a space in between.

Example1 expression
"hello" <+> "world"hello world
x <+> y = x <> space <> y
valuehsep :: [Doc ann] -> Doc ann
#

(hsep xs) concatenates all documents xs horizontally with <+>, i.e. it puts a space between all entries.

Example1 expression
let docs = Util.words "lorem ipsum dolor sit amet"
Example1 expression
hsep docslorem ipsum dolor sit amet

hsep does not introduce line breaks on its own, even when the page is too narrow:

Example1 expression
putDocW 5 (hsep docs)lorem ipsum dolor sit amet

For automatic line breaks, consider using fillSep instead.

valuevsep :: [Doc ann] -> Doc ann
#

(vsep xs) concatenates all documents xs above each other. If a group undoes the line breaks inserted by vsep, the documents are separated with a space instead.

Using vsep alone yields

Example1 expression
"prefix" <+> vsep ["text", "to", "lay", "out"]prefix texttolayout

grouping a vsep separates the documents with a space if it fits the page (and does nothing otherwise). See the sep convenience function for this use case.

The align function can be used to align the documents under their first element:

Example1 expression
"prefix" <+> align (vsep ["text", "to", "lay", "out"])prefix text       to       lay       out

Since grouping a vsep is rather common, sep is a built-in for doing that.

valuefinallyE :: Monad m => ExceptT e m a -> ExceptT e m () -> ExceptT e m a
#

finallyE a b executes computation a followed by computation b, even if a exits early by throwing an exception. In the latter case, the exception is re-thrown after b has been executed.

valuewithExcept :: (e -> e') -> Except e a -> Except e' a
#

Transform any exceptions thrown by the computation using the given function (a specialization of withExceptT).

valuebracketExceptionT
  1. :: MonadMask m
  2. => ExceptT e m a
  3. -> a -> ExceptT e m c
  4. -> a -> ExceptT e m b
  5. -> ExceptT e m b
#

Acquire a resource in ExceptT and then perform an action with it, cleaning up afterwards regardless of left or exception.

Like bracketExceptT, but the cleanup is called even when the bracketed function throws an exception. Exceptions in the bracketed function are caught to allow the cleanup to run and then rethrown.

valueexceptT :: Monad m => (x -> m b) -> (a -> m b) -> ExceptT x m a -> m b
#

Map over both arguments at the same time.

Specialised version of bimap for ExceptT.

valuehandleExceptT
  1. :: (MonadCatch m, Exception e)
  2. => e -> x
  3. -> m a
  4. -> ExceptT x m a
#

Try any monad action and catch the specified exception, wrapping it to convert it to the error type of the ExceptT transformer. Exceptions other that the specified exception type will escape the ExceptT transformer.

  • Warning*: This function should be used with caution! In particular, it is bad practice to catch SomeException because that includes asynchronous exceptions like stack/heap overflow, thread killed and user interrupt. Trying to handle StackOverflow, HeapOverflow and ThreadKilled exceptions could cause your program to crash or behave in unexpected ways.

valuehandlesExceptT
  1. :: (Foldable f, MonadCatch m)
  2. => f (Handler m x)
  3. -> m a
  4. -> ExceptT x m a
#

Try a monad action and catch any of the exceptions caught by the provided handlers. The handler for each exception type needs to wrap it to convert it to the error type of the ExceptT transformer. Exceptions not explicitly handled by the provided handlers will escape the ExceptT transformer.

valuehushM :: Monad m => Either e a -> (e -> m ()) -> m (Maybe a)
#

Convert an Either to a Maybe and execute the supplied handler in the Left case.

classclass FromJSON a where
#

A type that can be converted from JSON, with the possibility of failure.

In many cases, you can get the compiler to generate parsing code for you (see below). To begin, let's cover writing an instance by hand.

There are various reasons a conversion could fail. For example, an Object could be missing a required key, an Array could be of the wrong size, or a value could be of an incompatible type.

The basic ways to signal a failed conversion are as follows:

  • fail yields a custom error message: it is the recommended way of reporting a failure;

  • empty (or mzero) is uninformative: use it when the error is meant to be caught by some (<|>);

  • typeMismatch can be used to report a failure when the encountered value is not of the expected JSON type; unexpected is an appropriate alternative when more than one type may be expected, or to keep the expected type implicit.

prependFailure (or modifyFailure) add more information to a parser's error messages.

An example type and instance using typeMismatch and prependFailure:

-- Allow ourselves to write Text literals.
{-# LANGUAGE OverloadedStrings #-}

data Coord = Coord { x :: Double, y :: Double }

instance FromJSON Coord where
    parseJSON (Object v) = Coord
        <$> v .: "x"
        <*> v .: "y"

    -- We do not expect a non-Object value here.
    -- We could use empty to fail, but typeMismatch
    -- gives a much more informative error message.
    parseJSON invalid    =
        prependFailure "parsing Coord failed, "
            (typeMismatch "Object" invalid)

For this common case of only being concerned with a single type of JSON value, the functions withObject, withScientific, etc. are provided. Their use is to be preferred when possible, since they are more terse. Using withObject, we can rewrite the above instance (assuming the same language extension and data type) as:

instance FromJSON Coord where
    parseJSON = withObject "Coord" $ \v -> Coord
        <$> v .: "x"
        <*> v .: "y"

Instead of manually writing your FromJSON instance, there are two options to do it automatically:

  • Data.Aeson.TH provides Template Haskell functions which will derive an instance at compile time. The generated instance is optimized for your type so it will probably be more efficient than the following option.

  • The compiler can provide a default generic implementation for parseJSON.

To use the second, simply add a deriving Generic clause to your datatype and declare a FromJSON instance for your datatype without giving a definition for parseJSON.

For example, the previous example can be simplified to just:

{-# LANGUAGE DeriveGeneric #-}

import GHC.Generics

data Coord = Coord { x :: Double, y :: Double } deriving Generic

instance FromJSON Coord

or using the DerivingVia extension

deriving via Generically Coord instance FromJSON Coord

The default implementation will be equivalent to parseJSON = genericParseJSON defaultOptions; if you need different options, you can customize the generic decoding by defining:

customOptions = defaultOptions
                { fieldLabelModifier = map toUpper
                }

instance FromJSON Coord where
    parseJSON = genericParseJSON customOptions

Methods

Instances413FromJSON, …
classclass FromJSONKey a where
#

Read the docs for ToJSONKey first. This class is a conversion in the opposite direction. If you have a newtype wrapper around Text, the recommended way to define instances is with generalized newtype deriving:

newtype SomeId = SomeId { getSomeId :: Text }
  deriving (Eq,Ord,Hashable,FromJSONKey)

If you have a sum of nullary constructors, you may use the generic implementation:

data Color = Red | Green | Blue
  deriving Generic

instance FromJSONKey Color where
  fromJSONKey = genericFromJSONKey defaultJSONKeyOptions
Instances67FromJSONKey, …
classclass ToJSON a where
#

A type that can be converted to JSON.

Instances in general must specify toJSON and should (but don't need to) specify toEncoding.

An example type and instance:

-- Allow ourselves to write Text literals.
{-# LANGUAGE OverloadedStrings #-}

data Coord = Coord { x :: Double, y :: Double }

instance ToJSON Coord where
  toJSON (Coord x y) = object ["x" .= x, "y" .= y]

  toEncoding (Coord x y) = pairs ("x" .= x <> "y" .= y)

Instead of manually writing your ToJSON instance, there are two options to do it automatically:

  • Data.Aeson.TH provides Template Haskell functions which will derive an instance at compile time. The generated instance is optimized for your type so it will probably be more efficient than the following option.

  • The compiler can provide a default generic implementation for toJSON.

To use the second, simply add a deriving Generic clause to your datatype and declare a ToJSON instance. If you require nothing other than defaultOptions, it is sufficient to write (and this is the only alternative where the default toJSON implementation is sufficient):

{-# LANGUAGE DeriveGeneric #-}

import GHC.Generics

data Coord = Coord { x :: Double, y :: Double } deriving Generic

instance ToJSON Coord where
    toEncoding = genericToEncoding defaultOptions

or more conveniently using the DerivingVia extension

deriving via Generically Coord instance ToJSON Coord

If on the other hand you wish to customize the generic decoding, you have to implement both methods:

customOptions = defaultOptions
                { fieldLabelModifier = map toUpper
                }

instance ToJSON Coord where
    toJSON     = genericToJSON customOptions
    toEncoding = genericToEncoding customOptions

Previous versions of this library only had the toJSON method. Adding toEncoding had two reasons:

  1. toEncoding is more efficient for the common case that the output of toJSON is directly serialized to a ByteString. Further, expressing either method in terms of the other would be non-optimal.

  2. The choice of defaults allows a smooth transition for existing users: Existing instances that do not define toEncoding still compile and have the correct semantics. This is ensured by making the default implementation of toEncoding use toJSON. This produces correct results, but since it performs an intermediate conversion to a Value, it will be less efficient than directly emitting an Encoding. (this also means that specifying nothing more than instance ToJSON Coord would be sufficient as a generically decoding instance, but there probably exists no good reason to not specify toEncoding in new instances.)

Methods

  • toJSON :: a -> Value

    Convert a Haskell value to a JSON-friendly intermediate type.

  • toEncoding :: a -> Encoding

    Encode a Haskell value as JSON.

    The default implementation of this method creates an intermediate Value using toJSON. This provides source-level compatibility for people upgrading from older versions of this library, but obviously offers no performance advantage.

    To benefit from direct encoding, you must provide an implementation for this method. The easiest way to do so is by having your types implement Generic using the DeriveGeneric extension, and then have GHC generate a method body as follows.

    instance ToJSON Coord where
    toEncoding = genericToEncoding defaultOptions
  • toJSONList :: [a] -> Value
  • toEncodingList :: [a] -> Encoding
  • omitField :: a -> Bool

    Defines when it is acceptable to omit a field of this type from a record. Used by (.?=) operator, and Generics and TH deriving with omitNothingFields = True.

Instances629ToJSON, …
classclass ToJSONKey a where
#

Typeclass for types that can be used as the key of a map-like container (like Map or HashMap). For example, since Text has a ToJSONKey instance and Char has a ToJSON instance, we can encode a value of type Map Text Char:

Example1 expression
LBC8.putStrLn $ encode $ Map.fromList [("foo" :: Text, 'a')]{"foo":"a"}

Since Int also has a ToJSONKey instance, we can similarly write:

Example1 expression
LBC8.putStrLn $ encode $ Map.fromList [(5 :: Int, 'a')]{"5":"a"}

JSON documents only accept strings as object keys. For any type from base that has a natural textual representation, it can be expected that its ToJSONKey instance will choose that representation.

For data types that lack a natural textual representation, an alternative is provided. The map-like container is represented as a JSON array instead of a JSON object. Each value in the array is an array with exactly two values. The first is the key and the second is the value.

For example, values of type '[Text]' cannot be encoded to a string, so a Map with keys of type '[Text]' is encoded as follows:

Example1 expression
LBC8.putStrLn $ encode $ Map.fromList [(["foo","bar","baz" :: Text], 'a')][[["foo","bar","baz"],"a"]]

The default implementation of ToJSONKey chooses this method of encoding a key, using the ToJSON instance of the type.

To use your own data type as the key in a map, all that is needed is to write a ToJSONKey (and possibly a FromJSONKey) instance for it. If the type cannot be trivially converted to and from Text, it is recommended that ToJSONKeyValue is used. Since the default implementations of the typeclass methods can build this from a ToJSON instance, there is nothing that needs to be written:

data Foo = Foo { fooAge :: Int, fooName :: Text }
  deriving (Eq,Ord,Generic)
instance ToJSON Foo
instance ToJSONKey Foo

That's it. We can now write:

Example2 expressions
let m = Map.fromList [(Foo 4 "bar",'a'),(Foo 6 "arg",'b')]LBC8.putStrLn $ encode m[[{"fooName":"bar","fooAge":4},"a"],[{"fooName":"arg","fooAge":6},"b"]]

The next case to consider is if we have a type that is a newtype wrapper around Text. The recommended approach is to use generalized newtype deriving:

newtype RecordId = RecordId { getRecordId :: Text }
  deriving (Eq,Ord,ToJSONKey)

Then we may write:

Example1 expression
LBC8.putStrLn $ encode $ Map.fromList [(RecordId "abc",'a')]{"abc":"a"}

Simple sum types are a final case worth considering. Suppose we have:

data Color = Red | Green | Blue
  deriving (Show,Read,Eq,Ord)

It is possible to get the ToJSONKey instance for free as we did with Foo. However, in this case, we have a natural way to go to and from Text that does not require any escape sequences. So ToJSONKeyText can be used instead of ToJSONKeyValue to encode maps as objects instead of arrays of pairs. This instance may be implemented using generics as follows:

instance ToJSONKey Color where
  toJSONKey = genericToJSONKey defaultJSONKeyOptions
Low-level implementations

The Show instance can be used to help write ToJSONKey:

instance ToJSONKey Color where
  toJSONKey = ToJSONKeyText f g
    where f = Text.pack . show
          g = text . Text.pack . show
          -- text function is from Data.Aeson.Encoding

The situation of needing to turning function a -> Text into a ToJSONKeyFunction is common enough that a special combinator is provided for it. The above instance can be rewritten as:

instance ToJSONKey Color where
  toJSONKey = toJSONKeyText (Text.pack . show)

The performance of the above instance can be improved by not using String as an intermediate step when converting to Text. One option for improving performance would be to use template haskell machinery from the text-show package. However, even with the approach, the Encoding (a wrapper around a bytestring builder) is generated by encoding the Text to a ByteString, an intermediate step that could be avoided. The fastest possible implementation would be:

-- Assuming that OverloadedStrings is enabled
instance ToJSONKey Color where
  toJSONKey = ToJSONKeyText f g
    where f x = case x of {Red -> "Red";Green ->"Green";Blue -> "Blue"}
          g x = case x of {Red -> text "Red";Green -> text "Green";Blue -> text "Blue"}
          -- text function is from Data.Aeson.Encoding

This works because GHC can lift the encoded values out of the case statements, which means that they are only evaluated once. This approach should only be used when there is a serious need to maximize performance.

Instances83ToJSONKey, …
datadata Address addrtype where
#

Constructors

Instances15Eq, Ord, Show, NFData, FromJSON, ToJSON, …
datadata AddressAny
#

Constructors

Instances7Eq, Ord, Show, SerialiseAddress, HasTypeProxy, SerialiseAsRawBytes, …
datadata AddressInEra era where
#

Constructors

Instances10Eq, Ord, Show, NFData, FromJSON, ToJSON, …
datadata ByronAddr
#
Instances6HasTypeProxy, FromJSON, ToJSON, SerialiseAddress, SerialiseAsRawBytes, AsType
classclass HasTypeProxy addr => SerialiseAddress addr where
#

Methods

Instances5SerialiseAddress
datadata ShelleyAddr
#
Instances7HasTypeProxy, FromJSON, ToJSON, SerialiseAddress, SerialiseAsBech32, SerialiseAsRawBytes, …
datadata StakeAddress where
#

Constructors

Instances10Eq, Ord, Show, FromJSON, ToJSON, SerialiseAddress, …
datadata BlockHeader
#

Constructors

Instances9HasTypeProxy, Eq, Ord, Show, FromJSON, ToJSON, …
datadata TxValidationError era where
#

Constructors

Instances4Show, Generic, ToJSON, Rep
classclass (RunNode blk, IOLike m) => Protocol (m :: Type -> Type) blk where
#

Associated types

Methods

Instances3Protocol
classclass RunNode blk => ProtocolClient blk where
#

Associated types

Methods

Instances3ProtocolClient
familydata family ProtocolClientInfoArgs blk
#
Instances3ProtocolClientInfoArgs
familydata family ProtocolInfoArgs (m :: Type -> Type) blk
#
Instances3ProtocolInfoArgs
datadata AllegraEra
#
Instances5IsCardanoEra, IsAllegraBasedEra, IsShelleyBasedEra, HasTypeProxy, AsType
datadata AlonzoEra
#
Instances8IsCardanoEra, IsAllegraBasedEra, IsAlonzoBasedEra, IsMaryBasedEra, IsShelleyBasedEra, HasTypeProxy, …
datadata AnyCardanoEra where
#

Constructors

Instances7Bounded, Enum, Eq, Show, Pretty, FromJSON, …
datadata BabbageEra
#
Instances12IsCardanoEra, IsAllegraBasedEra, IsAlonzoBasedEra, IsBabbageBasedEra, IsMaryBasedEra, IsShelleyBasedEra, …
datadata CardanoEra era where
#

Constructors

Instances17Eon, ToCardanoEra, TestEquality, Convert, Eq, Ord, …
datadata ConwayEra
#
Instances16IsCardanoEra, IsAllegraBasedEra, IsAlonzoBasedEra, IsBabbageBasedEra, IsConwayBasedEra, IsMaryBasedEra, …
datadata DijkstraEra
#
Instances9IsCardanoEra, IsAllegraBasedEra, IsAlonzoBasedEra, IsBabbageBasedEra, IsMaryBasedEra, IsShelleyBasedEra, …
classclass Eon (eon :: Type -> Type) where
#

Methods

Instances10Eon, …
  • Eon CardanoEraDefined in cardano-api-11.7.0.0 · Cardano.Api.Era.Internal.Core
  • Eon AllegraEraOnwardsDefined in cardano-api-11.7.0.0 · Cardano.Api.Era.Internal.Eon.AllegraEraOnwards
  • Eon AlonzoEraOnwardsDefined in cardano-api-11.7.0.0 · Cardano.Api.Era.Internal.Eon.AlonzoEraOnwards
  • Eon BabbageEraOnwardsDefined in cardano-api-11.7.0.0 · Cardano.Api.Era.Internal.Eon.BabbageEraOnwards
  • Eon ConwayEraOnwardsDefined in cardano-api-11.7.0.0 · Cardano.Api.Era.Internal.Eon.ConwayEraOnwards
  • Eon MaryEraOnwardsDefined in cardano-api-11.7.0.0 · Cardano.Api.Era.Internal.Eon.MaryEraOnwards
  • Eon ShelleyBasedEraDefined in cardano-api-11.7.0.0 · Cardano.Api.Era.Internal.Eon.ShelleyBasedEra
  • Eon ShelleyEraOnlyDefined in cardano-api-11.7.0.0 · Cardano.Api.Era.Internal.Eon.ShelleyEraOnly
  • Eon ShelleyToBabbageEraDefined in cardano-api-11.7.0.0 · Cardano.Api.Era.Internal.Eon.ShelleyToBabbageEra
  • Eon EraDefined in cardano-api-11.7.0.0 · Cardano.Api.Experimental.Era
classclass HasTypeProxy era => IsCardanoEra era where
#

Methods

Instances8IsCardanoEra, …
datadata MaryEra
#
Instances6IsCardanoEra, IsAllegraBasedEra, IsMaryBasedEra, IsShelleyBasedEra, HasTypeProxy, AsType
classclass ToCardanoEra (eon :: Type -> Type) where
#

Methods

Instances10ToCardanoEra, …
datadata AllegraEraOnwards era where
#

Constructors

Instances7Eon, ToCardanoEra, Convert, Eq, Show, …
typetype AllegraEraOnwardsConstraints era = (HashAlgorithm HASH, Signable (VRF StandardCrypto) Seed, PraosProtocolSupportsNode (ConsensusProtocol era), ShelleyBlock (ConsensusProtocol era) (ShelleyLedgerEra era) ~ ConsensusBlockForEra era, ShelleyCompatible (ConsensusProtocol era) (ShelleyLedgerEra era), ADDRHASH ~ Blake2b_224, Era (ShelleyLedgerEra era), EraPParams (ShelleyLedgerEra era), EraTx (ShelleyLedgerEra era), EraTxBody (ShelleyLedgerEra era), EraTxOut (ShelleyLedgerEra era), HashAnnotated (TxBody TopTx (ShelleyLedgerEra era)) EraIndependentTxBody, AllegraEraTxBody (ShelleyLedgerEra era), EraTxCert (ShelleyLedgerEra era), FromCBOR (ChainDepState (ConsensusProtocol era)), FromCBOR (DebugLedgerState era), IsCardanoEra era, IsShelleyBasedEra era, ToJSON (ChainDepState (ConsensusProtocol era)), ToJSON (DebugLedgerState era), Typeable era, (era == ByronEra) ~ 'False)
#
classclass IsShelleyBasedEra era => IsAllegraBasedEra era where
#

Methods

Instances6IsAllegraBasedEra
datadata AlonzoEraOnwards era where
#

Constructors

Instances9Eon, ToCardanoEra, Convert, Eq, Show, …
typetype AlonzoEraOnwardsConstraints era = (HashAlgorithm HASH, Signable (VRF StandardCrypto) Seed, PraosProtocolSupportsNode (ConsensusProtocol era), ShelleyBlock (ConsensusProtocol era) (ShelleyLedgerEra era) ~ ConsensusBlockForEra era, ShelleyCompatible (ConsensusProtocol era) (ShelleyLedgerEra era), ADDRHASH ~ Blake2b_224, AlonzoEraPParams (ShelleyLedgerEra era), AlonzoEraTx (ShelleyLedgerEra era), AlonzoEraTxBody (ShelleyLedgerEra era), AlonzoEraTxOut (ShelleyLedgerEra era), AlonzoEraTxWits (ShelleyLedgerEra era), AlonzoEraUTxO (ShelleyLedgerEra era), Era (ShelleyLedgerEra era), EraPParams (ShelleyLedgerEra era), EraTx (ShelleyLedgerEra era), EraTxBody (ShelleyLedgerEra era), EraTxOut (ShelleyLedgerEra era), EraUTxO (ShelleyLedgerEra era), HashAnnotated (TxBody TopTx (ShelleyLedgerEra era)) EraIndependentTxBody, MaryEraTxBody (ShelleyLedgerEra era), EraPlutusContext (ShelleyLedgerEra era), Script (ShelleyLedgerEra era) ~ AlonzoScript (ShelleyLedgerEra era), ScriptsNeeded (ShelleyLedgerEra era) ~ AlonzoScriptsNeeded (ShelleyLedgerEra era), Value (ShelleyLedgerEra era) ~ MaryValue, FromCBOR (ChainDepState (ConsensusProtocol era)), FromCBOR (DebugLedgerState era), IsCardanoEra era, IsShelleyBasedEra era, ToJSON (ChainDepState (ConsensusProtocol era)), ToJSON (DebugLedgerState era), Typeable era, (era == ByronEra) ~ 'False)
#
classclass IsMaryBasedEra era => IsAlonzoBasedEra era where
#

Methods

Instances4IsAlonzoBasedEra
datadata BabbageEraOnwards era where
#

Constructors

Instances10Eon, ToCardanoEra, Convert, Eq, Show, …
typetype BabbageEraOnwardsConstraints era = (HashAlgorithm HASH, Signable (VRF StandardCrypto) Seed, PraosProtocolSupportsNode (ConsensusProtocol era), ShelleyBlock (ConsensusProtocol era) (ShelleyLedgerEra era) ~ ConsensusBlockForEra era, ShelleyCompatible (ConsensusProtocol era) (ShelleyLedgerEra era), ADDRHASH ~ Blake2b_224, AlonzoEraTxOut (ShelleyLedgerEra era), BabbageEraPParams (ShelleyLedgerEra era), BabbageEraTxBody (ShelleyLedgerEra era), BabbageEraTxOut (ShelleyLedgerEra era), Era (ShelleyLedgerEra era), EraPParams (ShelleyLedgerEra era), EraTx (ShelleyLedgerEra era), EraTxBody (ShelleyLedgerEra era), EraTxOut (ShelleyLedgerEra era), EraUTxO (ShelleyLedgerEra era), HashAnnotated (TxBody TopTx (ShelleyLedgerEra era)) EraIndependentTxBody, MaryEraTxBody (ShelleyLedgerEra era), Script (ShelleyLedgerEra era) ~ AlonzoScript (ShelleyLedgerEra era), ScriptsNeeded (ShelleyLedgerEra era) ~ AlonzoScriptsNeeded (ShelleyLedgerEra era), EraTxCert (ShelleyLedgerEra era), TxOut (ShelleyLedgerEra era) ~ BabbageTxOut (ShelleyLedgerEra era), Value (ShelleyLedgerEra era) ~ MaryValue, FromCBOR (ChainDepState (ConsensusProtocol era)), FromCBOR (DebugLedgerState era), IsCardanoEra era, IsShelleyBasedEra era, ToJSON (ChainDepState (ConsensusProtocol era)), ToJSON (DebugLedgerState era), Typeable era, (era == ByronEra) ~ 'False)
#
classclass Convert (f :: a -> Type) (g :: a -> Type) where
#

Methods

Instances28Convert, …
datadata ConwayEraOnwards era where
#

Constructors

Instances12Eon, ToCardanoEra, Convert, Eq, Ord, Show, …
typetype ConwayEraOnwardsConstraints era = (ConwayEraCertState (ShelleyLedgerEra era), HashAlgorithm HASH, Signable (VRF StandardCrypto) Seed, PraosProtocolSupportsNode (ConsensusProtocol era), ShelleyBlock (ConsensusProtocol era) (ShelleyLedgerEra era) ~ ConsensusBlockForEra era, ShelleyCompatible (ConsensusProtocol era) (ShelleyLedgerEra era), ADDRHASH ~ Blake2b_224, AlonzoEraTxOut (ShelleyLedgerEra era), AlonzoEraTxWits (ShelleyLedgerEra era), BabbageEraTxBody (ShelleyLedgerEra era), ConwayEraGov (ShelleyLedgerEra era), ConwayEraPParams (ShelleyLedgerEra era), ConwayEraTxBody (ShelleyLedgerEra era), ConwayEraTxCert (ShelleyLedgerEra era), Era (ShelleyLedgerEra era), EraGov (ShelleyLedgerEra era), EraPParams (ShelleyLedgerEra era), EraTx (ShelleyLedgerEra era), EraTxBody (ShelleyLedgerEra era), EraTxOut (ShelleyLedgerEra era), EraUTxO (ShelleyLedgerEra era), GovState (ShelleyLedgerEra era) ~ ConwayGovState (ShelleyLedgerEra era), HashAnnotated (TxBody TopTx (ShelleyLedgerEra era)) EraIndependentTxBody, MaryEraTxBody (ShelleyLedgerEra era), Script (ShelleyLedgerEra era) ~ AlonzoScript (ShelleyLedgerEra era), ScriptsNeeded (ShelleyLedgerEra era) ~ AlonzoScriptsNeeded (ShelleyLedgerEra era), Value (ShelleyLedgerEra era) ~ MaryValue, FromCBOR (ChainDepState (ConsensusProtocol era)), FromCBOR (DebugLedgerState era), IsCardanoEra era, IsShelleyBasedEra era, ToJSON (ChainDepState (ConsensusProtocol era)), ToJSON (DebugLedgerState era), Typeable era, (era == ByronEra) ~ 'False)
#
classclass IsAllegraBasedEra era => IsMaryBasedEra era where
#

Methods

Instances5IsMaryBasedEra
datadata MaryEraOnwards era where
#

Constructors

Instances8Eon, ToCardanoEra, Convert, Eq, Show, …
typetype MaryEraOnwardsConstraints era = (HashAlgorithm HASH, Signable (VRF StandardCrypto) Seed, PraosProtocolSupportsNode (ConsensusProtocol era), ShelleyBlock (ConsensusProtocol era) (ShelleyLedgerEra era) ~ ConsensusBlockForEra era, ShelleyCompatible (ConsensusProtocol era) (ShelleyLedgerEra era), ADDRHASH ~ Blake2b_224, Era (ShelleyLedgerEra era), EraPParams (ShelleyLedgerEra era), EraTx (ShelleyLedgerEra era), EraTxBody (ShelleyLedgerEra era), EraTxOut (ShelleyLedgerEra era), EraUTxO (ShelleyLedgerEra era), HashAnnotated (TxBody TopTx (ShelleyLedgerEra era)) EraIndependentTxBody, MaryEraTxBody (ShelleyLedgerEra era), Value (ShelleyLedgerEra era) ~ MaryValue, FromCBOR (ChainDepState (ConsensusProtocol era)), FromCBOR (DebugLedgerState era), IsCardanoEra era, IsShelleyBasedEra era, ToJSON (ChainDepState (ConsensusProtocol era)), ToJSON (DebugLedgerState era), Typeable era, (era == ByronEra) ~ 'False)
#
datadata AnyShelleyBasedEra where
#

Constructors

Instances6Bounded, Enum, Eq, Show, FromJSON, ToJSON
classclass IsCardanoEra era => IsShelleyBasedEra era where
#

Methods

Instances7IsShelleyBasedEra, …
datadata ShelleyBasedEra era where
#

Constructors

Instances18Eon, ToCardanoEra, TestEquality, Convert, Eq, Ord, …
typetype ShelleyBasedEraConstraints era = (HashAlgorithm HASH, Signable (VRF StandardCrypto) Seed, PraosProtocolSupportsNode (ConsensusProtocol era), ShelleyBlock (ConsensusProtocol era) (ShelleyLedgerEra era) ~ ConsensusBlockForEra era, ShelleyCompatible (ConsensusProtocol era) (ShelleyLedgerEra era), FromCBOR (ChainDepState (ConsensusProtocol era)), IsCardanoEra era, IsShelleyBasedEra era, ADDRHASH ~ Blake2b_224, Era (ShelleyLedgerEra era), EraPParams (ShelleyLedgerEra era), EraScript (ShelleyLedgerEra era), EraTx (ShelleyLedgerEra era), EraTxBody (ShelleyLedgerEra era), EraTxCert (ShelleyLedgerEra era), EraTxOut (ShelleyLedgerEra era), EraUTxO (ShelleyLedgerEra era), EraTxWits (ShelleyLedgerEra era), HashAnnotated (TxBody TopTx (ShelleyLedgerEra era)) EraIndependentTxBody, EraCertState (ShelleyLedgerEra era), EraAccounts (ShelleyLedgerEra era), EraGov (ShelleyLedgerEra era), FromCBOR (ChainDepState (ConsensusProtocol era)), FromCBOR (TxCert (ShelleyLedgerEra era)), HasTypeProxy era, IsCardanoEra era, IsShelleyBasedEra era, ToJSON (ChainDepState (ConsensusProtocol era)), ToJSON (ApplyTxError (ShelleyLedgerEra era)), ToJSON (PredicateFailure (EraRule "LEDGER" (ShelleyLedgerEra era))), Typeable era, (era == ByronEra) ~ 'False)
#
datadata ShelleyEraOnly era where
#

Constructors

Instances6Eon, ToCardanoEra, Convert, Eq, Show
typetype ShelleyEraOnlyConstraints era = (HashAlgorithm HASH, Signable (VRF StandardCrypto) Seed, PraosProtocolSupportsNode (ConsensusProtocol era), ShelleyBlock (ConsensusProtocol era) (ShelleyLedgerEra era) ~ ConsensusBlockForEra era, ShelleyCompatible (ConsensusProtocol era) (ShelleyLedgerEra era), ADDRHASH ~ Blake2b_224, Era (ShelleyLedgerEra era), EraPParams (ShelleyLedgerEra era), EraTx (ShelleyLedgerEra era), EraTxBody (ShelleyLedgerEra era), EraTxOut (ShelleyLedgerEra era), ExactEra ShelleyEra (ShelleyLedgerEra era), ExactEra ShelleyEra (ShelleyLedgerEra era), HashAnnotated (TxBody TopTx (ShelleyLedgerEra era)) EraIndependentTxBody, ProtVerAtMost (ShelleyLedgerEra era) 2, ProtVerAtMost (ShelleyLedgerEra era) 6, ProtVerAtMost (ShelleyLedgerEra era) 8, ShelleyEraTxBody (ShelleyLedgerEra era), ShelleyEraTxCert (ShelleyLedgerEra era), TxCert (ShelleyLedgerEra era) ~ ShelleyTxCert (ShelleyLedgerEra era), Value (ShelleyLedgerEra era) ~ Coin, FromCBOR (ChainDepState (ConsensusProtocol era)), FromCBOR (DebugLedgerState era), IsCardanoEra era, IsShelleyBasedEra era, ToJSON (ChainDepState (ConsensusProtocol era)), ToJSON (DebugLedgerState era), Typeable era, (era == ByronEra) ~ 'False)
#
datadata ShelleyToBabbageEra era where
#

Constructors

Instances7Eon, ToCardanoEra, Convert, Eq, Ord, Show, …
typetype ShelleyToBabbageEraConstraints era = (HashAlgorithm HASH, Signable (VRF StandardCrypto) Seed, PraosProtocolSupportsNode (ConsensusProtocol era), ShelleyBlock (ConsensusProtocol era) (ShelleyLedgerEra era) ~ ConsensusBlockForEra era, ShelleyCompatible (ConsensusProtocol era) (ShelleyLedgerEra era), ADDRHASH ~ Blake2b_224, Era (ShelleyLedgerEra era), EraPParams (ShelleyLedgerEra era), EraTx (ShelleyLedgerEra era), EraTxBody (ShelleyLedgerEra era), EraTxOut (ShelleyLedgerEra era), HashAnnotated (TxBody TopTx (ShelleyLedgerEra era)) EraIndependentTxBody, ProtVerAtMost (ShelleyLedgerEra era) 8, ShelleyEraTxBody (ShelleyLedgerEra era), ShelleyEraTxCert (ShelleyLedgerEra era), TxCert (ShelleyLedgerEra era) ~ ShelleyTxCert (ShelleyLedgerEra era), FromCBOR (ChainDepState (ConsensusProtocol era)), FromCBOR (DebugLedgerState era), IsCardanoEra era, IsShelleyBasedEra era, ToJSON (ChainDepState (ConsensusProtocol era)), ToJSON (DebugLedgerState era), Typeable era, (era == ByronEra) ~ 'False)
#
datadata Featured (eon :: Type -> Type) era a where
#

Constructors

Instances3Functor, Eq, Show
  • Functor (Featured eon era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Era.Internal.Feature
  • (Eq a, Eq (eon era)) => Eq (Featured eon era a)Defined in cardano-api-11.7.0.0 · Cardano.Api.Era.Internal.Feature
  • (Show a, Show (eon era)) => Show (Featured eon era a)Defined in cardano-api-11.7.0.0 · Cardano.Api.Era.Internal.Feature
classclass Error e where
#

Methods

Instances55Error, …
datadata FileError e
#

Constructors

Instances4Functor, Eq, Show, Error
datadata GenesisParameters era
#

Constructors

datadata GovernanceAction era
#

Constructors

datadata Proposal era where
#

Constructors

Instances10TestEquality, Eq, Ord, Show, FromCBOR, ToCBOR, …
datadata Vote
#
NoYesAbstain
Instances2Eq, Show
  • Eq VoteDefined in cardano-api-11.7.0.0 · Cardano.Api.Governance.Internal.Action.VotingProcedure
  • Show VoteDefined in cardano-api-11.7.0.0 · Cardano.Api.Governance.Internal.Action.VotingProcedure
newtypenewtype VotingProcedure era
#

Constructors

Instances8Eq, Show, FromCBOR, ToCBOR, HasTypeProxy, SerialiseAsCBOR, …
newtypenewtype VotingProcedures era
#

Constructors

Instances10Eq, Show, Generic, FromCBOR, ToCBOR, HasTypeProxy, …
datadata CIP119
#
DrepRegistrationMetadata
Instances12Show, Generic, FromJSON, Rep, Authors, Body, …
datadata CIP108
#
BaseGovActionMetadata
Instances16Show, Generic, FromJSON, Rep, Authors, Body, …
data familydata family Authors cip
#
Instances6Show, Generic, FromJSON, Rep, Authors
data familydata family Body cip
#
Instances10Show, Generic, FromJSON, Rep, Body, …
data familydata family HashAlgorithm cip
#
Instances10Show, Generic, FromJSON, Rep, HashAlgorithm, …
  • Show (HashAlgorithm CIP119)Defined in cardano-api-11.7.0.0 · Cardano.Api.Governance.Internal.Metadata.DrepRegistration
  • Show (HashAlgorithm CIP108)Defined in cardano-api-11.7.0.0 · Cardano.Api.Governance.Internal.Metadata.GovAction
  • Generic (HashAlgorithm CIP119)Defined in cardano-api-11.7.0.0 · Cardano.Api.Governance.Internal.Metadata.DrepRegistration
  • Generic (HashAlgorithm CIP108)Defined in cardano-api-11.7.0.0 · Cardano.Api.Governance.Internal.Metadata.GovAction
  • FromJSON (HashAlgorithm CIP119)Defined in cardano-api-11.7.0.0 · Cardano.Api.Governance.Internal.Metadata.DrepRegistration
  • FromJSON (HashAlgorithm CIP108)Defined in cardano-api-11.7.0.0 · Cardano.Api.Governance.Internal.Metadata.GovAction
  • type Rep (HashAlgorithm CIP119) = D1 ('MetaData "HashAlgorithm" "Cardano.Api.Governance.Internal.Metadata.DrepRegistration" "cardano-api-11.7.0.0-DnHzvZIL7yK6Z1zD9Frgyp" 'False) (C1 ('MetaCons "Blake2b256" 'PrefixI 'False) U1)Defined in cardano-api-11.7.0.0 · Cardano.Api.Governance.Internal.Metadata.DrepRegistration
  • type Rep (HashAlgorithm CIP108) = D1 ('MetaData "HashAlgorithm" "Cardano.Api.Governance.Internal.Metadata.GovAction" "cardano-api-11.7.0.0-DnHzvZIL7yK6Z1zD9Frgyp" 'False) (C1 ('MetaCons "Blake2b256" 'PrefixI 'False) U1)Defined in cardano-api-11.7.0.0 · Cardano.Api.Governance.Internal.Metadata.GovAction
  • data HashAlgorithm CIP119
    • Blake2b256
    Defined in cardano-api-11.7.0.0 · Cardano.Api.Governance.Internal.Metadata.DrepRegistration
  • data HashAlgorithm CIP108
    • Blake2b256
    Defined in cardano-api-11.7.0.0 · Cardano.Api.Governance.Internal.Metadata.GovAction
datadata GovernancePoll
#

Constructors

Instances13HasTypeProxy, SerialiseAsCBOR, HasTextEnvelope, AsTxMetadata, Eq, Ord, …
datadata GovernancePollAnswer
#

Constructors

Instances6Eq, Show, HasTypeProxy, SerialiseAsCBOR, AsTxMetadata, AsType
familydata family AsType t
#
Instances101Show, AsType, …
classclass Typeable t => HasTypeProxy t where
#

Associated types

Methods

Instances100HasTypeProxy, …
data familydata family Hash keyrole
#
Instances247Eq, Ord, Show, Pretty, FromJSON, FromJSONKey, …
newtypenewtype File content (direction :: FileDirection)
#

Constructors

Instances7Eq, Ord, Read, Show, IsString, FromJSON, …
  • Eq (File content direction)Defined in cardano-api-11.7.0.0 · Cardano.Api.IO.Internal.Base
  • Ord (File content direction)Defined in cardano-api-11.7.0.0 · Cardano.Api.IO.Internal.Base
  • Read (File content direction)Defined in cardano-api-11.7.0.0 · Cardano.Api.IO.Internal.Base
  • Show (File content direction)Defined in cardano-api-11.7.0.0 · Cardano.Api.IO.Internal.Base
  • IsString (File content direction)Defined in cardano-api-11.7.0.0 · Cardano.Api.IO.Internal.Base
  • FromJSON (File content direction)Defined in cardano-api-11.7.0.0 · Cardano.Api.IO.Internal.Base
  • ToJSON (File content direction)Defined in cardano-api-11.7.0.0 · Cardano.Api.IO.Internal.Base
datadata CommitteeColdExtendedKey
#
Instances33HasTypeProxy, Key, SigningKeyFromRootKey, CastVerificationKeyRole, Eq, Ord, …
datadata CommitteeColdKey
#
Instances34HasTypeProxy, Key, CastVerificationKeyRole, Eq, Ord, Show, …
datadata CommitteeHotExtendedKey
#
Instances33HasTypeProxy, Key, SigningKeyFromRootKey, CastVerificationKeyRole, Eq, Ord, …
datadata CommitteeHotKey
#
Instances34HasTypeProxy, Key, CastVerificationKeyRole, Eq, Ord, Show, …
datadata DRepExtendedKey
#
Instances33HasTypeProxy, Key, SigningKeyFromRootKey, CastVerificationKeyRole, Eq, Ord, …
datadata DRepKey
#
Instances36HasTypeProxy, Key, CastVerificationKeyRole, Eq, Ord, Show, …
datadata GenesisDelegateExtendedKey
#
Instances30HasTypeProxy, Key, CastVerificationKeyRole, Eq, Ord, Show, …
datadata GenesisDelegateKey
#
Instances32HasTypeProxy, Key, CastSigningKeyRole, CastVerificationKeyRole, Eq, Ord, …
datadata GenesisExtendedKey
#
Instances30HasTypeProxy, Key, CastVerificationKeyRole, Eq, Ord, Show, …
datadata GenesisKey
#
Instances34HasTypeProxy, Key, CastVerificationKeyRole, Eq, Ord, Show, …
datadata GenesisUTxOKey
#
Instances31HasTypeProxy, Key, CastSigningKeyRole, CastVerificationKeyRole, Eq, Ord, …
datadata PaymentExtendedKey
#
Instances34HasTypeProxy, Key, IndexedSigningKeyFromRootKey, CastVerificationKeyRole, Eq, Ord, …
datadata PaymentKey
#
Instances41HasTypeProxy, Key, CastSigningKeyRole, CastVerificationKeyRole, Eq, Ord, …
datadata StakeExtendedKey
#
Instances33HasTypeProxy, Key, IndexedSigningKeyFromRootKey, CastVerificationKeyRole, Eq, Ord, …
datadata StakeKey
#
Instances33HasTypeProxy, Key, CastVerificationKeyRole, Eq, Ord, Show, …
datadata StakePoolExtendedKey
#
Instances32HasTypeProxy, Key, CastVerificationKeyRole, Eq, Ord, Show, …
datadata StakePoolKey
#
Instances39HasTypeProxy, Key, CastSigningKeyRole, CastVerificationKeyRole, Eq, Ord, …
classclass CastVerificationKeyRole keyroleA keyroleB where
#

Methods

Instances17CastVerificationKeyRole, …
classclass (Eq (VerificationKey keyrole), Show (VerificationKey keyrole), SerialiseAsRawBytes (Hash keyrole), HasTextEnvelope (VerificationKey keyrole), HasTextEnvelope (SigningKey keyrole)) => Key keyrole where
#

Associated types

Methods

Instances22Key, …
familydata family SigningKey keyrole
#
Instances193Show, Pretty, FromCBOR, ToCBOR, HasTypeProxy, SerialiseAsBech32, …
familydata family VerificationKey keyrole
#
Instances215Eq, Show, Pretty, FromCBOR, ToCBOR, HasTypeProxy, …
datadata BlsKey
#
Instances31HasTypeProxy, Key, Eq, Ord, Show, Pretty, …
newtypenewtype BlsPossessionProof
#
Instances10Eq, Show, Pretty, FromCBOR, ToCBOR, HasTypeProxy, …
datadata KesKey
#
Instances31HasTypeProxy, Key, Eq, Ord, Show, Pretty, …
datadata VrfKey
#
Instances31HasTypeProxy, Key, Eq, Ord, Show, Pretty, …
datadata SomeAddressVerificationKey
#

Constructors

Instances1Show
datadata ConditionResult
#
ConditionNotMetConditionMet
Instances6Bounded, Enum, Eq, Ord, Read, Show
datadata LeadershipError
#

Constructors

Instances2Show, Error
datadata LedgerStateError
#

Constructors

Instances3Show, Exception, Error
datadata NodeConfig
#

Constructors

Instances1FromJSON
datadata LedgerEvent
#

Constructors

Instances1Show
  • Show LedgerEventDefined in cardano-api-11.7.0.0 · Cardano.Api.LedgerState.Internal.LedgerEvent
datadata LocalNodeClientParams where
#

Constructors

newtypenewtype LocalStateQueryExpr block point (query :: Type -> Type) r (m :: Type -> Type) a
#
Instances5MonadReader, Monad, Functor, Applicative, MonadIO
datadata AnyPlutusScriptVersion where
#

Constructors

Instances12Bounded, Enum, Eq, Ord, Show, Pretty, …
datadata AnyScriptLanguage where
#

Constructors

Instances5Bounded, Enum, Eq, Ord, Show
datadata ExecutionUnits
#

Constructors

Instances6Eq, Show, FromJSON, ToJSON, FromCBOR, ToCBOR
classclass HasScriptLanguageInEra lang era where
#

Methods

Instances6HasScriptLanguageInEra
classclass IsScriptLanguage lang => IsPlutusScriptLanguage lang where
#

Methods

Instances4IsPlutusScriptLanguage
classclass HasTypeProxy lang => IsScriptLanguage lang where
#

Methods

Instances5IsScriptLanguage
datadata PlutusScript lang where
#

Constructors

Instances8Eq, Ord, Show, HasTypeProxy, SerialiseAsCBOR, SerialiseAsRawBytes, …
datadata PlutusScriptInEra era lang where
#

Constructors

Instances5Eq, Show, HasTypeProxy, SerialiseAsCBOR, AsType
datadata PlutusScriptV1
#
Instances9HasTypeProxy, IsPlutusScriptLanguage, IsScriptLanguage, HasScriptLanguageInEra, ToAlonzoScript, AsType, …
datadata PlutusScriptV2
#
Instances8HasTypeProxy, IsPlutusScriptLanguage, IsScriptLanguage, HasScriptLanguageInEra, ToAlonzoScript, AsType, …
datadata PlutusScriptV3
#
Instances6HasTypeProxy, IsPlutusScriptLanguage, IsScriptLanguage, HasScriptLanguageInEra, ToAlonzoScript, AsType
datadata PlutusScriptV4
#
Instances4HasTypeProxy, IsPlutusScriptLanguage, IsScriptLanguage, AsType
datadata PlutusScriptVersion lang where
#

Constructors

Instances3TestEquality, Eq, Show
datadata ReferenceScript era where
#

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata Script lang where
#

Constructors

Instances6Eq, Show, HasTypeProxy, SerialiseAsCBOR, HasTextEnvelope, AsType
newtypenewtype ScriptHash
#

Constructors

Instances9Eq, Ord, Show, Pretty, FromJSON, ToJSON, …
datadata ScriptInAnyLang where
#

Constructors

Instances6Eq, Show, FromJSON, ToJSON, HasTypeProxy, AsType
datadata ScriptInEra era where
#

Constructors

Instances4Eq, Show, HasTypeProxy, AsType
datadata ScriptLanguage lang where
#

Constructors

Instances3TestEquality, Eq, Show
datadata ScriptLanguageInEra lang era where
#

Constructors

Instances4Eq, Ord, Show, ToJSON
datadata ScriptWitness witctx era where
#

Constructors

Instances2Eq, Show
  • Eq (ScriptWitness witctx era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Plutus.Internal.Script
  • Show (ScriptWitness witctx era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Plutus.Internal.Script
datadata SimpleScript
#

Constructors

Instances4Eq, Show, FromJSON, ToJSON
  • Eq SimpleScriptDefined in cardano-api-11.7.0.0 · Cardano.Api.Plutus.Internal.Script
  • Show SimpleScriptDefined in cardano-api-11.7.0.0 · Cardano.Api.Plutus.Internal.Script
  • FromJSON SimpleScriptDefined in cardano-api-11.7.0.0 · Cardano.Api.Plutus.Internal.Script
  • ToJSON SimpleScriptDefined in cardano-api-11.7.0.0 · Cardano.Api.Plutus.Internal.Script
classclass ToAlonzoScript lang era where
#

Methods

Instances5ToAlonzoScript
datadata HashableScriptData
#

Constructors

Instances6Eq, Ord, Show, HasTypeProxy, SerialiseAsCBOR, AsType
datadata ScriptData
#

Constructors

Instances18FromCBOR, ToCBOR, HasTypeProxy, SerialiseAsCBOR, Eq, Ord, …
datadata ScriptDataJsonError
#

Constructors

Instances4Eq, Data, Show, Error
datadata ScriptDataJsonSchemaError
#

Constructors

Instances4Eq, Data, Show, Error
newtypenewtype ScriptDataRangeError
#

Constructors

Instances4Eq, Data, Show, Error
newtypenewtype ShowOf a
#

Constructors

Instances4Show, Pretty, ToJSON, ToJSONKey
  • Show a => Show (ShowOf a)Defined in cardano-api-11.7.0.0 · Cardano.Api.Pretty.Internal.ShowOf
  • Show a => Pretty (ShowOf a)Defined in cardano-api-11.7.0.0 · Cardano.Api.Pretty.Internal.ShowOf
  • Show a => ToJSON (ShowOf a)Defined in cardano-api-11.7.0.0 · Cardano.Api.Pretty.Internal.ShowOf
  • Show a => ToJSONKey (ShowOf a)Defined in cardano-api-11.7.0.0 · Cardano.Api.Pretty.Internal.ShowOf
datadata AlonzoOnwardsPParams ledgerera
#

Constructors

Instances2Eq, Show
datadata CommonProtocolParametersUpdate
#

Constructors

Instances2Eq, Show
newtypenewtype CostModel
#

Constructors

Instances5Eq, Data, Show, FromCBOR, ToCBOR
  • Eq CostModelDefined in cardano-api-11.7.0.0 · Cardano.Api.ProtocolParameters
  • Data CostModelDefined in cardano-api-11.7.0.0 · Cardano.Api.ProtocolParameters
  • Show CostModelDefined in cardano-api-11.7.0.0 · Cardano.Api.ProtocolParameters
  • FromCBOR CostModelDefined in cardano-api-11.7.0.0 · Cardano.Api.ProtocolParameters
  • ToCBOR CostModelDefined in cardano-api-11.7.0.0 · Cardano.Api.ProtocolParameters
datadata EraBasedProtocolParametersUpdate era where
#

Constructors

Instances4Eq, Show, FromCBOR, ToCBOR
datadata ExecutionUnitPrices
#

Constructors

Instances6Eq, Show, FromJSON, ToJSON, FromCBOR, ToCBOR
datadata IntroducedInConwayPParams era
#

Constructors

Instances2Eq, Show
datadata IntroducedInDijkstraPParams era
#

Constructors

Instances2Eq, Show
newtypenewtype PraosNonce
#
Instances13Eq, Ord, Show, Generic, Pretty, FromJSON, …
datadata ProtocolParametersConversionError
#

Constructors

Instances4Eq, Data, Show, Error
datadata UpdateProposal era
#

Constructors

Instances8Eq, Show, FromCBOR, ToCBOR, HasTypeProxy, SerialiseAsCBOR, …
newtypenewtype DelegationsAndRewards
#

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata EraHistory where
#

Constructors

Instances4HasTypeProxy, SerialiseAsCBOR, HasTextEnvelope, AsType
datadata QueryInMode result where
#

Constructors

Instances1Show
  • Show (QueryInMode result)Defined in cardano-api-11.7.0.0 · Cardano.Api.Query.Internal.Type.QueryInMode
datadata QueryInShelleyBasedEra era result where
#

Constructors

Instances1Show
datadata Bech32DecodeError
#

Constructors

Instances4Eq, Data, Show, Error
classclass (HasTypeProxy a, SerialiseAsRawBytes a) => SerialiseAsBech32 a where
#

Methods

Instances37SerialiseAsBech32, …
classclass HasTypeProxy a => SerialiseAsCBOR a where
#

Methods

Instances89SerialiseAsCBOR, …
classclass (SerialiseAsRawBytes a, HasTypeProxy a) => Cip129 a where
#

Associated types

Methods

Instances4Cip129
familydata family Cip129Header a
#
Instances4Cip129Header
datadata InputDecodeError
#

Constructors

Instances4Eq, Data, Show, Error
classclass (HasTypeProxy a, Typeable a) => SerialiseAsRawBytes a where
#

Methods

Instances99SerialiseAsRawBytes, …
newtypenewtype UsingBech32 a
#

Constructors

Instances6Show, Pretty, FromJSON, FromJSONKey, ToJSON, ToJSONKey
newtypenewtype UsingRawBytesHex a
#

Constructors

Instances6Show, Pretty, FromJSON, FromJSONKey, ToJSON, ToJSONKey
classclass SerialiseAsCBOR a => HasTextEnvelope a where
#

Methods

Instances60HasTextEnvelope, …
datadata TextEnvelope
#

Constructors

Instances6Eq, Show, FromJSON, ToJSON, HasTypeProxy, AsType
newtypenewtype TextEnvelopeDescr
#

Constructors

Instances7Eq, Data, Show, IsString, Semigroup, FromJSON, …
datadata TextEnvelopeError
#

Constructors

Instances4Eq, Data, Show, Error
newtypenewtype TextEnvelopeType
#

Constructors

Instances7Eq, Data, Show, IsString, Semigroup, FromJSON, …
datadata TextEnvelopeCddlError
#

Constructors

Instances4Eq, Data, Show, Error
datadata ScriptWitnessIndex
#

Constructors

Instances4Eq, Ord, Show, ToJSON
datadata TxBodyContent build era
#

Deprecated. Use TxBodyContent from Cardano.Api.Experimental.Tx instead.

Constructors

Instances2Eq, Show
datadata TxBodyError
#

Constructors

Instances3Eq, Show, Error
  • Eq TxBodyErrorDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.Body
  • Show TxBodyErrorDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.Body
  • Error TxBodyErrorDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.Body
datadata TxMintValue build era where
#

Constructors

Instances4Eq, Show, Semigroup, Monoid
  • Eq (TxMintValue build era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.Body
  • Show (TxMintValue build era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.Body
  • Semigroup (TxMintValue build era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.Body
  • Monoid (TxMintValue build era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.Body
datadata TxProposalProcedures build era where
#

Constructors

Instances2Eq, Show
datadata BuildTxWith build a where
#

Constructors

Instances7Functor, Applicative, Eq, Show, Semigroup, Monoid, …
datadata ResolvablePointers where
#

Constructors

Instances1Show
datadata ScriptExecutionError
#

Constructors

Instances2Show, Error
datadata TxBodyErrorAutoBalance era
#

Constructors

Instances2Show, Error
datadata TxFeeEstimationError era
#

Constructors

Instances2Show, Error
datadata TxOut ctx era
#

Constructors

Instances8Eq, Show, FromJSON, ToJSON, FromCBOR, HasTypeProxy, …
datadata TxOutDatum ctx era where
#

Constructors

Instances2Eq, Show
  • Eq (TxOutDatum ctx era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.Output
  • Show (TxOutDatum ctx era)Defined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.Output
datadata TxOutValue era where
#

Constructors

Instances4Eq, Show, FromJSON, ToJSON
datadata KeyWitness era where
#

Constructors

Instances6Eq, Show, HasTypeProxy, SerialiseAsCBOR, HasTextEnvelope, AsType
datadata ShelleyWitnessSigningKey
#

Constructors

datadata Tx era where
#

Constructors

Instances10Eq, Show, HasTypeProxy, SerialiseAsCBOR, HasTextEnvelope, AsType, …
datadata TxBody era where
#

Deprecated. Use UnsignedTx from Cardano.Api.Experimental instead.

Constructors

Instances6Eq, Show, HasTypeProxy, SerialiseAsCBOR, HasTextEnvelope, AsType
newtypenewtype TxId
#

Constructors

Instances11Eq, Ord, Show, Pretty, FromJSON, FromJSONKey, …
  • Eq TxIdDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • Ord TxIdDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • Show TxIdDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • Pretty TxIdDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • FromJSON TxIdDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • FromJSONKey TxIdDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • ToJSON TxIdDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • ToJSONKey TxIdDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • HasTypeProxy TxIdDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • SerialiseAsRawBytes TxIdDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • data AsType TxIdDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
datadata TxIn
#

Constructors

Instances8Eq, Ord, Show, Pretty, FromJSON, FromJSONKey, …
  • Eq TxInDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • Ord TxInDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • Show TxInDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • Pretty TxInDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • FromJSON TxInDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • FromJSONKey TxInDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • ToJSON TxInDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • ToJSONKey TxInDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
newtypenewtype TxIx
#

Constructors

Instances7Enum, Eq, Ord, Show, Pretty, FromJSON, …
  • Enum TxIxDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • Eq TxIxDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • Ord TxIxDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • Show TxIxDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • Pretty TxIxDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • FromJSON TxIxDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
  • ToJSON TxIxDefined in cardano-api-11.7.0.0 · Cardano.Api.Tx.Internal.TxIn
newtypenewtype TxMetadata
#

Constructors

Instances7Eq, Show, Semigroup, Monoid, HasTypeProxy, SerialiseAsCBOR, …
datadata TxMetadataJsonError
#

Constructors

Instances4Eq, Data, Show, Error
datadata TxMetadataJsonSchemaError
#

Constructors

Instances4Eq, Data, Show, Error
datadata TxMetadataRangeError
#

Constructors

Instances4Eq, Data, Show, Error
datadata TxMetadataValue
#

Constructors

Instances4Eq, Data, Ord, Show
newtypenewtype UTxO era
#

Constructors

Instances12IsList, Eq, Show, Semigroup, Monoid, FromJSON, …
newtypenewtype AssetName
#

Constructors

Instances10Eq, Ord, Show, FromJSON, FromJSONKey, ToJSON, …
newtypenewtype PolicyAssets
#

Constructors

Instances8IsList, Eq, Show, Semigroup, Monoid, MonoFunctor, …
newtypenewtype PolicyId
#

Constructors

Instances8Eq, Ord, Show, FromJSON, ToJSON, HasTypeProxy, …
newtypenewtype Quantity
#

Constructors

Instances9Eq, Data, Num, Ord, Show, Semigroup, …
  • Eq QuantityDefined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
  • Data QuantityDefined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
  • Num QuantityDefined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
  • Ord QuantityDefined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
  • Show QuantityDefined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
  • Semigroup QuantityDefined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
  • Monoid QuantityDefined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
  • FromJSON QuantityDefined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
  • ToJSON QuantityDefined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
newtypenewtype Value
#
Instances8IsList, Eq, Show, Semigroup, Monoid, FromJSON, …
  • IsList ValueDefined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
  • Eq ValueDefined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
  • Show ValueDefined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
  • Semigroup ValueDefined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
  • Monoid ValueDefined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
  • FromJSON ValueDefined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
  • ToJSON ValueDefined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
  • type Item Value = (AssetId, Quantity)Defined in cardano-api-11.7.0.0 · Cardano.Api.Value.Internal
newtypenewtype ValueNestedRep
#

Constructors

Instances5Eq, Ord, Show, FromJSON, ToJSON
datadata DecoderError
#

Constructors

Instances8Eq, Data, Show, Exception, NFData, Buildable, …
classclass Typeable a => FromCBOR a where
#

Methods

Instances377FromCBOR, …
classclass Typeable a => ToCBOR a where
#

Methods

Instances413ToCBOR, …
datadata CommitteeMembersState
#

Constructors

Instances9Eq, Ord, Show, Generic, ToJSON, DecCBOR, …
datadata MemberStatus
#
ActiveExpiredUnrecognized
Instances10Bounded, Enum, Eq, Ord, Show, Generic, …
newtypenewtype EpochSlots
#

Constructors

Instances13Eq, Data, Ord, Read, Show, Generic, …
datadata ATxAux a
#

Constructors

Instances16Functor, Buildable, ToCBOR, EncCBOR, Eq, Show, …
classclass Inject t s where
#

Methods

Instances13Inject, …
newtypenewtype Coin
#

Constructors

Instances56Enum, Integral, Num, Real, Bits, Pretty, …
datadata ShelleyGenesis
#

Constructors

Instances13Eq, Show, Generic, NFData, FromJSON, ToJSON, …
datadata ShelleyGenesisStaking
#

Constructors

Instances13Eq, Show, Generic, Semigroup, Monoid, NFData, …
datadata StandardCrypto
#

The same crypto used on the net

Instances15Crypto, PraosCrypto, Protocol, FromCBOR, ToCBOR, ConvertLedgerEvent, …
newtypenewtype BlockNo
#

Constructors

Instances18Bounded, Enum, Eq, Num, Ord, Show, …
newtypenewtype EpochNo
#

Constructors

Instances16Enum, Eq, Ord, Show, Generic, NFData, …
newtypenewtype EpochSize
#

Constructors

Instances14Enum, Eq, Ord, Show, Generic, NFData, …
newtypenewtype SlotNo
#

Constructors

Instances21Bounded, Enum, Eq, Num, Ord, Show, …
newtypenewtype SystemStart
#

Constructors

Instances12Eq, Show, Generic, FromJSON, ToJSON, Serialise, …
classclass Monad m => MonadIO (m :: Type -> Type) where
#

Monads in which IO computations may be embedded. Any monad built by applying a sequence of monad transformers to the IO monad will be an instance of this class.

Instances should satisfy the following laws, which state that liftIO is a transformer of monads:

Methods

  • liftIO :: IO a -> m a

    Lift a computation from the IO monad. This allows us to run IO computations in any monadic stack, so long as it supports these kinds of operations (i.e. IO is the base monad for the stack).

    Example
    import Control.Monad.Trans.State -- from the "transformers" library

printState :: Show s => StateT s IO ()
printState = do
  state <- get
  liftIO $ print state

    Had we omitted liftIO, we would have ended up with this error:

    • Couldn't match type ‘IO’ with ‘StateT s IO’
 Expected type: StateT s IO ()
   Actual type: IO ()

    The important part here is the mismatch between StateT s IO () and IO ().

    Luckily, we know of a function that takes an IO a and returns an (m a): liftIO, enabling us to run the program and see the expected results:

    > evalStateT printState "hello"
"hello"

> evalStateT printState 3
3
Instances71Lifting, MonadIO, …
datadata Proxy (t :: k)
#

Proxy is a type that holds no data, but has a phantom parameter of arbitrary type (or even kind). Its use is to provide type information, even though there is no value available of that type (or it may be too costly to create one).

Historically, Proxy :: Proxy a is a safer alternative to the undefined :: a idiom.

Example1 expression
Proxy :: Proxy (Void, Int -> Int)Proxy

Proxy can even hold types of higher kinds,

Example1 expression
Proxy :: Proxy EitherProxy
Example1 expression
Proxy :: Proxy FunctorProxy
Example1 expression
Proxy :: Proxy complicatedStructureProxy
Proxy
Instances97Generic1, FoldableWithIndex, FunctorWithIndex, TraversableWithIndex, RepeatWithIndex, SemialignWithIndex, …
  • Generic1 ProxyDefined in ghc-internal-9.1401.0 · GHC.Internal.Generics
  • FoldableWithIndex Void ProxyDefined in indexed-traversable-0.1.5 · WithIndex
  • FunctorWithIndex Void ProxyDefined in indexed-traversable-0.1.5 · WithIndex
  • TraversableWithIndex Void ProxyDefined in indexed-traversable-0.1.5 · WithIndex
  • RepeatWithIndex Void ProxyDefined in semialign-1.4 · Data.Semialign.Internal
  • SemialignWithIndex Void ProxyDefined in semialign-1.4 · Data.Semialign.Internal
  • ZipWithIndex Void ProxyDefined in semialign-1.4 · Data.Semialign.Internal
  • FilterableWithIndex Void ProxyDefined in witherable-0.5 · Witherable
  • WitherableWithIndex Void ProxyDefined in witherable-0.5 · Witherable
  • ApplicativeB ProxyDefined in barbies-2.1.1.0 · Barbies.Internal.ApplicativeB
  • ConstraintsB ProxyDefined in barbies-2.1.1.0 · Barbies.Internal.ConstraintsB
  • DistributiveB ProxyDefined in barbies-2.1.1.0 · Barbies.Internal.DistributiveB
  • FunctorB ProxyDefined in barbies-2.1.1.0 · Barbies.Internal.FunctorB
  • TraversableB ProxyDefined in barbies-2.1.1.0 · Barbies.Internal.TraversableB
  • EqP ProxyDefined in some-1.0.6 · Data.EqP
  • OrdP ProxyDefined in some-1.0.6 · Data.OrdP
  • Monad ProxyDefined in ghc-internal-9.1401.0 · GHC.Internal.Data.Proxy
  • Functor ProxyDefined in ghc-internal-9.1401.0 · GHC.Internal.Data.Proxy
  • Applicative ProxyDefined in ghc-internal-9.1401.0 · GHC.Internal.Data.Proxy
  • Foldable ProxyDefined in ghc-internal-9.1401.0 · GHC.Internal.Data.Foldable
  • Traversable ProxyDefined in ghc-internal-9.1401.0 · GHC.Internal.Data.Traversable
  • Alternative ProxyDefined in ghc-internal-9.1401.0 · GHC.Internal.Data.Proxy
  • MonadPlus ProxyDefined in ghc-internal-9.1401.0 · GHC.Internal.Data.Proxy
  • MonadZip ProxyDefined in ghc-internal-9.1401.0 · GHC.Internal.Control.Monad.Zip
  • Eq1 ProxyDefined in base-4.22.0.0 · Data.Functor.Classes
  • Ord1 ProxyDefined in base-4.22.0.0 · Data.Functor.Classes
  • Read1 ProxyDefined in base-4.22.0.0 · Data.Functor.Classes
  • Show1 ProxyDefined in base-4.22.0.0 · Data.Functor.Classes
  • Contravariant ProxyDefined in base-4.22.0.0 · Data.Functor.Contravariant
  • NFData1 ProxyDefined in deepseq-1.5.1.0 · Control.DeepSeq
  • Arbitrary1 ProxyDefined in quickcheck-instances-0.4 · Test.QuickCheck.Instances.Tagged · orphan
  • Hashable1 ProxyDefined in hashable-1.5.1.0 · Data.Hashable.Class
  • Distributive ProxyDefined in distributive-0.6.3 · Data.Distributive
  • Decidable ProxyDefined in contravariant-1.5.6 · Data.Functor.Contravariant.Divisible
  • Divisible ProxyDefined in contravariant-1.5.6 · Data.Functor.Contravariant.Divisible
  • Alt ProxyDefined in semigroupoids-6.0.2 · Data.Functor.Alt
  • Apply ProxyDefined in semigroupoids-6.0.2 · Data.Functor.Bind.Class
  • Bind ProxyDefined in semigroupoids-6.0.2 · Data.Functor.Bind.Class
  • Extend ProxyDefined in semigroupoids-6.0.2 · Data.Functor.Extend
  • Conclude ProxyDefined in semigroupoids-6.0.2 · Data.Functor.Contravariant.Conclude
  • Decide ProxyDefined in semigroupoids-6.0.2 · Data.Functor.Contravariant.Decide
  • Divise ProxyDefined in semigroupoids-6.0.2 · Data.Functor.Contravariant.Divise
  • Plus ProxyDefined in semigroupoids-6.0.2 · Data.Functor.Plus
  • Representable ProxyDefined in adjunctions-4.4.4 · Data.Functor.Rep
  • Representable ProxyDefined in adjunctions-4.4.4 · Data.Functor.Contravariant.Rep
  • Align ProxyDefined in semialign-1.4 · Data.Semialign.Internal
  • Semialign ProxyDefined in semialign-1.4 · Data.Semialign.Internal
  • Unalign ProxyDefined in semialign-1.4 · Data.Semialign.Internal
  • Repeat ProxyDefined in semialign-1.4 · Data.Semialign.Internal
  • Unzip ProxyDefined in semialign-1.4 · Data.Semialign.Internal
  • Zip ProxyDefined in semialign-1.4 · Data.Semialign.Internal
  • Filterable ProxyDefined in witherable-0.5 · Witherable
  • Witherable ProxyDefined in witherable-0.5 · Witherable
  • FromJSON1 ProxyDefined in aeson-2.2.5.1 · Data.Aeson.Types.FromJSON
  • ToJSON1 ProxyDefined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
  • Invariant ProxyDefined in invariant-0.6.5 · Data.Functor.Invariant

    from Data.Proxy

  • CollectScopeInfo ProxyDefined in plutus-core-1.70.0.0 · PlutusCore.Check.Scoping
  • EstablishScoping ProxyDefined in plutus-core-1.70.0.0 · PlutusCore.Check.Scoping
  • Selective ProxyDefined in selective-0.7.0.1 · Control.Selective
  • Cosieve Tagged ProxyDefined in profunctors-5.6.3 · Data.Profunctor.Sieve
  • Bounded (Proxy t)Defined in ghc-internal-9.1401.0 · GHC.Internal.Data.Proxy
  • Enum (Proxy s)Defined in ghc-internal-9.1401.0 · GHC.Internal.Data.Proxy
  • Eq (Proxy s)Defined in ghc-internal-9.1401.0 · GHC.Internal.Data.Proxy
  • Data t => Data (Proxy t)Defined in ghc-internal-9.1401.0 · GHC.Internal.Data.Data
  • Ord (Proxy s)Defined in ghc-internal-9.1401.0 · GHC.Internal.Data.Proxy
  • Read (Proxy t)Defined in ghc-internal-9.1401.0 · GHC.Internal.Data.Proxy
  • Show (Proxy s)Defined in ghc-internal-9.1401.0 · GHC.Internal.Data.Proxy
  • Ix (Proxy s)Defined in ghc-internal-9.1401.0 · GHC.Internal.Data.Proxy
  • Generic (Proxy t)Defined in ghc-internal-9.1401.0 · GHC.Internal.Generics
  • Semigroup (Proxy s)Defined in ghc-internal-9.1401.0 · GHC.Internal.Data.Proxy
  • Monoid (Proxy s)Defined in ghc-internal-9.1401.0 · GHC.Internal.Data.Proxy
  • NFData (Proxy a)Defined in deepseq-1.5.1.0 · Control.DeepSeq
  • Arbitrary (Proxy a)Defined in quickcheck-instances-0.4 · Test.QuickCheck.Instances.Tagged · orphan
  • CoArbitrary (Proxy a)Defined in quickcheck-instances-0.4 · Test.QuickCheck.Instances.Tagged · orphan
  • Function (Proxy a)Defined in quickcheck-instances-0.4 · Test.QuickCheck.Instances.Tagged · orphan
  • Hashable (Proxy a)Defined in hashable-1.5.1.0 · Data.Hashable.Class
  • FromJSON (Proxy a)Defined in aeson-2.2.5.1 · Data.Aeson.Types.FromJSON
  • ToJSON (Proxy a)Defined in aeson-2.2.5.1 · Data.Aeson.Types.ToJSON
  • Default (Proxy a)Defined in data-default-0.8.0.2 · Data.Default.Internal
  • Serialise (Proxy a)Defined in serialise-0.2.6.1 · Codec.Serialise.Class
  • Boring (Proxy a)Defined in boring-0.2.2.1 · Data.Boring
  • Finite (Proxy a)Defined in universe-base-1.1.4 · Data.Universe.Class
  • Universe (Proxy a)Defined in universe-base-1.1.4 · Data.Universe.Class
  • MonoFoldable (Proxy a)Defined in mono-traversable-1.0.21.0 · Data.MonoTraversable
  • MonoFunctor (Proxy a)Defined in mono-traversable-1.0.21.0 · Data.MonoTraversable
  • MonoTraversable (Proxy a)Defined in mono-traversable-1.0.21.0 · Data.MonoTraversable
  • MonoPointed (Proxy a)Defined in mono-traversable-1.0.21.0 · Data.MonoTraversable
  • ToExpr (Proxy a)Defined in tree-diff-0.4.1 · Data.TreeDiff.Class
  • Abelian (Proxy x)Defined in groups-0.5.3 · Data.Group
  • Cyclic (Proxy x)Defined in groups-0.5.3 · Data.Group
  • Group (Proxy x)Defined in groups-0.5.3 · Data.Group

    Trivial group, Functor style.

  • type Rep (Proxy t) = D1 ('MetaData "Proxy" "GHC.Internal.Data.Proxy" "ghc-internal" 'False) (C1 ('MetaCons "Proxy" 'PrefixI 'False) U1)Defined in ghc-internal-9.1401.0 · GHC.Internal.Generics
  • type Rep1 Proxy = D1 ('MetaData "Proxy" "GHC.Internal.Data.Proxy" "ghc-internal" 'False) (C1 ('MetaCons "Proxy" 'PrefixI 'False) U1)Defined in ghc-internal-9.1401.0 · GHC.Internal.Generics
  • type Rep Proxy = VoidDefined in adjunctions-4.4.4 · Data.Functor.Rep
  • type Rep Proxy = ()Defined in adjunctions-4.4.4 · Data.Functor.Contravariant.Rep
  • type AllB c Proxy = ()Defined in barbies-2.1.1.0 · Barbies.Internal.ConstraintsB
  • type Element (Proxy a) = aDefined in mono-traversable-1.0.21.0 · Data.MonoTraversable
classclass Monad m => MonadError e (m :: Type -> Type) | m -> e where
#

The strategy of combining computations that can throw exceptions by bypassing bound functions from the point an exception is thrown to the point that it is handled.

Is parameterized over the type of error information and the monad type constructor. It is common to use Either String as the monad type constructor for an error monad in which error descriptions take the form of strings. In that case and many other common cases the resulting monad is already defined as an instance of the MonadError class. You can also define your own error type and/or use a monad type constructor other than Either String or Either IOError. In these cases you will have to explicitly define instances of the MonadError class. (If you are using the deprecated Control.Monad.Error or Control.Monad.Trans.Error, you may also have to define an Error instance.)

Methods

  • throwError :: e -> m a

    Is used within a monadic computation to begin exception processing.

  • catchError :: m a -> (e -> m a) -> m a

    A handler function to handle previous errors and return to normal execution. A common idiom is:

    do { action1; action2; action3 } `catchError` handler

    where the action functions can call throwError. Note that handler and the do-block must have the same return type.

Instances55Lifting, MonadError, …
datadata NodeKernel (m :: Type -> Type) addrNTN addrNTC blk
#

Constructors

data familydata family Header blk
#
Instances33GetHeader1, Inject, Isomorphic, StandardHash, ShowProxy, HasNestedContent, …
datadata RealPoint blk
#

Constructors

Instances7Eq, Ord, Show, Generic, NoThunks, Condense, …
datadata TopLevelConfig blk
#
Instances4Isomorphic, Generic, NoThunks, Rep
newtypenewtype SecurityParam
#

Constructors

Instances7Eq, Show, Generic, NoThunks, FromCBOR, ToCBOR, …
classclass HasHardForkHistory blk where
#

Associated types

Methods

Instances2HasHardForkHistory
datadata EraMismatch
#

Constructors

Instances5Eq, Show, Generic, Error, Rep
newtypenewtype OneEraHash (xs :: [k])
#

Constructors

Instances10Eq, Ord, Show, NFData, ToJSON, Serialise, …
  • Eq (OneEraHash xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.AcrossEras
  • Ord (OneEraHash xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.AcrossEras
  • Show (OneEraHash xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.AcrossEras
  • NFData (OneEraHash xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.AcrossEras
  • ToJSON (OneEraHash xs)Defined in cardano-api-11.7.0.0 · Cardano.Api.Internal.Orphans.Serialisation · orphan
  • Serialise (OneEraHash xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.AcrossEras
  • NoThunks (OneEraHash xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.AcrossEras
  • (Typeable k, Typeable xs) => FromCBOR (OneEraHash xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.AcrossEras
  • (Typeable k, Typeable xs) => ToCBOR (OneEraHash xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.AcrossEras
  • Condense (OneEraHash xs)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.HardFork.Combinator.AcrossEras
newtypenewtype PerEraLedgerConfig (xs :: [Type])
#

Constructors

Instances3Show, NoThunks, SerialiseNodeToClient
datadata HardForkLedgerConfig (xs :: [Type])
#

Constructors

Instances5Show, Generic, NoThunks, SerialiseNodeToClient, Rep
newtypenewtype WrapPartialLedgerConfig blk
#

Constructors

Instances3SerialiseNodeToClient, Show, NoThunks
data familydata family GenTx blk
#
Instances48Inject, Isomorphic, ShowProxy, Eq, Ord, Show, …
familytype family ChainDepState p
#
Instances4ChainDepState
familytype family ChainDepState p
#
Instances4ChainDepState
datadata ChainType
#
SelectedChainTentativeChain
Instances4Eq, Show, Generic, Rep
  • Eq ChainTypeDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ChainDB.API
  • Show ChainTypeDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ChainDB.API
  • Generic ChainTypeDefined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ChainDB.API
  • type Rep ChainType = D1 ('MetaData "ChainType" "Ouroboros.Consensus.Storage.ChainDB.API" "ouroboros-consensus-4.2.1.0-C9zVP0VXla2Fy4UJAsSSXt" 'False) (C1 ('MetaCons "SelectedChain" 'PrefixI 'False) U1 :+: C1 ('MetaCons "TentativeChain" 'PrefixI 'False) U1)Defined in ouroboros-consensus-4.2.1.0 · Ouroboros.Consensus.Storage.ChainDB.API
datadata BlockComponent blk a where
#

Constructors

Instances2Functor, Applicative
datadata ByronBlock
#
Instances1ConvertLedgerEvent
  • ConvertLedgerEvent ByronBlockDefined in cardano-api-11.7.0.0 · Cardano.Api.LedgerState.Internal.ConvertLedgerEvent
typetype CardanoBlock c = HardForkBlock (CardanoEras c)
#
Instances4Protocol, ProtocolClient, ProtocolInfoArgs, ProtocolClientInfoArgs
classclass (StandardHash b, Typeable b) => HasHeader b where
#
Instances5HasHeader
familytype family HeaderHash (b :: k)
#
Instances12HeaderHash, …
newtypenewtype Serialised (a :: k)
#

Constructors

Instances4EncodeDisk, DecodeDisk, SerialiseNodeToClient, SerialiseNodeToNode
datadata LedgerPeerSnapshot (a :: LedgerPeersKind) where
#

Constructors

datadata Doc ann
#

The abstract data type Doc ann represents pretty documents that have been annotated with data of type ann.

More specifically, a value of type Doc represents a non-empty set of possible layouts of a document. The layout functions select one of these possibilities, taking into account things like the width of the output document.

The annotation is an arbitrary piece of data associated with (part of) a document. Annotations may be used by the rendering backends in order to display output differently, such as

  • color information (e.g. when rendering to the terminal)

  • mouseover text (e.g. when rendering to rich HTML)

  • whether to show something or not (to allow simple or detailed versions)

The simplest way to display a Doc is via the Show class.

Example1 expression
putStrLn (show (vsep ["hello", "world"]))helloworld
Instances9Functor, PrettyAnn, Show, IsString, Generic, Semigroup, …
classclass Pretty a where
#

Overloaded conversion to Doc.

Laws:

  1. output should be pretty. :-)

Methods

  • pretty :: a -> Doc ann
    Example1 expression
    pretty 1 <+> pretty "hello" <+> pretty 1.2341 hello 1.234
  • prettyList :: [a] -> Doc ann

    prettyList is only used to define the instance Pretty a => Pretty [a]. In normal circumstances only the pretty function is used.

    Example1 expression
    prettyList [1, 23, 456][1, 23, 456]
Instances373Pretty, …
datadata ResourceRegistry (m :: Type -> Type)
#

Tracks resources during their lifetime.

Instances3Generic, NoThunks, Rep
datadata Text
#

A space efficient, packed, unboxed Unicode text type.

Instances127IsList, Eq, Data, Ord, Read, Show, …
classclass (forall (m :: Type -> Type). Monad m => Monad (t m)) => MonadTrans (t :: (Type -> Type) -> Type -> Type) where
#

The class of monad transformers. For any monad m, the result t m should also be a monad, and lift should be a monad transformation from m to t m, i.e. it should satisfy the following laws:

Since 0.6.0.0 and for GHC 8.6 and later, the requirement that t m be a Monad is enforced by the implication constraint forall m. Monad m => Monad (t m) enabled by the QuantifiedConstraints extension.

Ambiguity error with GHC 9.0 to 9.2.2

These versions of GHC have a bug (https://gitlab.haskell.org/ghc/ghc/-/issues/20582) which causes constraints like

(MonadTrans t, forall m. Monad m => Monad (t m)) => ...

to be reported as ambiguous. For transformers 0.6 and later, this can be fixed by removing the second constraint, which is implied by the first.

Methods

  • lift :: Monad m => m a -> t m a

    Lift a computation from the argument monad to the constructed monad.

Instances66MonadTrans, …
typetype Except e = ExceptT e Identity
#

The parameterizable exception monad.

Computations are either exceptions (of any type) or normal values. These computations are plain values, and are unrelated to the Control.Exception mechanism, which is tied to the IO monad.

The return function returns a normal value, while >>= exits on the first exception. For a variant that continues after an error and collects all the errors, see Errors.

newtypenewtype ExceptT e (m :: Type -> Type) a
#

A monad transformer that adds exceptions to other monads.

ExceptT constructs a monad parameterized over two things:

  • e - An arbitrary exception type.

  • m - The inner monad.

The monadic computations are a plain values. They are unrelated to the Control.Exception mechanism, which is tied to the IO monad.

The return function yields a computation that produces the given value, while >>= sequences two subcomputations, exiting on the first exception.

Constructors

Instances90MonadRWS, FunctorT, TraversableT, DistributiveT, MFunctor, Generic1, …