Safe Haskell	None
Language	Haskell2010

Blockfrost.Auth

Description

Blockfrost authentication schemes

Synopsis

data APIKeyInHeader (headerName :: Symbol )
newtype APIKeyInHeaderSettings = APIKeyInHeaderSettings {
- apiKeySettingsQueryProject :: Text -> IO ( Maybe Project )
}
data Env
- = Ipfs
- | Mainnet
- | Testnet
- | Localhost
data Project = Project {
- projectEnv :: Env
- projectId :: Text
}
data ProjectAuth (auths :: [ Type ]) val
mkProject :: Text -> Project
mkProjectEnv :: Env -> Text -> Project

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 apiKeySettingsQueryProject :: Text -> IO ( Maybe Project )

data Env Source #

Blockfrost environments

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

Constructors

Ipfs
Mainnet
Testnet
Localhost

Instances

Instances details

Eq Env Source #
Instance details Defined in Blockfrost.Env Methods (==) :: Env -> Env -> Bool Source # (/=) :: Env -> Env -> Bool Source #
Ord Env Source #
Instance details Defined in Blockfrost.Env Methods compare :: Env -> Env -> Ordering Source # (<) :: Env -> Env -> Bool Source # (<=) :: Env -> Env -> Bool Source # (>) :: Env -> Env -> Bool Source # (>=) :: Env -> Env -> Bool Source # max :: Env -> Env -> Env Source # min :: Env -> Env -> Env Source #
Read Env Source #
Instance details Defined in Blockfrost.Env Methods readsPrec :: Int -> ReadS Env Source # readList :: ReadS [ Env ] Source # readPrec :: ReadPrec Env Source # readListPrec :: ReadPrec [ Env ] Source #
Show Env Source #
Instance details Defined in Blockfrost.Env Methods showsPrec :: Int -> Env -> ShowS Source # show :: Env -> String Source # showList :: [ Env ] -> ShowS Source #
Generic Env Source #
Instance details Defined in Blockfrost.Env Associated Types type Rep Env :: Type -> Type Source # Methods from :: Env -> Rep Env x Source # to :: Rep Env x -> Env Source #
type Rep Env Source #
Instance details Defined in Blockfrost.Env type Rep Env = D1 (' MetaData "Env" "Blockfrost.Env" "blockfrost-api-0.4.0.1-A9W5au7R2kOUA8M8hTMe9" ' 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 "Localhost" ' PrefixI ' False ) ( U1 :: Type -> Type )))

data Project Source #

Constructors

Project
Fields projectEnv :: Env projectId :: Text

Instances

Instances details

Eq Project Source #
Instance details Defined in Blockfrost.Auth Methods (==) :: Project -> Project -> Bool Source # (/=) :: Project -> Project -> Bool Source #
Show Project Source #
Instance details Defined in Blockfrost.Auth Methods showsPrec :: Int -> Project -> ShowS Source # show :: Project -> String Source # showList :: [ Project ] -> ShowS Source #
IsString Project Source #
Instance details Defined in Blockfrost.Auth Methods fromString :: String -> Project Source #
Generic Project Source #
Instance details Defined in Blockfrost.Auth Associated Types type Rep Project :: Type -> Type Source # Methods from :: Project -> Rep Project x Source # to :: Rep Project x -> Project Source #
type Rep Project Source #
Instance details Defined in Blockfrost.Auth type Rep Project = D1 (' MetaData "Project" "Blockfrost.Auth" "blockfrost-api-0.4.0.1-A9W5au7R2kOUA8M8hTMe9" ' 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 Source #

Instances

Instances details

HasLink sub => HasLink ( ProjectAuth tag value :> sub :: Type ) Source #
Instance details Defined in Blockfrost.Auth Associated Types type MkLink ( ProjectAuth tag value :> sub) a Source # Methods toLink :: ( Link -> a) -> Proxy ( ProjectAuth tag value :> sub) -> Link -> MkLink ( ProjectAuth tag value :> sub) a Source #
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