feat: add function to withdraw and check delegator rewards

[fbac]

Description

Add distribute functions to the staking precompile:

• getDelegatorValidators: returns all the validators where a delegator has delegated to.
• getRewards: returns all the outstanding rewards in a validator for an specific delegator.
• claimRewards: claims all the delegation rewards. The caller has to be the delegator, or a contract called by the delegator.

How Has This Been Tested?

• Tested CCTX in localnet
• Tested in development environment
• Go unit tests
• Go integration tests
• Tested via GitHub Actions

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov]

Codecov Report

Attention: Patch coverage is 9.44882% with 230 lines in your changes missing coverage. Please review.

Project coverage is 62.60%. Comparing base (043e776) to head (69d00bd).
Report is 10 commits behind head on develop.

Files with missing lines	Patch %	Lines
precompiles/staking/method_claim_rewards.go	0.00%	86 Missing ⚠️
precompiles/staking/method_get_rewards.go	0.00%	54 Missing ⚠️
precompiles/staking/method_get_validators.go	0.00%	35 Missing ⚠️
precompiles/staking/staking.go	31.25%	33 Missing ⚠️
precompiles/staking/logs.go	0.00%	20 Missing ⚠️
precompiles/types/coin.go	0.00%	2 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3088      +/-   ##
===========================================
- Coverage    63.43%   62.60%   -0.83%     
===========================================
  Files          425      428       +3     
  Lines        30003    30405     +402     
===========================================
+ Hits         19031    19034       +3     
- Misses       10137    10537     +400     
+ Partials       835      834       -1     

Files with missing lines	Coverage Δ
precompiles/precompiles.go	100.00% <100.00%> (ø)
precompiles/types/coin.go	31.03% <0.00%> (-2.30%)	⬇️
precompiles/staking/logs.go	13.08% <0.00%> (-3.01%)	⬇️
precompiles/staking/staking.go	59.20% <31.25%> (-9.98%)	⬇️
precompiles/staking/method_get_validators.go	0.00% <0.00%> (ø)
precompiles/staking/method_get_rewards.go	0.00% <0.00%> (ø)
precompiles/staking/method_claim_rewards.go	0.00% <0.00%> (ø)

... and 18 files with indirect coverage changes

[fbac]

Do we want this function to actually withdraw the ZRC20?
An alternative could be withdrawing the cosmos coin to the delegator cosmos address, and then the delegator would unlock these coins from the bank precompile.

[lumtis]

I think it's better to keep the full workflow at the EVM.
Now you can still call a bank precompile from the same contract in the call but I think if you have a claim function it's would be intuitive that the claim is represented by a transfer on the EVM side