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(pool_manager): fix withdrawing lp when the pool has assets with 18 decimals #88

Merged
merged 1 commit into from
Nov 6, 2024

Conversation

mantricjavier
Copy link
Collaborator

@mantricjavier mantricjavier commented Nov 6, 2024

Description and Motivation

This PR fixes withdrawing LP when the pool has assets with 18 decimal places. Complements #87 .

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

    • Updated package version to 0.1.5, enhancing overall stability.
    • Improved precision in liquidity management calculations by transitioning to new data types.
  • Bug Fixes

    • Enhanced error handling for asset mismatches, ensuring more robust contract interactions.
  • Tests

    • Added new test cases for liquidity provision and swaps with high precision assets.
    • Updated existing tests to include additional assertions and checks for accuracy and error handling.
  • Chores

    • Minor code cleanup for improved readability and structure in the test suite.

Copy link

coderabbitai bot commented Nov 6, 2024

Walkthrough

The pull request includes updates to the Cargo.toml file for the pool-manager package, incrementing the package version from 0.1.4 to 0.1.5. Additionally, significant changes were made to the commands.rs file, transitioning from Decimal and Uint128 types to Decimal256 and Uint256 for improved precision in liquidity management functions. The integration tests in integration_tests.rs were also enhanced with new test cases, modifications to existing tests, and improved error handling to ensure comprehensive coverage of the updated functionality.

Changes

File Path Change Summary
contracts/pool-manager/Cargo.toml Updated package version from 0.1.4 to 0.1.5.
contracts/pool-manager/src/liquidity/commands.rs Changed provide_liquidity and withdraw_liquidity functions to use Decimal256 and Uint256 instead of Decimal and Uint128. Updated error handling and import statements.
contracts/pool-manager/src/tests/integration_tests.rs Added new tests for handling 18 decimal places, modified existing tests for improved assertions, and cleaned up code formatting.
contracts/pool-manager/schema/pool-manager.json Updated contract version from "0.1.4" to "0.1.5".

Poem

🐰 In the meadow where numbers play,
A version hops, brightening the day.
With precision now in every stride,
Liquidity flows, a joyful ride!
New tests join the fun, oh what a sight,
In the world of code, everything feels right! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 80cf19c and 05dce93.

⛔ Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
📒 Files selected for processing (4)
  • contracts/pool-manager/Cargo.toml (1 hunks)
  • contracts/pool-manager/schema/pool-manager.json (1 hunks)
  • contracts/pool-manager/src/liquidity/commands.rs (3 hunks)
  • contracts/pool-manager/src/tests/integration_tests.rs (13 hunks)

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.

Copy link

github-actions bot commented Nov 6, 2024

Schema generation had missing jobs:

contracts/pool-manager/schema/pool-manager.json

Please run just schemas locally and upload the generated schemas.

@mantricjavier mantricjavier force-pushed the hotfix/withdrawing_lp_18_decimals branch from 80cf19c to 05dce93 Compare November 6, 2024 10:02
@mantricjavier mantricjavier merged commit 9b024a1 into main Nov 6, 2024
4 of 5 checks passed
@mantricjavier mantricjavier deleted the hotfix/withdrawing_lp_18_decimals branch November 6, 2024 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant