Cardano.Provider.OgmiosTypes

class DecodeOgmios o  where

Variation of DecodeAeson for ogmios response, defines how to parse full ogmios reponse.

Members

• decodeOgmios :: Aeson -> Either OgmiosDecodeError o

Instances

• DecodeOgmios TxEvaluationR

type ExecutionUnits = { memory :: BigNum, steps :: BigNum }

type JsonRpc2Response = { error :: Maybe Aeson, id :: Maybe String, jsonrpc :: String, method :: Maybe String, result :: Maybe Aeson }

Structure of all json rpc websocket responses

type OgmiosAddress = Bech32String

type OgmiosDatum = String

data OgmiosDecodeError

Constructors

• ErrorResponse (Maybe OgmiosError)
• InvalidRpcError JsonDecodeError
• InvalidRpcResponse JsonDecodeError

Instances

• Generic OgmiosDecodeError _
• Show OgmiosDecodeError

newtype OgmiosError

Constructors

• OgmiosError { code :: Int, data :: Maybe Aeson, message :: String }

Instances

• Generic OgmiosError _
• Newtype OgmiosError _
• Show OgmiosError
• DecodeAeson OgmiosError

type OgmiosRedeemerPtr = { index :: UInt, purpose :: String }

type OgmiosScript = String

type OgmiosTxId = String

type OgmiosTxIn = { index :: Int, txId :: OgmiosTxId }

type OgmiosTxOut = { address :: OgmiosAddress, datum :: Maybe String, datumHash :: Maybe String, script :: Maybe ScriptRef, value :: Value }

type OgmiosTxOutRef = { index :: UInt, txId :: String }

type RedeemerPointer = { redeemerIndex :: UInt, redeemerTag :: RedeemerTag }

data ScriptFailure

Reason a script failed.

Constructors

• ExtraRedeemers (Array RedeemerPointer)
• MissingRequiredDatums { missing :: Array OgmiosDatum, provided :: Maybe (Array OgmiosDatum) }
• MissingRequiredScripts { missing :: Array RedeemerPointer, resolved :: Maybe (Map RedeemerPointer ScriptHash) }
• ValidatorFailed { error :: String, traces :: Array String }
• UnknownInputReferencedByRedeemer (Array OgmiosTxIn)
• NonScriptInputReferencedByRedeemer OgmiosTxIn
• NoCostModelForLanguage (Array String)
• InternalLedgerTypeConversionError String
• IllFormedExecutionBudget (Maybe ExecutionUnits)

Instances

• Generic ScriptFailure _
• Show ScriptFailure
• DecodeAeson ScriptFailure

data TxEvaluationFailure

Constructors

• UnparsedError String
• AdditionalUtxoOverlap (Array OgmiosTxOutRef)
• ScriptFailures (Map RedeemerPointer (Array ScriptFailure))

Instances

• Generic TxEvaluationFailure _
• Show TxEvaluationFailure
• DecodeAeson TxEvaluationFailure

newtype TxEvaluationR

Constructors

• TxEvaluationR (Either TxEvaluationFailure TxEvaluationResult)

Instances

• Newtype TxEvaluationR _
• Generic TxEvaluationR _
• Show TxEvaluationR
• DecodeOgmios TxEvaluationR

newtype TxEvaluationResult

Constructors

• TxEvaluationResult (Map RedeemerPointer ExecutionUnits)

Instances

• Newtype TxEvaluationResult _
• Generic TxEvaluationResult _
• Show TxEvaluationResult
• DecodeAeson TxEvaluationResult

decodeAesonJsonRpc2Response :: Aeson -> Either JsonDecodeError JsonRpc2Response

decodeErrorOrResult :: forall o. { parseError :: Aeson -> Either JsonDecodeError o } -> { parseResult :: Aeson -> Either JsonDecodeError o } -> Aeson -> Either OgmiosDecodeError o

Decode "result" field or if absent the error field of ogmios response.

decodeRedeemerPointer :: OgmiosRedeemerPtr -> Either JsonDecodeError RedeemerPointer

decodeResult :: forall o. (Aeson -> Either JsonDecodeError o) -> Aeson -> Either OgmiosDecodeError o

Decode "result" field of ogmios response.

makeDecodeOgmios :: forall o. These { parseError :: Aeson -> Either JsonDecodeError o } { parseResult :: Aeson -> Either JsonDecodeError o } -> Aeson -> Either OgmiosDecodeError o

Given how to parse result or error fields,

ogmiosDecodeErrorToError :: OgmiosDecodeError -> Error

pprintOgmiosDecodeError :: OgmiosDecodeError -> String

pprintOgmiosError :: OgmiosError -> String

redeemerTagFromString :: String -> Maybe RedeemerTag

redeemerTypeMismatch :: JsonDecodeError

showRedeemerPointer :: RedeemerPointer -> String