feat: support multiple denoms for delegation rewards #176

mbreithecker · 2024-04-29T08:06:01Z

This PR adjust the delegation module and its algorithm to support multiple coin denominations for reward payouts.

Summary by CodeRabbit

Documentation
- Updated API documentation to reflect changes in reward data structures.
New Features
- Enhanced reward tracking and distribution to support multiple denominations.
Bug Fixes
- Corrected reward-related field names for consistency across various responses.
Refactor
- Streamlined reward handling and payout processes in delegation management.
Tests
- Updated integration and unit tests to align with new reward structures and logic.

coderabbitai · 2024-04-29T08:06:09Z

Warning

Rate Limit Exceeded

@mbreithecker has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 26 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 95d480e and 1b9fc6c.

Walkthrough

The recent updates involve a significant transformation in reward management, transitioning to arrays of objects or sdk.Coins to handle diverse denominations. These changes impact various system aspects like data structures, API responses, and internal mechanisms, enhancing adaptability and resilience.

Changes

Files	Change Summary
`docs/static/openapi.yml`, `proto/.../delegation.proto`, `proto/.../events.proto`, `proto/.../account.proto`, `proto/.../delegation.proto`	Fields updated to arrays of objects or `sdk.Coins` for managing multiple reward denominations. Added necessary imports.
`testutil/integration/...`, `x/bundles/keeper/...`, `x/delegation/keeper/...`	Adjusted test assertions and internal logic to accommodate the new reward data structure. Enhanced minting functions to specify denominations.
`x/query/keeper/...`	Modified GRPC responses to align with changes in reward data structures, ensuring compliance with updated protocol specifications.

🐰 Poem by CodeRabbit

In the realm of code, where logic threads weave,
A change was made, in how rewards we perceive.
From strings to coins, a leap so bold,
A tale of updates, through binaries told.
🌟🚀 Gather 'round, let's cheer, for the devs so bright,
In the dance of bits, they bring dreams to light!

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

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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.

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 as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

coderabbitai

Actionable comments posted: 0

Out of diff range and nitpick comments (1)

x/delegation/keeper/logic_delegation.go (1)

59-72: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [62-79]

The updated performWithdrawal function correctly handles multiple coin denominations and introduces robust error handling.

Consider whether PanicHalt is the best approach for handling cases where no money is left in the module, as it might be beneficial to allow for a softer error recovery strategy.

…denoms

x/delegation/keeper/msg_server_withdraw_rewards_test.go

troykessler

Please also update the x/delegation spec files

…denoms # Conflicts: # x/bundles/keeper/msg_server_submit_bundle_proposal.go

x/delegation/keeper/logic_f1distribution.go

x/delegation/keeper/logic_delegation.go

troykessler · 2024-05-02T15:16:35Z

Also, should the migration be implemented here or afterwards when the entire multiple coin feature is fully implemented?

testutil/integration/checks.go

x/delegation/keeper/logic_f1distribution.go

x/delegation/keeper/keeper_suite_test.go

…denoms

mbreithecker added 3 commits April 26, 2024 16:44

feat: support multiple coins as delegation rewards

33238d2

chore: format

1992878

test: align existing tests

871e820

test: add more tests for multiple denoms

80d52aa

mbreithecker marked this pull request as ready for review April 29, 2024 12:31

mbreithecker requested review from troykessler and shifty11 as code owners April 29, 2024 12:31

coderabbitai bot reviewed Apr 29, 2024

View reviewed changes

Merge branch 'refs/heads/main' into mbreithecker/delegation-multiple-…

dcf0cb0

…denoms

shifty11 approved these changes Apr 30, 2024

View reviewed changes

x/delegation/keeper/msg_server_withdraw_rewards_test.go Outdated Show resolved Hide resolved

shifty11 previously approved these changes Apr 30, 2024

View reviewed changes

troykessler requested changes Apr 30, 2024

View reviewed changes

mbreithecker added 2 commits May 2, 2024 13:32

chore: update specs + small nits

6c309f4

Merge branch 'refs/heads/main' into mbreithecker/delegation-multiple-…

e96b190

…denoms # Conflicts: # x/bundles/keeper/msg_server_submit_bundle_proposal.go

mbreithecker dismissed shifty11’s stale review via e96b190 May 2, 2024 11:48

shifty11 previously approved these changes May 2, 2024

View reviewed changes

troykessler reviewed May 2, 2024

View reviewed changes

x/delegation/keeper/logic_f1distribution.go Show resolved Hide resolved

x/delegation/keeper/logic_delegation.go Show resolved Hide resolved

troykessler reviewed May 3, 2024

View reviewed changes

testutil/integration/checks.go Outdated Show resolved Hide resolved

x/delegation/keeper/logic_f1distribution.go Outdated Show resolved Hide resolved

x/delegation/keeper/keeper_suite_test.go Show resolved Hide resolved

chore: resolve comments

2c35c71

mbreithecker dismissed shifty11’s stale review via 2c35c71 May 3, 2024 09:20

mbreithecker added 2 commits May 3, 2024 11:30

Merge branch 'refs/heads/main' into mbreithecker/delegation-multiple-…

95d480e

…denoms

chore: small nits

1b9fc6c

mbreithecker requested a review from troykessler May 3, 2024 09:33

troykessler approved these changes May 3, 2024

View reviewed changes

mbreithecker merged commit 7358839 into main May 3, 2024
5 checks passed

mbreithecker deleted the mbreithecker/delegation-multiple-denoms branch May 3, 2024 12:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support multiple denoms for delegation rewards #176

feat: support multiple denoms for delegation rewards #176

mbreithecker commented Apr 29, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 29, 2024 •

edited

Loading

Rate Limit Exceeded

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

troykessler left a comment

troykessler commented May 2, 2024

feat: support multiple denoms for delegation rewards #176

feat: support multiple denoms for delegation rewards #176

Conversation

mbreithecker commented Apr 29, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Apr 29, 2024 • edited Loading

Rate Limit Exceeded

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

troykessler left a comment

Choose a reason for hiding this comment

troykessler commented May 2, 2024

mbreithecker commented Apr 29, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 29, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)