Blockfrost.Client.Types

Client Types

Documentation

type BlockfrostClient = ExceptT BlockfrostError (ReaderT ClientConfig IO)

data BlockfrostError

Constructors

BlockfrostError Text

BlockfrostBadRequest Text

BlockfrostTokenMissing Text

BlockfrostNotFound

BlockfrostIPBanned

BlockfrostUsageLimitReached

BlockfrostFatal Text

ServantClientError ClientError

Instances

Eq BlockfrostError

Defined in Blockfrost.Client.Core

Methods

(==) :: BlockfrostError -> BlockfrostError -> Bool

(/=) :: BlockfrostError -> BlockfrostError -> Bool

Show BlockfrostError

Defined in Blockfrost.Client.Core

Methods

showsPrec :: Int -> BlockfrostError -> ShowS

show :: BlockfrostError -> String

showList :: [BlockfrostError] -> ShowS

type ClientConfig = (ClientEnv, Project)

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

Run BlockfrostClient monad, using provided Project

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

Constructors

Project

Fields

• projectEnv :: Env
• projectId :: Text

Instances

Eq Project

Defined in Blockfrost.Auth

Methods

(==) :: Project -> Project -> Bool

(/=) :: Project -> Project -> Bool

Show Project

Defined in Blockfrost.Auth

Methods

showsPrec :: Int -> Project -> ShowS

show :: Project -> String

showList :: [Project] -> ShowS

IsString Project

Defined in Blockfrost.Auth

Methods

fromString :: String -> Project

Generic Project

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

Defined in Blockfrost.Auth

type Rep Project = D1 ('MetaData "Project" "Blockfrost.Auth" "blockfrost-api-0.1.0.0-IUovSY8qZrZI80mAb9CnjM" '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

Eq Paged

Defined in Blockfrost.Util.Pagination

Methods

(==) :: Paged -> Paged -> Bool

(/=) :: Paged -> Paged -> Bool

Ord Paged

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

Defined in Blockfrost.Util.Pagination

Methods

showsPrec :: Int -> Paged -> ShowS

show :: Paged -> String

showList :: [Paged] -> ShowS

Default Paged

Defined in Blockfrost.Util.Pagination

Methods

def :: Paged

data SortOrder

Constructors

Ascending

Descending

Instances

Eq SortOrder

Defined in Blockfrost.Util.Sorting

Methods

(==) :: SortOrder -> SortOrder -> Bool

(/=) :: SortOrder -> SortOrder -> Bool

Ord SortOrder

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

Defined in Blockfrost.Util.Sorting

Methods

showsPrec :: Int -> SortOrder -> ShowS

show :: SortOrder -> String

showList :: [SortOrder] -> ShowS

Default SortOrder

Defined in Blockfrost.Util.Sorting

Methods

def :: SortOrder

ToHttpApiData SortOrder

Defined in Blockfrost.Util.Sorting

Methods

toUrlPiece :: SortOrder -> Text

toEncodedUrlPiece :: SortOrder -> Builder

toHeader :: SortOrder -> ByteString

toQueryParam :: SortOrder -> Text

FromHttpApiData SortOrder

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

Helper

data AsClientT (m :: Type -> Type)

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

Instances

GenericMode (AsClientT m)

Defined in Servant.Client.Generic

Associated Types

type (AsClientT m) :- api

type (AsClientT m) :- api

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)

MonadError analogue to the try function.

def :: Default a => a

The default value for this type.