Add scope information in slithIR CFG

The main usage in the short term is to allow unchecked block
In the long term it will allow better handling of variables usage

Author: montyly

slither/core/cfg/node.py

@@ -54,6 +54,7 @@
         LibraryCallType,
         LowLevelCallType,
     )
+    from slither.core.cfg.scope import Scope
 
 
 # pylint: disable=too-many-lines,too-many-branches,too-many-instance-attributes
@@ -152,7 +153,7 @@ class Node(SourceMapping, ChildFunction):  # pylint: disable=too-many-public-met
 
     """
 
-    def __init__(self, node_type: NodeType, node_id: int):
+    def __init__(self, node_type: NodeType, node_id: int, scope: Union["Scope", "Function"]):
         super().__init__()
         self._node_type = node_type
 
@@ -220,6 +221,8 @@ def __init__(self, node_type: NodeType, node_id: int):
 
         self._asm_source_code: Optional[Union[str, Dict]] = None
 
+        self.scope = scope
+
     ###################################################################################
     ###################################################################################
     # region General's properties

slither/core/cfg/scope.py

@@ -0,0 +1,14 @@
+from typing import List, TYPE_CHECKING, Union
+
+if TYPE_CHECKING:
+    from slither.core.cfg.node import Node
+    from slither.core.declarations.function import Function
+
+
+class Scope:
+
+    def __init__(self, is_checked:bool, is_yul: bool, scope: Union["Scope", "Function"]):
+        self.nodes: List[Node] = []
+        self.is_checked = is_checked
+        self.is_yul = is_yul
+        self.father = scope

slither/core/declarations/contract.py

@@ -7,6 +7,7 @@
 
 from crytic_compile.platform import Type as PlatformType
 
+from slither.core.cfg.scope import Scope
 from slither.core.solidity_types.type import Type
 from slither.core.source_mapping.source_mapping import SourceMapping
 
@@ -1114,12 +1115,12 @@ def add_constructor_variables(self):
                     constructor_variable.set_offset(self.source_mapping, self.compilation_unit)
                     self._functions[constructor_variable.canonical_name] = constructor_variable
 
-                    prev_node = self._create_node(constructor_variable, 0, variable_candidate)
+                    prev_node = self._create_node(constructor_variable, 0, variable_candidate, constructor_variable)
                     variable_candidate.node_initialization = prev_node
                     counter = 1
                     for v in self.state_variables[idx + 1 :]:
                         if v.expression and not v.is_constant:
-                            next_node = self._create_node(constructor_variable, counter, v)
+                            next_node = self._create_node(constructor_variable, counter, v, prev_node.scope)
                             v.node_initialization = next_node
                             prev_node.add_son(next_node)
                             next_node.add_father(prev_node)
@@ -1142,12 +1143,12 @@ def add_constructor_variables(self):
                     constructor_variable.set_offset(self.source_mapping, self.compilation_unit)
                     self._functions[constructor_variable.canonical_name] = constructor_variable
 
-                    prev_node = self._create_node(constructor_variable, 0, variable_candidate)
+                    prev_node = self._create_node(constructor_variable, 0, variable_candidate, constructor_variable)
                     variable_candidate.node_initialization = prev_node
                     counter = 1
                     for v in self.state_variables[idx + 1 :]:
                         if v.expression and v.is_constant:
-                            next_node = self._create_node(constructor_variable, counter, v)
+                            next_node = self._create_node(constructor_variable, counter, v, prev_node.scope)
                             v.node_initialization = next_node
                             prev_node.add_son(next_node)
                             next_node.add_father(prev_node)
@@ -1156,7 +1157,7 @@ def add_constructor_variables(self):
 
                     break
 
-    def _create_node(self, func: Function, counter: int, variable: "Variable"):
+    def _create_node(self, func: Function, counter: int, variable: "Variable", scope: Union[Scope, Function]):
         from slither.core.cfg.node import Node, NodeType
         from slither.core.expressions import (
             AssignmentOperationType,
@@ -1165,7 +1166,7 @@ def _create_node(self, func: Function, counter: int, variable: "Variable"):
         )
 
         # Function uses to create node for state variable declaration statements
-        node = Node(NodeType.OTHER_ENTRYPOINT, counter)
+        node = Node(NodeType.OTHER_ENTRYPOINT, counter, scope)
         node.set_offset(variable.source_mapping, self.compilation_unit)
         node.set_function(func)
         func.add_node(node)

slither/core/declarations/function.py

@@ -8,6 +8,7 @@
 from itertools import groupby
 from typing import Dict, TYPE_CHECKING, List, Optional, Set, Union, Callable, Tuple
 
+from slither.core.cfg.scope import Scope
 from slither.core.declarations.solidity_variables import (
     SolidityFunction,
     SolidityVariable,
@@ -313,13 +314,16 @@ def can_send_eth(self) -> bool:
                     return True
         return self._can_send_eth
 
-    # @property
-    # def slither(self) -> "SlitherCore":
-    #     return self._slither
-    #
-    # @slither.setter
-    # def slither(self, sl: "SlitherCore"):
-    #     self._slither = sl
+    @property
+    def is_checked(self) -> bool:
+        """
+        Return true if the overflow are enabled by default
+
+
+        :return:
+        """
+
+        return self.compilation_unit.solc_version >= "0.8.0"
 
     # endregion
     ###################################################################################
@@ -1527,10 +1531,10 @@ def _analyze_calls(self):
     ###################################################################################
     ###################################################################################
 
-    def new_node(self, node_type: "NodeType", src: Union[str, Dict]) -> "Node":
+    def new_node(self, node_type: "NodeType", src: Union[str, Dict], scope: Union[Scope, "Function"]) -> "Node":
         from slither.core.cfg.node import Node
 
-        node = Node(node_type, self._counter_nodes)
+        node = Node(node_type, self._counter_nodes, scope)
         node.set_offset(src, self.compilation_unit)
         self._counter_nodes += 1
         node.set_function(self)

slither/slithir/operations/binary.py

@@ -131,7 +131,7 @@ def __str__(self):  # pylint: disable=too-many-branches
 
 
 class Binary(OperationWithLValue):
-    def __init__(self, result, left_variable, right_variable, operation_type):
+    def __init__(self, result, left_variable, right_variable, operation_type: BinaryType, is_checked: bool=False):
         assert is_valid_rvalue(left_variable) or isinstance(left_variable, Function)
         assert is_valid_rvalue(right_variable) or isinstance(right_variable, Function)
         assert is_valid_lvalue(result)
@@ -144,6 +144,7 @@ def __init__(self, result, left_variable, right_variable, operation_type):
             result.set_type(ElementaryType("bool"))
         else:
             result.set_type(left_variable.type)
+        self.is_checked = is_checked
 
     @property
     def read(self):