Safe Haskell	None
Language	Haskell2010

Console.BnbStaking.Api

Contents

Rewards
Low-Level Requests & Responses

Description

Binance.org API requests & responses.

Synopsis

getAllRewards :: MonadHttp m => Text -> m [Reward]
data Reward = Reward {
- rValidatorName :: Text
- rValidatorAddress :: Text
- rDelegator :: Text
- rChainId :: Text
- rHeight :: Integer
- rReward :: Scientific
- rRewardTime :: UTCTime
}
data Endpoint a where
- GetRewards :: Text -> Maybe Integer -> Maybe Integer -> Endpoint RewardResponse
makeRequest :: MonadHttp m => Endpoint a -> m a
data RewardResponse = RewardResponse {
- rrTotal :: Integer
- rrRewards :: [Reward]
}

Rewards

getAllRewards :: MonadHttp m => Text -> m [Reward] Source #

Fetch all rewards for the given Delegator PubKey.

data Reward Source #

A single staking reward.

Constructors

Reward
Fields rValidatorName :: Text rValidatorAddress :: Text rDelegator :: Text rChainId :: Text Always `bsc` at the moment - no testnet rewards supported. rHeight :: Integer rReward :: Scientific rRewardTime :: UTCTime

Instances

Instances details

FromJSON Reward Source #

Instance details

Defined in Console.BnbStaking.Api

Methods

parseJSON :: Value -> Parser Reward #

parseJSONList :: Value -> Parser [Reward] #

omittedField :: Maybe Reward #

Generic Reward Source #

Instance details

Defined in Console.BnbStaking.Api

Associated Types

type Rep Reward

Instance details

Defined in Console.BnbStaking.Api

type Rep Reward = D1 ('MetaData "Reward" "Console.BnbStaking.Api" "bnb-staking-csvs-0.2.2.0-JdFRNdX0VG33uX49rlXLbF" 'False) (C1 ('MetaCons "Reward" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rValidatorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "rValidatorAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "rDelegator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "rChainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "rHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :*: (S1 ('MetaSel ('Just "rReward") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Scientific) :*: S1 ('MetaSel ('Just "rRewardTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))))

Methods

from :: Reward -> Rep Reward x #

to :: Rep Reward x -> Reward #

Read Reward Source #

Instance details

Defined in Console.BnbStaking.Api

Methods

readsPrec :: Int -> ReadS Reward #

readList :: ReadS [Reward] #

readPrec :: ReadPrec Reward #

readListPrec :: ReadPrec [Reward] #

Show Reward Source #

Instance details

Defined in Console.BnbStaking.Api

Methods

showsPrec :: Int -> Reward -> ShowS #

show :: Reward -> String #

showList :: [Reward] -> ShowS #

Eq Reward Source #

Instance details

Defined in Console.BnbStaking.Api

Methods

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

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

type Rep Reward Source #

Instance details

Defined in Console.BnbStaking.Api

type Rep Reward = D1 ('MetaData "Reward" "Console.BnbStaking.Api" "bnb-staking-csvs-0.2.2.0-JdFRNdX0VG33uX49rlXLbF" 'False) (C1 ('MetaCons "Reward" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rValidatorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "rValidatorAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "rDelegator") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "rChainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "rHeight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :*: (S1 ('MetaSel ('Just "rReward") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Scientific) :*: S1 ('MetaSel ('Just "rRewardTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))))

Low-Level Requests & Responses

data Endpoint a where Source #

Represents all endpoints of the binance.org api, as well as their respective response data.

Constructors

GetRewards :: Text -> Maybe Integer -> Maybe Integer -> Endpoint RewardResponse

makeRequest :: MonadHttp m => Endpoint a -> m a Source #

Make a request to an endpoint.

data RewardResponse Source #

Response of requesting a delegator's rewards.

Constructors

RewardResponse
Fields rrTotal :: Integer Total number of rewards. rrRewards :: [Reward] Rewards in this page.

Instances

Instances details

FromJSON RewardResponse Source #

Instance details

Defined in Console.BnbStaking.Api

Methods

parseJSON :: Value -> Parser RewardResponse #

parseJSONList :: Value -> Parser [RewardResponse] #

omittedField :: Maybe RewardResponse #

Generic RewardResponse Source #

Instance details

Defined in Console.BnbStaking.Api

Associated Types

type Rep RewardResponse

Instance details

Defined in Console.BnbStaking.Api

type Rep RewardResponse = D1 ('MetaData "RewardResponse" "Console.BnbStaking.Api" "bnb-staking-csvs-0.2.2.0-JdFRNdX0VG33uX49rlXLbF" 'False) (C1 ('MetaCons "RewardResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "rrTotal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :*: S1 ('MetaSel ('Just "rrRewards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Reward])))

Methods

from :: RewardResponse -> Rep RewardResponse x #

to :: Rep RewardResponse x -> RewardResponse #

Read RewardResponse Source #

Instance details

Defined in Console.BnbStaking.Api

Methods

readsPrec :: Int -> ReadS RewardResponse #

readList :: ReadS [RewardResponse] #

readPrec :: ReadPrec RewardResponse #

readListPrec :: ReadPrec [RewardResponse] #

Show RewardResponse Source #

Instance details

Defined in Console.BnbStaking.Api

Methods

showsPrec :: Int -> RewardResponse -> ShowS #

show :: RewardResponse -> String #

showList :: [RewardResponse] -> ShowS #

Eq RewardResponse Source #

Instance details

Defined in Console.BnbStaking.Api

Methods

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

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

type Rep RewardResponse Source #

Instance details

Defined in Console.BnbStaking.Api

type Rep RewardResponse = D1 ('MetaData "RewardResponse" "Console.BnbStaking.Api" "bnb-staking-csvs-0.2.2.0-JdFRNdX0VG33uX49rlXLbF" 'False) (C1 ('MetaCons "RewardResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "rrTotal") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :*: S1 ('MetaSel ('Just "rrRewards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Reward])))