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!: adapt swap_router for SwapRouter02 #118

Merged
merged 1 commit into from
Dec 23, 2024
Merged

Conversation

shuhuiluo
Copy link
Owner

@shuhuiluo shuhuiluo commented Dec 23, 2024

The deadline field was removed from SwapOptions, delegating deadline validation to the multicall contract. Additionally, integrations with ISwapRouter were transitioned to IV3SwapRouter, with corresponding method and struct updates. Test cases and calldata expectations were adjusted to reflect the changes.

Summary by CodeRabbit

  • New Features

    • Renamed the swap router interface to IV3SwapRouter.
  • Bug Fixes

    • Removed the deadline parameter from multiple transaction parameter structs, which may enhance transaction handling.

The `deadline` field was removed from `SwapOptions`, delegating deadline validation to the `multicall` contract. Additionally, integrations with `ISwapRouter` were transitioned to `IV3SwapRouter`, with corresponding method and struct updates. Test cases and calldata expectations were adjusted to reflect the changes.
Copy link
Contributor

coderabbitai bot commented Dec 23, 2024

Walkthrough

In this pull request, the ISwapRouter interface in src/abi.rs undergoes a transformation. The interface is renamed to IV3SwapRouter, and a significant structural change occurs: the deadline parameter is systematically removed from four key parameter structs. This modification suggests a fundamental shift in how timing constraints are managed within the swap router's interface, potentially indicating an evolution in transaction handling methodology.

Changes

File Change Summary
src/abi.rs - Renamed ISwapRouter to IV3SwapRouter
- Removed deadline from ExactInputSingleParams
- Removed deadline from ExactInputParams
- Removed deadline from ExactOutputSingleParams
- Removed deadline from ExactOutputParams

Possibly related PRs

Poem

Deadline vanished, like Schrödinger's cat
Swap router evolves, imagine that!
Structs refined with surgical precision
A code transformation, my latest mission 🧪

[Adjusts glasses] Bazinga!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 774821e and ce4659d.

📒 Files selected for processing (1)
  • src/abi.rs (1 hunks)
🔇 Additional comments (1)
src/abi.rs (1)

Line range hint 277-308: Bazinga! The renaming and field removal appear logically sound.

Renaming ISwapRouter to IV3SwapRouter is fitting for versioning. Removing the deadline from these parameter structs shifts timing checks beyond this interface, presumably to your multicall system. Kindly validate all downstream usage aligns with the new struct definitions.

✅ Verification successful

Fascinating! The removal of deadline from IV3SwapRouter is indeed validated by empirical evidence.

The search results confirm that the deadline parameter has been intentionally moved to the multicall system, as explicitly documented in src/swap_router.rs:

"The check on deadline is delegated to [multicall]"

While the deadline field appears in various other interfaces (IERC20Permit, IDaiPermit, etc.), none of these occurrences relate to the IV3SwapRouter interface, indicating a clean architectural separation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Searching for old references to `ISwapRouter` or usage of `deadline`.
rg -A 5 'ISwapRouter'
rg -A 5 'deadline'

Length of output: 13445


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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@shuhuiluo shuhuiluo merged commit d334f67 into master Dec 23, 2024
3 checks passed
@shuhuiluo shuhuiluo deleted the swap-router-02 branch December 23, 2024 05:01
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