RFC.Client.Coinhive

Client to access API of Coinhive: https://coinhive.com/documentation/http-api

Documentation

newtype SecretKey

Constructors

SecretKey String

Instances

ToJSON SecretKey

Methods

toJSON :: SecretKey -> Value

toEncoding :: SecretKey -> Encoding

toJSONList :: [SecretKey] -> Value

toEncodingList :: [SecretKey] -> Encoding

FromJSON SecretKey

Methods

parseJSON :: Value -> Parser SecretKey

parseJSONList :: Value -> Parser [SecretKey]

newtype TokenId

Constructors

TokenId String

Instances

ToJSON TokenId

Methods

toJSON :: TokenId -> Value

toEncoding :: TokenId -> Encoding

toJSONList :: [TokenId] -> Value

toEncodingList :: [TokenId] -> Encoding

FromJSON TokenId

Methods

parseJSON :: Value -> Parser TokenId

parseJSONList :: Value -> Parser [TokenId]

data TokenVerification

Constructors

TokenVerification

Fields

• tvSuccess :: Bool
• tvHashes :: Integer
• tvCreated :: Integer
• tvError :: Maybe String

Instances

ToJSON TokenVerification

Methods

toJSON :: TokenVerification -> Value

toEncoding :: TokenVerification -> Encoding

toJSONList :: [TokenVerification] -> Value

toEncodingList :: [TokenVerification] -> Encoding

FromJSON TokenVerification

Methods

parseJSON :: Value -> Parser TokenVerification

parseJSONList :: Value -> Parser [TokenVerification]

data TokenVerifyRequest

Constructors

TokenVerifyRequest

Fields

• tvrSecret :: SecretKey
• tvrToken :: TokenId
• tvrHashes :: Integer

Instances

ToJSON TokenVerifyRequest

Methods

toJSON :: TokenVerifyRequest -> Value

toEncoding :: TokenVerifyRequest -> Encoding

toJSONList :: [TokenVerifyRequest] -> Value

toEncodingList :: [TokenVerifyRequest] -> Encoding

FromJSON TokenVerifyRequest

Methods

parseJSON :: Value -> Parser TokenVerifyRequest

parseJSONList :: Value -> Parser [TokenVerifyRequest]

data UserCurrentBalance

Constructors

UserCurrentBalance

Fields

• ucbSuccess :: Bool
• ucbName :: String
• ucbTotal :: Integer
• ucbWithdrawn :: Integer
• ucbBalance :: Integer
• ucbError :: Maybe String

Instances

ToJSON UserCurrentBalance

Methods

toJSON :: UserCurrentBalance -> Value

toEncoding :: UserCurrentBalance -> Encoding

toJSONList :: [UserCurrentBalance] -> Value

toEncodingList :: [UserCurrentBalance] -> Encoding

FromJSON UserCurrentBalance

Methods

parseJSON :: Value -> Parser UserCurrentBalance

parseJSONList :: Value -> Parser [UserCurrentBalance]

data UserWithdrawRequest

Constructors

UserWithdrawRequest

Fields

• uwrSecret :: SecretKey
• uwrName :: String
• uwrAmount :: Integer

Instances

ToJSON UserWithdrawRequest

Methods

toJSON :: UserWithdrawRequest -> Value

toEncoding :: UserWithdrawRequest -> Encoding

toJSONList :: [UserWithdrawRequest] -> Value

toEncodingList :: [UserWithdrawRequest] -> Encoding

FromJSON UserWithdrawRequest

Methods

parseJSON :: Value -> Parser UserWithdrawRequest

parseJSONList :: Value -> Parser [UserWithdrawRequest]

data UserWithdrawl

Constructors

UserWithdrawl

Fields

• uwSuccess :: Bool
• uwName :: String
• uwAmount :: Integer
• uwError :: Maybe String

Instances

ToJSON UserWithdrawl

Methods

toJSON :: UserWithdrawl -> Value

toEncoding :: UserWithdrawl -> Encoding

toJSONList :: [UserWithdrawl] -> Value

toEncodingList :: [UserWithdrawl] -> Encoding

FromJSON UserWithdrawl

Methods

parseJSON :: Value -> Parser UserWithdrawl

parseJSONList :: Value -> Parser [UserWithdrawl]

data UserOrdering

Constructors

TotalUserOrdering

BalanceUserOrdering

WithdrawnUserOrdering

Instances

ToJSON UserOrdering

Methods

toJSON :: UserOrdering -> Value

toEncoding :: UserOrdering -> Encoding

toJSONList :: [UserOrdering] -> Value

toEncodingList :: [UserOrdering] -> Encoding

FromJSON UserOrdering

Methods

parseJSON :: Value -> Parser UserOrdering

parseJSONList :: Value -> Parser [UserOrdering]

data ReportUser

Represents a single user in a UserTopReport or UserListReport

Constructors

ReportUser

Fields

• ruName :: String
• ruTotal :: Integer
• ruWithdrawn :: Integer
• ruBalance :: Integer

Instances

ToJSON ReportUser

Methods

toJSON :: ReportUser -> Value

toEncoding :: ReportUser -> Encoding

toJSONList :: [ReportUser] -> Value

toEncodingList :: [ReportUser] -> Encoding

FromJSON ReportUser

Methods

parseJSON :: Value -> Parser ReportUser

parseJSONList :: Value -> Parser [ReportUser]

data UserTopReport

Report of top users by UserOrdering.

Constructors

UserTopReport

Fields

• utrSuccess :: Bool
• utrUsers :: [ReportUser]
• utrError :: Maybe String

Instances

ToJSON UserTopReport

Methods

toJSON :: UserTopReport -> Value

toEncoding :: UserTopReport -> Encoding

toJSONList :: [UserTopReport] -> Value

toEncodingList :: [UserTopReport] -> Encoding

FromJSON UserTopReport

Methods

parseJSON :: Value -> Parser UserTopReport

parseJSONList :: Value -> Parser [UserTopReport]

data UserListReport

Constructors

UserListReport

Fields

• ulrSuccess :: Bool
• ulrUsers :: [ReportUser]
• ulrNextPage :: Maybe String
• ulrError :: Maybe String

Instances

ToJSON UserListReport

Methods

toJSON :: UserListReport -> Value

toEncoding :: UserListReport -> Encoding

toJSONList :: [UserListReport] -> Value

toEncodingList :: [UserListReport] -> Encoding

FromJSON UserListReport

Methods

parseJSON :: Value -> Parser UserListReport

parseJSONList :: Value -> Parser [UserListReport]

data UserResetRequest

Constructors

UserResetRequest

Fields

• urreqSecret :: SecretKey
• urreqName :: String

Instances

ToJSON UserResetRequest

Methods

toJSON :: UserResetRequest -> Value

toEncoding :: UserResetRequest -> Encoding

toJSONList :: [UserResetRequest] -> Value

toEncodingList :: [UserResetRequest] -> Encoding

FromJSON UserResetRequest

Methods

parseJSON :: Value -> Parser UserResetRequest

parseJSONList :: Value -> Parser [UserResetRequest]

data UserResetResult

Constructors

UserResetResult

Fields

• urrSuccess :: Bool
• urrError :: Maybe String

Instances

ToJSON UserResetResult

Methods

toJSON :: UserResetResult -> Value

toEncoding :: UserResetResult -> Encoding

toJSONList :: [UserResetResult] -> Value

toEncodingList :: [UserResetResult] -> Encoding

FromJSON UserResetResult

Methods

parseJSON :: Value -> Parser UserResetResult

parseJSONList :: Value -> Parser [UserResetResult]

api :: Proxy API

type API = TokenVerify :<|> (UserBalance :<|> (UserWithdraw :<|> (UserTop :<|> (UserList :<|> UserReset))))

The unification of the various endpoints.

type TokenVerify = "token" :> ("verify" :> (JReqBody TokenVerifyRequest :> JPost TokenVerification))

type UserBalance = "user" :> ("balance" :> (QueryParam "secret" SecretKey :> (QueryParam "name" String :> JGet UserCurrentBalance)))

type UserWithdraw = "user" :> ("withdraw" :> (JReqBody UserWithdrawRequest :> JPost UserWithdrawl))

type UserTop = "user" :> ("top" :> (QueryParam "secret" SecretKey :> (QueryParam "count" Integer :> (QueryParam "order" UserOrdering :> JGet UserTopReport))))

type UserList = "user" :> ("list" :> (QueryParam "secert" SecretKey :> (QueryParam "count" Integer :> (QueryParam "page" String :> JGet UserListReport))))

type UserReset = "user" :> ("reset" :> (JReqBody UserResetRequest :> JPost UserResetResult))

baseUrl :: BaseUrl

The URL prefix used for Coinhive's API