invariant suite rebased

euler-xyz · May 20, 2024 · 14892c9 · 14892c9
1 parent edb4d07
commit 14892c9
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -185,6 +185,26 @@ forge test
 forge coverage
 ```
 
+## Invariant Testing Suite
+
+This project has been set up with a suite of tests that check for specific invariants for the reward streams, implemented by [vnmrtz.eth](https://twitter.com/vn_martinez_). These tests are located in the `test/invariants` directory. They are written in Solidity and are designed to be run with the [echidna](https://github.com/crytic/echidna) fuzzing tool.
+
+Installation and usage of these tools is outside the scope of this README, but you can find more information in the respective repositories:
+- [Echidna Installation](https://github.com/crytic/echidna)
+
+To run invariant tests with Echidna:
+
+```sh
+./test/scripts/echidna.sh  
+```
+
+To run assert tests with Echidna:
+
+```sh
+./test/scripts/echidna-assert.sh  
+```
+
+
 ## Safety
 
 This software is **experimental** and is provided "as is" and "as available".

diff --git a/lib/ethereum-vault-connector b/lib/ethereum-vault-connector
diff --git a/lib/forge-std b/lib/forge-std
diff --git a/lib/openzeppelin-contracts b/lib/openzeppelin-contracts
diff --git a/test/invariants/CryticToFoundry.t.sol b/test/invariants/CryticToFoundry.t.sol
@@ -230,6 +230,23 @@ contract CryticToFoundry is Invariants, Setup {
         echidna_UPDATE_REWARDS_INVARIANT();
     }
 
+    function test_claimSpilloverReward() public {
+        uint128[] memory rewards = new uint128[](1);
+        rewards[0] = 2;
+        this.registerReward(0, 0, rewards);
+        _delay(4026900 + 204167);
+        this.claimSpilloverReward(0, 0);
+    }
+
+    function test_DISTRIBUTION_INVARIANTS8() public {
+        uint128[] memory rewards = new uint128[](1);
+        rewards[0] = 152;
+        this.registerReward(0, 0, rewards);
+        _delay(1800477);
+        this.claimSpilloverReward(0, 0);
+        echidna_DISTRIBUTION_INVARIANTS();
+    }
+
     ///////////////////////////////////////////////////////////////////////////////////////////////
     //                                           HELPERS                                         //
     ///////////////////////////////////////////////////////////////////////////////////////////////

diff --git a/test/invariants/handlers/BaseRewardsHandler.t.sol b/test/invariants/handlers/BaseRewardsHandler.t.sol
@@ -12,6 +12,8 @@ import {BaseRewardStreamsHarness} from "test/harness/BaseRewardStreamsHarness.so
 // Interfaces
 import {IRewardStreams} from "src/interfaces/IRewardStreams.sol";
 
+import "forge-std/console.sol";
+
 /// @title BaseRewardsHandler
 /// @notice Handler test contract for the risk balance forwarder module actions
 contract BaseRewardsHandler is BaseHandler {
@@ -81,8 +83,9 @@ contract BaseRewardsHandler is BaseHandler {
 
         _before(address(actor), _rewarded, reward);
 
-        (success, returnData) =
-            actor.proxy(_target, abi.encodeWithSelector(IRewardStreams.updateReward.selector, _rewarded, reward));
+        (success, returnData) = actor.proxy(
+            _target, abi.encodeWithSelector(IRewardStreams.updateReward.selector, _rewarded, reward, address(0))
+        );
 
         if (success) {
             _after(address(actor), _rewarded, reward);
@@ -139,12 +142,12 @@ contract BaseRewardsHandler is BaseHandler {
         // Get one of the two setups randomly
         (address _rewarded, address _target) = _getRandomRewards(j);
 
-        uint256 spilloverReward = target.earnedReward(address(0), _rewarded, reward, true);
+        uint256 spilloverReward = target.earnedReward(address(0), _rewarded, reward, false);
 
         _before(address(actor), _rewarded, reward);
 
         (success, returnData) = actor.proxy(
-            _target, abi.encodeWithSelector(IRewardStreams.claimSpilloverReward.selector, _rewarded, reward, recipient)
+            _target, abi.encodeWithSelector(IRewardStreams.updateReward.selector, _rewarded, reward, recipient)
         );
 
         if (success) {
@@ -210,16 +213,4 @@ contract BaseRewardsHandler is BaseHandler {
             }
         }
     }
-
-    function assert_VIEW_INVARIANT_A(uint8 i, uint48 epoch, uint48 lastUpdated) external setup {
-        // Get one of the two setups randomly
-        (, address _target) = _getRandomRewards(i);
-
-        BaseRewardStreamsHarness target_ = BaseRewardStreamsHarness(_target);
-
-        try target_.timeElapsedInEpochPublic(epoch, lastUpdated) {}
-        catch {
-            assertTrue(false, VIEW_INVARIANT_A);
-        }
-    }
 }
diff --git a/test/invariants/handlers/simulators/ERC20BalanceForwarderHandler.t.sol b/test/invariants/handlers/simulators/ERC20BalanceForwarderHandler.t.sol
@@ -24,9 +24,8 @@ contract ERC20BalanceForwarderHandler is BaseHandler {
         bool success;
         bytes memory returnData;
 
-        (success, returnData) = actor.proxy(
-            address(trackingDistributor), abi.encodeWithSelector(IBalanceForwarder.enableBalanceForwarding.selector)
-        );
+        (success, returnData) =
+            actor.proxy(trackingRewarded, abi.encodeWithSelector(IBalanceForwarder.enableBalanceForwarding.selector));
 
         if (success) {
             assert(true);
@@ -37,9 +36,8 @@ contract ERC20BalanceForwarderHandler is BaseHandler {
         bool success;
         bytes memory returnData;
 
-        (success, returnData) = actor.proxy(
-            address(trackingDistributor), abi.encodeWithSelector(IBalanceForwarder.disableBalanceForwarding.selector)
-        );
+        (success, returnData) =
+            actor.proxy(trackingRewarded, abi.encodeWithSelector(IBalanceForwarder.disableBalanceForwarding.selector));
 
         if (success) {
             assert(true);
@@ -53,7 +51,7 @@ contract ERC20BalanceForwarderHandler is BaseHandler {
         address account = _getRandomActor(i);
 
         (success, returnData) =
-            actor.proxy(address(trackingDistributor), abi.encodeWithSelector(ERC20.transfer.selector, account, amount));
+            actor.proxy(trackingRewarded, abi.encodeWithSelector(ERC20.transfer.selector, account, amount));
 
         if (success) {
             assert(true);

diff --git a/test/invariants/invariants/BaseInvariants.t.sol b/test/invariants/invariants/BaseInvariants.t.sol
@@ -21,7 +21,7 @@ abstract contract BaseInvariants is HandlerAggregator {
     function assert_BASE_INVARIANT_B(address _rewarded, address _reward, address _target) internal {
         (uint256 totalEligible,,) = BaseRewardStreamsHarness(_target).getDistributionTotals(_rewarded, _reward);
         if (totalEligible == 0) {
-            try BaseRewardStreamsHarness(_target).claimSpilloverReward(_rewarded, _reward, address(this)) {}
+            try BaseRewardStreamsHarness(_target).updateReward(_rewarded, _reward, address(0)) {}
             catch {
                 assertTrue(false, BASE_INVARIANT_B);
             }
@@ -42,8 +42,8 @@ abstract contract BaseInvariants is HandlerAggregator {
 
     function assert_UPDATE_REWARDS_INVARIANT_B(address _rewarded, address _reward, address _target) internal {
         BaseRewardStreamsHarness target_ = BaseRewardStreamsHarness(_target);
-        (uint48 totalEligible,,,,) = target_.getDistributionData(_rewarded, _reward);
-        assertGe(target_.currentEpoch(), target_.getEpoch(totalEligible), UPDATE_REWARDS_INVARIANT_B);
+        (uint48 lastUpdated,,,,) = target_.getDistributionData(_rewarded, _reward);
+        assertGe(target_.currentEpoch(), target_.getEpoch(lastUpdated), UPDATE_REWARDS_INVARIANT_B);
     }
 
     function assert_UPDATE_REWARDS_INVARIANT_C(
+28 −67		.github/workflows/test.yml
+19 −0		.solhint.json
+ −		audits/Euler ChainSecurity report.pdf
+ −		audits/Euler Open-Zeppelin report.pdf
+0 −103		docs/specs.md
+0 −17		docs/whitepaper.md
+58 −106		src/EthereumVaultConnector.sol
+1 −0		src/ExecutionContext.sol
+3 −32		src/Set.sol
+11 −25		src/interfaces/IEthereumVaultConnector.sol
+1 −11		src/utils/EVCUtil.sol
+0 −2		test/evc/EthereumVaultConnectorHarness.sol
+3 −12		test/evc/EthereumVaultConnectorScribble.sol
+24 −16		test/invariants/EthereumVaultConnector.t.sol
+0 −6		test/unit/EVCUtil/EVCUtil.t.sol
+1 −30		test/unit/EthereumVaultConnector/AccountAndVaultStatus.t.sol
+2 −28		test/unit/EthereumVaultConnector/AccountStatus.t.sol
+0 −1		test/unit/EthereumVaultConnector/Permit.t.sol
+4 −5		test/unit/EthereumVaultConnector/Receive.t.sol
+4 −4		test/unit/EthereumVaultConnector/SetPermitDisabledMode.t.sol
+0 −6		test/unit/Set/Set.t.sol
+4 −30		test/utils/mocks/Vault.sol
+12 −6		.github/workflows/ci.yml
+1 −3		.github/workflows/sync.yml
+1 −1		package.json
+1 −3		src/StdChains.sol
+3 −9		src/StdInvariant.sol
+1 −1		src/StdUtils.sol
+6 −113		src/Vm.sol
+1 −3		test/StdChains.t.sol
+2 −2		test/Vm.t.sol
+0 −5		.changeset/chilly-humans-warn.md
+0 −5		.changeset/cold-cheetahs-check.md
+0 −5		.changeset/spotty-falcons-explain.md
+4 −4		.github/workflows/checks.yml
+1 −1		.github/workflows/formal-verification.yml
+0 −2		contracts/mocks/Stateless.sol
+4 −4		contracts/proxy/transparent/ProxyAdmin.sol
+0 −3		contracts/utils/Arrays.sol
+0 −3		contracts/utils/README.adoc
+6 −22		contracts/utils/math/Math.sol
+2 −20		contracts/utils/math/SignedMath.sol
+0 −130		contracts/utils/structs/CircularBuffer.sol
+0 −1		scripts/generate/templates/Arrays.js
+1 −1		test/governance/Governor.t.sol
+0 −10		test/utils/math/Math.t.sol
+0 −10		test/utils/math/SignedMath.t.sol
+0 −79		test/utils/structs/CircularBuffer.test.js