search

ebtc-protocol / ebtc

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

Adding CDP stake related invariants #791

Closed wtj2021 closed 4 months ago

wtj2021 commented 4 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent updates focus on enhancing the functionality and integrity of the contract ecosystem, particularly around the management of stakes and collaterals. A new function has been introduced to calculate real stakes, and the interface now supports snapshots of total collaterals and stakes. TestContracts have been enriched with new variables and functions to ensure the robustness of stake and collateral calculations, alongside the introduction of invariant checks to maintain system properties.

Changes

Files Change Summary
.../contracts/CRLens.sol
.../contracts/Interfaces/ICdpManagerData.sol		 Added getRealStake function in CRLens contract;
Introduced totalCollateralSnapshot() and totalStakesSnapshot() in ICdpManagerData interface.
.../contracts/TestContracts/invariants/BeforeAfter.sol New variables for stake and collateral snapshots.
.../contracts/TestContracts/invariants/Properties.sol New internal view functions for CDPM and CSP invariants.
.../contracts/TestContracts/invariants/TargetFunctions.sol
.../contracts/TestContracts/invariants/echidna/EchidnaProperties.sol		 Added _checkStakeInvariants() for stake checks;
Added functions for CDPM invariants.

🐇✨
In the land of code, where the smart contracts bloom,
A rabbit hopped in, avoiding the gloom.
With a flick and a click, new functions took flight,
Ensuring the stakes and collaterals just right.
"To integrity and beyond!" the rabbit did cheer,
With every line of code, the vision became clear.
🌟📜🚀

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.` - `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](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 4 months ago
Job ID caf59116-8525-49d0-98de-1de66cf017e6
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-0a50904cbda7d5bd3
Instance Type c5.2xlarge
Status Started
Elapsed
getrecon-bot commented 4 months ago
Job ID caf59116-8525-49d0-98de-1de66cf017e6
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-0a50904cbda7d5bd3
Instance Type c5.2xlarge
Status Running
Elapsed 49 seconds
getrecon-bot commented 4 months ago
Job ID caf59116-8525-49d0-98de-1de66cf017e6
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-0a50904cbda7d5bd3
Instance Type c5.2xlarge
Status Running
Elapsed 50 seconds
getrecon-bot commented 4 months ago
Job ID caf59116-8525-49d0-98de-1de66cf017e6
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-0a50904cbda7d5bd3
Instance Type c5.2xlarge
Status Success
Elapsed 13 hours 4 minutes 13 seconds