Blockfrost.Auth

Blockfrost authentication schemes

Documentation

data APIKeyInHeader (headerName :: Symbol)

The type of Auth scheme.

newtype APIKeyInHeaderSettings

Auth scheme settings Needs IO action to verify passed in token and maybe return Project

Constructors

APIKeyInHeaderSettings

Fields

• apiKeySettingsQueryProject :: Text -> IO (Maybe Project)

data Env

Blockfrost environments

Corresponds to Network when creating a Blockfrost project. Each environment has separate token.

Constructors

Ipfs

Mainnet

Testnet

Preprod

Preview

Sanchonet

Localhost

Instances

Generic Env

Defined in Blockfrost.Env

Associated Types

type Rep Env :: Type -> Type

Methods

from :: Env -> Rep Env x

to :: Rep Env x -> Env

Read Env

Defined in Blockfrost.Env

Methods

readsPrec :: Int -> ReadS Env

readList :: ReadS [Env]

readPrec :: ReadPrec Env

readListPrec :: ReadPrec [Env]

Show Env

Defined in Blockfrost.Env

Methods

showsPrec :: Int -> Env -> ShowS

show :: Env -> String

showList :: [Env] -> ShowS

Eq Env

Defined in Blockfrost.Env

Methods

(==) :: Env -> Env -> Bool

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

Ord Env

Defined in Blockfrost.Env

Methods

compare :: Env -> Env -> Ordering

(<) :: Env -> Env -> Bool

(<=) :: Env -> Env -> Bool

(>) :: Env -> Env -> Bool

(>=) :: Env -> Env -> Bool

max :: Env -> Env -> Env

min :: Env -> Env -> Env

type Rep Env

Defined in Blockfrost.Env

type Rep Env = D1 ('MetaData "Env" "Blockfrost.Env" "blockfrost-api-0.11.0.0-2jNq3H6sEubDGpTeuodF8r" 'False) ((C1 ('MetaCons "Ipfs" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Mainnet" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Testnet" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "Preprod" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Preview" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Sanchonet" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Localhost" 'PrefixI 'False) (U1 :: Type -> Type))))

data Project

Constructors

Project

Fields

• projectEnv :: Env
• projectId :: Text

Instances

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

Show Project

Defined in Blockfrost.Auth

Methods

showsPrec :: Int -> Project -> ShowS

show :: Project -> String

showList :: [Project] -> ShowS

Eq Project

Defined in Blockfrost.Auth

Methods

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

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

type Rep Project

Defined in Blockfrost.Auth

type Rep Project = D1 ('MetaData "Project" "Blockfrost.Auth" "blockfrost-api-0.11.0.0-2jNq3H6sEubDGpTeuodF8r" '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 ProjectAuth (auths :: [Type]) val

Instances

HasLink sub => HasLink (ProjectAuth tag value :> sub :: Type)

Defined in Blockfrost.Auth

Associated Types

type MkLink (ProjectAuth tag value :> sub) a

Methods

toLink :: (Link -> a) -> Proxy (ProjectAuth tag value :> sub) -> Link -> MkLink (ProjectAuth tag value :> sub) a

type MkLink (ProjectAuth tag value :> sub :: Type) r

Defined in Blockfrost.Auth

type MkLink (ProjectAuth tag value :> sub :: Type) r = MkLink sub r

mkProject :: Text -> Project

Parse Project from Text or fail with error

mkProjectEnv :: Env -> Text -> Project

Project constructor