Safe Haskell	None
Language	Haskell2010

Blockfrost.Client.Types

Description

Client Types

Synopsis

type BlockfrostClient = ExceptT BlockfrostError (ReaderT ClientConfig IO)
data BlockfrostError
type ClientConfig = (ClientEnv, Project)
runBlockfrost :: Project -> BlockfrostClient a -> IO (Either BlockfrostError a)
apiClient :: BlockfrostAPI (AsClientT BlockfrostClient)
api0Client :: Project -> BlockfrostV0API (AsClientT BlockfrostClient)
commonClient :: Project -> CommonAPI (AsClientT BlockfrostClient)
cardanoClient :: Project -> CardanoAPI (AsClientT BlockfrostClient)
ipfsClient :: Project -> IPFSAPI (AsClientT BlockfrostClient)
nutLinkClient :: Project -> NutLinkAPI (AsClientT BlockfrostClient)
data Project = Project {
- projectEnv :: Env
- projectId :: Text
}
data Paged = Paged {
- countPerPage :: Int
- pageNumber :: Int
}
data SortOrder
- = Ascending
- | Descending
go :: (Project -> BlockfrostClient a) -> BlockfrostClient 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

Documentation

type BlockfrostClient = ExceptT BlockfrostError (ReaderT ClientConfig IO) Source #

data BlockfrostError #

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 # (/=) :: BlockfrostError -> BlockfrostError -> Bool #
Show BlockfrostError
Instance details Defined in Blockfrost.Client.Core Methods showsPrec :: Int -> BlockfrostError -> ShowS # show :: BlockfrostError -> String # showList :: [BlockfrostError] -> ShowS #

type ClientConfig = (ClientEnv, Project) Source #

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

Run BlockfrostClient monad, using provided Project

apiClient :: BlockfrostAPI (AsClientT BlockfrostClient) Source #

api0Client :: Project -> BlockfrostV0API (AsClientT BlockfrostClient) Source #

commonClient :: Project -> CommonAPI (AsClientT BlockfrostClient) Source #

cardanoClient :: Project -> CardanoAPI (AsClientT BlockfrostClient) Source #

ipfsClient :: Project -> IPFSAPI (AsClientT BlockfrostClient) Source #

nutLinkClient :: Project -> NutLinkAPI (AsClientT BlockfrostClient) Source #

data Project #

Constructors

Project
Fields projectEnv :: Env projectId :: Text

Instances

Instances details

Eq Project
Instance details Defined in Blockfrost.Auth Methods (==) :: Project -> Project -> Bool # (/=) :: Project -> Project -> Bool #
Show Project
Instance details Defined in Blockfrost.Auth Methods showsPrec :: Int -> Project -> ShowS # show :: Project -> String # showList :: [Project] -> ShowS #
IsString Project
Instance details Defined in Blockfrost.Auth Methods fromString :: String -> Project #
Generic Project
Instance details Defined in Blockfrost.Auth Associated Types type Rep Project :: Type -> Type # Methods from :: Project -> Rep Project x # to :: Rep Project x -> Project #
type Rep Project
Instance details Defined in Blockfrost.Auth type Rep Project = D1 ('MetaData "Project" "Blockfrost.Auth" "blockfrost-api-0.2.0.0-Hsre1z6A3K049l5HFlEppT" '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 #

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

data SortOrder #

Constructors

Ascending
Descending

Instances

Instances details

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

go :: (Project -> BlockfrostClient a) -> BlockfrostClient a Source #

Helper

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

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

Instances

Instances details

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

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

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 #

The default value for this type.