search

ebtc-protocol / ebtc

GNU General Public License v3.0
48 stars 24 forks source link

Adding TWAP overflow unit test and invariant #782

Closed wtj2021 closed 5 months ago

wtj2021 commented 5 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 5 months ago

[!WARNING]

Rate Limit Exceeded

@wtj2021 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 27 minutes and 25 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 2341278676e00e206222d31f599e15d42210ea17 and 48a3d7e359265b51a797dd0b9a2e3cf2553aab24.

Walkthrough

The recent update introduces a new invariant to ensure the twapDisabled flag within the ActivePool contract remains false, emphasizing the importance of TWAP (Time-Weighted Average Price) being always enabled. This is achieved by adding a new internal function to check this condition, a description for clarity, and an echidna property for testing. Additionally, a test function and event were introduced to validate the scenario where twapDisabled might be set to true, reinforcing the system's resilience against such changes.

Changes

Files Changes
.../invariants/Properties.sol
.../invariants/PropertiesDescriptions.sol
.../invariants/echidna/EchidnaProperties.sol		 Added internal function invariant_GENERAL_19, constant GENERAL_19, and public function echidna_GENERAL_19() to enforce and describe the new TWAP invariant.
.../foundry_test/ActivePool.twapAcc.t.sol Introduced event TwapDisabled() and testTwapOverflow function to test twapDisabled behavior.

🐇 A whimsical tale, in code we weave,
🌟 Ensuring TWAP, we never leave.
🚫 No false flags, our contracts tight,
🛡️ Invariants guard, both day and night.
🎉 Celebrate, for our code does gleam,
🐾 With every push, towards the dream.
🥕 Here's to the devs, with foresight keen!

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
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 .` - `Generate unit-tests for this file.` - 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 from git 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](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.
getrecon-bot commented 5 months ago
Job ID 2a97e90b-5fe6-403e-851f-679f56332356
Command yarn && git submodule init && git submodule update && solc-select use 0.8.17 && cd packages/contracts/ && yarn echidna --test-mode assertion --test-limit 300000
Instance ID i-0b76afc58fbd4172d
Instance Type c5.2xlarge
Status Started
Elapsed
getrecon-bot commented 5 months ago
Job ID 2a97e90b-5fe6-403e-851f-679f56332356
Command yarn && git submodule init && git submodule update && solc-select use 0.8.17 && cd packages/contracts/ && yarn echidna --test-mode assertion --test-limit 300000
Instance ID i-0b76afc58fbd4172d
Instance Type c5.2xlarge
Status Running
Elapsed 52 seconds
getrecon-bot commented 5 months ago
Job ID 2a97e90b-5fe6-403e-851f-679f56332356
Command yarn && git submodule init && git submodule update && solc-select use 0.8.17 && cd packages/contracts/ && yarn echidna --test-mode assertion --test-limit 300000
Instance ID i-0b76afc58fbd4172d
Instance Type c5.2xlarge
Status Running
Elapsed 52 seconds
getrecon-bot commented 5 months ago
Job ID 2a97e90b-5fe6-403e-851f-679f56332356
Command yarn && git submodule init && git submodule update && solc-select use 0.8.17 && cd packages/contracts/ && yarn echidna --test-mode assertion --test-limit 300000
Instance ID i-0b76afc58fbd4172d
Instance Type c5.2xlarge
Status Success
Elapsed 17 hours 45 minutes 8 seconds