Fix: increase exit pool slippage with high precision amounts

[jonator]

What is the purpose of the change:

Linear Task

Fixes FE-1089: Troubleshoot error removing lp from pool 1016

Brief Changelog

• If the amount is high precision, increase default slippage tolerance

Testing and Verifying

Tested locally

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
osmosis-frontend	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 26, 2024 7:28pm

4 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
osmosis-frontend-datadog	⬜️ Ignored (Inspect)	Visit Preview		Sep 26, 2024 7:28pm
osmosis-frontend-dev	⬜️ Ignored (Inspect)	Visit Preview		Sep 26, 2024 7:28pm
osmosis-frontend-edgenet	⬜️ Ignored (Inspect)			Sep 26, 2024 7:28pm
osmosis-testnet	⬜️ Ignored (Inspect)	Visit Preview		Sep 26, 2024 7:28pm

[coderabbitai]

Walkthrough

The changes introduce a new constant HIGH_DEFAULT_SLIPPAGE set to "15" in the packages/stores/src/account/osmosis/index.ts file. This constant is utilized in the exitPool method of the OsmosisAccountImpl class to adjust the maxSlippage based on the precision of token amounts. The method's documentation has been updated to reflect this new default slippage value for high precision scenarios.

Changes

File Path	Change Summary
packages/stores/src/account/osmosis/index.ts	Added constant HIGH_DEFAULT_SLIPPAGE = "15"; updated maxSlippage documentation in exitPool method; added conditional logic for slippage based on poolAssets amount length.

Possibly related PRs

• check for nil response data in numia tokens endpoint #3847: This PR addresses handling null values in token data, which may indirectly relate to slippage calculations if liquidity data is involved in determining slippage tolerance.
• fix: amino signing for withdraw position message #3852: This PR modifies how liquidity amounts are processed in the context of withdrawal messages, which could be relevant to the handling of slippage in transactions involving liquidity.

Suggested reviewers

• p0mvn
• CryptoAssassin1
• MaxMillington
• JoseRFelix

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between fefd949 and a7658a2.

📒 Files selected for processing (1)

• packages/stores/src/account/osmosis/index.ts (3 hunks)

🔇 Additional comments (4)

packages/stores/src/account/osmosis/index.ts (4)

54-54: LGTM: New constant for high slippage tolerance added.

The addition of HIGH_DEFAULT_SLIPPAGE with a value of "15" is appropriate for handling high precision amounts. This aligns well with the PR objective of addressing issues when removing liquidity from specific pools.

---

Line range hint 1418-1453: LGTM: Improved handling of high precision amounts in exitPool.

The changes to the sendExitPoolMsg method are well-implemented:

1. Additional parameters (poolTotalShares, poolAssets, poolExitFee) provide more context for accurate calculations.
2. The conditional check for high precision amounts (length > 18) is a good approach to detect when higher slippage tolerance is needed.
3. Setting maxSlippage to HIGH_DEFAULT_SLIPPAGE when high precision amounts are detected aligns with the PR objectives of reducing errors when removing liquidity from specific pools.

These changes should effectively address the issues mentioned in the PR summary.

---

Line range hint 1-2311: Summary: Improved handling of high precision amounts in exit pool operations.

The changes in this file effectively address the issue of handling high precision amounts when exiting pools:

1. A new constant HIGH_DEFAULT_SLIPPAGE has been introduced.
2. The sendExitPoolMsg method has been updated to dynamically adjust the slippage tolerance based on the precision of the amounts involved.
3. The implementation aligns well with the PR objectives of reducing errors when removing liquidity from specific pools.

These changes provide a more flexible and robust solution for different scenarios without affecting other parts of the codebase. The localized nature of the changes minimizes the risk of unintended side effects.

Overall, this implementation should improve the user experience by reducing errors encountered when attempting to remove liquidity from pool 1016, as mentioned in the PR summary.

---

Line range hint 1418-1453: Verify impact on other parts of the system.

The changes to sendExitPoolMsg improve handling of high precision amounts in exit pool operations. The dynamic adjustment of slippage tolerance provides a more flexible solution. However, it's important to ensure this change doesn't introduce unexpected behavior in other parts of the system that may rely on the default slippage value.

To verify:

1. Check if there are any other methods or components that assume a fixed slippage value.
2. Test the exit pool operation with various precision levels to ensure smooth transitions between default and high slippage tolerances.
3. Update any relevant documentation or comments that mention the default slippage value.

---

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.

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.