Invariant tests for UbiquityPoolFacet

[alexandr-masl]

Resolves #563

[0x4007]

I understand that this is a draft pull request, so you should mark it as a draft pull request instead of emphasizing in your pull request body.

[ubiquity-os-deployer]

42d739a

6689906

dd94c7e

1b7f1da

44e9bf5

316d557

16de33c

c8e4c35

[alexandr-masl]

Hey everyone,

I believe we're could start with this invariant test. The primary goal was to implement a condition that consistently ensures the dollar amount remains fully collateralized. This condition addresses two key scenarios:

1. Users cannot mint more Dollars (in USD value) than the provided collateral
2. Users cannot redeem more collateral (in USD value) than the corresponding Dollar tokens

If either of these scenarios were to succeed, it would break the collateralization of the Dollar, thereby violating the invariant

During the test, it performs various manipulations with the values of collateral, USD, ETH/USDT, and Dollar prices, as well as minting and redemption fees, among other parameters

As the next step, additional invariants might be about the governance token and its associated logic

Looking forward to your feedback

[rndquu]

@alexandr-masl Overall this is a great job.

1. Pls fix minor issues in the comments
2. Here you mention the Users cannot redeem more collateral (in USD value) than the corresponding Dollar tokens invariant test. Is it going to be implemented?
3. This issue also implies setting up CI. You may take fuzzing CI as an example.

[alexandr-masl]

@alexandr-masl Overall this is a great job.

Thanks for the feedback and kind words, will come up with an update soon

[gitcoindev]

I did a review of the invariant tests skeleton, looks like a good start. Looking forward to see it in the ready for review stage.

[alexandr-masl]

I did a review of the invariant tests skeleton, looks like a good start. Looking forward to see it in the ready for review stage.

Thanks for the feedback. I'm actively working on it

[alexandr-masl]

Please review my basic invariant tests. I have minimized the use of prank(admin) and focused more on simulating user activity. The tests cover regular scenarios where there is no need to burn uDollars to rebalance collateral coverage. Additionally, I have included tests for the following conditions:

• Users cannot mint more uDollars (in USD) than the provided collateral
• Users cannot redeem more collateral (in USD) than the Dollar tokens they hold

[rndquu]

Pls add this config to foundry.toml:

[profile.intense.invariant]
runs = 50000 # ~1 hour

[alexandr-masl]

Pls add this config to foundry.toml:

[profile.intense.invariant]
runs = 50000 # ~1 hour

I'm not highly experienced with the foundry.toml profile settings, but when I try to run the tests locally under the intense profile using the command FOUNDRY_PROFILE=intense forge test --match-path "test/invariant/**/*", the number of runs increases from the regular 256 to 4743 and 3280. However, it is still significantly lower than the 50,000 runs defined in the foundry.toml

Ran 2 tests for test/invariant/diamond/facets/UbiquityPoolFacet.invariant.t.sol:UbiquityPoolFacetInvariantTest
[PASS] invariant_CannotMintMoreDollarsThanCollateral() (runs: 3280, calls: 1640000, reverts: 133999)
[PASS] invariant_CannotRedeemMoreCollateralThanDollarValue() (runs: 4743, calls: 2371500, reverts: 193564)
Suite result: ok. 2 passed; 0 failed; 0 skipped; finished in 809.21s (1384.47s CPU time)

[rndquu]

Pls add this config to foundry.toml:

[profile.intense.invariant]
runs = 50000 # ~1 hour

I'm not highly experienced with the foundry.toml profile settings, but when I try to run the tests locally under the intense profile using the command FOUNDRY_PROFILE=intense forge test --match-path "test/invariant/**/*", the number of runs increases from the regular 256 to 4743 and 3280. However, it is still significantly lower than the 50,000 runs defined in the foundry.toml

Ran 2 tests for test/invariant/diamond/facets/UbiquityPoolFacet.invariant.t.sol:UbiquityPoolFacetInvariantTest
[PASS] invariant_CannotMintMoreDollarsThanCollateral() (runs: 3280, calls: 1640000, reverts: 133999)
[PASS] invariant_CannotRedeemMoreCollateralThanDollarValue() (runs: 4743, calls: 2371500, reverts: 193564)
Suite result: ok. 2 passed; 0 failed; 0 skipped; finished in 809.21s (1384.47s CPU time)

That's strange, we'll see how it goes in the CI environment.

[rndquu]

Overall this is a good start. There're still too many reverts but it's something that we should work out in the next invariant tests iteration.