Certora adaptation to stata

bgd-labs · Sep 9, 2024 · a2c9ca3 · a2c9ca3
1 parent 687022d
commit a2c9ca3
Show file tree

Hide file tree

Showing 31 changed files with 3,509 additions and 0 deletions.
diff --git a/.github/workflows/certora-stata.yml b/.github/workflows/certora-stata.yml
@@ -0,0 +1,79 @@
+name: certora-stata
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+  workflow_dispatch:
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+
+      - name: Install python
+        uses: actions/setup-python@v2
+        with: { python-version: 3.9 }
+
+      - name: Install java
+        uses: actions/setup-java@v1
+        with: { java-version: "11", java-package: jre }
+
+      - name: Install certora cli
+        run: pip install certora-cli==7.14.2
+
+      - name: Install solc
+        run: |
+          wget https://github.com/ethereum/solidity/releases/download/v0.8.20/solc-static-linux
+          chmod +x solc-static-linux
+          sudo mv solc-static-linux /usr/local/bin/solc8.20
+
+      - name: Verify rule ${{ matrix.rule }}
+        run: |
+          cd certora/stata
+          touch applyHarness.patch
+          make munged
+          cd ../..
+          certoraRun certora/stata/conf/${{ matrix.rule }}
+        env:
+          CERTORAKEY: ${{ secrets.CERTORAKEY }}
+
+    strategy:
+      fail-fast: false
+      max-parallel: 16
+      matrix:
+        rule:
+          - verifyERC4626.conf --rule previewRedeemIndependentOfBalance previewMintAmountCheck previewDepositIndependentOfAllowanceApprove previewWithdrawAmountCheck previewWithdrawIndependentOfBalance2 previewWithdrawIndependentOfBalance1 previewRedeemIndependentOfMaxRedeem1 previewRedeemAmountCheck previewRedeemIndependentOfMaxRedeem2 amountConversionRoundedDown withdrawCheck redeemCheck redeemATokensCheck convertToAssetsCheck convertToSharesCheck toAssetsDoesNotRevert sharesConversionRoundedDown toSharesDoesNotRevert previewDepositAmountCheck maxRedeemCompliance maxWithdrawConversionCompliance
+          - verifyERC4626.conf --rule maxMintMustntRevert maxDepositMustntRevert maxRedeemMustntRevert maxWithdrawMustntRevert totalAssetsMustntRevert
+          # Timeout
+          # - verifyERC4626.conf --rule previewWithdrawIndependentOfMaxWithdraw
+          - verifyERC4626MintDepositSummarization.conf --rule depositCheckIndexGRayAssert2 depositATokensCheckIndexGRayAssert2 depositWithPermitCheckIndexGRayAssert2 depositCheckIndexERayAssert2 depositATokensCheckIndexERayAssert2 depositWithPermitCheckIndexERayAssert2 mintCheckIndexGRayUpperBound mintCheckIndexGRayLowerBound mintCheckIndexEqualsRay
+          - verifyERC4626DepositSummarization.conf --rule depositCheckIndexGRayAssert1 depositATokensCheckIndexGRayAssert1 depositWithPermitCheckIndexGRayAssert1 depositCheckIndexERayAssert1 depositATokensCheckIndexERayAssert1 depositWithPermitCheckIndexERayAssert1
+          - verifyERC4626Extended.conf --rule previewWithdrawRoundingRange previewRedeemRoundingRange amountConversionPreserved sharesConversionPreserved accountsJoiningSplittingIsLimited convertSumOfAssetsPreserved previewDepositSameAsDeposit previewMintSameAsMint
+          - verifyERC4626Extended.conf --rule maxDepositConstant
+          - verifyERC4626Extended.conf --rule redeemSum
+          - verifyERC4626Extended.conf --rule redeemATokensSum
+          - verifyAToken.conf --rule aTokenBalanceIsFixed_for_collectAndUpdateRewards aTokenBalanceIsFixed_for_claimRewards aTokenBalanceIsFixed_for_claimRewardsOnBehalf
+          - verifyAToken.conf --rule aTokenBalanceIsFixed_for_claimSingleRewardOnBehalf aTokenBalanceIsFixed_for_claimRewardsToSelf
+          - verifyStataToken.conf --rule rewardsConsistencyWhenSufficientRewardsExist
+          - verifyStataToken.conf --rule rewardsConsistencyWhenInsufficientRewards
+          - verifyStataToken.conf --rule totalClaimableRewards_stable
+          - verifyStataToken.conf --rule solvency_positive_total_supply_only_if_positive_asset
+          - verifyStataToken.conf --rule solvency_total_asset_geq_total_supply
+          - verifyStataToken.conf --rule singleAssetAccruedRewards
+          - verifyStataToken.conf --rule totalAssets_stable
+          - verifyStataToken.conf --rule getClaimableRewards_stable
+          - verifyStataToken.conf --rule getClaimableRewards_stable_after_deposit
+          - verifyStataToken.conf --rule getClaimableRewards_stable_after_refreshRewardTokens
+          - verifyStataToken.conf --rule getClaimableRewardsBefore_leq_claimed_claimRewardsOnBehalf
+          - verifyStataToken.conf --rule rewardsTotalDeclinesOnlyByClaim
+          - verifyDoubleClaim.conf --rule prevent_duplicate_reward_claiming_single_reward_sufficient
+          - verifyDoubleClaim.conf --rule prevent_duplicate_reward_claiming_single_reward_insufficient
diff --git a/certora/stata/Makefile b/certora/stata/Makefile
@@ -0,0 +1,33 @@
+default: help
+
+PATCH         = applyHarness.patch
+CONTRACTS_DIR = ../../src
+LIBS_DIR = ../../lib
+MUNGED_SRC    = munged/src
+MUNGED_LIB    = munged/lib
+MUNGED_DIR    = munged
+
+help:
+	@echo "usage:"
+	@echo "  make clean:  remove all generated files (those ignored by git)"
+	@echo "  make $(MUNGED_DIR): create $(MUNGED_DIR) directory by applying the patch file to $(CONTRACTS_DIR)"
+	@echo "  make record: record a new patch file capturing the differences between $(CONTRACTS_DIR) and $(MUNGED_DIR)"
+
+munged:  $(wildcard $(CONTRACTS_DIR)/*.sol) $(PATCH)
+	rm -rf $@
+	mkdir $@
+	cp -r ../../lib $@
+	cp -r ../../src $@
+	patch -p0 -d $@ < $(PATCH)
+
+record:
+	mkdir tmp
+	cp -r ../../lib tmp
+	cp -r ../../src tmp
+	diff -ruN tmp $(MUNGED_DIR) | sed 's+tmp/++g' | sed 's+$(MUNGED_DIR)/++g' > $(PATCH)
+	rm -rf tmp
+
+clean:
+	git clean -fdX
+	touch $(PATCH)
+
diff --git a/certora/stata/applyHarness.patch b/certora/stata/applyHarness.patch
@@ -0,0 +1,48 @@
+diff -ruN .gitignore .gitignore
+--- .gitignore	1970-01-01 02:00:00
++++ .gitignore	2024-09-04 13:59:46
+@@ -0,0 +1,2 @@
++*
++!.gitignore
+\ No newline at end of file
+diff -ruN src/core/instances/ATokenInstance.sol src/core/instances/ATokenInstance.sol
+--- src/core/instances/ATokenInstance.sol	2024-09-05 19:01:54
++++ src/core/instances/ATokenInstance.sol	2024-09-05 11:33:23
+@@ -35,15 +35,15 @@
+
+     _domainSeparator = _calculateDomainSeparator();
+
+-    emit Initialized(
+-      underlyingAsset,
+-      address(POOL),
+-      treasury,
+-      address(incentivesController),
+-      aTokenDecimals,
+-      aTokenName,
+-      aTokenSymbol,
+-      params
+-    );
++    // emit Initialized(
++    //   underlyingAsset,
++    //   address(POOL),
++    //   treasury,
++    //   address(incentivesController),
++    //   aTokenDecimals,
++    //   aTokenName,
++    //   aTokenSymbol,
++    //   params
++    // );
+   }
+ }
+diff -ruN src/periphery/contracts/static-a-token/ERC20AaveLMUpgradeable.sol src/periphery/contracts/static-a-token/ERC20AaveLMUpgradeable.sol
+--- src/periphery/contracts/static-a-token/ERC20AaveLMUpgradeable.sol	2024-09-05 19:01:54
++++ src/periphery/contracts/static-a-token/ERC20AaveLMUpgradeable.sol	2024-09-05 13:48:31
+@@ -147,7 +147,7 @@
+   }
+
+   ///@inheritdoc IERC20AaveLM
+-  function rewardTokens() external view returns (address[] memory) {
++  function rewardTokens() public view returns (address[] memory) {
+     ERC20AaveLMStorage storage $ = _getERC20AaveLMStorage();
+     return $._rewardTokens;
+   }
diff --git a/certora/stata/conf/verifyAToken.conf b/certora/stata/conf/verifyAToken.conf
@@ -0,0 +1,40 @@
+{
+  "files": [
+    "certora/stata/harness/StataTokenV2Harness.sol",
+    "certora/stata/harness/pool/SymbolicLendingPool.sol",
+    "certora/stata/harness/rewards/RewardsControllerHarness.sol",
+    "certora/stata/harness/rewards/TransferStrategyHarness.sol",
+    "certora/stata/harness/tokens/DummyERC20_aTokenUnderlying.sol",
+    "certora/stata/harness/tokens/DummyERC20_rewardToken.sol",
+    "certora/stata/munged/src/core/instances/ATokenInstance.sol",
+  ],
+  "link": [
+    "SymbolicLendingPool:aToken=ATokenInstance",
+    "SymbolicLendingPool:underlyingToken=DummyERC20_aTokenUnderlying",
+    "TransferStrategyHarness:INCENTIVES_CONTROLLER=RewardsControllerHarness",
+    "TransferStrategyHarness:REWARD=DummyERC20_rewardToken",
+    "ATokenInstance:POOL=SymbolicLendingPool",
+    "ATokenInstance:_incentivesController=RewardsControllerHarness",
+    "ATokenInstance:_underlyingAsset=DummyERC20_aTokenUnderlying",
+    "StataTokenV2Harness:INCENTIVES_CONTROLLER=RewardsControllerHarness",
+    "StataTokenV2Harness:POOL=SymbolicLendingPool",
+    "StataTokenV2Harness:_reward_A=DummyERC20_rewardToken"
+  ],
+  "packages": [
+     "aave-v3-core/=certora/stata/munged/src/core",
+     "aave-v3-periphery/=certora/stata/munged/src/periphery",
+     "solidity-utils/=certora/stata/munged/lib/solidity-utils/src",
+     "forge-std/=certora/stata/munged/lib/forge-std/src",
+     "openzeppelin-contracts-upgradeable/=certora/stata/munged/lib/solidity-utils/lib/openzeppelin-contracts-upgradeable",
+     "openzeppelin-contracts/=certora/stata/munged/lib/solidity-utils/lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts",
+     "@openzeppelin/contracts/=certora/stata/munged/lib/solidity-utils/lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts/contracts",
+  ],
+  "loop_iter": "1",
+  "msg": "aToken properties",
+  "optimistic_hashing": true,
+  "optimistic_loop": true,
+  "solc": "solc8.20",
+  "smt_timeout": "1400",
+  "verify": "StataTokenV2Harness:certora/stata/specs/StataToken/aTokenProperties.spec",
+  "build_cache": true,
+}
diff --git a/certora/stata/conf/verifyDoubleClaim.conf b/certora/stata/conf/verifyDoubleClaim.conf
@@ -0,0 +1,40 @@
+{
+  "files": [
+    "certora/stata/harness/StataTokenV2Harness.sol",
+    "certora/stata/harness/pool/SymbolicLendingPool.sol",
+    "certora/stata/harness/rewards/RewardsControllerHarness.sol",
+    "certora/stata/harness/rewards/TransferStrategyHarness.sol",
+    "certora/stata/harness/tokens/DummyERC20_aTokenUnderlying.sol",
+    "certora/stata/harness/tokens/DummyERC20_rewardToken.sol",
+    "certora/stata/munged/src/core/instances/ATokenInstance.sol",
+  ],
+  "link": [
+    "SymbolicLendingPool:aToken=ATokenInstance",
+    "SymbolicLendingPool:underlyingToken=DummyERC20_aTokenUnderlying",
+    "TransferStrategyHarness:INCENTIVES_CONTROLLER=RewardsControllerHarness",
+    "TransferStrategyHarness:REWARD=DummyERC20_rewardToken",
+    "ATokenInstance:POOL=SymbolicLendingPool",
+    "ATokenInstance:_incentivesController=RewardsControllerHarness",
+    "ATokenInstance:_underlyingAsset=DummyERC20_aTokenUnderlying",
+    "StataTokenV2Harness:INCENTIVES_CONTROLLER=RewardsControllerHarness",
+    "StataTokenV2Harness:POOL=SymbolicLendingPool",
+    "StataTokenV2Harness:_reward_A=DummyERC20_rewardToken"
+  ],
+  "packages": [
+     "aave-v3-core/=certora/stata/munged/src/core",
+     "aave-v3-periphery/=certora/stata/munged/src/periphery",
+     "solidity-utils/=certora/stata/munged/lib/solidity-utils/src",
+     "forge-std/=certora/stata/munged/lib/forge-std/src",
+     "openzeppelin-contracts-upgradeable/=certora/stata/munged/lib/solidity-utils/lib/openzeppelin-contracts-upgradeable",
+     "openzeppelin-contracts/=certora/stata/munged/lib/solidity-utils/lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts",
+     "@openzeppelin/contracts/=certora/stata/munged/lib/solidity-utils/lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts/contracts",
+],
+  "verify":"StataTokenV2Harness:certora/stata/specs/StataToken/double_claim.spec",
+  "solc": "solc8.20",
+  "msg": "Multi rewards - double claim properties",
+  "optimistic_loop": true,
+  "smt_timeout": "2000",
+  "loop_iter": "2",
+  "optimistic_hashing": true,
+  "build_cache": true,
+}
diff --git a/certora/stata/conf/verifyERC4626.conf b/certora/stata/conf/verifyERC4626.conf
@@ -0,0 +1,40 @@
+{
+  "files": [
+    "certora/stata/harness/StataTokenV2Harness.sol",
+    "certora/stata/harness/pool/SymbolicLendingPool.sol",
+    "certora/stata/harness/rewards/RewardsControllerHarness.sol",
+    "certora/stata/harness/rewards/TransferStrategyHarness.sol",
+    "certora/stata/harness/tokens/DummyERC20_aTokenUnderlying.sol",
+    "certora/stata/harness/tokens/DummyERC20_rewardToken.sol",
+    "certora/stata/munged/src/core/instances/ATokenInstance.sol",
+  ],
+  "link": [
+    "SymbolicLendingPool:aToken=ATokenInstance",
+    "SymbolicLendingPool:underlyingToken=DummyERC20_aTokenUnderlying",
+    "TransferStrategyHarness:INCENTIVES_CONTROLLER=RewardsControllerHarness",
+    "TransferStrategyHarness:REWARD=DummyERC20_rewardToken",
+    "ATokenInstance:POOL=SymbolicLendingPool",
+    "ATokenInstance:_incentivesController=RewardsControllerHarness",
+    "ATokenInstance:_underlyingAsset=DummyERC20_aTokenUnderlying",
+    "StataTokenV2Harness:INCENTIVES_CONTROLLER=RewardsControllerHarness",
+    "StataTokenV2Harness:POOL=SymbolicLendingPool",
+    "StataTokenV2Harness:_reward_A=DummyERC20_rewardToken"
+  ],
+  "packages": [
+     "aave-v3-core/=certora/stata/munged/src/core",
+     "aave-v3-periphery/=certora/stata/munged/src/periphery",
+     "solidity-utils/=certora/stata/munged/lib/solidity-utils/src",
+     "forge-std/=certora/stata/munged/lib/forge-std/src",
+     "openzeppelin-contracts-upgradeable/=certora/stata/munged/lib/solidity-utils/lib/openzeppelin-contracts-upgradeable",
+     "openzeppelin-contracts/=certora/stata/munged/lib/solidity-utils/lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts",
+     "@openzeppelin/contracts/=certora/stata/munged/lib/solidity-utils/lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts/contracts",
+],
+  "verify":"StataTokenV2Harness:certora/stata/specs/erc4626/erc4626.spec",
+  "solc": "solc8.20",
+  "msg": "ERC4626 properties",
+  "optimistic_loop": true,
+  "smt_timeout": "3600",
+  "loop_iter": "1",
+  "optimistic_hashing": true,
+  "build_cache": true,
+}
diff --git a/certora/stata/conf/verifyERC4626DepositSummarization.conf b/certora/stata/conf/verifyERC4626DepositSummarization.conf
@@ -0,0 +1,39 @@
+{
+  "files": [
+    "certora/stata/harness/StataTokenV2Harness.sol",
+    "certora/stata/harness/pool/SymbolicLendingPool.sol",
+    "certora/stata/harness/rewards/RewardsControllerHarness.sol",
+    "certora/stata/harness/rewards/TransferStrategyHarness.sol",
+    "certora/stata/harness/tokens/DummyERC20_aTokenUnderlying.sol",
+    "certora/stata/harness/tokens/DummyERC20_rewardToken.sol",
+    "certora/stata/munged/src/core/instances/ATokenInstance.sol",
+  ],
+  "link": [
+    "SymbolicLendingPool:aToken=ATokenInstance",
+    "SymbolicLendingPool:underlyingToken=DummyERC20_aTokenUnderlying",
+    "TransferStrategyHarness:INCENTIVES_CONTROLLER=RewardsControllerHarness",
+    "TransferStrategyHarness:REWARD=DummyERC20_rewardToken",
+    "ATokenInstance:POOL=SymbolicLendingPool",
+    "ATokenInstance:_incentivesController=RewardsControllerHarness",
+    "ATokenInstance:_underlyingAsset=DummyERC20_aTokenUnderlying",
+    "StataTokenV2Harness:INCENTIVES_CONTROLLER=RewardsControllerHarness",
+    "StataTokenV2Harness:POOL=SymbolicLendingPool",
+    "StataTokenV2Harness:_reward_A=DummyERC20_rewardToken"
+  ],
+  "packages": [
+     "aave-v3-core/=certora/stata/munged/src/core",
+     "aave-v3-periphery/=certora/stata/munged/src/periphery",
+     "solidity-utils/=certora/stata/munged/lib/solidity-utils/src",
+     "forge-std/=certora/stata/munged/lib/forge-std/src",
+     "openzeppelin-contracts-upgradeable/=certora/stata/munged/lib/solidity-utils/lib/openzeppelin-contracts-upgradeable",
+     "openzeppelin-contracts/=certora/stata/munged/lib/solidity-utils/lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts",
+     "@openzeppelin/contracts/=certora/stata/munged/lib/solidity-utils/lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts/contracts",
+],
+  "verify": "StataTokenV2Harness:certora/stata/specs/erc4626/erc4626DepositSummarization.spec",
+  "solc": "solc8.20",
+  "msg": "ERC4626 Deposit summarized",
+  "optimistic_loop": true,
+  "loop_iter": "1",
+  "optimistic_hashing": true,
+  "build_cache": true,
+}
diff --git a/certora/stata/conf/verifyERC4626Extended.conf b/certora/stata/conf/verifyERC4626Extended.conf
@@ -0,0 +1,40 @@
+{
+  "files": [
+    "certora/stata/harness/StataTokenV2Harness.sol",
+    "certora/stata/harness/pool/SymbolicLendingPool.sol",
+    "certora/stata/harness/rewards/RewardsControllerHarness.sol",
+    "certora/stata/harness/rewards/TransferStrategyHarness.sol",
+    "certora/stata/harness/tokens/DummyERC20_aTokenUnderlying.sol",
+    "certora/stata/harness/tokens/DummyERC20_rewardToken.sol",
+    "certora/stata/munged/src/core/instances/ATokenInstance.sol",
+  ],
+  "link": [
+    "SymbolicLendingPool:aToken=ATokenInstance",
+    "SymbolicLendingPool:underlyingToken=DummyERC20_aTokenUnderlying",
+    "TransferStrategyHarness:INCENTIVES_CONTROLLER=RewardsControllerHarness",
+    "TransferStrategyHarness:REWARD=DummyERC20_rewardToken",
+    "ATokenInstance:POOL=SymbolicLendingPool",
+    "ATokenInstance:_incentivesController=RewardsControllerHarness",
+    "ATokenInstance:_underlyingAsset=DummyERC20_aTokenUnderlying",
+    "StataTokenV2Harness:INCENTIVES_CONTROLLER=RewardsControllerHarness",
+    "StataTokenV2Harness:POOL=SymbolicLendingPool",
+    "StataTokenV2Harness:_reward_A=DummyERC20_rewardToken"
+  ],
+  "packages": [
+     "aave-v3-core/=certora/stata/munged/src/core",
+     "aave-v3-periphery/=certora/stata/munged/src/periphery",
+     "solidity-utils/=certora/stata/munged/lib/solidity-utils/src",
+     "forge-std/=certora/stata/munged/lib/forge-std/src",
+     "openzeppelin-contracts-upgradeable/=certora/stata/munged/lib/solidity-utils/lib/openzeppelin-contracts-upgradeable",
+     "openzeppelin-contracts/=certora/stata/munged/lib/solidity-utils/lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts",
+     "@openzeppelin/contracts/=certora/stata/munged/lib/solidity-utils/lib/openzeppelin-contracts-upgradeable/lib/openzeppelin-contracts/contracts",
+  ],
+  "verify":"StataTokenV2Harness:certora/stata/specs/erc4626/erc4626Extended.spec",
+  "solc": "solc8.20",
+  "msg": "ERC4626 Extended properties",
+  "optimistic_loop": true,
+  "smt_timeout": "1000",
+  "loop_iter": "1",
+  "optimistic_hashing": true,
+  "build_cache": true,
+}