refactor(farm_manager): remove rewards validation on position withdrawal #82

mantricjavier · 2024-10-23T13:44:00Z

Description and Motivation

It didn't make sense to verify if the user had pending rewards when withdrawing a position due to the following reasons:

Closed positions don't accumulate rewards.
If an open position was going to be withdrawn with the emergency unlock, the user would forfeit its rewards anyway.
Withdrawing an open position with the emergency unlock updates the weights on the contract, which was the main reason why the user was force to claim rewards in the first place.
Ultimately, it would prevent users to withdraw closed positions easily without taking an additional action on their open positions.

Related Issues

Checklist:

I have read MANTRA's contribution guidelines.
My pull request has a sound title and description (not something vague like Update index.md)
All existing and new tests are passing.
I updated/added relevant documentation.
The code is formatted properly cargo fmt --all --.
Clippy doesn't report any issues cargo clippy -- -D warnings.
I have regenerated the schemas if needed with just schemas.

Summary by CodeRabbit

New Features
- Introduced an emergency withdrawal option, allowing users to withdraw funds before a position expires, subject to a penalty fee.
Bug Fixes
- Enhanced error handling in integration tests for various scenarios, ensuring more robust validation of farm and position management.
Tests
- Added new integration tests to verify the functionality of emergency withdrawals and weight updates after withdrawals.

coderabbitai · 2024-10-23T13:44:10Z

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request include an update to the Cargo.toml file for the farm-manager package, where the version is incremented from 0.1.3 to 0.1.4. Additionally, modifications were made to the withdraw_position function in commands.rs, introducing an emergency_unlock parameter to facilitate emergency withdrawals with a penalty fee structure. Integration tests in integration.rs were also enhanced, including the addition of a new test for verifying LP weight updates after emergency withdrawals and various adjustments to existing tests for improved error handling and logic verification.

Changes

File Path	Change Summary
`contracts/farm-manager/Cargo.toml`	Version updated from `0.1.3` to `0.1.4`.
`contracts/farm-manager/src/position/commands.rs`	Updated `withdraw_position` function to include `emergency_unlock: Option<bool>` parameter and modified withdrawal logic.
`contracts/farm-manager/tests/integration.rs`	Added `test_withdrawing_open_positions_updates_weight`, adjusted multiple test method signatures for improved logic and error handling.

Poem

In the fields where rabbits play,
A new version hops in today!
With emergency unlocks so bright,
We can withdraw with delight.
Testing now is sharper and keen,
A joyful leap in our code scene! 🐇✨

Note

🎁 Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.

🪧 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.

CodeRabbit Configuration 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.

mantricjavier · 2024-10-23T13:44:24Z

contracts/farm-manager/src/position/commands.rs

@@ -307,16 +308,13 @@ pub(crate) fn withdraw_position(
        ContractError::Unauthorized
    );

-    if emergency_unlock.is_none() || emergency_unlock.is_some() && !emergency_unlock.unwrap() {


Not making sense anymore.

mantricjavier · 2024-10-23T13:46:38Z

contracts/farm-manager/tests/integration.rs

@@ -1906,26 +1905,21 @@ pub fn test_manage_position() {
            },
            vec![],
            |result| {
-                let err = result.unwrap_err().downcast::<ContractError>().unwrap();
-                match err {


Would not error anymore, as the pending rewards check is not being done.

mantricjavier · 2024-10-23T13:47:33Z

contracts/farm-manager/tests/integration.rs

@@ -2299,6 +2279,161 @@ pub fn test_manage_position() {
        );
 }

+#[test]
+#[allow(clippy::inconsistent_digit_grouping)]
+pub fn test_withdrawing_open_positions_updates_weight() {


A test to verify the weight is being updated properly when withdrawing an open position when the emergency unlock flag is used.

mantricjavier commented Oct 23, 2024

View reviewed changes

refactor(farm_manager): remove rewards validation on position withdrawal

3f8d4dc

mantricjavier force-pushed the refactor/remove-claiming-gs branch from 56867e8 to 3f8d4dc Compare October 23, 2024 13:45

mantricjavier commented Oct 23, 2024

View reviewed changes

mantricjavier merged commit 81baa8c into main Oct 23, 2024
4 of 5 checks passed

mantricjavier deleted the refactor/remove-claiming-gs branch October 23, 2024 13:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(farm_manager): remove rewards validation on position withdrawal #82

refactor(farm_manager): remove rewards validation on position withdrawal #82

mantricjavier commented Oct 23, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 23, 2024 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

mantricjavier Oct 23, 2024

mantricjavier Oct 23, 2024

mantricjavier Oct 23, 2024

refactor(farm_manager): remove rewards validation on position withdrawal #82

refactor(farm_manager): remove rewards validation on position withdrawal #82

Conversation

mantricjavier commented Oct 23, 2024 • edited by coderabbitai bot Loading

Description and Motivation

Related Issues

Checklist:

Summary by CodeRabbit

coderabbitai bot commented Oct 23, 2024 • edited Loading

Review failed

Walkthrough

Changes

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

mantricjavier Oct 23, 2024

Choose a reason for hiding this comment

mantricjavier Oct 23, 2024

Choose a reason for hiding this comment

mantricjavier Oct 23, 2024

Choose a reason for hiding this comment

mantricjavier commented Oct 23, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Oct 23, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)