cosmos / cosmos-sdk

:chains: A Framework for Building High Value Public Blockchains :sparkles:
https://cosmos.network/
Apache License 2.0
6.07k stars 3.48k forks source link

refactor(x/protocolpool)!: Reducing complexity and removing some bugs #20786

Closed facundomedica closed 2 days ago

facundomedica commented 4 days ago

Description

Changes done:

  1. Added basic integration tests and some more unit tests
  2. Removed RecipientFundPercentage, as having this number without its fund's expiration is useless. We should always use the ContinuousFund and check its expiration.
  3. Reduced some duplicated code
  4. SetToDistribute now adds on top of the previous value
  5. Reduced conversions between math.Int and math.LegacyDec
  6. Simplified iterateAndUpdateFundsDistribution (the math and reduced iterations).
  7. Funds were being distributed from the total community pool, not just from the funds that we got from x/distribution

(Made iterateAndUpdateFundsDistribution exported for a bit just to cut some corners, will make it non-exported again)


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.

I have...

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

Summary by CodeRabbit

coderabbitai[bot] commented 4 days ago

[!WARNING]

Rate limit exceeded

@facundomedica has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 35 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](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between f28ec0c458fdaab479cfd07cf82c0a5d76449ee6 and 760d354cb9237eb1eda8ff2b6a3e42fe30e4b193.

Walkthrough

The recent updates enhance the testing framework for the protocolpool package by adding new test functions to validate fund withdrawal and expiration scenarios. Additionally, significant modifications to the Keeper in x/protocolpool/keeper streamline fund distribution logic, remove the RecipientFundPercentage map, and update method signatures and calculations. A new test function for iterating and updating fund distribution ensures these changes work correctly.

Changes

File Summary
tests/integration/protocolpool/... Added tests for fund withdrawals and expiration scenarios in module_test.go.
x/protocolpool/keeper/keeper.go Removed RecipientFundPercentage map, updated fund distribution logic, and renamed methods.
x/protocolpool/keeper/keeper_test.go Introduced TestIterateAndUpdateFundsDistribution to validate new distribution logic.

Sequence Diagram(s)

sequenceDiagram
    participant TestModule as Test Module
    participant ProtocolPool as Protocol Pool
    participant Keeper as Keeper

    TestModule->>+ProtocolPool: TestWithdrawAnytime()
    ProtocolPool->>+Keeper: Withdraw Fund
    Keeper-->>-ProtocolPool: Fund Withdrawn

    TestModule->>+ProtocolPool: TestExpireInTheMiddle()
    ProtocolPool->>+Keeper: Check Fund Expiry
    Keeper-->>-ProtocolPool: Fund Expired

    TestModule->>+Keeper: TestIterateAndUpdateFundsDistribution()
    Keeper->>+Keeper: Iterate and Update Funds
    Keeper-->>-TestModule: Funds Updated

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@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 as 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. 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
JulianToledano commented 3 days ago

I think this can be removed as is unused https://github.com/cosmos/cosmos-sdk/blob/5f2bcfc416c9464661da6c81ee7d6e50653fa882/x/protocolpool/types/keys.go#L27