Skip to content

Commit

Permalink
docs: adapt README
Browse files Browse the repository at this point in the history
  • Loading branch information
QGarchery committed Sep 30, 2024
1 parent bbb4cca commit eb6c5b6
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
3 changes: 2 additions & 1 deletion certora/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -250,12 +250,13 @@ The [`certora/specs`](specs) folder contains the following files:
- [`ExactMath.spec`](specs/ExactMath.spec) checks precise properties when taking into account exact multiplication and division.
Notably, this file specifies that using supply and withdraw in the same block cannot yield more funds than at the start.
- [`Health.spec`](specs/Health.spec) checks properties about the health of the positions.
Notably, functions cannot render an account unhealthy, and debt positions always have some collateral (thanks to the bad debt realization mechanism).
Notably, debt positions always have some collateral thanks to the bad debt realization mechanism.
- [`LibSummary.spec`](specs/LibSummary.spec) checks the summarization of the library functions that are used in other specification files.
- [`Liveness.spec`](specs/Liveness.spec) checks that main functions change the owner of funds and the amount of shares as expected, and that it's always possible to exit a position.
- [`ExchangeRate.spec`](specs/ExchangeRate.spec) checks that the exchange rate between shares and assets evolves predictably over time.
- [`Reentrancy.spec`](specs/Reentrancy.spec) checks that the contract is immune to a particular class of reentrancy issues.
- [`Reverts.spec`](specs/Reverts.spec) checks the condition for reverts and that inputs are correctly validated.
- [`StayHealthy.spec`](specs/Health.spec) checks that functions cannot render an account unhealthy.
- [`Transfer.spec`](specs/Transfer.spec) checks the summarization of the safe transfer library functions that are used in other specification files.

The [`certora/confs`](confs) folder contains a configuration file for each corresponding specification file.
Expand Down
1 change: 0 additions & 1 deletion certora/specs/StayHealthy.spec
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ filtered {
// Assumption to ensure that no interest is accumulated.
require lastUpdate(id) == e.block.timestamp;

priceChanged = false;
f(e, data);

// Safe require because of the invariant sumBorrowSharesCorrect.
Expand Down

0 comments on commit eb6c5b6

Please sign in to comment.