Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pos] Add epoch argument to vp::pos::rewards #4196

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

joel-u410
Copy link
Contributor

@joel-u410 joel-u410 commented Dec 18, 2024

Describe your changes

This adds an epoch argument to the rewards() function in vp::pos. It does require a RPC node update in order to work, but it's backwards compatible. Tested with previous build of namadan and results are same as before:

With node on main and client on this branch:

$ ./target/debug/namadac rewards --source tnam1qrtypl0yazfamk8ptmgp608msl8wzrkpmqwppc7w --validator tnam1qxsx2ezu89gx252kwwluqp7hadyp285tkczhaqg0
Current rewards available for claim: 4625.955882 NAM

With both client and node on this branch:

$ ./target/debug/namadac rewards --source tnam1qrtypl0yazfamk8ptmgp608msl8wzrkpmqwppc7w --validator tnam1qxsx2ezu89gx252kwwluqp7hadyp285tkczhaqg0
Current rewards available for claim: 4625.955882 NAM

$ ./target/debug/namadac rewards --source tnam1qrtypl0yazfamk8ptmgp608msl8wzrkpmqwppc7w --validator tnam1qxsx2ezu89gx252kwwluqp7hadyp285tkczhaqg0 --epoch 60
Rewards for epoch 60: 4625.955882 NAM

$ ./target/debug/namadac rewards --source tnam1qrtypl0yazfamk8ptmgp608msl8wzrkpmqwppc7w --validator tnam1qxsx2ezu89gx252kwwluqp7hadyp285tkczhaqg0 --epoch 59
Rewards for epoch 59: 3887.536527 NAM

$ ./target/debug/namadac rewards --source tnam1qrtypl0yazfamk8ptmgp608msl8wzrkpmqwppc7w --validator tnam1qxsx2ezu89gx252kwwluqp7hadyp285tkczhaqg0 --epoch 58
Rewards for epoch 58: 3148.755426 NAM

Checklist before merging

  • If this PR has some consensus breaking changes, I added the corresponding breaking:: labels
    • This will require 2 reviewers to approve the changes
  • If this PR requires changes to the docs or specs, a corresponding PR is opened in the namada-docs repo
    • Relevant PR if applies: (coming soon)
  • If this PR affects services such as namada-indexer or namada-masp-indexer, a corresponding PR is opened in that repo

Copy link

codecov bot commented Dec 18, 2024

Codecov Report

Attention: Patch coverage is 13.79310% with 50 lines in your changes missing coverage. Please review.

Project coverage is 74.42%. Comparing base (2ae305c) to head (89df61f).
Report is 3 commits behind head on main.

Files with missing lines Patch % Lines
crates/sdk/src/queries/vp/pos.rs 12.28% 50 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4196      +/-   ##
==========================================
- Coverage   74.46%   74.42%   -0.05%     
==========================================
  Files         342      342              
  Lines      107773   107826      +53     
==========================================
- Hits        80257    80252       -5     
- Misses      27516    27574      +58     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@joel-u410
Copy link
Contributor Author

Testing that this behaves as expected for a validator that claimed rewards in epoch 51:

$ ./target/debug/namadac rewards --validator tnam1qyf80vw4e8aa2efuk4jsg9lpwxrntsj2dql4tssa --epoch 50
Rewards for epoch 50: 2.179855 NAM

$ ./target/debug/namadac rewards --validator tnam1qyf80vw4e8aa2efuk4jsg9lpwxrntsj2dql4tssa --epoch 51
Rewards for epoch 51: 4.363707 NAM

$ ./target/debug/namadac rewards --validator tnam1qyf80vw4e8aa2efuk4jsg9lpwxrntsj2dql4tssa --epoch 52
Rewards for epoch 52: 2.897536 NAM

@joel-u410
Copy link
Contributor Author

joel-u410 commented Dec 19, 2024

Of particular note, this code accounts for the rewards_counter when specifying an epoch by:

  • Subtracting the current counter that was included by query_reward_tokens
  • Adding the historical counter queried from storage at the height of epoch start

@Fraccaman Fraccaman requested a review from tzemanovic December 19, 2024 12:27
@brentstone
Copy link
Collaborator

Mind adding some unit tests here to demonstrate the behavior too @joel-u410?

@joel-u410
Copy link
Contributor Author

Mind adding some unit tests here to demonstrate the behavior too @joel-u410?

For sure, I can look into that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants