Safe Haskell	Safe-Inferred
Language	Haskell2010

Console.SolanaStaking.Api

Contents

Configuration
Requests / Responses
General API Types

Description

Solana Beach API requests & responses.

TODO: Extract into a solana-beach-api package.

Synopsis

data Config = Config {
- cApiKey :: Text
- cAccountPubKey :: Text
}
mkConfig :: String -> String -> Config
data APIResponse a
- = SuccessfulReponse a
- | ProcessingResponse
- | RateLimitResponse Int
- | ErrorResponse APIError
data APIError
- = APIError Text
- | RetriesExceeded Text
- | RateLimitError Int
runApi :: Monad m => APIResponse a -> m (Either APIError a)
raiseAPIError :: MonadError APIError m => APIResponse a -> m a
getAccountStakes :: (MonadReader Config m, MonadCatch m, MonadIO m) => m (APIResponse StakingAccounts)
data StakingAccounts = StakingAccounts {
- saResults :: [StakingAccount]
- saTotalPages :: Integer
}
data StakingAccount = StakingAccount {
- saPubKey :: StakingPubKey
- saLamports :: Lamports
- saValidatorName :: Text
}
getAllStakeRewards :: (MonadReader Config m, MonadCatch m, MonadIO m) => StakingPubKey -> m ([APIError], [StakeReward])
getYearsStakeRewards :: (MonadReader Config m, MonadCatch m, MonadIO m) => StakingPubKey -> Integer -> m ([APIError], [StakeReward])
getStakeRewards :: (MonadReader Config m, MonadCatch m, MonadIO m) => StakingPubKey -> Maybe Integer -> m (APIResponse [StakeReward])
data StakeReward = StakeReward {
- srEpoch :: Integer
- srSlot :: Integer
- srAmount :: Lamports
- srTimestamp :: POSIXTime
}
getBlock :: (MonadReader Config m, MonadCatch m, MonadIO m) => Integer -> m (APIResponse Block)
data Block = Block {
- bNumber :: Integer
- bBlockTime :: POSIXTime
}
newtype Lamports = Lamports {
- fromLamports :: Integer
}
renderLamports :: Lamports -> Text
scientificLamports :: Lamports -> Scientific
newtype StakingPubKey = StakingPubKey {
- fromStakingPubKey :: Text
}

Configuration

data Config Source #

Solana Beach API Configuration

Constructors

Config
Fields cApiKey :: Text Your API Key. Get one here: https://github.com/solana-beach/api cAccountPubKey :: Text TODO: probably drop this when solana-beach-api is extracted to separate package.

Instances

Instances details

Read Config Source #
Instance details Defined in Console.SolanaStaking.Api Methods readsPrec :: Int -> ReadS Config # readList :: ReadS [Config] # readPrec :: ReadPrec Config # readListPrec :: ReadPrec [Config] #
Show Config Source #
Instance details Defined in Console.SolanaStaking.Api Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #
Eq Config Source #
Instance details Defined in Console.SolanaStaking.Api Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #

mkConfig :: String -> String -> Config Source #

Create a program config from the API key & the target account's pubkey.

Requests / Responses

data APIResponse a Source #

Wrapper around error & processing responses from the API.

Constructors

SuccessfulReponse a
ProcessingResponse
RateLimitResponse Int
ErrorResponse APIError

Instances

Instances details

FromJSON a => FromJSON (APIResponse a) Source #	Attempts to parse a processing response, then an error response, & finally the inner `a` response.
Instance details Defined in Console.SolanaStaking.Api Methods parseJSON :: Value -> Parser (APIResponse a) # parseJSONList :: Value -> Parser [APIResponse a] # omittedField :: Maybe (APIResponse a) #
Read a => Read (APIResponse a) Source #
Instance details Defined in Console.SolanaStaking.Api Methods readsPrec :: Int -> ReadS (APIResponse a) # readList :: ReadS [APIResponse a] # readPrec :: ReadPrec (APIResponse a) # readListPrec :: ReadPrec [APIResponse a] #
Show a => Show (APIResponse a) Source #
Instance details Defined in Console.SolanaStaking.Api Methods showsPrec :: Int -> APIResponse a -> ShowS # show :: APIResponse a -> String # showList :: [APIResponse a] -> ShowS #
Eq a => Eq (APIResponse a) Source #
Instance details Defined in Console.SolanaStaking.Api Methods (==) :: APIResponse a -> APIResponse a -> Bool # (/=) :: APIResponse a -> APIResponse a -> Bool #

data APIError Source #

Potential error responses from the Solana Beach API.

Constructors

APIError Text	Generic API error with message.
RetriesExceeded Text	Exceeded maximum number of `ProcessingResponse` retries.
RateLimitError Int	Rate limiting 429 error.

Instances

Instances details

Generic APIError Source #
Instance details Defined in Console.SolanaStaking.Api Associated Types type Rep APIError :: Type -> Type # Methods from :: APIError -> Rep APIError x # to :: Rep APIError x -> APIError #
Read APIError Source #
Instance details Defined in Console.SolanaStaking.Api Methods readsPrec :: Int -> ReadS APIError # readList :: ReadS [APIError] # readPrec :: ReadPrec APIError # readListPrec :: ReadPrec [APIError] #
Show APIError Source #
Instance details Defined in Console.SolanaStaking.Api Methods showsPrec :: Int -> APIError -> ShowS # show :: APIError -> String # showList :: [APIError] -> ShowS #
Eq APIError Source #
Instance details Defined in Console.SolanaStaking.Api Methods (==) :: APIError -> APIError -> Bool # (/=) :: APIError -> APIError -> Bool #
type Rep APIError Source #
Instance details Defined in Console.SolanaStaking.Api type Rep APIError = D1 ('MetaData "APIError" "Console.SolanaStaking.Api" "solana-staking-csvs-0.1.3.0-E9Qk519OQkrEnmFIJzRHLJ" 'False) (C1 ('MetaCons "APIError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "RetriesExceeded" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: C1 ('MetaCons "RateLimitError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))

runApi :: Monad m => APIResponse a -> m (Either APIError a) Source #

Evaluate an API response.

raiseAPIError :: MonadError APIError m => APIResponse a -> m a Source #

Pull the inner value out of an APIResponse or throw the respective APIError.

Get Stake Accounts

getAccountStakes :: (MonadReader Config m, MonadCatch m, MonadIO m) => m (APIResponse StakingAccounts) Source #

Get the staking accounts for the cAccountPubKey.

data StakingAccounts Source #

Single Result Page of Staking Accounts Query.

Constructors

StakingAccounts
Fields saResults :: [StakingAccount] The returned staking accounts saTotalPages :: Integer The total number of pages for the Account's PubKey.

Instances

Instances details

FromJSON StakingAccounts Source #
Instance details Defined in Console.SolanaStaking.Api Methods parseJSON :: Value -> Parser StakingAccounts # parseJSONList :: Value -> Parser [StakingAccounts] # omittedField :: Maybe StakingAccounts #
Generic StakingAccounts Source #
Instance details Defined in Console.SolanaStaking.Api Associated Types type Rep StakingAccounts :: Type -> Type # Methods from :: StakingAccounts -> Rep StakingAccounts x # to :: Rep StakingAccounts x -> StakingAccounts #
Read StakingAccounts Source #
Instance details Defined in Console.SolanaStaking.Api Methods readsPrec :: Int -> ReadS StakingAccounts # readList :: ReadS [StakingAccounts] # readPrec :: ReadPrec StakingAccounts # readListPrec :: ReadPrec [StakingAccounts] #
Show StakingAccounts Source #
Instance details Defined in Console.SolanaStaking.Api Methods showsPrec :: Int -> StakingAccounts -> ShowS # show :: StakingAccounts -> String # showList :: [StakingAccounts] -> ShowS #
Eq StakingAccounts Source #
Instance details Defined in Console.SolanaStaking.Api Methods (==) :: StakingAccounts -> StakingAccounts -> Bool # (/=) :: StakingAccounts -> StakingAccounts -> Bool #
type Rep StakingAccounts Source #
Instance details Defined in Console.SolanaStaking.Api type Rep StakingAccounts = D1 ('MetaData "StakingAccounts" "Console.SolanaStaking.Api" "solana-staking-csvs-0.1.3.0-E9Qk519OQkrEnmFIJzRHLJ" 'False) (C1 ('MetaCons "StakingAccounts" 'PrefixI 'True) (S1 ('MetaSel ('Just "saResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [StakingAccount]) :*: S1 ('MetaSel ('Just "saTotalPages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)))

data StakingAccount Source #

A single Staking Account.

Constructors

StakingAccount
Fields saPubKey :: StakingPubKey The Staking Accounts PubKey saLamports :: Lamports The Balance of the Staking Account saValidatorName :: Text The Name of the Staking Account's Validator

Instances

Instances details

FromJSON StakingAccount Source #
Instance details Defined in Console.SolanaStaking.Api Methods parseJSON :: Value -> Parser StakingAccount # parseJSONList :: Value -> Parser [StakingAccount] # omittedField :: Maybe StakingAccount #
Generic StakingAccount Source #
Instance details Defined in Console.SolanaStaking.Api Associated Types type Rep StakingAccount :: Type -> Type # Methods from :: StakingAccount -> Rep StakingAccount x # to :: Rep StakingAccount x -> StakingAccount #
Read StakingAccount Source #
Instance details Defined in Console.SolanaStaking.Api Methods readsPrec :: Int -> ReadS StakingAccount # readList :: ReadS [StakingAccount] # readPrec :: ReadPrec StakingAccount # readListPrec :: ReadPrec [StakingAccount] #
Show StakingAccount Source #
Instance details Defined in Console.SolanaStaking.Api Methods showsPrec :: Int -> StakingAccount -> ShowS # show :: StakingAccount -> String # showList :: [StakingAccount] -> ShowS #
Eq StakingAccount Source #
Instance details Defined in Console.SolanaStaking.Api Methods (==) :: StakingAccount -> StakingAccount -> Bool # (/=) :: StakingAccount -> StakingAccount -> Bool #
type Rep StakingAccount Source #
Instance details Defined in Console.SolanaStaking.Api type Rep StakingAccount = D1 ('MetaData "StakingAccount" "Console.SolanaStaking.Api" "solana-staking-csvs-0.1.3.0-E9Qk519OQkrEnmFIJzRHLJ" 'False) (C1 ('MetaCons "StakingAccount" 'PrefixI 'True) (S1 ('MetaSel ('Just "saPubKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 StakingPubKey) :: (S1 ('MetaSel ('Just "saLamports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Lamports) :: S1 ('MetaSel ('Just "saValidatorName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

Get Staking Rewards

getAllStakeRewards :: (MonadReader Config m, MonadCatch m, MonadIO m) => StakingPubKey -> m ([APIError], [StakeReward]) Source #

Get all the staking rewards for the given account.

The API's stake-rewards route only returns a maximum of 5 rewards, so we have to use the earliest epoch as the cursor in an additional request to see if there are any more rewards.

getYearsStakeRewards :: (MonadReader Config m, MonadCatch m, MonadIO m) => StakingPubKey -> Integer -> m ([APIError], [StakeReward]) Source #

Get the year's worth of staking rewards for the given account.

getStakeRewards :: (MonadReader Config m, MonadCatch m, MonadIO m) => StakingPubKey -> Maybe Integer -> m (APIResponse [StakeReward]) Source #

Get the staking rewards with a staking account's pubkey.

data StakeReward Source #

A Staking Reward Payment.

Constructors

StakeReward
Fields srEpoch :: Integer The Epoch the reward was paid. srSlot :: Integer The `Block` number of the reward. srAmount :: Lamports The total number of `Lamports` awarded. srTimestamp :: POSIXTime

Instances

Instances details

FromJSON StakeReward Source #
Instance details Defined in Console.SolanaStaking.Api Methods parseJSON :: Value -> Parser StakeReward # parseJSONList :: Value -> Parser [StakeReward] # omittedField :: Maybe StakeReward #
Generic StakeReward Source #
Instance details Defined in Console.SolanaStaking.Api Associated Types type Rep StakeReward :: Type -> Type # Methods from :: StakeReward -> Rep StakeReward x # to :: Rep StakeReward x -> StakeReward #
Read StakeReward Source #
Instance details Defined in Console.SolanaStaking.Api Methods readsPrec :: Int -> ReadS StakeReward # readList :: ReadS [StakeReward] # readPrec :: ReadPrec StakeReward # readListPrec :: ReadPrec [StakeReward] #
Show StakeReward Source #
Instance details Defined in Console.SolanaStaking.Api Methods showsPrec :: Int -> StakeReward -> ShowS # show :: StakeReward -> String # showList :: [StakeReward] -> ShowS #
Eq StakeReward Source #
Instance details Defined in Console.SolanaStaking.Api Methods (==) :: StakeReward -> StakeReward -> Bool # (/=) :: StakeReward -> StakeReward -> Bool #
type Rep StakeReward Source #
Instance details Defined in Console.SolanaStaking.Api type Rep StakeReward = D1 ('MetaData "StakeReward" "Console.SolanaStaking.Api" "solana-staking-csvs-0.1.3.0-E9Qk519OQkrEnmFIJzRHLJ" 'False) (C1 ('MetaCons "StakeReward" 'PrefixI 'True) ((S1 ('MetaSel ('Just "srEpoch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :: S1 ('MetaSel ('Just "srSlot") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)) :: (S1 ('MetaSel ('Just "srAmount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Lamports) :*: S1 ('MetaSel ('Just "srTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime))))

Get Block

getBlock :: (MonadReader Config m, MonadCatch m, MonadIO m) => Integer -> m (APIResponse Block) Source #

Get information about a specific block number.

data Block Source #

A single block on the Solana blockchain.

Constructors

Block
Fields bNumber :: Integer The blocks number. bBlockTime :: POSIXTime The blocks absolute timestamp.

Instances

Instances details

FromJSON Block Source #
Instance details Defined in Console.SolanaStaking.Api Methods parseJSON :: Value -> Parser Block # parseJSONList :: Value -> Parser [Block] # omittedField :: Maybe Block #
Generic Block Source #
Instance details Defined in Console.SolanaStaking.Api Associated Types type Rep Block :: Type -> Type # Methods from :: Block -> Rep Block x # to :: Rep Block x -> Block #
Read Block Source #
Instance details Defined in Console.SolanaStaking.Api Methods readsPrec :: Int -> ReadS Block # readList :: ReadS [Block] # readPrec :: ReadPrec Block # readListPrec :: ReadPrec [Block] #
Show Block Source #
Instance details Defined in Console.SolanaStaking.Api Methods showsPrec :: Int -> Block -> ShowS # show :: Block -> String # showList :: [Block] -> ShowS #
Eq Block Source #
Instance details Defined in Console.SolanaStaking.Api Methods (==) :: Block -> Block -> Bool # (/=) :: Block -> Block -> Bool #
type Rep Block Source #
Instance details Defined in Console.SolanaStaking.Api type Rep Block = D1 ('MetaData "Block" "Console.SolanaStaking.Api" "solana-staking-csvs-0.1.3.0-E9Qk519OQkrEnmFIJzRHLJ" 'False) (C1 ('MetaCons "Block" 'PrefixI 'True) (S1 ('MetaSel ('Just "bNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer) :*: S1 ('MetaSel ('Just "bBlockTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 POSIXTime)))

General API Types

newtype Lamports Source #

An amount of Lamports, each of which represent 0.000000001 SOL.

Constructors

Lamports
Fields fromLamports :: Integer

Instances

Instances details

FromJSON Lamports Source #
Instance details Defined in Console.SolanaStaking.Api Methods parseJSON :: Value -> Parser Lamports # parseJSONList :: Value -> Parser [Lamports] # omittedField :: Maybe Lamports #
Generic Lamports Source #
Instance details Defined in Console.SolanaStaking.Api Associated Types type Rep Lamports :: Type -> Type # Methods from :: Lamports -> Rep Lamports x # to :: Rep Lamports x -> Lamports #
Num Lamports Source #
Instance details Defined in Console.SolanaStaking.Api Methods (+) :: Lamports -> Lamports -> Lamports # (-) :: Lamports -> Lamports -> Lamports # (*) :: Lamports -> Lamports -> Lamports # negate :: Lamports -> Lamports # abs :: Lamports -> Lamports # signum :: Lamports -> Lamports # fromInteger :: Integer -> Lamports #
Read Lamports Source #
Instance details Defined in Console.SolanaStaking.Api Methods readsPrec :: Int -> ReadS Lamports # readList :: ReadS [Lamports] # readPrec :: ReadPrec Lamports # readListPrec :: ReadPrec [Lamports] #
Show Lamports Source #
Instance details Defined in Console.SolanaStaking.Api Methods showsPrec :: Int -> Lamports -> ShowS # show :: Lamports -> String # showList :: [Lamports] -> ShowS #
Eq Lamports Source #
Instance details Defined in Console.SolanaStaking.Api Methods (==) :: Lamports -> Lamports -> Bool # (/=) :: Lamports -> Lamports -> Bool #
type Rep Lamports Source #
Instance details Defined in Console.SolanaStaking.Api type Rep Lamports = D1 ('MetaData "Lamports" "Console.SolanaStaking.Api" "solana-staking-csvs-0.1.3.0-E9Qk519OQkrEnmFIJzRHLJ" 'True) (C1 ('MetaCons "Lamports" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromLamports") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)))

renderLamports :: Lamports -> Text Source #

Render an amount of Lamports as text, converting it to SOL.

scientificLamports :: Lamports -> Scientific Source #

Convert Lamports into Scientific representation of SOL.

newtype StakingPubKey Source #

A PubKey for a Staking Account.

Constructors

StakingPubKey
Fields fromStakingPubKey :: Text

Instances

Instances details

FromJSON StakingPubKey Source #
Instance details Defined in Console.SolanaStaking.Api Methods parseJSON :: Value -> Parser StakingPubKey # parseJSONList :: Value -> Parser [StakingPubKey] # omittedField :: Maybe StakingPubKey #
Generic StakingPubKey Source #
Instance details Defined in Console.SolanaStaking.Api Associated Types type Rep StakingPubKey :: Type -> Type # Methods from :: StakingPubKey -> Rep StakingPubKey x # to :: Rep StakingPubKey x -> StakingPubKey #
Read StakingPubKey Source #
Instance details Defined in Console.SolanaStaking.Api Methods readsPrec :: Int -> ReadS StakingPubKey # readList :: ReadS [StakingPubKey] # readPrec :: ReadPrec StakingPubKey # readListPrec :: ReadPrec [StakingPubKey] #
Show StakingPubKey Source #
Instance details Defined in Console.SolanaStaking.Api Methods showsPrec :: Int -> StakingPubKey -> ShowS # show :: StakingPubKey -> String # showList :: [StakingPubKey] -> ShowS #
Eq StakingPubKey Source #
Instance details Defined in Console.SolanaStaking.Api Methods (==) :: StakingPubKey -> StakingPubKey -> Bool # (/=) :: StakingPubKey -> StakingPubKey -> Bool #
type Rep StakingPubKey Source #
Instance details Defined in Console.SolanaStaking.Api type Rep StakingPubKey = D1 ('MetaData "StakingPubKey" "Console.SolanaStaking.Api" "solana-staking-csvs-0.1.3.0-E9Qk519OQkrEnmFIJzRHLJ" 'True) (C1 ('MetaCons "StakingPubKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromStakingPubKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))