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

fix: Implement redepositing of forfeited incentives (backport #7746) #7793

Merged
merged 1 commit into from
Mar 22, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Mar 21, 2024

Closes: #7744

What is the purpose of the change

This PR implements redepositing of forfeited incentives into pool uptime accumulators. It replaces the previous approach, which sent forfeited funds to the community pool (see issue for discussion on why this is problematic).

Testing and Verifying

  • Existing tests were amended to reflect the impact from the implemented changes. Any new functions/helpers are separately tested

Documentation and Release Note

  • Does this pull request introduce a new feature or user-facing behavior changes?
  • Changelog entry added to Unreleased section of CHANGELOG.md?

Where is the change documented?

  • Specification (x/{module}/README.md)
  • Osmosis documentation site
  • Code comments?
  • N/A

Summary by CodeRabbit

  • New Features
    • Introduced functionality to scale down incentive amounts and redeposit forfeited incentives back into the pool.
  • Bug Fixes
    • Added comprehensive handling for forfeited incentives during position withdrawals and incentive collections.
  • Documentation
    • Updated CHANGELOG.md to reflect changes in incentive handling in version v23.0.7-iavl-v1.
  • Refactor
    • Enhanced the logic for calculating and asserting expected incentives, including handling of forfeited incentives.
  • Tests
    • Adjusted and added tests to cover new logic for incentive collection, scaling, and redepositing.
  • Chores
    • Code cleanup including the removal of unused imports and the addition of necessary imports.
  • New Error Types
    • Added InvalidForfeitedIncentivesLengthError to handle errors related to mismatch in expected length of forfeited incentives.

This is an automatic backport of pull request #7746 done by [Mergify](https://mergify.com).

* implement redepositing of forfeited incentives

* fix broken tests to follow new logic

* changelog

* convert tracker for forfeited incentives from map to slice

* clean up comments

* move new lp logic into helper

* remove prints

* clean up helper logic

* clean up test comments

* tests for new helper

* further test cleanup

* simplify test helper logic

* fix tests to work with new supported uptimes

* add thorough godoc for redepositing logic

* apply comment fixes from review

Co-authored-by: Adam Tucker <[email protected]>

* further clean up comments

---------

Co-authored-by: Adam Tucker <[email protected]>
(cherry picked from commit 446d894)
Copy link
Contributor

coderabbitai bot commented Mar 21, 2024

Important

Auto Review Skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

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-tests 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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@PaddyMc PaddyMc merged commit db38847 into v24.x Mar 22, 2024
1 check passed
@PaddyMc PaddyMc deleted the mergify/bp/v24.x/pr-7746 branch March 22, 2024 10:31
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