Merge pull request #99 from term-finance/master

[aazhou1]

merge governor setting changes

Summary by CodeRabbit

• New Features

  • Introduced new test cases for cumulative and present value calculations in multiple test contracts.
  • Added a new testing framework for TermAuctionList and RepoTokenList.

• Bug Fixes

  • Enhanced error handling and validation in auction and token management functions.

• Refactor

  • Simplified function signatures and logic across multiple contracts, improving clarity and maintainability.
  • Updated internal functions to streamline data loading and storage processes.

• Documentation

  • Improved comments and descriptions in the code to clarify functionality and logic changes.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several modifications across multiple Solidity files, primarily focusing on configuration settings, contract logic, and testing frameworks. Key changes include updates to the kontrol.toml file for verbosity and test cases, simplifications in function signatures in contracts like RepoTokenList, Strategy, and TermAuctionList, and the introduction of new test cases in various testing contracts. Additionally, the changes enhance error handling and streamline logic, particularly in the context of repo tokens and auction management.

Changes

File	Change Summary
kontrol.toml	Updated verbosity settings and added new test cases in [prove.tests]. Adjusted bmc-depth and disabled recompilation.
src/RepoTokenList.sol	Simplified getPresentValue function signature; adjusted insertion logic for repoToken; improved discount rate handling.
src/Strategy.sol	Removed parameters from various functions; enhanced error handling in submitAuctionOffer; updated constructor initialization.
src/TermAuctionList.sol	Simplified getPresentValue and getCumulativeOfferData signatures; improved auction offer handling logic.
src/test/kontrol/KontrolTest.sol	Added pure modifier to functions; refactored data loading and storing functions for enhanced flexibility.
src/test/kontrol/RepoToken.sol	Changed decimals function from view to pure.
src/test/kontrol/RepoTokenListInvariants.t.sol	Changed inheritance to RepoTokenListTest; removed internal functions; added new test cases for cumulative and present values.
src/test/kontrol/RepoTokenListTest.t.sol	Introduced new testing contract with comprehensive functionality for managing RepoToken instances.
src/test/kontrol/TermAuctionListInvariants.t.sol	Expanded inheritance; simplified setup; added new test scenarios for auction offers.
src/test/kontrol/TermAuctionListTest.t.sol	New contract for testing auction functionalities with various internal functions for managing offers and state validation.
src/test/kontrol/TermAuctionOfferLocker.sol	Updated function signatures and simplified logic in lockOffers and unlockOffers.
src/test/kontrol/TermDiscountRateAdapter.sol	Cosmetic change to variable naming in initializeSymbolicParamsFor.
src/test/kontrol/TermRepoServicer.sol	Renamed parameter in initializeSymbolic and removed symbolic storage calls in redeemTermRepoTokens.

Possibly related PRs

• Adding unit tests #3: Changes in RepoTokenList.sol regarding matured tokens handling may affect tests added in this PR.
• Fix edit offer #4: Modifications in RepoTokenList.sol related to function signatures and logic for repo tokens are relevant to the testing focus of this PR.
• Adding repo concentration limit #5: Introduction of a discount rate adapter in RepoTokenList.sol aligns with the testing objectives of this PR.
• Various strategy fixes #9: Removal of termController parameters in RepoTokenList.sol simplifies validation logic, impacting tests in this PR.
• Fixing strategy tests #10: Enhancements in error handling and validation logic for repo tokens in Strategy.sol are relevant to this PR's focus.
• Adding back concentration ratio #12: New output parameter for simulating liquidity in Strategy.sol may affect repo token testing in this PR.
• Refactor to use repo token utils #21: Refactoring to use repo token utilities in RepoTokenList.sol enhances functionality relevant to this PR.
• Kontrol property tests for RepoTokenList and TermAuctionList invariants #47: Introduction of symbolic property tests for RepoTokenList invariants relates directly to the testing focus of this PR.
• fix exisiting unit tests #54: Enhancements to auction offer tests may directly relate to the tests added in this PR.
• remove collateral token ratio initialization #88: Removal of collateral token parameters in Strategy impacts repo token management and testing relevance.

🐰 In the land of code where rabbits play,
Changes hop in, brightening the day!
With tests anew and logic refined,
Our repo tokens are now well-defined.
So let’s celebrate this coding spree,
For every tweak brings joy, you see! 🎉

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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