Haskell SDK for Blockfrost.io API.
About • Getting started • Installation • Usage
The repository provides an API definition, data types, client and utilities for working with Blockfrost. We are striving to provide beginner-friendly interface while adding a bit of type safety, especially when working with monetary values.
blockfrost-apiTypes, sample data, API definition and tests. See theREADME.mdfor quick tutorialblockfrost-client-coreInstances and helpers shared by all clients.blockfrost-clientBlockfrost client for use withmtl. ItsREADME.mdcontains an introduction and usage examples.blockfrost-prettyPretty printing utilities for pretty printing Ada values and various Blockfrost types.
To use this SDK, you first need to log in to blockfrost.io, create your project and retrieve the API token.
Packages are available on Hackage, you only need to add blockfrost-client
to your package dependencies.
Haddocks available on Hackage:
You can either work within this repository using plain cabal or in combination
with nix.
If you already have GHC and cabal installed:
git clone https://github.com/blockfrost/blockfrost-haskell
cd blockfrost-haskell
cabal update
cabal build all
cabal repl blockfrost-clientNote: Due to TLS support, you might need to
provide zlib headers if compilation
of http-client-tls fails. (On NixOS this is nix-shell -p zlib.dev).
Using nix-shell, you can obtain a preconfigured environment
with GHC and cabal:
git clone https://github.com/blockfrost/blockfrost-haskell
cd blockfrost-haskell
nix-shell
cabal build all
cabal repl blockfrost-clientSee blockfrost-client for a tutorial and usage examples.
Readme of blockfrost-api contains a short primer for working with Blockfrost types, data samples and monetary values.