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: Liquidity deposits via addLiquidityAndStake are vulnerable to sandwich attack #169

Conversation

andresaiello
Copy link
Collaborator

@andresaiello andresaiello commented Aug 20, 2024

Summary

  • Fix by ToB audit

Summary by CodeRabbit

  • New Features

    • Enhanced liquidity management with the addition of minimum token amount parameters in liquidity functions.
    • Users can now specify minimum amounts for tokens during liquidity addition to mitigate slippage risks.
  • Bug Fixes

    • Improved reliability of the addLiquidityAndStake function in tests by ensuring asynchronous operations complete before proceeding.

Copy link

coderabbitai bot commented Aug 20, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

Walkthrough

The recent updates to the RewardDistributor contract enhance liquidity management by introducing parameters for minimum token amounts during liquidity addition. This improves control and reduces risks associated with slippage. Corresponding adjustments were made in the testing suite to align with the updated function signatures, ensuring comprehensive coverage of the new functionality. Additionally, asynchronous behavior was improved in the MultipleOutput.spec.ts tests to enhance reliability.

Changes

Files Change Summary
packages/zevm-app-contracts/contracts/liquidity-incentives/RewardDistributor.sol Updated _addLiquidity and addLiquidityAndStake functions to include amountAMin and amountBMin for improved liquidity management.
packages/zevm-app-contracts/test/LiquidityIncentives.spec.ts Modified calls to addLiquidityAndStake to accept four parameters, updating test cases to match new function signatures.
packages/zevm-app-contracts/test/MultipleOutput.spec.ts Added await keyword to registerDestinationToken calls for improved asynchronous handling in tests.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant RewardDistributor
    participant TokenA
    participant TokenB

    User->>RewardDistributor: addLiquidityAndStake(tokenAddress, amount, amountAMin, amountBMin)
    RewardDistributor->>TokenA: Transfer(amount)
    RewardDistributor->>TokenB: Transfer(amount)
    RewardDistributor->>RewardDistributor: Validate amounts against amountAMin and amountBMin
    RewardDistributor->>User: Confirm liquidity addition
Loading

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 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 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
Collaborator

@GMaiolo GMaiolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK

@andresaiello andresaiello merged commit 03f8b9a into main Aug 20, 2024
10 checks passed
@andresaiello andresaiello deleted the andy/Liquidity-deposits-via-addLiquidityAndStake-are-vulnerable-to-sandwich-attacks branch August 20, 2024 15:37
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.

2 participants