Blockfrost.Client.Types

Client Types

Documentation

type BlockfrostClient = BlockfrostClientT 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

Monad m => MonadError BlockfrostError (BlockfrostClientT m)

Defined in Blockfrost.Client.Types

Methods

throwError :: BlockfrostError -> BlockfrostClientT m a

catchError :: BlockfrostClientT m a -> (BlockfrostError -> BlockfrostClientT m a) -> BlockfrostClientT m a

type ClientConfig = (ClientEnv, Project)

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

Run BlockfrostClientT monad in IO, using provided Project

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

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

Monad m => MonadReader ClientConfig (BlockfrostClientT m)

Defined in Blockfrost.Client.Types

Methods

ask :: BlockfrostClientT m ClientConfig

local :: (ClientConfig -> ClientConfig) -> BlockfrostClientT m a -> BlockfrostClientT m a

reader :: (ClientConfig -> a) -> BlockfrostClientT m a

type Rep Project

Defined in Blockfrost.Auth

type Rep Project = D1 ('MetaData "Project" "Blockfrost.Auth" "blockfrost-api-0.4.0.1-9IppWzogtB2Kw5eDV4M9U" '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 :: MonadBlockfrost m => (Project -> m a) -> m 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.Core.HasClient

Associated Types

type (AsClientT m) :- api

type (AsClientT m) :- api

Defined in Servant.Client.Core.HasClient

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.

newtype BlockfrostClientT m a

Constructors

BlockfrostClientT

Fields

• unBlockfrostClientT :: ExceptT BlockfrostError (ReaderT ClientConfig m) a

Instances

Monad m => MonadReader ClientConfig (BlockfrostClientT m)

Defined in Blockfrost.Client.Types

Methods

ask :: BlockfrostClientT m ClientConfig

local :: (ClientConfig -> ClientConfig) -> BlockfrostClientT m a -> BlockfrostClientT m a

reader :: (ClientConfig -> a) -> BlockfrostClientT m a

Monad m => MonadError BlockfrostError (BlockfrostClientT m)

Defined in Blockfrost.Client.Types

Methods

throwError :: BlockfrostError -> BlockfrostClientT m a

catchError :: BlockfrostClientT m a -> (BlockfrostError -> BlockfrostClientT m a) -> BlockfrostClientT m a

Monad m => Monad (BlockfrostClientT m)

Defined in Blockfrost.Client.Types

Methods

(>>=) :: BlockfrostClientT m a -> (a -> BlockfrostClientT m b) -> BlockfrostClientT m b

(>>) :: BlockfrostClientT m a -> BlockfrostClientT m b -> BlockfrostClientT m b

return :: a -> BlockfrostClientT m a

Functor m => Functor (BlockfrostClientT m)

Defined in Blockfrost.Client.Types

Methods

fmap :: (a -> b) -> BlockfrostClientT m a -> BlockfrostClientT m b

(<$) :: a -> BlockfrostClientT m b -> BlockfrostClientT m a

Monad m => Applicative (BlockfrostClientT m)

Defined in Blockfrost.Client.Types

Methods

pure :: a -> BlockfrostClientT m a

(<*>) :: BlockfrostClientT m (a -> b) -> BlockfrostClientT m a -> BlockfrostClientT m b

liftA2 :: (a -> b -> c) -> BlockfrostClientT m a -> BlockfrostClientT m b -> BlockfrostClientT m c

(*>) :: BlockfrostClientT m a -> BlockfrostClientT m b -> BlockfrostClientT m b

(<*) :: BlockfrostClientT m a -> BlockfrostClientT m b -> BlockfrostClientT m a

MonadIO m => MonadIO (BlockfrostClientT m)

Defined in Blockfrost.Client.Types

Methods

liftIO :: IO a -> BlockfrostClientT m a

MonadIO m => MonadBlockfrost (BlockfrostClientT m)

Defined in Blockfrost.Client.Types

Methods

liftBlockfrostClient :: ClientM a -> BlockfrostClientT m a

getConf :: BlockfrostClientT m ClientConfig

class MonadIO m => MonadBlockfrost m where

Methods

liftBlockfrostClient :: ClientM a -> m a

getConf :: m ClientConfig

Instances

MonadBlockfrost IO

Defined in Blockfrost.Client.Types

Methods

liftBlockfrostClient :: ClientM a -> IO a

getConf :: IO ClientConfig

MonadBlockfrost ClientM

Defined in Blockfrost.Client.Types

Methods

liftBlockfrostClient :: ClientM a -> ClientM a

getConf :: ClientM ClientConfig

MonadIO m => MonadBlockfrost (BlockfrostClientT m)

Defined in Blockfrost.Client.Types

Methods

liftBlockfrostClient :: ClientM a -> BlockfrostClientT m a

getConf :: BlockfrostClientT m ClientConfig

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

Run BlockfrostClientT, using provided Project

newClientConfig :: MonadIO m => m ClientConfig

Build default ClientConfig using BLOCKFROST_TOKEN_PATH environment variable