Feat 17: Hackage readiness - An important fix/change: New route to pass for api key instead of it being overridden in each request

Author: sourabhxyz

src/Maestro/API.hs

@@ -1,6 +1,6 @@
 module Maestro.API where
 
-import           Data.Proxy              (Proxy (..))
+import           Data.Text               (Text)
 import           Maestro.API.Accounts
 import           Maestro.API.Address
 import           Maestro.API.Assets
@@ -13,7 +13,7 @@ import           Maestro.API.Transaction
 import           Servant.API
 import           Servant.API.Generic
 
-data MaestroApi route  = Routes
+data MaestroApiV0 route  = MaestroApiV0
   { _accounts :: route :- "accounts" :> ToServantApi AccountsAPI
   , _address  :: route :- "addresses" :> ToServantApi AddressAPI
   , _assets   :: route :- "assets" :> ToServantApi AssetsAPI
@@ -25,5 +25,6 @@ data MaestroApi route  = Routes
   , _scripts  :: route :- "scripts" :> ToServantApi ScriptsAPI
   } deriving Generic
 
-api :: Proxy (ToServantApi MaestroApi)
-api = genericApi (Proxy :: Proxy MaestroApi)
+newtype MaestroApiV0Auth route = MaestroApiV0Auth
+  { _apiV0 :: route :- Header' '[Required] "api-key" Text :> ToServantApi MaestroApiV0 }
+  deriving Generic

src/Maestro/Client/Accounts.hs

@@ -10,7 +10,7 @@ import           Servant.API.Generic
 import           Servant.Client
 
 accountsClient :: MaestroEnv -> AccountsAPI (AsClientT IO)
-accountsClient = fromServant . _accounts . apiClient
+accountsClient = fromServant . _accounts . apiV0Client
 
 getAccount :: MaestroEnv -> Text -> IO AccountInfo
 getAccount = _account . accountsClient

src/Maestro/Client/Address.hs

@@ -11,7 +11,7 @@ import           Servant.API.Generic
 import           Servant.Client
 
 addressClient :: MaestroEnv -> AddressAPI (AsClientT IO)
-addressClient = fromServant . _address . apiClient
+addressClient = fromServant . _address . apiV0Client
 
 -- |
 -- Returns list of utxos for multiple addresses

src/Maestro/Client/Assets.hs

@@ -11,7 +11,7 @@ import           Servant.API.Generic
 import           Servant.Client
 
 assetClient :: MaestroEnv -> AssetsAPI (AsClientT IO)
-assetClient = fromServant . _assets . apiClient
+assetClient = fromServant . _assets . apiV0Client
 
 -- |
 -- Returns list of  Information about the assets of the given policy ID

src/Maestro/Client/Core.hs

@@ -3,7 +3,7 @@
 module Maestro.Client.Core
   (
     ApiError (..)
-  , apiClient
+  , apiV0Client
   , MaestroError (..)
   , fromServantClientError
   , module Maestro.Client.Core.Pagination
@@ -18,6 +18,7 @@ import           Maestro.Client.Core.Pagination
 import           Maestro.Client.Env
 import           Maestro.Types.Common           (LowerFirst)
 import           Network.HTTP.Types
+import           Servant.API                    (fromServant)
 import           Servant.Client
 import           Servant.Client.Generic
 
@@ -79,5 +80,8 @@ fromServantClientError e = case e of
         Just (ae :: ApiError) -> _apiErrorMessage ae
         Nothing               -> mempty
 
-apiClient :: MaestroEnv -> MaestroApi (AsClientT IO)
-apiClient MaestroEnv{..} = genericClientHoist $ \x -> runClientM x _maeClientEnv >>= either (throwIO . fromServantClientError) pure
+apiV0ClientAuth :: MaestroEnv -> MaestroApiV0Auth (AsClientT IO)
+apiV0ClientAuth MaestroEnv{..} = genericClientHoist $ \x -> runClientM x _maeClientEnv >>= either (throwIO . fromServantClientError) pure
+
+apiV0Client :: MaestroEnv -> MaestroApiV0 (AsClientT IO)
+apiV0Client mEnv@MaestroEnv {..} = fromServant $ _apiV0 (apiV0ClientAuth mEnv) _maeToken

src/Maestro/Client/Datum.hs

@@ -12,7 +12,7 @@ import           Servant.API.Generic
 import           Servant.Client
 
 datumClient :: MaestroEnv -> DatumAPI (AsClientT IO)
-datumClient = fromServant . _datum . apiClient
+datumClient = fromServant . _datum . apiV0Client
 
 -- | Get information about the datum from it's hash.
 getDatumByHash :: MaestroEnv -> Text -> IO Datum

src/Maestro/Client/Env.hs

@@ -6,16 +6,16 @@ module Maestro.Client.Env
   ) where
 
 import           Data.Text               (Text)
-import           Data.Text.Encoding      (encodeUtf8)
-import           Network.HTTP.Client     (managerModifyRequest, requestHeaders)
-import           Network.HTTP.Client.TLS (newTlsManagerWith, tlsManagerSettings)
+import           Network.HTTP.Client     (newManager)
+import           Network.HTTP.Client.TLS (tlsManagerSettings)
 
 import qualified Servant.Client          as Servant
 
 type MaestroToken = Text
 
-newtype MaestroEnv = MaestroEnv
-  { _maeClientEnv :: Servant.ClientEnv
+data MaestroEnv = MaestroEnv
+  { _maeClientEnv :: !Servant.ClientEnv
+  , _maeToken     :: !MaestroToken
   }
 
 data MaestroNetwork = Mainnet | Preprod
@@ -26,15 +26,11 @@ maestroBaseUrl Mainnet = "https://mainnet.gomaestro-api.org/v0"
 
 mkMaestroEnv :: MaestroToken -> MaestroNetwork -> IO MaestroEnv
 mkMaestroEnv token nid = do
-  clientEnv <- servantClientEnv token $ maestroBaseUrl nid
-  pure $ MaestroEnv {_maeClientEnv = clientEnv}
+  clientEnv <- servantClientEnv $ maestroBaseUrl nid
+  pure $ MaestroEnv { _maeClientEnv = clientEnv, _maeToken = token }
 
-servantClientEnv :: MaestroToken -> String -> IO Servant.ClientEnv
-servantClientEnv token url = do
+servantClientEnv :: String -> IO Servant.ClientEnv
+servantClientEnv url = do
   baseUrl <- Servant.parseBaseUrl url
-  manager <- newTlsManagerWith $ tlsManagerSettings {managerModifyRequest = addTokenHeader}
-
+  manager <- newManager tlsManagerSettings
   pure $ Servant.mkClientEnv manager baseUrl
-
-  where
-    addTokenHeader req  = pure $ req {requestHeaders = [("api-key", encodeUtf8 token), ("Content-Type", "application/json")]}

src/Maestro/Client/Epochs.hs

@@ -12,7 +12,7 @@ import           Servant.API.Generic
 import           Servant.Client
 
 epochsClient :: MaestroEnv -> EpochsAPI (AsClientT IO)
-epochsClient = fromServant . _epochs . apiClient
+epochsClient = fromServant . _epochs . apiV0Client
 
 -- | Get information about the current epoch.
 getCurrentEpoch :: MaestroEnv -> IO CurrentEpochInfo

src/Maestro/Client/General.hs

@@ -14,7 +14,7 @@ import           Servant.API.Generic
 import           Servant.Client
 
 generalClient :: MaestroEnv -> GeneralAPI (AsClientT IO)
-generalClient = fromServant . _general . apiClient
+generalClient = fromServant . _general . apiV0Client
 
 -- | Get details about the latest block of the network.
 getChainTip :: MaestroEnv -> IO ChainTip

src/Maestro/Client/Pools.hs

@@ -20,7 +20,7 @@ import           Servant.API.Generic
 import           Servant.Client
 
 poolsClient :: MaestroEnv -> PoolAPI (AsClientT IO)
-poolsClient = fromServant . _pools . apiClient
+poolsClient = fromServant . _pools . apiV0Client
 
 -- | Returns a list of currently registered stake pools
 listPools :: MaestroEnv -> Page -> IO [PoolListInfo]