Add withdraw options and add fees on provide/withdraw events

[ALPAC-4]

New features

• imbalance_withdraw_liquidity_script: withdraw liquidity with custom amounts of coins.
• single_asset_withdraw_liquidity_script: withdraw function that withdraws only one type of coin.

Update

• add fee_amounts on provide/withdraw events

Fix

• The withdraw action was emitting a provide event, but has now been fixed to emit the correct event.

Summary by CodeRabbit

• New Features

  • Enhanced the ProvideEvent and WithdrawEvent to include detailed fee amounts.
  • Introduced new constant EMAX_LIQUIDITY for improved liquidity management.
  • Added functionality for single asset withdrawal with new functions.

• Improvements

  • Refined swap_simulation for better fee and amount handling.
  • Updated various function signatures for consistency and readability.

• Tests

  • Implemented new test cases for single asset withdrawal and imbalance scenarios.

[coderabbitai[bot]]

Walkthrough

In the stableswap.move module of the initia_std package, several enhancements have been made. Key changes include updates to the ProvideEvent and WithdrawEvent structs, the addition of new constants, and significant modifications to various functions. New functions for liquidity withdrawal and calculations have been introduced, along with additional tests to ensure the correctness of these updates.

Changes

File	Change Summary
precompile/modules/initia_stdlib/sources/...	Updates to ProvideEvent and WithdrawEvent structs to include fee_amounts.
precompile/modules/initia_stdlib/sources/...	Introduced a new constant EMAX_LIQUIDITY with a value of 21.
precompile/modules/initia_stdlib/sources/...	Adjusted get_pool and end_to_end function signatures.
precompile/modules/initia_stdlib/sources/...	Enhanced the swap_simulation function for better handling of amounts and fees.
precompile/modules/initia_stdlib/sources/...	Introduced new functions: single_asset_withdraw_liquidity_script, single_asset_withdraw_liquidity, and additional test functions.
precompile/modules/initia_stdlib/sources/...	Added calculation-specific functions: calc_withdraw_one_coin, calc_withdraw_imbalance, get_y_with_given_d, and swap_simulation_with_given_amounts.

Poem

Amidst the code where logic weaves,
New wonders grow like summer leaves.
Swaps and yields now clear and bright,
Liquidity flows just right.
A rabbit hops in fields of code,
Embracing changes, on we rode.
🌿✨🚀

---

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.