Safe Haskell	None
Language	Haskell2010

Blockfrost.Client.Types

Description

Client Types

Synopsis

type BlockfrostClient = BlockfrostClientT IO
data BlockfrostError
- = BlockfrostError Text
- | BlockfrostBadRequest Text
- | BlockfrostTokenMissing Text
- | BlockfrostNotFound
- | BlockfrostIPBanned
- | BlockfrostUsageLimitReached
- | BlockfrostFatal Text
- | ServantClientError ClientError
type ClientConfig = ( ClientEnv , Project )
runBlockfrost :: Project -> BlockfrostClientT IO a -> IO ( Either BlockfrostError a)
apiClient :: MonadBlockfrost m => BlockfrostAPI ( AsClientT m)
api0Client :: MonadBlockfrost m => Project -> BlockfrostV0API ( AsClientT m)
commonClient :: MonadBlockfrost m => Project -> CommonAPI ( AsClientT m)
cardanoClient :: MonadBlockfrost m => Project -> CardanoAPI ( AsClientT m)
ipfsClient :: MonadBlockfrost m => Project -> IPFSAPI ( AsClientT m)
nutLinkClient :: MonadBlockfrost m => Project -> NutLinkAPI ( AsClientT m)
data Project = Project {
- projectEnv :: Env
- projectId :: Text
}
data Paged = Paged {
- countPerPage :: Int
- pageNumber :: Int
}
data SortOrder
- = Ascending
- | Descending
go :: MonadBlockfrost m => ( Project -> m a) -> m a
data AsClientT (m :: Type -> Type )
fromServant :: GenericServant routes mode => ToServant routes mode -> routes mode
tryError :: MonadError e m => m a -> m ( Either e a)
def :: Default a => a
newtype BlockfrostClientT m a = BlockfrostClientT {
- unBlockfrostClientT :: ExceptT BlockfrostError ( ReaderT ClientConfig m) a
}
class MonadIO m => MonadBlockfrost m where
- liftBlockfrostClient :: ClientM a -> m a
- getConf :: m ClientConfig
runBlockfrostClientT :: MonadIO m => Project -> BlockfrostClientT m a -> m ( Either BlockfrostError a)
newClientConfig :: MonadIO m => m ClientConfig

Documentation

type BlockfrostClient = BlockfrostClientT IO Source #

data BlockfrostError Source #

Constructors

BlockfrostError Text
BlockfrostBadRequest Text
BlockfrostTokenMissing Text
BlockfrostNotFound
BlockfrostIPBanned
BlockfrostUsageLimitReached
BlockfrostFatal Text
ServantClientError ClientError

Instances

Instances details

Eq BlockfrostError
Instance details Defined in Blockfrost.Client.Core Methods (==) :: BlockfrostError -> BlockfrostError -> Bool Source # (/=) :: BlockfrostError -> BlockfrostError -> Bool Source #
Show BlockfrostError
Instance details Defined in Blockfrost.Client.Core Methods showsPrec :: Int -> BlockfrostError -> ShowS Source # show :: BlockfrostError -> String Source # showList :: [ BlockfrostError ] -> ShowS Source #
Monad m => MonadError BlockfrostError ( BlockfrostClientT m) Source #
Instance details Defined in Blockfrost.Client.Types Methods throwError :: BlockfrostError -> BlockfrostClientT m a Source # catchError :: BlockfrostClientT m a -> ( BlockfrostError -> BlockfrostClientT m a) -> BlockfrostClientT m a Source #

type ClientConfig = ( ClientEnv , Project ) Source #

runBlockfrost :: Project -> BlockfrostClientT IO a -> IO ( Either BlockfrostError a) Source #

Run BlockfrostClientT monad in IO , using provided Project

apiClient :: MonadBlockfrost m => BlockfrostAPI ( AsClientT m) Source #

api0Client :: MonadBlockfrost m => Project -> BlockfrostV0API ( AsClientT m) Source #

commonClient :: MonadBlockfrost m => Project -> CommonAPI ( AsClientT m) Source #

cardanoClient :: MonadBlockfrost m => Project -> CardanoAPI ( AsClientT m) Source #

ipfsClient :: MonadBlockfrost m => Project -> IPFSAPI ( AsClientT m) Source #

nutLinkClient :: MonadBlockfrost m => Project -> NutLinkAPI ( AsClientT m) Source #

data Project Source #

Constructors

Project
Fields projectEnv :: Env projectId :: Text

Instances

Instances details

Eq Project
Instance details Defined in Blockfrost.Auth Methods (==) :: Project -> Project -> Bool Source # (/=) :: Project -> Project -> Bool Source #
Show Project
Instance details Defined in Blockfrost.Auth Methods showsPrec :: Int -> Project -> ShowS Source # show :: Project -> String Source # showList :: [ Project ] -> ShowS Source #
IsString Project
Instance details Defined in Blockfrost.Auth Methods fromString :: String -> Project Source #
Generic Project
Instance details Defined in Blockfrost.Auth Associated Types type Rep Project :: Type -> Type Source # Methods from :: Project -> Rep Project x Source # to :: Rep Project x -> Project Source #
Monad m => MonadReader ClientConfig ( BlockfrostClientT m) Source #
Instance details Defined in Blockfrost.Client.Types Methods ask :: BlockfrostClientT m ClientConfig Source # local :: ( ClientConfig -> ClientConfig ) -> BlockfrostClientT m a -> BlockfrostClientT m a Source # reader :: ( ClientConfig -> a) -> BlockfrostClientT m a Source #
type Rep Project
Instance details Defined in Blockfrost.Auth type Rep Project = D1 (' MetaData "Project" "Blockfrost.Auth" "blockfrost-api-0.4.0.1-A9W5au7R2kOUA8M8hTMe9" ' False ) ( C1 (' MetaCons "Project" ' PrefixI ' True ) ( S1 (' MetaSel (' Just "projectEnv") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Env ) :*: S1 (' MetaSel (' Just "projectId") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Text )))

data Paged Source #

Pagination parameters

Constructors

Paged
Fields countPerPage :: Int Count of results per page pageNumber :: Int Page number

Instances

Instances details

Eq Paged
Instance details Defined in Blockfrost.Util.Pagination Methods (==) :: Paged -> Paged -> Bool Source # (/=) :: Paged -> Paged -> Bool Source #
Ord Paged
Instance details Defined in Blockfrost.Util.Pagination Methods compare :: Paged -> Paged -> Ordering Source # (<) :: Paged -> Paged -> Bool Source # (<=) :: Paged -> Paged -> Bool Source # (>) :: Paged -> Paged -> Bool Source # (>=) :: Paged -> Paged -> Bool Source # max :: Paged -> Paged -> Paged Source # min :: Paged -> Paged -> Paged Source #
Show Paged
Instance details Defined in Blockfrost.Util.Pagination Methods showsPrec :: Int -> Paged -> ShowS Source # show :: Paged -> String Source # showList :: [ Paged ] -> ShowS Source #
Default Paged
Instance details Defined in Blockfrost.Util.Pagination Methods def :: Paged Source #

data SortOrder Source #

Constructors

Ascending
Descending

Instances

Instances details

Eq SortOrder
Instance details Defined in Blockfrost.Util.Sorting Methods (==) :: SortOrder -> SortOrder -> Bool Source # (/=) :: SortOrder -> SortOrder -> Bool Source #
Ord SortOrder
Instance details Defined in Blockfrost.Util.Sorting Methods compare :: SortOrder -> SortOrder -> Ordering Source # (<) :: SortOrder -> SortOrder -> Bool Source # (<=) :: SortOrder -> SortOrder -> Bool Source # (>) :: SortOrder -> SortOrder -> Bool Source # (>=) :: SortOrder -> SortOrder -> Bool Source # max :: SortOrder -> SortOrder -> SortOrder Source # min :: SortOrder -> SortOrder -> SortOrder Source #
Show SortOrder
Instance details Defined in Blockfrost.Util.Sorting Methods showsPrec :: Int -> SortOrder -> ShowS Source # show :: SortOrder -> String Source # showList :: [ SortOrder ] -> ShowS Source #
Default SortOrder
Instance details Defined in Blockfrost.Util.Sorting Methods def :: SortOrder Source #
ToHttpApiData SortOrder
Instance details Defined in Blockfrost.Util.Sorting Methods toUrlPiece :: SortOrder -> Text Source # toEncodedUrlPiece :: SortOrder -> Builder Source # toHeader :: SortOrder -> ByteString Source # toQueryParam :: SortOrder -> Text Source #
FromHttpApiData SortOrder
Instance details Defined in Blockfrost.Util.Sorting Methods parseUrlPiece :: Text -> Either Text SortOrder Source # parseHeader :: ByteString -> Either Text SortOrder Source # parseQueryParam :: Text -> Either Text SortOrder Source #

go :: MonadBlockfrost m => ( Project -> m a) -> m a Source #

Helper

data AsClientT (m :: Type -> Type ) Source #

A type that specifies that an API record contains a client implementation.

Instances

Instances details

GenericMode ( AsClientT m)
Instance details Defined in Servant.Client.Core.HasClient Associated Types type ( AsClientT m) :- api Source #
type ( AsClientT m) :- api
Instance details Defined in Servant.Client.Core.HasClient type ( AsClientT m) :- api = Client m api

fromServant :: GenericServant routes mode => ToServant routes mode -> routes mode Source #

Inverse of toServant .

This can be used to turn generated values such as client functions into records.

You may need to provide a type signature for the output type (your record type).

tryError :: MonadError e m => m a -> m ( Either e a) Source #

MonadError analogue to the try function.

def :: Default a => a Source #

The default value for this type.

newtype BlockfrostClientT m a Source #

Constructors

BlockfrostClientT
Fields unBlockfrostClientT :: ExceptT BlockfrostError ( ReaderT ClientConfig m) a

Instances

Instances details

Monad m => MonadReader ClientConfig ( BlockfrostClientT m) Source #
Instance details Defined in Blockfrost.Client.Types Methods ask :: BlockfrostClientT m ClientConfig Source # local :: ( ClientConfig -> ClientConfig ) -> BlockfrostClientT m a -> BlockfrostClientT m a Source # reader :: ( ClientConfig -> a) -> BlockfrostClientT m a Source #
Monad m => MonadError BlockfrostError ( BlockfrostClientT m) Source #
Instance details Defined in Blockfrost.Client.Types Methods throwError :: BlockfrostError -> BlockfrostClientT m a Source # catchError :: BlockfrostClientT m a -> ( BlockfrostError -> BlockfrostClientT m a) -> BlockfrostClientT m a Source #
Monad m => Monad ( BlockfrostClientT m) Source #
Instance details Defined in Blockfrost.Client.Types Methods (>>=) :: BlockfrostClientT m a -> (a -> BlockfrostClientT m b) -> BlockfrostClientT m b Source # (>>) :: BlockfrostClientT m a -> BlockfrostClientT m b -> BlockfrostClientT m b Source # return :: a -> BlockfrostClientT m a Source #
Functor m => Functor ( BlockfrostClientT m) Source #
Instance details Defined in Blockfrost.Client.Types Methods fmap :: (a -> b) -> BlockfrostClientT m a -> BlockfrostClientT m b Source # (<$) :: a -> BlockfrostClientT m b -> BlockfrostClientT m a Source #
Monad m => Applicative ( BlockfrostClientT m) Source #
Instance details Defined in Blockfrost.Client.Types Methods pure :: a -> BlockfrostClientT m a Source # (<>) :: BlockfrostClientT m (a -> b) -> BlockfrostClientT m a -> BlockfrostClientT m b Source # liftA2 :: (a -> b -> c) -> BlockfrostClientT m a -> BlockfrostClientT m b -> BlockfrostClientT m c Source # (>) :: BlockfrostClientT m a -> BlockfrostClientT m b -> BlockfrostClientT m b Source # (<*) :: BlockfrostClientT m a -> BlockfrostClientT m b -> BlockfrostClientT m a Source #
MonadIO m => MonadIO ( BlockfrostClientT m) Source #
Instance details Defined in Blockfrost.Client.Types Methods liftIO :: IO a -> BlockfrostClientT m a Source #
MonadIO m => MonadBlockfrost ( BlockfrostClientT m) Source #
Instance details Defined in Blockfrost.Client.Types Methods liftBlockfrostClient :: ClientM a -> BlockfrostClientT m a Source # getConf :: BlockfrostClientT m ClientConfig Source #

class MonadIO m => MonadBlockfrost m where Source #

Methods

liftBlockfrostClient :: ClientM a -> m a Source #

getConf :: m ClientConfig Source #

Instances

Instances details

MonadBlockfrost IO Source #
Instance details Defined in Blockfrost.Client.Types Methods liftBlockfrostClient :: ClientM a -> IO a Source # getConf :: IO ClientConfig Source #
MonadBlockfrost ClientM Source #
Instance details Defined in Blockfrost.Client.Types Methods liftBlockfrostClient :: ClientM a -> ClientM a Source # getConf :: ClientM ClientConfig Source #
MonadIO m => MonadBlockfrost ( BlockfrostClientT m) Source #
Instance details Defined in Blockfrost.Client.Types Methods liftBlockfrostClient :: ClientM a -> BlockfrostClientT m a Source # getConf :: BlockfrostClientT m ClientConfig Source #

runBlockfrostClientT :: MonadIO m => Project -> BlockfrostClientT m a -> m ( Either BlockfrostError a) Source #

Run BlockfrostClientT , using provided Project

newClientConfig :: MonadIO m => m ClientConfig Source #

Build default ClientConfig using BLOCKFROST_TOKEN_PATH environment variable