Copyright	(c) 2023 GYELD GMBH
License	Apache 2.0
Maintainer	[email protected]
Stability	develop
Safe Haskell	Safe-Inferred
Language	GHC2021

GeniusYield.TxBuilder.Errors

Description

Synopsis

data PlutusToCardanoError
- = DeserialiseRawBytesError {
  - ptceTag ∷ Text
  }
- | StakePtrAddressUnsupported Address
- | UnknownPlutusToCardanoError {
  - ptceTag ∷ Text
  }
data GYConversionError
data GYQueryUTxOError
- = GYNoUtxosAtAddress ![GYAddress]
- | GYNoUtxoAtRef !GYTxOutRef
data GYQueryDatumError
- = GYNoDatumForHash !GYDatumHash
- | GYInvalidDatum !GYDatum
- | GYNoDatumHash !GYUTxO
data GYTxMonadException ∷ Type where
- GYConversionException ∷ GYConversionError → GYTxMonadException
- GYQueryUTxOException ∷ GYQueryUTxOError → GYTxMonadException
- GYBuildTxException ∷ GYBuildTxError → GYTxMonadException
- GYNoSuitableCollateralException ∷ {..} → GYTxMonadException
- GYSlotOverflowException ∷ {..} → GYTxMonadException
- GYTimeUnderflowException ∷ SystemStart → GYTime → GYTxMonadException
- GYQueryDatumException ∷ GYQueryDatumError → GYTxMonadException
- GYDatumMismatch ∷ GYOutDatum → GYTxIn v → GYTxMonadException
- GYApplicationException ∷ (Exception e, IsGYApiError e) ⇒ e → GYTxMonadException
data GYBuildTxError
data GYBalancingError
- = GYBalancingErrorInsufficientFunds !GYValue
- | ∀ v. GYBalancingErrorNonPositiveTxOut !(GYTxOut v)
- | GYBalancingErrorChangeShortFall !Natural
- | GYBalancingErrorEmptyOwnUTxOs
throwAppError ∷ (IsGYApiError e, Exception e, MonadError GYTxMonadException m) ⇒ e → m a

Documentation

data PlutusToCardanoError #

PlutusToCardanoError is raised when using Plutus to Cardano API type conversion functions from plutus-ledger. It is a focused version of Ledger.Tx.CardanoAPI.ToCardanoError.

Constructors

DeserialiseRawBytesError	Deserialization failed; tag indicates the type being deserialized.
Fields ptceTag ∷ Text
StakePtrAddressUnsupported Address	Raised when trying to convert a stake ptr plutus address.
UnknownPlutusToCardanoError	Wildcard unhandled constructors; shouldn't happen usually.
Fields ptceTag ∷ Text

Instances

Instances details

Show PlutusToCardanoError #
Instance details Defined in GeniusYield.Types.Ledger Methods showsPrec ∷ Int → PlutusToCardanoError → ShowS # show ∷ PlutusToCardanoError → String # showList ∷ [PlutusToCardanoError] → ShowS #

data GYConversionError #

GYConversionErrors may be raised during type conversions.

Constructors

GYNotPubKeyAddress !GYAddress	An address was expected to contain a pub key hash, but it did not.
GYNotScriptAddress !GYAddress	An address was expected to contain a script hash, but it did not.
GYInvalidPlutusValue !GYFromPlutusValueError !Value	Raised during Plutus Value to `GYValue` conversion.
GYInvalidPlutusAsset !GYFromPlutusValueError	Raised during Plutus asset to GY asset conversion.
GYInvalidAddressText !Text	Raised when trying to parse `Text` into `GYAddress`.
GYEraSummariesToSlotConfigError !Text	Raised when trying to convert EraHistory to GYSlotConfig.
GYLedgerToCardanoError !PlutusToCardanoError	Errors raised during plutus-ledger -> cardano api type conversion.
GYInvalidAssetClass !Text	Errors raised by "GeniusYield.Types.Value.parseAssetClassCore" and similar.
GYInvalidSlot !Integer	Errors caused by "GeniusYield.Types.Slot.slotFromInteger" resulting in `Nothing`.

Instances

Instances details

Show GYConversionError #
Instance details Defined in GeniusYield.TxBuilder.Errors Methods showsPrec ∷ Int → GYConversionError → ShowS # show ∷ GYConversionError → String # showList ∷ [GYConversionError] → ShowS #

data GYQueryUTxOError #

GYQueryUTxOErrors may be raised during utxo related queries.

Constructors

GYNoUtxosAtAddress ![GYAddress]	An address was queried for one or more UTxOs but none were found.
GYNoUtxoAtRef !GYTxOutRef	No UTxO exists at given ref.

Instances

Instances details

Show GYQueryUTxOError #
Instance details Defined in GeniusYield.TxBuilder.Errors Methods showsPrec ∷ Int → GYQueryUTxOError → ShowS # show ∷ GYQueryUTxOError → String # showList ∷ [GYQueryUTxOError] → ShowS #

data GYQueryDatumError #

GYQueryDatumError may be raised during fetching and parsing datums.

Constructors

GYNoDatumForHash !GYDatumHash	No datum found for given hash.
GYInvalidDatum !GYDatum	Datum parsing failed.
GYNoDatumHash !GYUTxO	No datum hash at utxo.

Instances

Instances details

Show GYQueryDatumError #
Instance details Defined in GeniusYield.TxBuilder.Errors Methods showsPrec ∷ Int → GYQueryDatumError → ShowS # show ∷ GYQueryDatumError → String # showList ∷ [GYQueryDatumError] → ShowS #

data GYTxMonadException ∷ Type where #

Exceptions raised within the GYTxMonad computation.

This includes exceptions raised within the contract itself. It does not include:

Exceptions that may be raised by the provider.
Exceptions raised during transaction building/balancing.
Other wildcard exceptions raised within IO.

Constructors

GYConversionException ∷ GYConversionError → GYTxMonadException	Errors encountered during type conversions.
GYQueryUTxOException ∷ GYQueryUTxOError → GYTxMonadException	Errors encountered during utxo related queries.
GYBuildTxException ∷ GYBuildTxError → GYTxMonadException	Errors encountered during transaction building related functions.
GYNoSuitableCollateralException	Raised when no suitable collateral of at least `tmeMinLovelace` amount is found at `tmeAddress`.
Fields ∷ { tmeMinLovelace ∷ Natural , tmeAddress ∷ GYAddress } → GYTxMonadException
GYSlotOverflowException	Raised if `tmeSlot` value overflows when advancing it by `tmeAdvanceAmount`.
Fields ∷ { tmeSlot ∷ GYSlot , tmeAdvanceAmount ∷ Natural } → GYTxMonadException
GYTimeUnderflowException ∷ SystemStart → GYTime → GYTxMonadException	Raised during time -> slot conversion, if given timestamp is before known system start.
GYQueryDatumException ∷ GYQueryDatumError → GYTxMonadException	Raised during fetching/parsing datums.
GYDatumMismatch ∷ GYOutDatum → GYTxIn v → GYTxMonadException	When actual datum in the UTxO is different than what is mentioned for in witness.
GYApplicationException ∷ (Exception e, IsGYApiError e) ⇒ e → GYTxMonadException	Wildcard user application specific errors. This is the "plug-in" point where an application using the GY framework, can raise its own protocol specific errors within `GYTxMonad`.

Instances

Instances details

Exception GYTxMonadException #
Instance details Defined in GeniusYield.TxBuilder.Errors Methods toException ∷ GYTxMonadException → SomeException # fromException ∷ SomeException → Maybe GYTxMonadException # displayException ∷ GYTxMonadException → String #
Show GYTxMonadException #
Instance details Defined in GeniusYield.TxBuilder.Errors Methods showsPrec ∷ Int → GYTxMonadException → ShowS # show ∷ GYTxMonadException → String # showList ∷ [GYTxMonadException] → ShowS #
MonadError GYTxMonadException GYTxMonadClb #
Instance details Defined in GeniusYield.Test.Clb Methods throwError ∷ GYTxMonadException → GYTxMonadClb a # catchError ∷ GYTxMonadClb a → (GYTxMonadException → GYTxMonadClb a) → GYTxMonadClb a #
MonadError GYTxMonadException GYTxGameMonadIO #
Instance details Defined in GeniusYield.TxBuilder.IO Methods throwError ∷ GYTxMonadException → GYTxGameMonadIO a # catchError ∷ GYTxGameMonadIO a → (GYTxMonadException → GYTxGameMonadIO a) → GYTxGameMonadIO a #
MonadError GYTxMonadException GYTxMonadIO #
Instance details Defined in GeniusYield.TxBuilder.IO Methods throwError ∷ GYTxMonadException → GYTxMonadIO a # catchError ∷ GYTxMonadIO a → (GYTxMonadException → GYTxMonadIO a) → GYTxMonadIO a #
MonadError GYTxMonadException GYTxBuilderMonadIO #
Instance details Defined in GeniusYield.TxBuilder.IO.Builder Methods throwError ∷ GYTxMonadException → GYTxBuilderMonadIO a # catchError ∷ GYTxBuilderMonadIO a → (GYTxMonadException → GYTxBuilderMonadIO a) → GYTxBuilderMonadIO a #
MonadError GYTxMonadException GYTxQueryMonadIO #
Instance details Defined in GeniusYield.TxBuilder.IO.Query Methods throwError ∷ GYTxMonadException → GYTxQueryMonadIO a # catchError ∷ GYTxQueryMonadIO a → (GYTxMonadException → GYTxQueryMonadIO a) → GYTxQueryMonadIO a #
MonadError GYTxMonadException m ⇒ MonadError GYTxMonadException (FeeTracker m) #
Instance details Defined in GeniusYield.Test.FeeTracker Methods throwError ∷ GYTxMonadException → FeeTracker m a # catchError ∷ FeeTracker m a → (GYTxMonadException → FeeTracker m a) → FeeTracker m a #
MonadError GYTxMonadException m ⇒ MonadError GYTxMonadException (FeeTrackerGame m) #
Instance details Defined in GeniusYield.Test.FeeTracker Methods throwError ∷ GYTxMonadException → FeeTrackerGame m a # catchError ∷ FeeTrackerGame m a → (GYTxMonadException → FeeTrackerGame m a) → FeeTrackerGame m a #

data GYBuildTxError #

GYBuildTxError may be raised when building transactions, for non-trivial errors. Insufficient funds and similar are considered trivial transaction building errors.

Constructors

GYBuildTxBalancingError !GYBalancingError
GYBuildTxBodyErrorAutoBalance !(TxBodyErrorAutoBalance ApiEra)
GYBuildTxExUnitsTooBig	Execution units required is higher than the maximum as specified by protocol params.
Fields (Natural, Natural) Tuple of maximum execution steps & memory as given by protocol parameters. (Natural, Natural) Tuple of execution steps & memory as taken by built transaction.
GYBuildTxSizeTooBig	Transaction size is higher than the maximum as specified by protocol params.
Fields !Natural Maximum size as specified by protocol parameters. !Natural Size our built transaction took.
GYBuildTxCollateralShortFall	Shortfall (in collateral inputs) for collateral requirement.
Fields !Natural Transaction collateral requirement. !Natural Lovelaces in given collateral UTxO.
GYBuildTxNoSuitableCollateral	Couldn't find a UTxO to use as collateral.
GYBuildTxCborSimplificationError !CborSimplificationError
GYBuildTxCollapseExtraOutError !TxBodyError

Instances

Instances details

Show GYBuildTxError #
Instance details Defined in GeniusYield.Transaction.Common Methods showsPrec ∷ Int → GYBuildTxError → ShowS # show ∷ GYBuildTxError → String # showList ∷ [GYBuildTxError] → ShowS #

data GYBalancingError #

Constructors

GYBalancingErrorInsufficientFunds !GYValue
∀ v. GYBalancingErrorNonPositiveTxOut !(GYTxOut v)
GYBalancingErrorChangeShortFall !Natural	Lovelace shortfall in constructing a change output. See: Cardano.CoinSelection.Balance.UnableToConstructChangeError
GYBalancingErrorEmptyOwnUTxOs	User wallet has no utxos to select.

Instances

Instances details

Show GYBalancingError #
Instance details Defined in GeniusYield.Transaction.Common Methods showsPrec ∷ Int → GYBalancingError → ShowS # show ∷ GYBalancingError → String # showList ∷ [GYBalancingError] → ShowS #
PrintfArg GYBalancingError #
Instance details Defined in GeniusYield.Transaction.Common Methods formatArg ∷ GYBalancingError → FieldFormatter # parseFormat ∷ GYBalancingError → ModifierParser #
Eq GYBalancingError #
Instance details Defined in GeniusYield.Transaction.Common Methods (==) ∷ GYBalancingError → GYBalancingError → Bool # (/=) ∷ GYBalancingError → GYBalancingError → Bool #

throwAppError ∷ (IsGYApiError e, Exception e, MonadError GYTxMonadException m) ⇒ e → m a #

Throw an application specific exception (GYApplicationException) within GYTxMonad.