Deploy v2

.github/workflows/ci.yml

@@ -153,3 +153,45 @@ jobs:
         run: |
           echo "## Foundry Unit tests result" >> $GITHUB_STEP_SUMMARY
           echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+  coverage:
+    needs: ["build", "lint"]
+    runs-on: "ubuntu-latest"
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: "recursive"
+
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
+
+      - name: "Install lcov"
+        run: "sudo apt-get install lcov"
+
+      - uses: actions/cache/restore@v3
+        with:
+          fail-on-cache-miss: true
+          path: |
+            cache-forge
+            out
+            cache-hh
+            artifacts
+            typechain
+            node_modules
+          key: "build-${{ github.sha }}"
+
+      - name: "Generate the coverage report using the unit and the integration tests"
+        run: "yarn ci:coverage"
+        env:
+          ETH_NODE_URI_OPTIMISM: ${{ secrets.ETH_NODE_URI_OPTIMISM }}
+
+      - name: "Upload coverage report to Codecov"
+        uses: "codecov/codecov-action@v3"
+        with:
+          files: "./lcov.info"
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: "Add coverage summary"
+        run: |
+          echo "## Coverage result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Uploaded to Codecov" >> $GITHUB_STEP_SUMMARY

.vscode/settings.json

@@ -7,7 +7,7 @@
     "editor.defaultFormatter": "JuanBlanco.solidity"
   },
   "editor.codeActionsOnSave": {
-    "source.fixAll": true
+    "source.fixAll": "explicit"
   },
   "solidity.compileUsingRemoteVersion": "v0.8.17+commit.8df45f5f"
 }

README.md

@@ -1,6 +1,7 @@
 # <img src="logo.svg" alt="Merkl Contracts" height="40px"> Merkl Contracts
 
 [![CI](https://github.com/AngleProtocol/merkl-contracts/actions/workflows/ci.yml/badge.svg)](https://github.com/AngleProtocol/merkl-contracts/actions)
+[![Coverage](https://codecov.io/gh/AngleProtocol/merkl-contracts/branch/main/graph/badge.svg)](https://codecov.io/gh/AngleProtocol/merkl-contracts)
 
 This repository contains the smart contracts of the Merkl product developed by Angle.
 

contracts/Distributor.sol

@@ -39,7 +39,7 @@
 import { SafeERC20 } from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";
 
 import "./utils/UUPSHelper.sol";
 
 struct MerkleTree {
     // Root of a Merkle tree which leaves are `(address user, address token, uint amount)`
@@ -58,7 +58,7 @@
 }
 
 /// @title Distributor
-/// @notice Allows LPs on AMMs with concentrated liquidity to claim the rewards that were distributed to them
+/// @notice Allows to claim rewards distributed to them through Merkl
 /// @author Angle Labs. Inc
 contract Distributor is UUPSHelper {
     using SafeERC20 for IERC20;
@@ -130,6 +130,12 @@
         _;
     }
 
+    /// @notice Checks whether the `msg.sender` has the governor role or the guardian role
+    modifier onlyGovernor() {
+        if (!core.isGovernor(msg.sender)) revert NotGovernor();
+        _;
+    }
+
     /// @notice Checks whether the `msg.sender` is the `user` address or is a trusted address
     modifier onlyTrustedOrUser(address user) {
         if (user != msg.sender && canUpdateMerkleRoot[msg.sender] != 1 && !core.isGovernorOrGuardian(msg.sender))
@@ -147,7 +153,7 @@
     }
 
     /// @inheritdoc UUPSUpgradeable
-    function _authorizeUpgrade(address) internal view override onlyGuardianUpgrader(core) {}
+    function _authorizeUpgrade(address) internal view override onlyGovernorUpgrader(core) {}
 
     // =============================== MAIN FUNCTION ===============================
 
@@ -205,7 +211,7 @@
     // ============================ GOVERNANCE FUNCTIONS ===========================
 
     /// @notice Adds or removes EOAs which are trusted to update the Merkle root
-    function toggleTrusted(address eoa) external onlyGovernorOrGuardian {
+    function toggleTrusted(address eoa) external onlyGovernor {
         uint256 trustedStatus = 1 - canUpdateMerkleRoot[eoa];
         canUpdateMerkleRoot[eoa] = trustedStatus;
         emit TrustedToggled(eoa, trustedStatus == 1);
@@ -218,7 +224,7 @@
             // A trusted address cannot update a tree right after a precedent tree update otherwise it can de facto
             // validate a tree which has not passed the dispute period
             ((canUpdateMerkleRoot[msg.sender] != 1 || block.timestamp < endOfDisputePeriod) &&
-                !core.isGovernorOrGuardian(msg.sender))
+                !core.isGovernor(msg.sender))
         ) revert NotTrusted();
         MerkleTree memory _lastTree = tree;
         tree = _tree;
@@ -278,26 +284,26 @@
     }
 
     /// @notice Recovers any ERC20 token
-    function recoverERC20(address tokenAddress, address to, uint256 amountToRecover) external onlyGovernorOrGuardian {
+    function recoverERC20(address tokenAddress, address to, uint256 amountToRecover) external onlyGovernor {
         IERC20(tokenAddress).safeTransfer(to, amountToRecover);
         emit Recovered(tokenAddress, to, amountToRecover);
     }
 
     /// @notice Sets the dispute period after which a tree update becomes effective
-    function setDisputePeriod(uint48 _disputePeriod) external onlyGovernorOrGuardian {
+    function setDisputePeriod(uint48 _disputePeriod) external onlyGovernor {
         disputePeriod = uint48(_disputePeriod);
         emit DisputePeriodUpdated(_disputePeriod);
     }
 
     /// @notice Sets the token used as a caution during disputes
-    function setDisputeToken(IERC20 _disputeToken) external onlyGovernorOrGuardian {
+    function setDisputeToken(IERC20 _disputeToken) external onlyGovernor {
         if (disputer != address(0)) revert UnresolvedDispute();
         disputeToken = _disputeToken;
         emit DisputeTokenUpdated(address(_disputeToken));
     }
 
     /// @notice Sets the amount of `disputeToken` used as a caution during disputes
-    function setDisputeAmount(uint256 _disputeAmount) external onlyGovernorOrGuardian {
+    function setDisputeAmount(uint256 _disputeAmount) external onlyGovernor {
         if (disputer != address(0)) revert UnresolvedDispute();
         disputeAmount = _disputeAmount;
         emit DisputeAmountUpdated(_disputeAmount);