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

GeniusYield.Providers.Common

Description

Synopsis

data SomeDeserializeError
newtype SubmitTxException = SubmitTxException Text
datumFromCBOR ∷ Text → Either SomeDeserializeError GYDatum
newServantClientEnv ∷ String → IO ClientEnv
fromJson ∷ FromData a ⇒ ByteString → Either SomeDeserializeError a
parseEraHist ∷ (t → EraSummary) → [t] → Maybe EraHistory
preprodEraHist ∷ Interpreter (CardanoEras StandardCrypto)
previewEraHist ∷ Interpreter (CardanoEras StandardCrypto)
mainnetEraHist ∷ Interpreter (CardanoEras StandardCrypto)
silenceHeadersClientError ∷ ClientError → ClientError
extractAssetClass ∷ Maybe GYAssetClass → Maybe (Text, Text)

Documentation

data SomeDeserializeError #

Constructors

DeserializeErrorBech32 !Bech32DecodeError
DeserializeErrorAeson !Text
DeserializeErrorAssetClass !Text
DeserializeErrorScriptDataJson !ScriptDataJsonError
DeserializeErrorHex !Text
DeserializeErrorAddress
DeserializeErrorImpossibleBranch !Text

Instances

Instances details

Show SomeDeserializeError #
Instance details Defined in GeniusYield.Providers.Common Methods showsPrec ∷ Int → SomeDeserializeError → ShowS # show ∷ SomeDeserializeError → String # showList ∷ [SomeDeserializeError] → ShowS #
Eq SomeDeserializeError #
Instance details Defined in GeniusYield.Providers.Common Methods (==) ∷ SomeDeserializeError → SomeDeserializeError → Bool # (/=) ∷ SomeDeserializeError → SomeDeserializeError → Bool #

newtype SubmitTxException #

Constructors

SubmitTxException Text

Instances

Instances details

Exception SubmitTxException #
Instance details Defined in GeniusYield.Providers.Common Methods toException ∷ SubmitTxException → SomeException # fromException ∷ SomeException → Maybe SubmitTxException # displayException ∷ SubmitTxException → String #
Show SubmitTxException #
Instance details Defined in GeniusYield.Providers.Common Methods showsPrec ∷ Int → SubmitTxException → ShowS # show ∷ SubmitTxException → String # showList ∷ [SubmitTxException] → ShowS #

datumFromCBOR ∷ Text → Either SomeDeserializeError GYDatum #

Get datum from bytes.

newServantClientEnv ∷ String → IO ClientEnv #

Creates a new Servant ClientEnv from a base url.

fromJson ∷ FromData a ⇒ ByteString → Either SomeDeserializeError a #

parseEraHist ∷ (t → EraSummary) → [t] → Maybe EraHistory #

Convert a regular list of era summaries (a la Ogmios) into a typed EraHistory (a la Ouroboros).

NOTE ==

TODO: This must be updated with each hardfork.

See NonEmptyConsSummaryCardanoEras types to understand why one cannot trivially automate this.

Well, unless one uses vectors, from dependent type land.

preprodEraHist ∷ Interpreter (CardanoEras StandardCrypto) #

Hardcoded era history for preprod.

NOTE: This is only to be used for testing.

Also see: "GeniusYield.CardanoApi.EraHistory.showEraHistory"

previewEraHist ∷ Interpreter (CardanoEras StandardCrypto) #

mainnetEraHist ∷ Interpreter (CardanoEras StandardCrypto) #

silenceHeadersClientError ∷ ClientError → ClientError #

Remove request headers info from returned ClientError.

This is used as quick and simple way to hide confidential information such as API token.

extractAssetClass ∷ Maybe GYAssetClass → Maybe (Text, Text) #

Extract currency symbol & token name part of an GYAssetClass when it is of such a form. When input is Just GYLovelace or Nothing, this function returns Nothing.