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

Chore: update quoter v2 config #320

Merged
merged 4 commits into from
Mar 29, 2024
Merged

Conversation

ChiTimesChi
Copy link
Collaborator

@ChiTimesChi ChiTimesChi commented Mar 14, 2024

Description

Also includes the artifacts for SwapQuoterV2 on Canto which was deployed some time ago, but never pushed 😮‍💨

Checklist

  • New Contracts have been tested
  • Lint has been run
  • I have checked my code and corrected any misspellings

Summary by CodeRabbit

  • Refactor
    • Improved the handling of ignored pools in the SaveConfigQuoterV2 contract, allowing for more flexible configurations.

Copy link

coderabbitai bot commented Mar 14, 2024

Walkthrough

The SaveConfigQuoterV2 contract has been enhanced for better management of ignored pools. The update involves refactoring the process of loading and marking these pools, introducing a distinction between global and chain-specific configurations. This change streamlines the handling of ignored pools, improving the contract's efficiency and flexibility.

Changes

File Path Change Summary
.../quoter/SaveConfigQuoterV2.s.sol Refactored loading and marking of ignored pools. Introduced markIgnoredPools for separate handling of global and chain-specific configurations.

🐇✨
In the realm of code, where smart contracts bloom,
A quoter was tweaked, dispelling its gloom.
Ignored pools, once muddled, now clearly marked,
With global and local paths distinctly embarked.
So here's to the devs, with wisdom so bold,
Crafting futures in blockchain, a sight to behold.
🌟🐰

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-tests 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 tests 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 tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@coveralls
Copy link

Pull Request Test Coverage Report for Build 8285687609

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 12.934%

Totals Coverage Status
Change from base Build 8163211251: 0.0%
Covered Lines: 664
Relevant Lines: 4684

💛 - Coveralls

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 47fe6e8 and 5f35fa2.
Files ignored due to path filters (5)
  • deployments/canto/DefaultPoolCalc.json is excluded by: !**/*.json
  • deployments/canto/SwapQuoterV2.json is excluded by: !**/*.json
  • script/configs/SwapQuoterV2.ignored.json is excluded by: !**/*.json
  • script/configs/avalanche/SwapQuoterV2.dc.json is excluded by: !**/*.json
  • script/configs/canto/SwapQuoterV2.dc.json is excluded by: !**/*.json
Files selected for processing (1)
  • script/router/quoter/SaveConfigQuoterV2.s.sol (1 hunks)
Additional comments: 2
script/router/quoter/SaveConfigQuoterV2.s.sol (2)
  • 49-54: The refactoring of the loadIgnoredPools function to use a new markIgnoredPools function for handling ignored pools is a good improvement. It separates concerns and makes the code more modular. However, ensure that the ignoredJson structure and the vm.keyExists method are robust enough to handle potential edge cases or malformed JSON data.
  • 60-69: The implementation of the markIgnoredPools function is clear and straightforward. Using the tryGetDeploymentAddress method to resolve pool addresses from names and then marking them as ignored if they are not the zero address is a good approach. However, consider adding error handling or logging for cases where tryGetDeploymentAddress fails to find an address for a given pool name, as this could indicate a configuration issue.

@ChiTimesChi ChiTimesChi merged commit 17daba5 into master Mar 29, 2024
10 checks passed
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.

3 participants