Blockfrost.Client.Core

Core shared by clients

Documentation

data BlockfrostError

Constructors

BlockfrostError Text

BlockfrostBadRequest Text

BlockfrostTokenMissing Text

BlockfrostNotFound

BlockfrostIPBanned

BlockfrostMempoolFullOrPinQueueFull

BlockfrostUsageLimitReached

BlockfrostFatal Text

ServantClientError ClientError

Instances

Show BlockfrostError

Defined in Blockfrost.Client.Core

Methods

showsPrec :: Int -> BlockfrostError -> ShowS

show :: BlockfrostError -> String

showList :: [BlockfrostError] -> ShowS

Eq BlockfrostError

Defined in Blockfrost.Client.Core

Methods

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

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

data Paged

Pagination parameters

Constructors

Paged

Fields

• countPerPage :: Int

  Count of results per page

• pageNumber :: Int

  Page number

Instances

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

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

data SortOrder

Constructors

Ascending

Descending

Instances

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

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

FromHttpApiData SortOrder

Defined in Blockfrost.Util.Sorting

Methods

parseUrlPiece :: Text -> Either Text SortOrder

parseHeader :: ByteString -> Either Text SortOrder

parseQueryParam :: Text -> Either Text SortOrder

ToHttpApiData SortOrder

Defined in Blockfrost.Util.Sorting

Methods

toUrlPiece :: SortOrder -> Text

toEncodedUrlPiece :: SortOrder -> Builder

toHeader :: SortOrder -> ByteString

toQueryParam :: SortOrder -> Text

toEncodedQueryParam :: SortOrder -> Builder

asc :: SortOrder

Ascending shortcut

def :: Default a => a

The default value for this type.

desc :: SortOrder

Descending shortcut

fromServantClientError :: ClientError -> BlockfrostError

newEnvByProject :: Project -> IO ClientEnv

page :: Int -> Paged

Default Paged at specific page number

paged :: Int -> Int -> Paged

Construct Paged from page size and page number.

Throws error on invalid values.

allPages :: Monad m => (Paged -> m [a]) -> m [a]

Query all results, until we get less than maximum items per page.

nextPage :: Paged -> Paged

Increment page number

projectFromEnv :: IO Project

Read file according to BLOCKFROST_TOKEN_PATH environment variable name.

projectFromEnv' :: String -> IO Project

Read file according to environment variable name.

projectFromFile :: FilePath -> IO Project

Read file with token and turn it into Project Expects tokens prefixed with environment, e.g. testnetA3C2E...

Orphan instances

ToMultipart Tmp Form

Methods

toMultipart :: Form -> MultipartData Tmp