Merge pull request #1111 from crytic/dev-slither-check-erc-4626-2612

Add support of ERC4626, ERC2612 for slither-check-erc
crytic · Mar 16, 2022 · a2a2d7a · a2a2d7a
2 parents 7879251 + a2ae683
commit a2a2d7a
Show file tree

Hide file tree

Showing 2 changed files with 102 additions and 0 deletions.
diff --git a/slither/core/declarations/contract.py b/slither/core/declarations/contract.py
@@ -20,6 +20,8 @@
     ERC1820_signatures,
     ERC777_signatures,
     ERC1155_signatures,
+    ERC2612_signatures,
+    ERC4626_signatures,
 )
 from slither.utils.tests_pattern import is_test_contract
 
@@ -900,6 +902,8 @@ def ercs(self) -> List[str]:
             ("ERC223", self.is_erc223),
             ("ERC721", self.is_erc721),
             ("ERC777", self.is_erc777),
+            ("ERC2612", self.is_erc2612),
+            ("ERC4626", self.is_erc4626),
         ]
 
         return [erc for erc, is_erc in all_erc if is_erc()]
@@ -974,6 +978,26 @@ def is_erc1155(self) -> bool:
         full_names = self.functions_signatures
         return all(s in full_names for s in ERC1155_signatures)
 
+    def is_erc4626(self) -> bool:
+        """
+            Check if the contract is an erc4626
+
+            Note: it does not check for correct return values
+        :return: Returns a true if the contract is an erc4626
+        """
+        full_names = self.functions_signatures
+        return all(s in full_names for s in ERC4626_signatures)
+
+    def is_erc2612(self) -> bool:
+        """
+            Check if the contract is an erc2612
+
+            Note: it does not check for correct return values
+        :return: Returns a true if the contract is an erc2612
+        """
+        full_names = self.functions_signatures
+        return all(s in full_names for s in ERC2612_signatures)
+
     @property
     def is_token(self) -> bool:
         """

diff --git a/slither/utils/erc.py b/slither/utils/erc.py
@@ -320,6 +320,82 @@ def erc_to_signatures(erc: List[ERC]):
 
 ERC1155_signatures = erc_to_signatures(ERC1155)
 
+# Review
+# https://eips.ethereum.org/EIPS/eip-2612
+# Must have ERC20
+
+ERC2612_EVENTS = []
+ERC2612 = [
+    ERC(
+        "permit",
+        ["address", "address", "uint256", "uint256", "uint8", "bytes32", "bytes32"],
+        "",
+        False,
+        True,
+        [],
+    ),
+    ERC("nonces", ["address"], "uint256", True, True, []),
+    ERC("DOMAIN_SEPARATOR", [], "bytes32", True, True, []),
+] + ERC20
+
+ERC2612_signatures = erc_to_signatures(ERC2612)
+
+# Final
+# https://eips.ethereum.org/EIPS/eip-4626
+# Must have ERC20
+
+ERC4626_deposit_event = ERC_EVENT(
+    "Deposit",
+    ["address", "address", "uint256", "uint256"],
+    [True, True, False, False],
+)
+
+ERC4626_withdraw_event = ERC_EVENT(
+    "Withdraw",
+    ["address", "address", "address", "uint256", "uint256"],
+    [True, True, True, False, False],
+)
+
+ERC4626_EVENTS = [
+    ERC4626_deposit_event,
+    ERC4626_withdraw_event,
+]
+
+ERC4626 = [
+    ERC("asset", [], "address", True, True, []),
+    ERC("totalAssets", [], "uint256", True, True, []),
+    ERC("convertToShares", ["uint256"], "uint256", True, True, []),
+    ERC("convertToAssets", ["uint256"], "uint256", True, True, []),
+    ERC("maxDeposit", ["address"], "uint256", True, True, []),
+    ERC("previewDeposit", ["uint256"], "uint256", True, True, []),
+    ERC("deposit", ["uint256", "address"], "uint256", False, True, [ERC4626_deposit_event]),
+    ERC("maxMint", ["address"], "uint256", True, True, []),
+    ERC("previewMint", ["uint256"], "uint256", True, True, []),
+    ERC("mint", ["uint256", "address"], "uint256", False, True, [ERC4626_deposit_event]),
+    ERC("maxWithdraw", ["address"], "uint256", True, True, []),
+    ERC("previewWithdraw", ["uint256"], "uint256", True, True, []),
+    ERC(
+        "withdraw",
+        ["uint256", "address", "address"],
+        "uint256",
+        False,
+        True,
+        [ERC4626_withdraw_event],
+    ),
+    ERC("maxRedeem", ["address"], "uint256", True, True, []),
+    ERC("previewRedeem", ["uint256"], "uint256", True, True, []),
+    ERC(
+        "redeem",
+        ["uint256", "address", "address"],
+        "uint256",
+        False,
+        True,
+        [ERC4626_withdraw_event],
+    ),
+] + ERC20
+
+ERC4626_signatures = erc_to_signatures(ERC4626)
+
 ERCS = {
     "ERC20": (ERC20, ERC20_EVENTS),
     "ERC223": (ERC223, ERC223_EVENTS),
@@ -328,4 +404,6 @@ def erc_to_signatures(erc: List[ERC]):
     "ERC1820": (ERC1820, ERC1820_EVENTS),
     "ERC777": (ERC777, ERC777_EVENTS),
     "ERC1155": (ERC1155, ERC1155_EVENTS),
+    "ERC2612": (ERC2612, ERC2612_EVENTS),
+    "ERC4626": (ERC4626, ERC4626_EVENTS),
 }