Rpc: introduce get_inflation_reward rpc call #16278

oJshua · 2021-03-31T20:34:50Z

Problem

There is currently no way in the RPC to get the reward for a given epoch.

Summary of Changes

introduce rpc call for fetching reward for a single epoch
if epoch is omitted, the most recent reward is fetched

Fixes #16077

codecov · 2021-04-01T00:52:55Z

Codecov Report

Merging #16278 (2858528) into master (92f4018) will decrease coverage by 0.0%.
The diff coverage is 0.0%.

@@            Coverage Diff            @@
##           master   #16278     +/-   ##
=========================================
- Coverage    80.1%    80.0%   -0.1%     
=========================================
  Files         413      413             
  Lines      110490   110564     +74     
=========================================
- Hits        88558    88553      -5     
- Misses      21932    22011     +79

core/src/rpc.rs

client/src/rpc_response.rs

core/src/rpc.rs

oJshua · 2021-04-01T21:40:30Z

@CriesofCarrots was waiting for this to pass CI, but it might be good for another glance. Thanks much!

core/src/rpc.rs

CriesofCarrots

One nit, otherwise lgtm! Thanks for all the polish

Pull request has been modified.

mvines · 2021-04-02T16:09:47Z

Can you please also add a section in the JSON RPC API docs, as well as support in RpcClient for the new method

oJshua · 2021-04-02T16:13:28Z

@mvines on it.

mvines · 2021-04-02T16:14:36Z

Oh as a follow-up PR, can you please use this new method in the cli as well. To avoid backwards compatibility issues for now, the cli changes could only go into master and 1.6

CriesofCarrots · 2021-04-02T16:19:53Z

Oh as a follow-up PR, can you please use this new method in the cli as well. To avoid backwards compatibility issues for now, the cli changes could only go into master and 1.6

What do you think about limiting the cli to some number of previous epochs? We could add a separate command or arg to include complete rewards history. But it would be rather nice if solana stake-account could return quicker for users who just want to check the current status of an account.

mvines · 2021-04-02T16:25:08Z

Oh as a follow-up PR, can you please use this new method in the cli as well. To avoid backwards compatibility issues for now, the cli changes could only go into master and 1.6

What do you think about limiting the cli to some number of previous epochs? We could add a separate command or arg to include complete rewards history. But it would be rather nice if solana stake-account could return quicker for users who just want to check the current status of an account.

Yes. I hate so much how slow it is. It worked great for the first couple epochs after pico-inflation was enabled though.

How about if on solana stake-account and solana vote-account, there

were no rewards displayed by default
--rewards by default shows the the latest epoch with an optional EPOCH arg to --rewards to display a previous epoch. No ability

Alternatively move rewards to solana inflation-rewards? solana inflation-rewards --epoch X address1 address2 ...

core/src/rpc.rs

CriesofCarrots · 2021-04-02T16:31:51Z

How about if on solana stake-account and solana vote-account, there
1. were no rewards displayed by default

2. `--rewards` by default shows the the latest epoch with an optional `EPOCH` arg to `--rewards` to display a previous epoch.  No ability
Alternatively move rewards to solana inflation-rewards? solana inflation-rewards --epoch X address1 address2 ...

How about both? Too much? I can see different use-cases for each.

mvines · 2021-04-02T16:41:54Z

How about both? Too much? I can see different use-cases for each.

Yeah I think probably both too

client/src/rpc_response.rs

client/src/rpc_client.rs

core/src/rpc.rs

docs/src/developing/clients/jsonrpc-api.md

…nd some filter staking and voting rewards

* feat: introduce get_inflation_reward rpc call * fix: style suggestions * fix: more style changes and match how other rpc functions are defined * feat: get reward for a single epoch * feat: default to the most recent epoch * fix: don't factor out get_confirmed_block * style: introduce from impl for RpcEncodingConfigWrapper * style: bring commitment into variable * feat: support multiple pubkeys for get_inflation_reward * feat: add get_inflation_reward to rpc client * feat: return rewards in order * fix: rename pubkeys to addresses * docs: introduce jsonrpc docs for get_inflation_reward * style: early return in map (not sure which is more idiomatic) * fix: call the rpc client function args addresses as well * fix: style * fix: filter out only addresses we care about * style: make this more idiomatic * fix: change rpc client epoch to optional and include some docs edits * feat: filter out rent rewards in get_inflation_reward * feat: add option epoch config param to get_inflation_reward * feat: rpc client get_inflation_reward takes epoch instead of config and some filter staking and voting rewards (cherry picked from commit e501fa5) # Conflicts: # client/src/rpc_client.rs # core/src/rpc.rs

* feat: introduce get_inflation_reward rpc call * fix: style suggestions * fix: more style changes and match how other rpc functions are defined * feat: get reward for a single epoch * feat: default to the most recent epoch * fix: don't factor out get_confirmed_block * style: introduce from impl for RpcEncodingConfigWrapper * style: bring commitment into variable * feat: support multiple pubkeys for get_inflation_reward * feat: add get_inflation_reward to rpc client * feat: return rewards in order * fix: rename pubkeys to addresses * docs: introduce jsonrpc docs for get_inflation_reward * style: early return in map (not sure which is more idiomatic) * fix: call the rpc client function args addresses as well * fix: style * fix: filter out only addresses we care about * style: make this more idiomatic * fix: change rpc client epoch to optional and include some docs edits * feat: filter out rent rewards in get_inflation_reward * feat: add option epoch config param to get_inflation_reward * feat: rpc client get_inflation_reward takes epoch instead of config and some filter staking and voting rewards (cherry picked from commit e501fa5)

* feat: introduce get_inflation_reward rpc call * fix: style suggestions * fix: more style changes and match how other rpc functions are defined * feat: get reward for a single epoch * feat: default to the most recent epoch * fix: don't factor out get_confirmed_block * style: introduce from impl for RpcEncodingConfigWrapper * style: bring commitment into variable * feat: support multiple pubkeys for get_inflation_reward * feat: add get_inflation_reward to rpc client * feat: return rewards in order * fix: rename pubkeys to addresses * docs: introduce jsonrpc docs for get_inflation_reward * style: early return in map (not sure which is more idiomatic) * fix: call the rpc client function args addresses as well * fix: style * fix: filter out only addresses we care about * style: make this more idiomatic * fix: change rpc client epoch to optional and include some docs edits * feat: filter out rent rewards in get_inflation_reward * feat: add option epoch config param to get_inflation_reward * feat: rpc client get_inflation_reward takes epoch instead of config and some filter staking and voting rewards (cherry picked from commit e501fa5) Co-authored-by: Josh <josh.hundley@gmail.com>

* Rpc: introduce get_inflation_reward rpc call (#16278) * feat: introduce get_inflation_reward rpc call * fix: style suggestions * fix: more style changes and match how other rpc functions are defined * feat: get reward for a single epoch * feat: default to the most recent epoch * fix: don't factor out get_confirmed_block * style: introduce from impl for RpcEncodingConfigWrapper * style: bring commitment into variable * feat: support multiple pubkeys for get_inflation_reward * feat: add get_inflation_reward to rpc client * feat: return rewards in order * fix: rename pubkeys to addresses * docs: introduce jsonrpc docs for get_inflation_reward * style: early return in map (not sure which is more idiomatic) * fix: call the rpc client function args addresses as well * fix: style * fix: filter out only addresses we care about * style: make this more idiomatic * fix: change rpc client epoch to optional and include some docs edits * feat: filter out rent rewards in get_inflation_reward * feat: add option epoch config param to get_inflation_reward * feat: rpc client get_inflation_reward takes epoch instead of config and some filter staking and voting rewards (cherry picked from commit e501fa5) # Conflicts: # client/src/rpc_client.rs # core/src/rpc.rs * fix: resolve cherry-pick conflicts * fix: change bool_to_option filter_map to filter + map * style: use filter_map in place of filter + map Co-authored-by: Josh <josh.hundley@gmail.com>

oJshua force-pushed the rpc/getinflationreward branch 4 times, most recently from d08d592 to a574cd9 Compare March 31, 2021 23:36

oJshua added v1.5 labels Mar 31, 2021

oJshua changed the title ~~RPC: introduce get_inflation_reward rpc call~~ Rpc: introduce get_inflation_reward rpc call Mar 31, 2021

mvines reviewed Apr 1, 2021

View reviewed changes

core/src/rpc.rs Show resolved Hide resolved

mvines reviewed Apr 1, 2021

View reviewed changes

core/src/rpc.rs Outdated Show resolved Hide resolved

mvines reviewed Apr 1, 2021

View reviewed changes

client/src/rpc_response.rs Outdated Show resolved Hide resolved

oJshua commented Apr 1, 2021

View reviewed changes

core/src/rpc.rs Outdated Show resolved Hide resolved

CriesofCarrots reviewed Apr 1, 2021

View reviewed changes

core/src/rpc.rs Outdated Show resolved Hide resolved

core/src/rpc.rs Outdated Show resolved Hide resolved

core/src/rpc.rs Outdated Show resolved Hide resolved

core/src/rpc.rs Outdated Show resolved Hide resolved

oJshua force-pushed the rpc/getinflationreward branch 2 times, most recently from f178076 to 3ea4247 Compare April 1, 2021 21:12

oJshua requested a review from CriesofCarrots April 1, 2021 21:40

CriesofCarrots reviewed Apr 1, 2021

View reviewed changes

core/src/rpc.rs Outdated Show resolved Hide resolved

core/src/rpc.rs Show resolved Hide resolved

CriesofCarrots previously approved these changes Apr 1, 2021

View reviewed changes

mvines reviewed Apr 2, 2021

View reviewed changes

core/src/rpc.rs Outdated Show resolved Hide resolved

oJshua requested a review from CriesofCarrots April 2, 2021 18:44

mvines reviewed Apr 2, 2021

View reviewed changes

client/src/rpc_response.rs Outdated Show resolved Hide resolved

oJshua added 14 commits April 6, 2021 16:38

fix: don't factor out get_confirmed_block

d17bea7

style: introduce from impl for RpcEncodingConfigWrapper

1aa24ff

style: bring commitment into variable

9179a71

feat: support multiple pubkeys for get_inflation_reward

ca9c0f6

feat: add get_inflation_reward to rpc client

de596b2

feat: return rewards in order

8065cf9

fix: rename pubkeys to addresses

a5366b7

docs: introduce jsonrpc docs for get_inflation_reward

55e602c

style: early return in map (not sure which is more idiomatic)

7d84b9c

fix: call the rpc client function args addresses as well

86ac7f1

fix: style

7135135

fix: filter out only addresses we care about

9aba91e

style: make this more idiomatic

d7c6471

fix: change rpc client epoch to optional and include some docs edits

503f7b7

oJshua force-pushed the rpc/getinflationreward branch from a8e4b9b to 503f7b7 Compare April 6, 2021 16:39

oJshua added 2 commits April 6, 2021 20:11

feat: filter out rent rewards in get_inflation_reward

c748b20

feat: add option epoch config param to get_inflation_reward

8cdd0b3

oJshua force-pushed the rpc/getinflationreward branch from a10ca8e to 8cdd0b3 Compare April 6, 2021 20:43

CriesofCarrots reviewed Apr 6, 2021

View reviewed changes

client/src/rpc_client.rs Outdated Show resolved Hide resolved

core/src/rpc.rs Outdated Show resolved Hide resolved

core/src/rpc.rs Outdated Show resolved Hide resolved

docs/src/developing/clients/jsonrpc-api.md Outdated Show resolved Hide resolved

feat: rpc client get_inflation_reward takes epoch instead of config a…

2858528

…nd some filter staking and voting rewards

CriesofCarrots mentioned this pull request Apr 6, 2021

Cli: use get_inflation_rewards and limit epochs queried #16408

Merged

oJshua merged commit e501fa5 into solana-labs:master Apr 7, 2021

mergify bot mentioned this pull request Apr 7, 2021

Rpc: introduce get_inflation_reward rpc call (bp #16278) #16409

Merged

mergify bot mentioned this pull request Apr 7, 2021

Rpc: introduce get_inflation_reward rpc call (bp #16278) #16410

Merged

CriesofCarrots mentioned this pull request Aug 13, 2021

No RPC API to easily figure rewards for a specific stake or vote account #11251

Closed

brooksprumo mentioned this pull request Aug 23, 2021

backport 19361 v16 #19379

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rpc: introduce get_inflation_reward rpc call #16278

Rpc: introduce get_inflation_reward rpc call #16278

oJshua commented Mar 31, 2021 •

edited

Loading

codecov bot commented Apr 1, 2021 •

edited

Loading

oJshua commented Apr 1, 2021

CriesofCarrots left a comment

mvines commented Apr 2, 2021

oJshua commented Apr 2, 2021

mvines commented Apr 2, 2021

CriesofCarrots commented Apr 2, 2021

mvines commented Apr 2, 2021

CriesofCarrots commented Apr 2, 2021

mvines commented Apr 2, 2021

Rpc: introduce get_inflation_reward rpc call #16278

Rpc: introduce get_inflation_reward rpc call #16278

Conversation

oJshua commented Mar 31, 2021 • edited Loading

Problem

Summary of Changes

codecov bot commented Apr 1, 2021 • edited Loading

Codecov Report

oJshua commented Apr 1, 2021

CriesofCarrots left a comment

Choose a reason for hiding this comment

mvines commented Apr 2, 2021

oJshua commented Apr 2, 2021

mvines commented Apr 2, 2021

CriesofCarrots commented Apr 2, 2021

mvines commented Apr 2, 2021

CriesofCarrots commented Apr 2, 2021

mvines commented Apr 2, 2021

oJshua commented Mar 31, 2021 •

edited

Loading

codecov bot commented Apr 1, 2021 •

edited

Loading