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

Runtime fv #85

Merged
merged 9 commits into from
Nov 7, 2024
Merged

Runtime fv #85

merged 9 commits into from
Nov 7, 2024

Conversation

aazhou1
Copy link

@aazhou1 aazhou1 commented Nov 7, 2024

Summary by CodeRabbit

Release Notes

  • New Features

    • Enhanced term controller management with the introduction of prevTermController and currTermController.
    • Updated discount rate retrieval process to allow specification of term controllers.
  • Bug Fixes

    • Improved error handling in discount rate fetching to prevent function reverts.
  • Documentation

    • Clarified method signatures for better understanding and usage.
  • Refactor

    • Streamlined logic for determining discount rates and managing repo tokens across term controllers.

@aazhou1 aazhou1 self-assigned this Nov 7, 2024
Copy link

coderabbitai bot commented Nov 7, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces significant modifications across several Solidity files, primarily enhancing the management of term controllers and discount rates for repo tokens. Key changes include the addition of new parameters in functions, improved error handling, and the introduction of new interfaces. The getPresentValue and validateAndInsertRepoToken functions in RepoTokenList.sol, as well as the setTermController and getRepoTokenHoldingValue functions in Strategy.sol, have been updated to incorporate these changes. Overall, the updates aim to improve the robustness and flexibility of the contracts involved.

Changes

File Change Summary
src/RepoTokenList.sol - Added import for ITermController.
- Introduced constant ZERO_AUCTION_RATE.
- Updated getPresentValue to include prevTermController and currTermController.
- Modified validateAndInsertRepoToken for better error handling.
src/Strategy.sol - Renamed parameter in setTermController to newTermControllerAddr.
- Updated logic in setTermController and getRepoTokenHoldingValue to verify term controller deployments.
- Adjusted logic in several internal functions.
src/TermAuctionList.sol - Imported ITermController.
- Updated getPresentValue to include prevTermController and currTermController.
- Modified removeCompleted to improve offer management logic.
src/TermDiscountRateAdapter.sol - Replaced TERM_CONTROLLER with prevTermController and currTermController.
- Updated getDiscountRate to accept termController as a parameter.
- Introduced setTermController and refactored internal logic for discount rates.
src/interfaces/term/ITermDiscountRateAdapter.sol - Renamed TERM_CONTROLLER to currTermController.
- Added new method getDiscountRate(address termController, address repoToken).
src/test/kontrol/TermDiscountRateAdapter.sol - Updated getDiscountRate to accept termController.
- Added currTermController method.
- Removed TERM_CONTROLLER method.

Possibly related PRs

  • Adding repo concentration limit #5: Changes in RepoTokenList.sol regarding the integration of ITermDiscountRateAdapter and modifications to the getPresentValue function are directly related to the main PR's updates to the same function, which also includes new parameters for term controllers.
  • Various strategy fixes #9: The removal of the termController parameter from the validateRepoToken and validateAndInsertRepoToken functions in RepoTokenList.sol aligns with the main PR's focus on enhancing the handling of repo tokens and discount rates.
  • Refactor to use repo token utils #21: The addition of the discountRateAdapter parameter in the getPresentValue function in RepoTokenList.sol is relevant as it connects to the main PR's changes that also involve the integration of discount rate logic.
  • Fixes to the list insert functions #46: Modifications to the insertion logic in RepoTokenList and TermAuctionList regarding maturity comparisons and linked list management are relevant as they enhance the overall functionality and integrity of repo token management, which is a focus of the main PR.
  • Kontrol property tests for RepoTokenList and TermAuctionList invariants #47: The introduction of symbolic property tests for RepoTokenList invariants is related as it aims to ensure the correctness of the functionalities that have been modified in the main PR, particularly around the handling of repo tokens and their associated logic.

Suggested reviewers

  • 0xddong

🐰 In the meadow, changes bloom,
New terms and rates dispel the gloom.
With controllers both old and new,
Our tokens thrive, their value grew.
In code we trust, with hops so spry,
Let's celebrate, oh my, oh my! 🌼


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

@aazhou1 aazhou1 merged commit 6a42b85 into master Nov 7, 2024
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