Haspara.FXQuote

This module provides base data definitions and functions for Haspara library.

FX Quote

Data Definition

data FXQuote (s :: Nat)

Type encoding for FX rates.

Instances

Eq (FXQuote s)

Defined in Haspara.Internal.FXQuote

Methods

(==) :: FXQuote s -> FXQuote s -> Bool

(/=) :: FXQuote s -> FXQuote s -> Bool

Ord (FXQuote s)

Defined in Haspara.Internal.FXQuote

Methods

compare :: FXQuote s -> FXQuote s -> Ordering

(<) :: FXQuote s -> FXQuote s -> Bool

(<=) :: FXQuote s -> FXQuote s -> Bool

(>) :: FXQuote s -> FXQuote s -> Bool

(>=) :: FXQuote s -> FXQuote s -> Bool

max :: FXQuote s -> FXQuote s -> FXQuote s

min :: FXQuote s -> FXQuote s -> FXQuote s

KnownNat s => Show (FXQuote s)

Defined in Haspara.Internal.FXQuote

Methods

showsPrec :: Int -> FXQuote s -> ShowS

show :: FXQuote s -> String

showList :: [FXQuote s] -> ShowS

KnownNat s => ToJSON (FXQuote s)

ToJSON instance for Currency

>>> :set -XDataKinds
>>> let rate = fxquoteUnsafe (read "2021-01-01") "USD" "SGD" 1.35 :: FXQuote 2
>>> Aeson.encode rate
"{\"ccy2\":\"SGD\",\"date\":\"2021-01-01\",\"rate\":1.35,\"ccy1\":\"USD\"}"

Defined in Haspara.Internal.FXQuote

Methods

toJSON :: FXQuote s -> Value

toEncoding :: FXQuote s -> Encoding

toJSONList :: [FXQuote s] -> Value

toEncodingList :: [FXQuote s] -> Encoding

KnownNat s => FromJSON (FXQuote s)

FromJSON instance for Currency

>>> :set -XDataKinds
>>> Aeson.eitherDecode "{\"date\": \"2021-01-01\", \"ccy1\": \"USD\", \"ccy2\": \"SGD\", \"rate\": 1.35}" :: Either String (FXQuote 2)
Right ("USD/SGD","2021-01-01","1.35")
>>> Aeson.eitherDecode "{\"date\": \"2021-01-01\", \"ccy1\": \"USD\", \"ccy2\": \"SGD\", \"rate\": 1.354}" :: Either String (FXQuote 2)
Right ("USD/SGD","2021-01-01","1.35")
>>> Aeson.eitherDecode "{\"date\": \"2021-01-01\", \"ccy1\": \"USD\", \"ccy2\": \"SGD\", \"rate\": 1.355}" :: Either String (FXQuote 2)
Right ("USD/SGD","2021-01-01","1.36")
>>> Aeson.eitherDecode "{\"date\": \"2021-01-01\", \"ccy1\": \"USD\", \"ccy2\": \"SGD\", \"rate\": 1.356}" :: Either String (FXQuote 2)
Right ("USD/SGD","2021-01-01","1.36")
>>> Aeson.eitherDecode "{\"date\": \"2021-01-01\", \"ccy1\": \"USD\", \"ccy2\": \"SGD\", \"rate\": 1.364}" :: Either String (FXQuote 2)
Right ("USD/SGD","2021-01-01","1.36")
>>> Aeson.eitherDecode "{\"date\": \"2021-01-01\", \"ccy1\": \"USD\", \"ccy2\": \"SGD\", \"rate\": 1.365}" :: Either String (FXQuote 2)
Right ("USD/SGD","2021-01-01","1.36")
>>> Aeson.eitherDecode "{\"date\": \"2021-01-01\", \"ccy1\": \"USD\", \"ccy2\": \"SGD\", \"rate\": 1.366}" :: Either String (FXQuote 2)
Right ("USD/SGD","2021-01-01","1.37")
>>> Aeson.eitherDecode "{\"date\": \"2021-01-01\", \"ccy1\": \"USD\", \"ccy2\": \"USD\", \"rate\": 1.35}" :: Either String (FXQuote 2)
Left "Error in $: Can not create FX Rate. Error was: Can not create currency pair from same currencies: USD and USD"
>>> Aeson.eitherDecode "{\"date\": \"2021-01-01\", \"ccy1\": \"USD\", \"ccy2\": \"SGD\", \"rate\": -1.35}" :: Either String (FXQuote 2)
Left "Error in $: Can not create FX Rate. Error was:   The predicate (GreaterThan 0) failed with the message: Value is not greater than 0\n"

Defined in Haspara.Internal.FXQuote

Methods

parseJSON :: Value -> Parser (FXQuote s)

parseJSONList :: Value -> Parser [FXQuote s]

fxQuoteDate :: FXQuote s -> Date

Actual date of the FX rate.

fxQuotePair :: FXQuote s -> CurrencyPair

Currency pair of the FX rate.

fxQuoteRate :: FXQuote s -> Refined Positive (Quantity s)

Rate value of the FX rate.

Constructors

fxquote

Arguments

:: (KnownNat s, MonadError String m)

=> Date

Date of the FX rate.

-> Currency

First currency (from) of the FX rate.

-> Currency

Second currency (to) of the FX rate.

-> Scientific

FX rate value.

-> m (FXQuote s)

Smart constructor for FXQuote values within MonadError context.

fxquoteFail

Arguments

:: (KnownNat s, MonadFail m)

=> Date

Date of the FX rate.

-> Currency

First currency (from) of the FX rate.

-> Currency

Second currency (to) of the FX rate.

-> Scientific

FX rate value.

-> m (FXQuote s)

Smart constructor for FXQuote values within MonadFail context.

FX Quote Database

fxquoteDatabase

type FXQuoteDatabase (n :: Nat) = HashMap CurrencyPair (FXQuotePairDatabase n)

data FXQuotePairDatabase (n :: Nat)

Constructors

FXQuotePairDatabase

Fields

• fxQuotePairDatabasePair :: !CurrencyPair
• fxQuotePairDatabaseTable :: !(HashMap Date (FXQuote n))
• fxQuotePairDatabaseSince :: !Date
• fxQuotePairDatabaseUntil :: !Date

findFXQuote :: KnownNat n => FXQuoteDatabase n -> CurrencyPair -> Date -> Maybe (FXQuote n)