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

Yearn audit variable optimizations #119

Merged
merged 5 commits into from
Dec 23, 2024

Conversation

aazhou1
Copy link

@aazhou1 aazhou1 commented Dec 20, 2024

Summary by CodeRabbit

  • New Features

    • Enhanced clarity and efficiency in the management of term controllers and repo tokens.
  • Bug Fixes

    • Streamlined validation process by removing unused return values in relevant functions.
  • Documentation

    • Improved comments for better understanding of functions and parameters.

@aazhou1 aazhou1 self-assigned this Dec 20, 2024
Copy link

coderabbitai bot commented Dec 20, 2024

Walkthrough

The pull request introduces modifications to three Solidity files: RepoTokenList.sol, Strategy.sol, and TermAuctionList.sol. The primary changes involve updating the validateAndInsertRepoToken function signature to remove the discountRate return value, simplifying the logic in various contract methods. These modifications aim to streamline the handling of repo tokens, term controllers, and auction list management while maintaining the core functionality of the existing code.

Changes

File Change Summary
src/RepoTokenList.sol - Modified validateAndInsertRepoToken function signature to remove discountRate return value
- Adjusted internal logic to handle discountRate as a local variable
src/Strategy.sol - Updated setTermController to directly use new term controller address
- Simplified sellRepoToken by removing unused return value from validateAndInsertRepoToken
src/TermAuctionList.sol - Modified removeCompleted function to handle updated validateAndInsertRepoToken return values

Possibly related issues

  • term-finance/yearn-v3-term-vault#56: The changes in this PR directly address the issue of potential infinite revert in the removeCompleted function by modifying the validateAndInsertRepoToken function signature and handling.

Poem

🐰 Hop, hop, through the code we go,
Removing rates with a gentle flow,
Tokens dance, controllers align,
Simplicity makes our logic shine!
A rabbit's refactor, clean and bright 🌟


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.

Copy link

codecov bot commented Dec 20, 2024

Codecov Report

Attention: Patch coverage is 87.50000% with 1 line in your changes missing coverage. Please review.

Project coverage is 88.90%. Comparing base (1339629) to head (7f40555).

Files with missing lines Patch % Lines
src/RepoTokenList.sol 80.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #119      +/-   ##
==========================================
- Coverage   88.96%   88.90%   -0.06%     
==========================================
  Files           5        5              
  Lines         607      604       -3     
  Branches       90       90              
==========================================
- Hits          540      537       -3     
  Misses         56       56              
  Partials       11       11              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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.

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1339629 and 7f40555.

📒 Files selected for processing (3)
  • src/RepoTokenList.sol (2 hunks)
  • src/Strategy.sol (2 hunks)
  • src/TermAuctionList.sol (1 hunks)
🧰 Additional context used
🪛 GitHub Check: codecov/patch
src/RepoTokenList.sol

[warning] 357-357: src/RepoTokenList.sol#L357
Added line #L357 was not covered by tests

🔇 Additional comments (4)
src/RepoTokenList.sol (2)

350-351: Function signature change improves code clarity

The removal of discountRate from the return tuple simplifies the function interface since the rate is only used internally.


357-357: ⚠️ Potential issue

Add test coverage for early return path

The early return path for matured repoTokens is not covered by tests. This is a critical validation path that should be tested.

🧰 Tools
🪛 GitHub Check: codecov/patch

[warning] 357-357: src/RepoTokenList.sol#L357
Added line #L357 was not covered by tests

src/TermAuctionList.sol (1)

190-190: LGTM: Correctly adapted to new function signature

The code properly handles the updated return values from validateAndInsertRepoToken, correctly unpacking only the boolean and timestamp values.

src/Strategy.sol (1)

1087-1088: LGTM: Correctly adapted to new function signature

The code properly handles the updated return values from validateAndInsertRepoToken, correctly unpacking only the boolean and timestamp values.

@@ -374,20 +373,20 @@
discountRate = rate == 0 ? ZERO_AUCTION_RATE : rate;
} catch {
discountRate = INVALID_AUCTION_RATE;
return (false, discountRate, redemptionTimestamp);
return (false, redemptionTimestamp);
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consistent error handling pattern needed

The function has inconsistent error handling:

  • Line 357: Returns false with redemptionTimestamp
  • Line 376: Returns false with redemptionTimestamp
  • Line 383: Returns false with redemptionTimestamp
  • Line 389: Returns true with redemptionTimestamp

Consider using a more consistent pattern, either:

  1. Always revert with InvalidRepoToken for invalid cases (commented out in line 357)
  2. Return false with a specific error code/reason

Also applies to: 383-383, 389-389

@aazhou1 aazhou1 merged commit 78b5e15 into master Dec 23, 2024
1 check passed
@aazhou1 aazhou1 deleted the yearn-audit-variable-optimizations branch December 23, 2024 17: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.

1 participant