Add support of ERC1155 for slither-check-erc tool.

Author: smonicas

slither/core/declarations/contract.py

@@ -19,6 +19,7 @@
     ERC721_signatures,
     ERC1820_signatures,
     ERC777_signatures,
+    ERC1155_signatures,
 )
 from slither.utils.tests_pattern import is_test_contract
 
@@ -925,6 +926,16 @@ def is_erc777(self) -> bool:
         full_names = self.functions_signatures
         return all(s in full_names for s in ERC777_signatures)
 
+    def is_erc1155(self) -> bool:
+        """
+            Check if the contract is an erc1155
+
+            Note: it does not check for correct return values
+        :return: Returns a true if the contract is an erc1155
+        """
+        full_names = self.functions_signatures
+        return all(s in full_names for s in ERC1155_signatures)
+
     @property
     def is_token(self) -> bool:
         """
@@ -937,6 +948,7 @@ def is_token(self) -> bool:
             or self.is_erc165()
             or self.is_erc223()
             or self.is_erc777()
+            or self.is_erc1155()
         )
 
     def is_possible_erc20(self) -> bool:

slither/tools/erc_conformance/__main__.py

@@ -8,6 +8,7 @@
 from slither.utils.output import output_to_json
 from .erc.ercs import generic_erc_checks
 from .erc.erc20 import check_erc20
+from .erc.erc1155 import check_erc1155
 
 logging.basicConfig()
 logging.getLogger("Slither").setLevel(logging.INFO)
@@ -22,7 +23,7 @@
 logger.handlers[0].setFormatter(formatter)
 logger.propagate = False
 
-ADDITIONAL_CHECKS = {"ERC20": check_erc20}
+ADDITIONAL_CHECKS = {"ERC20": check_erc20, "ERC1155": check_erc1155}
 
 
 def parse_args():

slither/tools/erc_conformance/erc/erc1155.py

@@ -0,0 +1,48 @@
+import logging
+
+from slither.slithir.operations import EventCall
+from slither.utils import output
+
+logger = logging.getLogger("Slither-conformance")
+
+def events_safeBatchTransferFrom(contract, ret):
+    function = contract.get_function_from_signature("safeBatchTransferFrom(address,address,uint256[],uint256[],bytes)")
+    events = [
+                {"name": "TransferSingle", "parameters": ["address", "address", "address", "uint256", "uint256"]},
+                {"name": "TransferBatch", "parameters": ["address", "address", "address", "uint256[]", "uint256[]"]}
+             ]
+
+    event_counter_name = 0
+    event_counter_parameters = 0
+    if function:
+        for event in events:
+            for ir in function.all_slithir_operations():
+                if isinstance(ir, EventCall) and ir.name == event["name"]:
+                    event_counter_name += 1
+                    if event["parameters"] == [str(a.type) for a in ir.arguments]:
+                        event_counter_parameters += 1
+    if event_counter_parameters == 1 and event_counter_name == 1:
+        txt = "[✓] safeBatchTransferFrom emit TransferSingle or TransferBatch"
+        logger.info(txt)
+    else:
+        txt = "[ ] safeBatchTransferFrom must emit TransferSingle or TransferBatch"
+        logger.info(txt)
+
+        erroneous_erc1155_safeBatchTransferFrom_event = output.Output(txt)
+        erroneous_erc1155_safeBatchTransferFrom_event.add(contract)
+        ret["erroneous_erc1155_safeBatchTransferFrom_event"].append(
+            erroneous_erc1155_safeBatchTransferFrom_event.data
+        )
+
+def check_erc1155(contract, ret, explored=None):
+    if explored is None:
+        explored = set()
+
+    explored.add(contract)
+
+    events_safeBatchTransferFrom(contract, ret)
+
+    for derived_contract in contract.derived_contracts:
+        check_erc1155(derived_contract, ret, explored)
+
+    return ret

slither/utils/erc.py

@@ -237,11 +237,93 @@ def erc_to_signatures(erc: List[ERC]):
 ]
 ERC777_signatures = erc_to_signatures(ERC777)
 
+# Final
+# https://eips.ethereum.org/EIPS/eip-1155
+# Must have ERC165
+
+ERC1155_transfersingle_event = ERC_EVENT(
+    "TransferSingle",
+    ["address", "address", "address", "uint256", "uint256"],
+    [True, True, True, False, False],
+)
+
+ERC1155_transferbatch_event = ERC_EVENT(
+    "TransferBatch",
+    ["address", "address", "address", "uint256[]", "uint256[]"],
+    [True, True, True, False, False],
+)
+
+ERC1155_approvalforall_event = ERC_EVENT(
+    "ApprovalForAll",
+    ["address", "address", "bool"],
+    [True, True, False],
+)
+
+ERC1155_uri_event = ERC_EVENT(
+    "URI",
+    ["string", "uint256"],
+    [False, True],
+)
+
+ERC1155_EVENTS = [
+    ERC1155_transfersingle_event,
+    ERC1155_transferbatch_event,
+    ERC1155_approvalforall_event,
+    ERC1155_uri_event,
+]
+
+ERC1155 = [
+    ERC("safeTransferFrom",
+        ["address", "address", "uint256", "uint256", "bytes"],
+        "",
+        False,
+        True,
+        [ERC1155_transfersingle_event]
+    ),
+    ERC("safeBatchTransferFrom",
+        ["address", "address", "uint256[]", "uint256[]", "bytes"],
+        "",
+        False,
+        True,
+        []
+    ),
+    ERC("balanceOf", ["address", "uint256"], "uint256", True, True, []),
+    ERC("balanceOfBatch", ["address[]", "uint256[]"], "uint256[]", True, True, []),
+    ERC("setApprovalForAll", ["address", "bool"], "", False, True, [ERC1155_approvalforall_event]),
+    ERC("isApprovedForAll", ["address", "address"], "bool", True, True, []),
+] + ERC165
+
+ERC1155_TOKEN_RECEIVER = [
+    ERC("onERC1155Received",
+        ["address", "address", "uint256", "uint256", "bytes"],
+        "bytes4",
+        False,
+        False,
+        []
+    ),
+    ERC("onERC1155BatchReceived",
+        ["address", "address", "uint256[]", "uint256[]", "bytes"],
+        "bytes4",
+        False,
+        False,
+        []
+    ),
+]
+
+ERC1155_METADATA = [
+    ERC("uri", ["uint256"], "string", True, False, [])
+]
+
+ERC1155 = ERC1155 + ERC1155_TOKEN_RECEIVER + ERC1155_METADATA
+
+ERC1155_signatures = erc_to_signatures(ERC1155)
+
 ERCS = {
     "ERC20": (ERC20, ERC20_EVENTS),
     "ERC223": (ERC223, ERC223_EVENTS),
     "ERC165": (ERC165, ERC165_EVENTS),
     "ERC721": (ERC721, ERC721_EVENTS),
     "ERC1820": (ERC1820, ERC1820_EVENTS),
     "ERC777": (ERC777, ERC777_EVENTS),
+    "ERC1155": (ERC1155, ERC1155_EVENTS),
 }