blockfrost-api-0.14.0.0: API definitions for blockfrost.io
Safe HaskellNone
LanguageHaskell2010

Blockfrost.Auth

Description

Blockfrost authentication schemes

Synopsis

Documentation

data APIKeyInHeader (headerName :: Symbol) Source #

The type of Auth scheme.

newtype APIKeyInHeaderSettings Source #

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

Constructors

APIKeyInHeaderSettings 

Fields

data Env Source #

Blockfrost environments

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

Constructors

Ipfs 
Mainnet 
Testnet 
Preprod 
Preview 
Localhost 
CustomURL String

Full URL to custom Blockfrost instance

Instances

Instances details
Generic Env Source # 
Instance details

Defined in Blockfrost.Env

Associated Types

type Rep Env 
Instance details

Defined in Blockfrost.Env

type Rep Env = D1 ('MetaData "Env" "Blockfrost.Env" "blockfrost-api-0.14.0.0-EOEPNng3ChUIo9pM8WY4OK" '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 "Localhost" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CustomURL" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))))

Methods

from :: Env -> Rep Env x #

to :: Rep Env x -> Env #

Read Env Source # 
Instance details

Defined in Blockfrost.Env

Methods

readsPrec :: Int -> ReadS Env #

readList :: ReadS [Env] #

readPrec :: ReadPrec Env #

readListPrec :: ReadPrec [Env] #

Show Env Source # 
Instance details

Defined in Blockfrost.Env

Methods

showsPrec :: Int -> Env -> ShowS #

show :: Env -> String #

showList :: [Env] -> ShowS #

Eq Env Source # 
Instance details

Defined in Blockfrost.Env

Methods

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

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

Ord Env Source # 
Instance details

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 Source # 
Instance details

Defined in Blockfrost.Env

type Rep Env = D1 ('MetaData "Env" "Blockfrost.Env" "blockfrost-api-0.14.0.0-EOEPNng3ChUIo9pM8WY4OK" '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 "Localhost" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "CustomURL" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))))

data Project Source #

Constructors

Project 

Fields

Instances

Instances details
IsString Project Source # 
Instance details

Defined in Blockfrost.Auth

Methods

fromString :: String -> Project #

Generic Project Source # 
Instance details

Defined in Blockfrost.Auth

Associated Types

type Rep Project 
Instance details

Defined in Blockfrost.Auth

type Rep Project = D1 ('MetaData "Project" "Blockfrost.Auth" "blockfrost-api-0.14.0.0-EOEPNng3ChUIo9pM8WY4OK" 'False) (C1 ('MetaCons "Project" 'PrefixI 'True) (S1 ('MetaSel ('Just "projectEnv") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Env) :*: S1 ('MetaSel ('Just "projectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: Project -> Rep Project x #

to :: Rep Project x -> Project #

Show Project Source # 
Instance details

Defined in Blockfrost.Auth

Methods

showsPrec :: Int -> Project -> ShowS #

show :: Project -> String #

showList :: [Project] -> ShowS #

Eq Project Source # 
Instance details

Defined in Blockfrost.Auth

Methods

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

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

type Rep Project Source # 
Instance details

Defined in Blockfrost.Auth

type Rep Project = D1 ('MetaData "Project" "Blockfrost.Auth" "blockfrost-api-0.14.0.0-EOEPNng3ChUIo9pM8WY4OK" '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 :: k) Source #

Instances

Instances details
HasLink sub => HasLink (ProjectAuth tag value :> sub :: Type) Source # 
Instance details

Defined in Blockfrost.Auth

Methods

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

type MkLink (ProjectAuth tag value :> sub :: Type) r Source # 
Instance details

Defined in Blockfrost.Auth

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

mkProject :: Text -> Project Source #

Parse Project from Text or fail with error

mkProjectEnv :: Env -> Text -> Project Source #

Project constructor