Add CustomError as printable output (#2063)

slither/core/declarations/__init__.py

@@ -18,3 +18,5 @@
 from .function_contract import FunctionContract
 from .function_top_level import FunctionTopLevel
 from .custom_error_contract import CustomErrorContract
+from .custom_error_top_level import CustomErrorTopLevel
+from .custom_error import CustomError

slither/core/declarations/custom_error_contract.py

@@ -16,3 +16,7 @@ def is_declared_by(self, contract: "Contract") -> bool:
         :return:
         """
         return self.contract == contract
+
+    @property
+    def canonical_name(self) -> str:
+        return self.contract.name + "." + self.full_name

slither/core/declarations/custom_error_top_level.py

@@ -12,3 +12,7 @@ class CustomErrorTopLevel(CustomError, TopLevel):
     def __init__(self, compilation_unit: "SlitherCompilationUnit", scope: "FileScope") -> None:
         super().__init__(compilation_unit)
         self.file_scope: "FileScope" = scope
+
+    @property
+    def canonical_name(self) -> str:
+        return self.full_name

slither/utils/output.py

@@ -18,6 +18,7 @@
     Structure,
     Pragma,
     FunctionContract,
+    CustomError,
 )
 from slither.core.source_mapping.source_mapping import SourceMapping
 from slither.core.variables.local_variable import LocalVariable
@@ -438,6 +439,8 @@ def add(self, add: SupportedOutput, additional_fields: Optional[Dict] = None) ->
             self.add_event(add, additional_fields=additional_fields)
         elif isinstance(add, Structure):
             self.add_struct(add, additional_fields=additional_fields)
+        elif isinstance(add, CustomError):
+            self.add_custom_error(add, additional_fields=additional_fields)
         elif isinstance(add, Pragma):
             self.add_pragma(add, additional_fields=additional_fields)
         elif isinstance(add, Node):
@@ -585,6 +588,32 @@ def add_event(self, event: Event, additional_fields: Optional[Dict] = None) -> N
 
         self._data["elements"].append(element)
 
+    # endregion
+    ###################################################################################
+    ###################################################################################
+    # region CustomError
+    ###################################################################################
+    ###################################################################################
+
+    def add_custom_error(
+        self, custom_error: CustomError, additional_fields: Optional[Dict] = None
+    ) -> None:
+        if additional_fields is None:
+            additional_fields = {}
+        type_specific_fields = {
+            "parent": _create_parent_element(custom_error),
+            "signature": custom_error.full_name,
+        }
+        element = _create_base_element(
+            "custom_error",
+            custom_error.name,
+            custom_error.source_mapping.to_json(),
+            type_specific_fields,
+            additional_fields,
+        )
+
+        self._data["elements"].append(element)
+
     # endregion
     ###################################################################################
     ###################################################################################