Merge pull request #990 from crytic/dev-scope-file

Refactor core objects to add a file scope.

.github/workflows/features.yml

@@ -0,0 +1,47 @@
+---
+name: Features tests
+
+defaults:
+  run:
+    # To load bashrc
+    shell: bash -ieo pipefail {0}
+
+on:
+  pull_request:
+    branches: [master, dev]
+  schedule:
+    # run CI every day even if no PRs/merges occur
+    - cron:  '0 12 * * *'
+
+jobs:
+  build:
+    name: Features tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+
+      - name: Set up Python 3.6
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.6
+
+      - name: Install dependencies
+        run: |
+          python setup.py install
+          pip install deepdiff
+          pip install pytest
+
+          pip install solc-select
+          solc-select install all
+          solc-select use 0.8.0
+
+          cd tests/test_node_modules/
+          npm install hardhat
+          cd ../..
+
+      - name: Test with pytest
+        run: |
+          pytest tests/test_features.py
+

slither/core/cfg/node.py

@@ -54,6 +54,7 @@ if TYPE_CHECKING:
         LowLevelCallType,
     )
     from slither.core.cfg.scope import Scope
+    from slither.core.scope.scope import FileScope
 
 
 # pylint: disable=too-many-lines,too-many-branches,too-many-instance-attributes
@@ -152,7 +153,13 @@ class Node(SourceMapping, ChildFunction):  # pylint: disable=too-many-public-met
 
     """
 
-    def __init__(self, node_type: NodeType, node_id: int, scope: Union["Scope", "Function"]):
+    def __init__(
+        self,
+        node_type: NodeType,
+        node_id: int,
+        scope: Union["Scope", "Function"],
+        file_scope: "FileScope",
+    ):
         super().__init__()
         self._node_type = node_type
 
@@ -220,7 +227,8 @@ class Node(SourceMapping, ChildFunction):  # pylint: disable=too-many-public-met
 
         self._asm_source_code: Optional[Union[str, Dict]] = None
 
-        self.scope = scope
+        self.scope: Union["Scope", "Function"] = scope
+        self.file_scope: "FileScope" = file_scope
 
     ###################################################################################
     ###################################################################################
@@ -902,7 +910,7 @@ class Node(SourceMapping, ChildFunction):  # pylint: disable=too-many-public-met
                     except AttributeError as error:
                         #  pylint: disable=raise-missing-from
                         raise SlitherException(
-                            f"Function not found on {ir}. Please try compiling with a recent Solidity version. {error}"
+                            f"Function not found on IR: {ir}.\nNode: {self} ({self.source_mapping_str})\nFunction: {self.function}\nPlease try compiling with a recent Solidity version. {error}"
                         )
             elif isinstance(ir, LibraryCall):
                 assert isinstance(ir.destination, Contract)

slither/core/compilation_unit.py

@@ -1,9 +1,9 @@
 import math
-from collections import defaultdict
 from typing import Optional, Dict, List, Set, Union, TYPE_CHECKING, Tuple
 
 from crytic_compile import CompilationUnit, CryticCompile
 from crytic_compile.compiler.compiler import CompilerVersion
+from crytic_compile.utils.naming import Filename
 
 from slither.core.context.context import Context
 from slither.core.declarations import (
@@ -17,6 +17,7 @@ from slither.core.declarations.custom_error import CustomError
 from slither.core.declarations.enum_top_level import EnumTopLevel
 from slither.core.declarations.function_top_level import FunctionTopLevel
 from slither.core.declarations.structure_top_level import StructureTopLevel
+from slither.core.scope.scope import FileScope
 from slither.core.variables.state_variable import StateVariable
 from slither.core.variables.top_level_variable import TopLevelVariable
 from slither.slithir.operations import InternalCall
@@ -25,6 +26,7 @@ from slither.slithir.variables import Constant
 if TYPE_CHECKING:
     from slither.core.slither_core import SlitherCore
 
+
 # pylint: disable=too-many-instance-attributes,too-many-public-methods
 class SlitherCompilationUnit(Context):
     def __init__(self, core: "SlitherCore", crytic_compilation_unit: CompilationUnit):
@@ -34,7 +36,7 @@ class SlitherCompilationUnit(Context):
         self._crytic_compile_compilation_unit = crytic_compilation_unit
 
         # Top level object
-        self._contracts: Dict[str, Contract] = {}
+        self.contracts: List[Contract] = []
         self._structures_top_level: List[StructureTopLevel] = []
         self._enums_top_level: List[EnumTopLevel] = []
         self._variables_top_level: List[TopLevelVariable] = []
@@ -51,7 +53,6 @@ class SlitherCompilationUnit(Context):
 
         self._storage_layouts: Dict[str, Dict[str, Tuple[int, int]]] = {}
 
-        self._contract_name_collisions = defaultdict(list)
         self._contract_with_missing_inheritance = set()
 
         self._source_units: Dict[int, str] = {}
@@ -60,6 +61,8 @@ class SlitherCompilationUnit(Context):
         self.counter_slithir_temporary = 0
         self.counter_slithir_reference = 0
 
+        self.scopes: Dict[Filename, FileScope] = dict()
+
     @property
     def core(self) -> "SlitherCore":
         return self._core
@@ -115,32 +118,22 @@ class SlitherCompilationUnit(Context):
     ###################################################################################
     ###################################################################################
 
-    @property
-    def contracts(self) -> List[Contract]:
-        """list(Contract): List of contracts."""
-        return list(self._contracts.values())
-
     @property
     def contracts_derived(self) -> List[Contract]:
         """list(Contract): List of contracts that are derived and not inherited."""
         inheritances = [x.inheritance for x in self.contracts]
         inheritance = [item for sublist in inheritances for item in sublist]
-        return [c for c in self._contracts.values() if c not in inheritance and not c.is_top_level]
+        return [c for c in self.contracts if c not in inheritance and not c.is_top_level]
 
-    @property
+    def get_contract_from_name(self, contract_name: Union[str, Constant]) -> List[Contract]:
-    def contracts_as_dict(self) -> Dict[str, Contract]:
-        """list(dict(str: Contract): List of contracts as dict: name -> Contract."""
-        return self._contracts
-
-    def get_contract_from_name(self, contract_name: Union[str, Constant]) -> Optional[Contract]:
         """
-            Return a contract from a name
+            Return a list of contract from a name
         Args:
             contract_name (str): name of the contract
         Returns:
-            Contract
+            List[Contract]
         """
-        return next((c for c in self.contracts if c.name == contract_name), None)
+        return [c for c in self.contracts if c.name == contract_name]
 
     # endregion
     ###################################################################################
@@ -223,14 +216,27 @@ class SlitherCompilationUnit(Context):
     ###################################################################################
     ###################################################################################
 
-    @property
-    def contract_name_collisions(self) -> Dict:
-        return self._contract_name_collisions
-
     @property
     def contracts_with_missing_inheritance(self) -> Set:
         return self._contract_with_missing_inheritance
 
+    # endregion
+    ###################################################################################
+    ###################################################################################
+    # region Scope
+    ###################################################################################
+    ###################################################################################
+
+    def get_scope(self, filename_str: str) -> FileScope:
+        filename = self._crytic_compile_compilation_unit.crytic_compile.filename_lookup(
+            filename_str
+        )
+
+        if filename not in self.scopes:
+            self.scopes[filename] = FileScope(filename)
+
+        return self.scopes[filename]
+
     # endregion
     ###################################################################################
     ###################################################################################

slither/core/declarations/contract.py

@@ -39,6 +39,7 @@ if TYPE_CHECKING:
     from slither.core.variables.state_variable import StateVariable
     from slither.core.compilation_unit import SlitherCompilationUnit
     from slither.core.declarations.custom_error_contract import CustomErrorContract
+    from slither.core.scope.scope import FileScope
 
 
 LOGGER = logging.getLogger("Contract")
@@ -49,7 +50,7 @@ class Contract(SourceMapping):  # pylint: disable=too-many-public-methods
     Contract class
     """
 
-    def __init__(self, compilation_unit: "SlitherCompilationUnit"):
+    def __init__(self, compilation_unit: "SlitherCompilationUnit", scope: "FileScope"):
         super().__init__()
 
         self._name: Optional[str] = None
@@ -69,7 +70,7 @@ class Contract(SourceMapping):  # pylint: disable=too-many-public-methods
         self._modifiers: Dict[str, "Modifier"] = {}
         self._functions: Dict[str, "FunctionContract"] = {}
         self._linearizedBaseContracts: List[int] = []
-        self._custom_errors: Dict[str:"CustomErrorContract"] = {}
+        self._custom_errors: Dict[str, "CustomErrorContract"] = {}
 
         # The only str is "*"
         self._using_for: Dict[Union[str, Type], List[str]] = {}
@@ -92,6 +93,7 @@ class Contract(SourceMapping):  # pylint: disable=too-many-public-methods
         self._all_functions_called: Optional[List["InternalCallType"]] = None
 
         self.compilation_unit: "SlitherCompilationUnit" = compilation_unit
+        self.file_scope: "FileScope" = scope
 
     ###################################################################################
     ###################################################################################
@@ -1086,7 +1088,7 @@ class Contract(SourceMapping):  # pylint: disable=too-many-public-methods
             self._is_upgradeable = False
             if self.is_upgradeable_proxy:
                 return False
-            initializable = self.compilation_unit.get_contract_from_name("Initializable")
+            initializable = self.file_scope.get_contract_from_name("Initializable")
             if initializable:
                 if initializable in self.inheritance:
                     self._is_upgradeable = True
@@ -1224,7 +1226,7 @@ class Contract(SourceMapping):  # pylint: disable=too-many-public-methods
         )
 
         # Function uses to create node for state variable declaration statements
-        node = Node(NodeType.OTHER_ENTRYPOINT, counter, scope)
+        node = Node(NodeType.OTHER_ENTRYPOINT, counter, scope, func.file_scope)
         node.set_offset(variable.source_mapping, self.compilation_unit)
         node.set_function(func)
         func.add_node(node)

slither/core/declarations/custom_error_top_level.py

@@ -1,6 +1,14 @@
+from typing import TYPE_CHECKING
+
 from slither.core.declarations.custom_error import CustomError
 from slither.core.declarations.top_level import TopLevel
 
+if TYPE_CHECKING:
+    from slither.core.compilation_unit import SlitherCompilationUnit
+    from slither.core.scope.scope import FileScope
+
 
 class CustomErrorTopLevel(CustomError, TopLevel):
-    pass
+    def __init__(self, compilation_unit: "SlitherCompilationUnit", scope: "FileScope"):
+        super().__init__(compilation_unit)
+        self.file_scope: "FileScope" = scope

slither/core/declarations/enum_top_level.py

@@ -1,6 +1,13 @@
+from typing import TYPE_CHECKING, List
+
 from slither.core.declarations import Enum
 from slither.core.declarations.top_level import TopLevel
 
+if TYPE_CHECKING:
+    from slither.core.scope.scope import FileScope
+
 
 class EnumTopLevel(Enum, TopLevel):
-    pass
+    def __init__(self, name: str, canonical_name: str, values: List[str], scope: "FileScope"):
+        super().__init__(name, canonical_name, values)
+        self.file_scope: "FileScope" = scope

slither/core/declarations/function.py

@@ -44,6 +44,7 @@ if TYPE_CHECKING:
     from slither.core.expressions.expression import Expression
     from slither.slithir.operations import Operation
     from slither.core.compilation_unit import SlitherCompilationUnit
+    from slither.core.scope.scope import FileScope
 
 LOGGER = logging.getLogger("Function")
 ReacheableNode = namedtuple("ReacheableNode", ["node", "ir"])
@@ -117,7 +118,7 @@ class Function(SourceMapping, metaclass=ABCMeta):  # pylint: disable=too-many-pu
 
     def __init__(self, compilation_unit: "SlitherCompilationUnit"):
         super().__init__()
-        self._scope: List[str] = []
+        self._internal_scope: List[str] = []
         self._name: Optional[str] = None
         self._view: bool = False
         self._pure: bool = False
@@ -216,6 +217,8 @@ class Function(SourceMapping, metaclass=ABCMeta):  # pylint: disable=too-many-pu
         # Assume we are analyzing Solidty by default
         self.function_language: FunctionLanguage = FunctionLanguage.Solidity
 
+        self._id: Optional[str] = None
+
     ###################################################################################
     ###################################################################################
     # region General properties
@@ -244,18 +247,18 @@ class Function(SourceMapping, metaclass=ABCMeta):  # pylint: disable=too-many-pu
         self._name = new_name
 
     @property
-    def scope(self) -> List[str]:
+    def internal_scope(self) -> List[str]:
         """
         Return a list of name representing the scope of the function
         This is used to model nested functions declared in YUL
 
         :return:
         """
-        return self._scope
+        return self._internal_scope
 
-    @scope.setter
+    @internal_scope.setter
-    def scope(self, new_scope: List[str]):
+    def internal_scope(self, new_scope: List[str]):
-        self._scope = new_scope
+        self._internal_scope = new_scope
 
     @property
     def full_name(self) -> str:
@@ -265,7 +268,7 @@ class Function(SourceMapping, metaclass=ABCMeta):  # pylint: disable=too-many-pu
         """
         if self._full_name is None:
             name, parameters, _ = self.signature
-            full_name = ".".join(self._scope + [name]) + "(" + ",".join(parameters) + ")"
+            full_name = ".".join(self._internal_scope + [name]) + "(" + ",".join(parameters) + ")"
             self._full_name = full_name
         return self._full_name
 
@@ -334,6 +337,26 @@ class Function(SourceMapping, metaclass=ABCMeta):  # pylint: disable=too-many-pu
 
         return self.compilation_unit.solc_version >= "0.8.0"
 
+    @property
+    def id(self) -> Optional[str]:
+        """
+        Return the ID of the funciton. For Solidity with compact-AST the ID is the reference ID
+        For other, the ID is None
+
+        :return:
+        :rtype:
+        """
+        return self._id
+
+    @id.setter
+    def id(self, new_id: str):
+        self._id = new_id
+
+    @property
+    @abstractmethod
+    def file_scope(self) -> "FileScope":
+        pass
+
     # endregion
     ###################################################################################
     ###################################################################################
@@ -1552,7 +1575,7 @@ class Function(SourceMapping, metaclass=ABCMeta):  # pylint: disable=too-many-pu
     ) -> "Node":
         from slither.core.cfg.node import Node
 
-        node = Node(node_type, self._counter_nodes, scope)
+        node = Node(node_type, self._counter_nodes, scope, self.file_scope)
         node.set_offset(src, self.compilation_unit)
         self._counter_nodes += 1
         node.set_function(self)

slither/core/declarations/function_contract.py

@@ -11,6 +11,7 @@ from slither.core.declarations import Function
 
 if TYPE_CHECKING:
     from slither.core.declarations import Contract
+    from slither.core.scope.scope import FileScope
 
 
 class FunctionContract(Function, ChildContract, ChildInheritance):
@@ -23,7 +24,7 @@ class FunctionContract(Function, ChildContract, ChildInheritance):
         if self._canonical_name is None:
             name, parameters, _ = self.signature
             self._canonical_name = (
-                ".".join([self.contract_declarer.name] + self._scope + [name])
+                ".".join([self.contract_declarer.name] + self._internal_scope + [name])
                 + "("
                 + ",".join(parameters)
                 + ")"
@@ -38,6 +39,10 @@ class FunctionContract(Function, ChildContract, ChildInheritance):
         """
         return self.contract_declarer == contract
 
+    @property
+    def file_scope(self) -> "FileScope":
+        return self.contract.file_scope
+
     # endregion
     ###################################################################################
     ###################################################################################

slither/core/declarations/function_top_level.py

@@ -1,13 +1,25 @@
 """
     Function module
 """
-from typing import List, Tuple
+from typing import List, Tuple, TYPE_CHECKING
 
 from slither.core.declarations import Function
 from slither.core.declarations.top_level import TopLevel
 
+if TYPE_CHECKING:
+    from slither.core.compilation_unit import SlitherCompilationUnit
+    from slither.core.scope.scope import FileScope
+
 
 class FunctionTopLevel(Function, TopLevel):
+    def __init__(self, compilation_unit: "SlitherCompilationUnit", scope: "FileScope"):
+        super().__init__(compilation_unit)
+        self._scope: "FileScope" = scope
+
+    @property
+    def file_scope(self) -> "FileScope":
+        return self._scope
+
     @property
     def canonical_name(self) -> str:
         """
@@ -16,7 +28,9 @@ class FunctionTopLevel(Function, TopLevel):
         """
         if self._canonical_name is None:
             name, parameters, _ = self.signature
-            self._canonical_name = ".".join(self._scope + [name]) + "(" + ",".join(parameters) + ")"
+            self._canonical_name = (
+                ".".join(self._internal_scope + [name]) + "(" + ",".join(parameters) + ")"
+            )
         return self._canonical_name
 
     # endregion

slither/core/declarations/import_directive.py

@@ -1,14 +1,18 @@
 from pathlib import Path
-from typing import Optional
+from typing import Optional, TYPE_CHECKING
 
 from slither.core.source_mapping.source_mapping import SourceMapping
 
+if TYPE_CHECKING:
+    from slither.core.scope.scope import FileScope
+
 
 class Import(SourceMapping):
-    def __init__(self, filename: Path):
+    def __init__(self, filename: Path, scope: "FileScope"):
         super().__init__()
         self._filename: Path = filename
         self._alias: Optional[str] = None
+        self.scope: "FileScope" = scope
 
     @property
     def filename(self) -> str:

slither/core/declarations/pragma_directive.py

@@ -1,12 +1,16 @@
-from typing import List
+from typing import List, TYPE_CHECKING
 
 from slither.core.source_mapping.source_mapping import SourceMapping
 
+if TYPE_CHECKING:
+    from slither.core.scope.scope import FileScope
+
 
 class Pragma(SourceMapping):
-    def __init__(self, directive: List[str]):
+    def __init__(self, directive: List[str], scope: "FileScope"):
         super().__init__()
         self._directive = directive
+        self.scope: "FileScope" = scope
 
     @property
     def directive(self) -> List[str]:

slither/core/declarations/structure.py

@@ -4,16 +4,18 @@ from slither.core.source_mapping.source_mapping import SourceMapping
 
 if TYPE_CHECKING:
     from slither.core.variables.structure_variable import StructureVariable
+    from slither.core.compilation_unit import SlitherCompilationUnit
 
 
 class Structure(SourceMapping):
-    def __init__(self):
+    def __init__(self, compilation_unit: "SlitherCompilationUnit"):
         super().__init__()
         self._name = None
         self._canonical_name = None
         self._elems: Dict[str, "StructureVariable"] = dict()
         # Name of the elements in the order of declaration
         self._elems_ordered: List[str] = []
+        self.compilation_unit = compilation_unit
 
     @property
     def canonical_name(self) -> str:

slither/core/declarations/structure_top_level.py

@@ -1,6 +1,14 @@
+from typing import TYPE_CHECKING
+
 from slither.core.declarations import Structure
 from slither.core.declarations.top_level import TopLevel
 
+if TYPE_CHECKING:
+    from slither.core.scope.scope import FileScope
+    from slither.core.compilation_unit import SlitherCompilationUnit
+
 
 class StructureTopLevel(Structure, TopLevel):
-    pass
+    def __init__(self, compilation_unit: "SlitherCompilationUnit", scope: "FileScope"):
+        super().__init__(compilation_unit)
+        self.file_scope: "FileScope" = scope

slither/core/scope/scope.py

@@ -0,0 +1,100 @@
+from typing import List, Any, Dict, Optional, Union, Set
+from crytic_compile.utils.naming import Filename
+
+from slither.core.declarations import Contract, Import, Pragma
+from slither.core.declarations.custom_error_top_level import CustomErrorTopLevel
+from slither.core.declarations.enum_top_level import EnumTopLevel
+from slither.core.declarations.function_top_level import FunctionTopLevel
+from slither.core.declarations.structure_top_level import StructureTopLevel
+from slither.slithir.variables import Constant
+
+
+def _dict_contain(d1: Dict, d2: Dict) -> bool:
+    """
+    Return true if d1 is included in d2
+    """
+    d2_keys = d2.keys()
+    return all(item in d2_keys for item in d1.keys())
+
+
+# pylint: disable=too-many-instance-attributes
+class FileScope:
+    def __init__(self, filename: Filename):
+        self.filename = filename
+        self.accessible_scopes: List[FileScope] = []
+
+        self.contracts: Dict[str, Contract] = dict()
+        # Custom error are a list instead of a dict
+        # Because we parse the function signature later on
+        # So we simplify the logic and have the scope fields all populated
+        self.custom_errors: Set[CustomErrorTopLevel] = set()
+        self.enums: Dict[str, EnumTopLevel] = dict()
+        # Functions is a list instead of a dict
+        # Because we parse the function signature later on
+        # So we simplify the logic and have the scope fields all populated
+        self.functions: Set[FunctionTopLevel] = set()
+        self.imports: Set[Import] = set()
+        self.pragmas: Set[Pragma] = set()
+        self.structures: Dict[str, StructureTopLevel] = dict()
+
+    def add_accesible_scopes(self) -> bool:
+        """
+        Add information from accessible scopes. Return true if new information was obtained
+
+        :return:
+        :rtype:
+        """
+
+        learn_something = False
+
+        for new_scope in self.accessible_scopes:
+            if not _dict_contain(new_scope.contracts, self.contracts):
+                self.contracts.update(new_scope.contracts)
+                learn_something = True
+            if not new_scope.custom_errors.issubset(self.custom_errors):
+                self.custom_errors |= new_scope.custom_errors
+                learn_something = True
+            if not _dict_contain(new_scope.enums, self.enums):
+                self.enums.update(new_scope.enums)
+                learn_something = True
+            if not new_scope.functions.issubset(self.functions):
+                self.functions |= new_scope.functions
+                learn_something = True
+            if not new_scope.imports.issubset(self.imports):
+                self.imports |= new_scope.imports
+                learn_something = True
+            if not new_scope.pragmas.issubset(self.pragmas):
+                self.pragmas |= new_scope.pragmas
+                learn_something = True
+            if not _dict_contain(new_scope.structures, self.structures):
+                self.structures.update(new_scope.structures)
+                learn_something = True
+
+        return learn_something
+
+    def get_contract_from_name(self, name: Union[str, Constant]) -> Optional[Contract]:
+        if isinstance(name, Constant):
+            return self.contracts.get(name.name, None)
+        return self.contracts.get(name, None)
+
+    # region Built in definitions
+    ###################################################################################
+    ###################################################################################
+
+    def __eq__(self, other: Any) -> bool:
+        if isinstance(other, str):
+            return other == self.filename
+        return NotImplemented
+
+    def __neq__(self, other: Any) -> bool:
+        if isinstance(other, str):
+            return other != self.filename
+        return NotImplemented
+
+    def __str__(self) -> str:
+        return str(self.filename.relative)
+
+    def __hash__(self) -> int:
+        return hash(self.filename.relative)
+
+    # endregion

slither/core/slither_core.py

@@ -110,9 +110,7 @@ class SlitherCore(Context):
         """
         contracts = []
         for compilation_unit in self._compilation_units:
-            contract = compilation_unit.get_contract_from_name(contract_name)
+            contracts += compilation_unit.get_contract_from_name(contract_name)
-            if contract:
-                contracts.append(contract)
         return contracts
 
     ###################################################################################

slither/detectors/slither/name_reused.py

@@ -53,7 +53,16 @@ As a result, the second contract cannot be analyzed.
     def _detect(self):  # pylint: disable=too-many-locals,too-many-branches
         results = []
         compilation_unit = self.compilation_unit
-        names_reused = compilation_unit.contract_name_collisions
+
+        all_contracts = compilation_unit.contracts
+        all_contracts_name = [c.name for c in all_contracts]
+        contracts_name_reused = {
+            contract for contract in all_contracts_name if all_contracts_name.count(contract) > 1
+        }
+
+        names_reused = {
+            name: compilation_unit.get_contract_from_name(name) for name in contracts_name_reused
+        }
 
         # First show the contracts that we know are missing
         incorrectly_constructed = [

slither/formatters/attributes/const_functions.py

@@ -5,13 +5,14 @@ from slither.formatters.exceptions import FormatError
 from slither.formatters.utils.patches import create_patch
 
 
-def custom_format(comilation_unit: SlitherCompilationUnit, result):
+def custom_format(compilation_unit: SlitherCompilationUnit, result):
+    for file_scope in compilation_unit.scopes.values():
         elements = result["elements"]
         for element in elements:
             if element["type"] != "function":
                 # Skip variable elements
                 continue
-        target_contract = comilation_unit.get_contract_from_name(
+            target_contract = file_scope.get_contract_from_name(
                 element["type_specific_fields"]["parent"]["name"]
             )
             if target_contract:
@@ -20,7 +21,7 @@ def custom_format(comilation_unit: SlitherCompilationUnit, result):
                 )
                 if function:
                     _patch(
-                    comilation_unit,
+                        compilation_unit,
                         result,
                         element["source_mapping"]["filename_absolute"],
                         int(
@@ -32,9 +33,9 @@ def custom_format(comilation_unit: SlitherCompilationUnit, result):
 
 
 def _patch(
-    comilation_unit: SlitherCompilationUnit, result, in_file, modify_loc_start, modify_loc_end
+    compilation_unit: SlitherCompilationUnit, result, in_file, modify_loc_start, modify_loc_end
 ):
-    in_file_str = comilation_unit.core.source_code[in_file].encode("utf8")
+    in_file_str = compilation_unit.core.source_code[in_file].encode("utf8")
     old_str_of_interest = in_file_str[modify_loc_start:modify_loc_end]
     # Find the keywords view|pure|constant and remove them
     m = re.search("(view|pure|constant)", old_str_of_interest.decode("utf-8"))

slither/formatters/functions/external_function.py

@@ -4,10 +4,11 @@ from slither.core.compilation_unit import SlitherCompilationUnit
 from slither.formatters.utils.patches import create_patch
 
 
-def custom_format(comilation_unit: SlitherCompilationUnit, result):
+def custom_format(compilation_unit: SlitherCompilationUnit, result):
+    for file_scope in compilation_unit.scopes.values():
         elements = result["elements"]
         for element in elements:
-        target_contract = comilation_unit.get_contract_from_name(
+            target_contract = file_scope.get_contract_from_name(
                 element["type_specific_fields"]["parent"]["name"]
             )
             if target_contract:
@@ -16,7 +17,7 @@ def custom_format(comilation_unit: SlitherCompilationUnit, result):
                 )
                 if function:
                     _patch(
-                    comilation_unit,
+                        compilation_unit,
                         result,
                         element["source_mapping"]["filename_absolute"],
                         int(function.parameters_src().source_mapping["start"]),
@@ -25,9 +26,9 @@ def custom_format(comilation_unit: SlitherCompilationUnit, result):
 
 
 def _patch(
-    comilation_unit: SlitherCompilationUnit, result, in_file, modify_loc_start, modify_loc_end
+    compilation_unit: SlitherCompilationUnit, result, in_file, modify_loc_start, modify_loc_end
 ):
-    in_file_str = comilation_unit.core.source_code[in_file].encode("utf8")
+    in_file_str = compilation_unit.core.source_code[in_file].encode("utf8")
     old_str_of_interest = in_file_str[modify_loc_start:modify_loc_end]
     # Search for 'public' keyword which is in-between the function name and modifier name (if present)
     # regex: 'public' could have spaces around or be at the end of the line

slither/formatters/naming_convention/naming_convention.py

@@ -201,8 +201,9 @@ conventions = {
 
 
 def _get_from_contract(compilation_unit: SlitherCompilationUnit, element, name, getter):
+    scope = compilation_unit.get_scope(element["source_mapping"]["filename_absolute"])
     contract_name = element["type_specific_fields"]["parent"]["name"]
-    contract = compilation_unit.get_contract_from_name(contract_name)
+    contract = scope.get_contract_from_name(contract_name)
     return getattr(contract, getter)(name)
 
 
@@ -215,8 +216,10 @@ def _get_from_contract(compilation_unit: SlitherCompilationUnit, element, name,
 
 
 def _patch(compilation_unit: SlitherCompilationUnit, result, element, _target):
+    scope = compilation_unit.get_scope(element["source_mapping"]["filename_absolute"])
+
     if _target == "contract":
-        target = compilation_unit.get_contract_from_name(element["name"])
+        target = scope.get_contract_from_name(element["name"])
 
     elif _target == "structure":
         target = _get_from_contract(
@@ -250,7 +253,7 @@ def _patch(compilation_unit: SlitherCompilationUnit, result, element, _target):
             "signature"
         ]
         param_name = element["name"]
-        contract = compilation_unit.get_contract_from_name(contract_name)
+        contract = scope.get_contract_from_name(contract_name)
         function = contract.get_function_from_signature(function_sig)
         target = function.get_local_variable_from_name(param_name)
 
@@ -264,7 +267,7 @@ def _patch(compilation_unit: SlitherCompilationUnit, result, element, _target):
                 "signature"
             ]
             var_name = element["name"]
-            contract = compilation_unit.get_contract_from_name(contract_name)
+            contract = scope.get_contract_from_name(contract_name)
             function = contract.get_function_from_signature(function_sig)
             target = function.get_local_variable_from_name(var_name)
         # State variable

slither/formatters/variables/possible_const_state_variables.py

@@ -11,7 +11,8 @@ def custom_format(compilation_unit: SlitherCompilationUnit, result):
 
         # TODO: decide if this should be changed in the constant detector
         contract_name = element["type_specific_fields"]["parent"]["name"]
-        contract = compilation_unit.get_contract_from_name(contract_name)
+        scope = compilation_unit.get_scope(element["source_mapping"]["filename_absolute"])
+        contract = scope.get_contract_from_name(contract_name)
         var = contract.get_state_variable_from_name(element["name"])
         if not var.expression:
             raise FormatImpossible(f"{var.name} is uninitialized and cannot become constant.")

slither/slither.py

@@ -1,10 +1,11 @@
 import logging
-from typing import Union, List
+from typing import Union, List, ValuesView
 
 from crytic_compile import CryticCompile, InvalidCompilation
 
 # pylint: disable= no-name-in-module
 from slither.core.compilation_unit import SlitherCompilationUnit
+from slither.core.scope.scope import FileScope
 from slither.core.slither_core import SlitherCore
 from slither.detectors.abstract_detector import AbstractDetector, DetectorClassification
 from slither.exceptions import SlitherError
@@ -31,6 +32,21 @@ def _check_common_things(thing_name, cls, base_cls, instances_list):
         raise Exception("You can't register {!r} twice.".format(cls))
 
 
+def _update_file_scopes(candidates: ValuesView[FileScope]):
+    """
+    Because solc's import allows cycle in the import
+    We iterate until we aren't adding new information to the scope
+
+    """
+    learned_something = False
+    while True:
+        for candidate in candidates:
+            learned_something |= candidate.add_accesible_scopes()
+        if not learned_something:
+            break
+        learned_something = False
+
+
 class Slither(SlitherCore):  # pylint: disable=too-many-instance-attributes
     def __init__(self, target: Union[str, CryticCompile], **kwargs):
         """
@@ -81,6 +97,8 @@ class Slither(SlitherCore):  # pylint: disable=too-many-instance-attributes
                 parser.parse_top_level_from_loaded_json(ast, path)
                 self.add_source_code(path)
 
+            _update_file_scopes(compilation_unit_slither.scopes.values())
+
         if kwargs.get("generate_patches", False):
             self.generate_patches = True
 

slither/slithir/convert.py

@@ -527,7 +527,7 @@ def propagate_types(ir, node: "Node"):  # pylint: disable=too-many-locals
                     # UserdefinedType
                     t_type = t.type
                     if isinstance(t_type, Contract):
-                        contract = node.compilation_unit.get_contract_from_name(t_type.name)
+                        contract = node.file_scope.get_contract_from_name(t_type.name)
                         return convert_type_of_high_and_internal_level_call(ir, contract)
 
                 # Convert HighLevelCall to LowLevelCall
@@ -729,7 +729,7 @@ def propagate_types(ir, node: "Node"):  # pylint: disable=too-many-locals
             elif isinstance(ir, NewArray):
                 ir.lvalue.set_type(ir.array_type)
             elif isinstance(ir, NewContract):
-                contract = node.compilation_unit.get_contract_from_name(ir.contract_name)
+                contract = node.file_scope.get_contract_from_name(ir.contract_name)
                 ir.lvalue.set_type(UserDefinedType(contract))
             elif isinstance(ir, NewElementaryType):
                 ir.lvalue.set_type(ir.type)
@@ -1287,7 +1287,7 @@ def convert_to_pop(ir, node):
 
 def look_for_library(contract, ir, using_for, t):
     for destination in using_for[t]:
-        lib_contract = contract.compilation_unit.get_contract_from_name(str(destination))
+        lib_contract = contract.file_scope.get_contract_from_name(str(destination))
         if lib_contract:
             lib_call = LibraryCall(
                 lib_contract,
@@ -1434,7 +1434,7 @@ def _convert_to_structure_to_list(return_type: Type) -> List[Type]:
 def convert_type_of_high_and_internal_level_call(ir: Operation, contract: Optional[Contract]):
     func = None
     if isinstance(ir, InternalCall):
-
+        candidates: List[Function]
         if ir.function_candidates:
             # This path is taken only for SolidityImportPlaceHolder
             # Here we have already done a filtering on the potential targets
@@ -1447,6 +1447,12 @@ def convert_type_of_high_and_internal_level_call(ir: Operation, contract: Option
                 and f.contract_declarer.name == ir.contract_name
                 and len(f.parameters) == len(ir.arguments)
             ]
+
+            for import_statement in contract.file_scope.imports:
+                if import_statement.alias and import_statement.alias == ir.contract_name:
+                    imported_scope = contract.compilation_unit.get_scope(import_statement.filename)
+                    candidates += list(imported_scope.functions)
+
         func = _find_function_from_parameter(ir, candidates)
 
         if not func:

slither/slithir/operations/new_contract.py

@@ -50,7 +50,7 @@ class NewContract(Call, OperationWithLValue):  # pylint: disable=too-many-instan
     @property
     def contract_created(self):
         contract_name = self.contract_name
-        contract_instance = self.compilation_unit.get_contract_from_name(contract_name)
+        contract_instance = self.node.file_scope.get_contract_from_name(contract_name)
         return contract_instance
 
     ###################################################################################

slither/solc_parsing/declarations/caller_context.py

@@ -0,0 +1,35 @@
+import abc
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from slither.core.compilation_unit import SlitherCompilationUnit
+    from slither.solc_parsing.slither_compilation_unit_solc import SlitherCompilationUnitSolc
+
+
+class CallerContextExpression(metaclass=abc.ABCMeta):
+    """
+    This class is inherited by all the declarations class that can be used in the expression/type parsing
+    As a source of context/scope
+
+    It is used by any declaration class that can be top-level and require complex parsing
+
+    """
+
+    @property
+    @abc.abstractmethod
+    def is_compact_ast(self) -> bool:
+        pass
+
+    @property
+    @abc.abstractmethod
+    def compilation_unit(self) -> "SlitherCompilationUnit":
+        pass
+
+    @abc.abstractmethod
+    def get_key(self) -> str:
+        pass
+
+    @property
+    @abc.abstractmethod
+    def slither_parser(self) -> "SlitherCompilationUnitSolc":
+        pass

slither/solc_parsing/declarations/contract.py

@@ -6,6 +6,7 @@ from slither.core.declarations.contract import Contract
 from slither.core.declarations.custom_error_contract import CustomErrorContract
 from slither.core.declarations.function_contract import FunctionContract
 from slither.core.variables.state_variable import StateVariable
+from slither.solc_parsing.declarations.caller_context import CallerContextExpression
 from slither.solc_parsing.declarations.custom_error import CustomErrorSolc
 from slither.solc_parsing.declarations.event import EventSolc
 from slither.solc_parsing.declarations.function import FunctionSolc
@@ -25,7 +26,7 @@ if TYPE_CHECKING:
 # pylint: disable=too-many-instance-attributes,import-outside-toplevel,too-many-nested-blocks,too-many-public-methods
 
 
-class ContractSolc:
+class ContractSolc(CallerContextExpression):
     def __init__(self, slither_parser: "SlitherCompilationUnitSolc", contract: Contract, data):
         # assert slitherSolc.solc_version.startswith('0.4')
 
@@ -258,7 +259,7 @@ class ContractSolc:
 
     def _parse_struct(self, struct: Dict):
 
-        st = StructureContract()
+        st = StructureContract(self._contract.compilation_unit)
         st.set_contract(self._contract)
         st.set_offset(struct["src"], self._contract.compilation_unit)
 
@@ -423,7 +424,7 @@ class ContractSolc:
         Cls: Callable,
         Cls_parser: Callable,
         element_parser: FunctionSolc,
-        explored_reference_id: Set[int],
+        explored_reference_id: Set[str],
         parser: List[FunctionSolc],
         all_elements: Dict[str, Function],
     ):
@@ -442,13 +443,13 @@ class ContractSolc:
             elem, element_parser.function_not_parsed, self, self.slither_parser
         )
         if (
-            element_parser.referenced_declaration
+            element_parser.underlying_function.id
-            and element_parser.referenced_declaration in explored_reference_id
+            and element_parser.underlying_function.id in explored_reference_id
         ):
             # Already added from other fathers
             return
-        if element_parser.referenced_declaration:
+        if element_parser.underlying_function.id:
-            explored_reference_id.add(element_parser.referenced_declaration)
+            explored_reference_id.add(element_parser.underlying_function.id)
         elem_parser.analyze_params()
         if isinstance(elem, Modifier):
             self._contract.compilation_unit.add_modifier(elem)

slither/solc_parsing/declarations/custom_error.py

@@ -1,18 +1,22 @@
 from typing import TYPE_CHECKING, Dict
 
 from slither.core.declarations.custom_error import CustomError
+from slither.core.declarations.custom_error_contract import CustomErrorContract
+from slither.core.declarations.custom_error_top_level import CustomErrorTopLevel
 from slither.core.variables.local_variable import LocalVariable
+from slither.solc_parsing.declarations.caller_context import CallerContextExpression
 from slither.solc_parsing.variables.local_variable import LocalVariableSolc
 
 if TYPE_CHECKING:
     from slither.solc_parsing.slither_compilation_unit_solc import SlitherCompilationUnitSolc
+    from slither.core.compilation_unit import SlitherCompilationUnit
 
 
 # Part of the code was copied from the function parsing
 # In the long term we should refactor these two classes to merge the duplicated code
 
 
-class CustomErrorSolc:
+class CustomErrorSolc(CallerContextExpression):
     def __init__(
         self,
         custom_error: CustomError,
@@ -84,6 +88,10 @@ class CustomErrorSolc:
 
         local_var_parser = LocalVariableSolc(local_var, param)
 
+        if isinstance(self._custom_error, CustomErrorTopLevel):
+            local_var_parser.analyze(self)
+        else:
+            assert isinstance(self._custom_error, CustomErrorContract)
             local_var_parser.analyze(self)
 
         # see https://solidity.readthedocs.io/en/v0.4.24/types.html?highlight=storage%20location#data-location
@@ -99,3 +107,7 @@ class CustomErrorSolc:
     @property
     def slither_parser(self) -> "SlitherCompilationUnitSolc":
         return self._slither_parser
+
+    @property
+    def compilation_unit(self) -> "SlitherCompilationUnit":
+        return self._custom_error.compilation_unit

slither/solc_parsing/declarations/function.py

@@ -14,6 +14,7 @@ from slither.core.expressions import AssignmentOperation
 from slither.core.variables.local_variable import LocalVariable
 from slither.core.variables.local_variable_init_from_tuple import LocalVariableInitFromTuple
 from slither.solc_parsing.cfg.node import NodeSolc
+from slither.solc_parsing.declarations.caller_context import CallerContextExpression
 from slither.solc_parsing.exceptions import ParsingError
 from slither.solc_parsing.expressions.expression_parsing import parse_expression
 from slither.solc_parsing.variables.local_variable import LocalVariableSolc
@@ -43,7 +44,7 @@ def link_underlying_nodes(node1: NodeSolc, node2: NodeSolc):
 # pylint: disable=too-many-lines,too-many-branches,too-many-locals,too-many-statements,too-many-instance-attributes
 
 
-class FunctionSolc:
+class FunctionSolc(CallerContextExpression):
 
     # elems = [(type, name)]
 
@@ -59,11 +60,9 @@ class FunctionSolc:
         self._function = function
 
         # Only present if compact AST
-        self._referenced_declaration: Optional[int] = None
         if self.is_compact_ast:
             self._function.name = function_data["name"]
             if "id" in function_data:
-                self._referenced_declaration = function_data["id"]
                 self._function.id = function_data["id"]
         else:
             self._function.name = function_data["attributes"][self.get_key()]
@@ -125,13 +124,6 @@ class FunctionSolc:
     def is_compact_ast(self):
         return self._slither_parser.is_compact_ast
 
-    @property
-    def referenced_declaration(self) -> Optional[str]:
-        """
-        Return the compact AST referenced declaration id (None for legacy AST)
-        """
-        return self._referenced_declaration
-
     # endregion
     ###################################################################################
     ###################################################################################

slither/solc_parsing/declarations/structure_top_level.py

@@ -3,15 +3,17 @@
 """
 from typing import TYPE_CHECKING, Dict
 
-from slither.core.declarations.structure import Structure
+from slither.core.compilation_unit import SlitherCompilationUnit
+from slither.core.declarations.structure_top_level import StructureTopLevel
 from slither.core.variables.structure_variable import StructureVariable
+from slither.solc_parsing.declarations.caller_context import CallerContextExpression
 from slither.solc_parsing.variables.structure_variable import StructureVariableSolc
 
 if TYPE_CHECKING:
     from slither.solc_parsing.slither_compilation_unit_solc import SlitherCompilationUnitSolc
 
 
-class StructureTopLevelSolc:  # pylint: disable=too-few-public-methods
+class StructureTopLevelSolc(CallerContextExpression):  # pylint: disable=too-few-public-methods
     """
     Structure class
     """
@@ -20,7 +22,7 @@ class StructureTopLevelSolc:  # pylint: disable=too-few-public-methods
 
     def __init__(  # pylint: disable=too-many-arguments
         self,
-        st: Structure,
+        st: StructureTopLevel,
         struct: Dict,
         slither_parser: "SlitherCompilationUnitSolc",
     ):
@@ -52,8 +54,27 @@ class StructureTopLevelSolc:  # pylint: disable=too-few-public-methods
             elem.set_offset(elem_to_parse["src"], self._slither_parser.compilation_unit)
 
             elem_parser = StructureVariableSolc(elem, elem_to_parse)
-            elem_parser.analyze(self._slither_parser)
+            elem_parser.analyze(self)
 
             self._structure.elems[elem.name] = elem
             self._structure.add_elem_in_order(elem.name)
         self._elemsNotParsed = []
+
+    @property
+    def is_compact_ast(self) -> bool:
+        return self._slither_parser.is_compact_ast
+
+    @property
+    def compilation_unit(self) -> SlitherCompilationUnit:
+        return self._slither_parser.compilation_unit
+
+    def get_key(self) -> str:
+        return self._slither_parser.get_key()
+
+    @property
+    def slither_parser(self) -> "SlitherCompilationUnitSolc":
+        return self._slither_parser
+
+    @property
+    def underlying_structure(self) -> StructureTopLevel:
+        return self._structure

slither/solc_parsing/expressions/expression_parsing.py

@@ -33,8 +33,9 @@ from slither.core.solidity_types import (
     ArrayType,
     ElementaryType,
 )
+from slither.solc_parsing.declarations.caller_context import CallerContextExpression
 from slither.solc_parsing.exceptions import ParsingError, VariableNotFound
-from slither.solc_parsing.expressions.find_variable import CallerContext, find_variable
+from slither.solc_parsing.expressions.find_variable import find_variable
 from slither.solc_parsing.solidity_types.type_parsing import UnknownType, parse_type
 
 if TYPE_CHECKING:
@@ -196,7 +197,7 @@ def parse_super_name(expression: Dict, is_compact_ast: bool) -> str:
 
 
 def _parse_elementary_type_name_expression(
-    expression: Dict, is_compact_ast: bool, caller_context
+    expression: Dict, is_compact_ast: bool, caller_context: CallerContextExpression
 ) -> ElementaryTypeNameExpression:
     # nop exression
     # uint;
@@ -216,7 +217,12 @@ def _parse_elementary_type_name_expression(
     return e
 
 
-def parse_expression(expression: Dict, caller_context: CallerContext) -> "Expression":
+if TYPE_CHECKING:
+
+    from slither.core.scope.scope import FileScope
+
+
+def parse_expression(expression: Dict, caller_context: CallerContextExpression) -> "Expression":
     # pylint: disable=too-many-nested-blocks,too-many-statements
     """
 
@@ -246,6 +252,7 @@ def parse_expression(expression: Dict, caller_context: CallerContext) -> "Expres
     #    | Expression ('=' | '|=' | '^=' | '&=' | '<<=' | '>>=' | '+=' | '-=' | '*=' | '/=' | '%=') Expression
     #    | PrimaryExpression
     # The AST naming does not follow the spec
+    assert isinstance(caller_context, CallerContextExpression)
     name = expression[caller_context.get_key()]
     is_compact_ast = caller_context.is_compact_ast
     src = expression["src"]

slither/solc_parsing/expressions/find_variable.py

@@ -13,6 +13,7 @@ from slither.core.declarations.solidity_variables import (
     SolidityFunction,
     SolidityVariable,
 )
+from slither.core.scope.scope import FileScope
 from slither.core.solidity_types import (
     ArrayType,
     FunctionType,
@@ -20,18 +21,17 @@ from slither.core.solidity_types import (
 )
 from slither.core.variables.variable import Variable
 from slither.exceptions import SlitherError
+from slither.solc_parsing.declarations.caller_context import CallerContextExpression
 from slither.solc_parsing.exceptions import VariableNotFound
 
 if TYPE_CHECKING:
     from slither.solc_parsing.declarations.function import FunctionSolc
     from slither.solc_parsing.declarations.contract import ContractSolc
-    from slither.solc_parsing.slither_compilation_unit_solc import SlitherCompilationUnitSolc
-    from slither.core.compilation_unit import SlitherCompilationUnit
 
 # pylint: disable=import-outside-toplevel,too-many-branches,too-many-locals
 
 
-CallerContext = Union["ContractSolc", "FunctionSolc"]
+# CallerContext =Union["ContractSolc", "FunctionSolc", "CustomErrorSolc", "StructureTopLevelSolc"]
 
 
 def _get_pointer_name(variable: Variable):
@@ -51,7 +51,7 @@ def _get_pointer_name(variable: Variable):
 def _find_variable_from_ref_declaration(
     referenced_declaration: Optional[int],
     all_contracts: List["Contract"],
-    all_functions_parser: List["FunctionSolc"],
+    all_functions: List["Function"],
 ) -> Optional[Union[Contract, Function]]:
     if referenced_declaration is None:
         return None
@@ -59,14 +59,11 @@ def _find_variable_from_ref_declaration(
     # This is not true for the functions, as we dont always have the referenced_declaration
     # But maybe we could? (TODO)
     for contract_candidate in all_contracts:
-        if contract_candidate.id == referenced_declaration:
+        if contract_candidate and contract_candidate.id == referenced_declaration:
             return contract_candidate
-    for function_candidate in all_functions_parser:
+    for function_candidate in all_functions:
-        if (
+        if function_candidate.id == referenced_declaration and not function_candidate.is_shadowed:
-            function_candidate.referenced_declaration == referenced_declaration
+            return function_candidate
-            and not function_candidate.underlying_function.is_shadowed
-        ):
-            return function_candidate.underlying_function
     return None
 
 
@@ -100,7 +97,7 @@ def _find_variable_in_function_parser(
 
 
 def _find_top_level(
-    var_name: str, sl: "SlitherCompilationUnit"
+    var_name: str, scope: "FileScope"
 ) -> Tuple[Optional[Union[Enum, Structure, SolidityImportPlaceHolder, CustomError]], bool]:
     """
     Return the top level variable use, and a boolean indicating if the variable returning was cretead
@@ -113,23 +110,19 @@ def _find_top_level(
     :return:
     :rtype:
     """
-    structures_top_level = sl.structures_top_level
-    for st in structures_top_level:
-        if st.name == var_name:
-            return st, False
 
-    enums_top_level = sl.enums_top_level
+    if var_name in scope.structures:
-    for enum in enums_top_level:
+        return scope.structures[var_name], False
-        if enum.name == var_name:
-            return enum, False
 
-    for import_directive in sl.import_directives:
+    if var_name in scope.enums:
+        return scope.enums[var_name], False
+
+    for import_directive in scope.imports:
         if import_directive.alias == var_name:
             new_val = SolidityImportPlaceHolder(import_directive)
             return new_val, True
 
-    # Note for now solidity prevent two custom error from having the same name
+    for custom_error in scope.custom_errors:
-    for custom_error in sl.custom_errors:
         if custom_error.solidity_signature == var_name:
             return custom_error, False
 
@@ -142,7 +135,6 @@ def _find_in_contract(
     contract_declarer: Optional[Contract],
     is_super: bool,
 ) -> Optional[Union[Variable, Function, Contract, Event, Enum, Structure, CustomError]]:
-
     if contract is None or contract_declarer is None:
         return None
 
@@ -214,56 +206,57 @@ def _find_in_contract(
 
 
 def _find_variable_init(
-    caller_context: CallerContext,
+    caller_context: CallerContextExpression,
-) -> Tuple[
+) -> Tuple[List[Contract], List["Function"], FileScope,]:
-    List[Contract],
-    Union[List["FunctionSolc"]],
-    "SlitherCompilationUnit",
-    "SlitherCompilationUnitSolc",
-]:
-    from slither.solc_parsing.slither_compilation_unit_solc import SlitherCompilationUnitSolc
     from slither.solc_parsing.declarations.contract import ContractSolc
     from slither.solc_parsing.declarations.function import FunctionSolc
 
     direct_contracts: List[Contract]
-    direct_functions_parser: List[FunctionSolc]
+    direct_functions_parser: List[Function]
+    scope: FileScope
 
-    if isinstance(caller_context, SlitherCompilationUnitSolc):
+    if isinstance(caller_context, FileScope):
         direct_contracts = []
         direct_functions_parser = []
-        sl = caller_context.compilation_unit
+        scope = caller_context
-        sl_parser = caller_context
     elif isinstance(caller_context, ContractSolc):
         direct_contracts = [caller_context.underlying_contract]
-        direct_functions_parser = caller_context.functions_parser + caller_context.modifiers_parser
+        direct_functions_parser = [
-        sl = caller_context.slither_parser.compilation_unit
+            f.underlying_function
-        sl_parser = caller_context.slither_parser
+            for f in caller_context.functions_parser + caller_context.modifiers_parser
+        ]
+        scope = caller_context.underlying_contract.file_scope
     elif isinstance(caller_context, FunctionSolc):
         if caller_context.contract_parser:
             direct_contracts = [caller_context.contract_parser.underlying_contract]
-            direct_functions_parser = (
+            direct_functions_parser = [
-                caller_context.contract_parser.functions_parser
+                f.underlying_function
+                for f in caller_context.contract_parser.functions_parser
                 + caller_context.contract_parser.modifiers_parser
-            )
+            ]
         else:
             # Top level functions
             direct_contracts = []
             direct_functions_parser = []
-        sl = caller_context.underlying_function.compilation_unit
+        underlying_function = caller_context.underlying_function
-        sl_parser = caller_context.slither_parser
+        if isinstance(underlying_function, FunctionTopLevel):
+            scope = underlying_function.file_scope
+        else:
+            assert isinstance(underlying_function, FunctionContract)
+            scope = underlying_function.contract.file_scope
     else:
         raise SlitherError(
             f"{type(caller_context)} ({caller_context} is not valid for find_variable"
         )
 
-    return direct_contracts, direct_functions_parser, sl, sl_parser
+    return direct_contracts, direct_functions_parser, scope
 
 
 def find_variable(
     var_name: str,
-    caller_context: CallerContext,
+    caller_context: CallerContextExpression,
     referenced_declaration: Optional[int] = None,
-    is_super=False,
+    is_super: bool = False,
 ) -> Tuple[
     Union[
         Variable,
@@ -311,28 +304,25 @@ def find_variable(
     # for events it's unclear what should be the behavior, as they can be shadowed, but there is not impact
     # structure/enums cannot be shadowed
 
-    direct_contracts, direct_functions_parser, sl, sl_parser = _find_variable_init(caller_context)
+    direct_contracts, direct_functions, current_scope = _find_variable_init(caller_context)
-
-    all_contracts = sl.contracts
-    all_functions_parser = sl_parser.all_functions_and_modifiers_parser
-
     # Only look for reference declaration in the direct contract, see comment at the end
     # Reference looked are split between direct and all
     # Because functions are copied between contracts, two functions can have the same ref
     # So we need to first look with respect to the direct context
 
-    ret = _find_variable_from_ref_declaration(
+    # Use ret0/ret1 to help mypy
-        referenced_declaration, direct_contracts, direct_functions_parser
+    ret0 = _find_variable_from_ref_declaration(
+        referenced_declaration, direct_contracts, direct_functions
     )
-    if ret:
+    if ret0:
-        return ret, False
+        return ret0, False
 
     function_parser: Optional[FunctionSolc] = (
         caller_context if isinstance(caller_context, FunctionSolc) else None
     )
-    ret = _find_variable_in_function_parser(var_name, function_parser, referenced_declaration)
+    ret1 = _find_variable_in_function_parser(var_name, function_parser, referenced_declaration)
-    if ret:
+    if ret1:
-        return ret, False
+        return ret1, False
 
     contract: Optional[Contract] = None
     contract_declarer: Optional[Contract] = None
@@ -352,12 +342,12 @@ def find_variable(
         return ret, False
 
     # Could refer to any enum
-    all_enumss = [c.enums_as_dict for c in sl.contracts]
+    all_enumss = [c.enums_as_dict for c in current_scope.contracts.values()]
     all_enums = {k: v for d in all_enumss for k, v in d.items()}
     if var_name in all_enums:
         return all_enums[var_name], False
 
-    contracts = sl.contracts_as_dict
+    contracts = current_scope.contracts
     if var_name in contracts:
         return contracts[var_name], False
 
@@ -368,7 +358,7 @@ def find_variable(
         return SolidityFunction(var_name), False
 
     # Top level must be at the end, if nothing else was found
-    ret, var_was_created = _find_top_level(var_name, sl)
+    ret, var_was_created = _find_top_level(var_name, current_scope)
     if ret:
         return ret, var_was_created
 
@@ -394,7 +384,9 @@ def find_variable(
     # get's AST will say that the ref declaration for _f() is A._f(), but in the context of B, its not
 
     ret = _find_variable_from_ref_declaration(
-        referenced_declaration, all_contracts, all_functions_parser
+        referenced_declaration,
+        list(current_scope.contracts.values()),
+        list(current_scope.functions),
     )
     if ret:
         return ret, False

slither/solc_parsing/slither_compilation_unit_solc.py

@@ -120,7 +120,7 @@ class SlitherCompilationUnitSolc:
                 return True
             return False
 
-    def _parse_enum(self, top_level_data: Dict):
+    def _parse_enum(self, top_level_data: Dict, filename: str):
         if self.is_compact_ast:
             name = top_level_data["name"]
             canonicalName = top_level_data["canonicalName"]
@@ -143,7 +143,9 @@ class SlitherCompilationUnitSolc:
             else:
                 values.append(child["attributes"][self.get_key()])
 
-        enum = EnumTopLevel(name, canonicalName, values)
+        scope = self.compilation_unit.get_scope(filename)
+        enum = EnumTopLevel(name, canonicalName, values, scope)
+        scope.enums[name] = enum
         enum.set_offset(top_level_data["src"], self._compilation_unit)
         self._compilation_unit.enums_top_level.append(enum)
 
@@ -169,10 +171,13 @@ class SlitherCompilationUnitSolc:
 
         if self.get_children() not in data_loaded:
             return
+        scope = self.compilation_unit.get_scope(filename)
+
         for top_level_data in data_loaded[self.get_children()]:
             if top_level_data[self.get_key()] == "ContractDefinition":
-                contract = Contract(self._compilation_unit)
+                contract = Contract(self._compilation_unit, scope)
                 contract_parser = ContractSolc(self, contract, top_level_data)
+                scope.contracts[contract.name] = contract
                 if "src" in top_level_data:
                     contract.set_offset(top_level_data["src"], self._compilation_unit)
 
@@ -180,29 +185,33 @@ class SlitherCompilationUnitSolc:
 
             elif top_level_data[self.get_key()] == "PragmaDirective":
                 if self._is_compact_ast:
-                    pragma = Pragma(top_level_data["literals"])
+                    pragma = Pragma(top_level_data["literals"], scope)
+                    scope.pragmas.add(pragma)
                 else:
-                    pragma = Pragma(top_level_data["attributes"]["literals"])
+                    pragma = Pragma(top_level_data["attributes"]["literals"], scope)
+                    scope.pragmas.add(pragma)
                 pragma.set_offset(top_level_data["src"], self._compilation_unit)
                 self._compilation_unit.pragma_directives.append(pragma)
             elif top_level_data[self.get_key()] == "ImportDirective":
                 if self.is_compact_ast:
                     import_directive = Import(
                         Path(
-                            self._compilation_unit.crytic_compile.working_dir,
                             top_level_data["absolutePath"],
+                        ),
+                        scope,
                     )
-                    )
+                    scope.imports.add(import_directive)
                     # TODO investigate unitAlias in version < 0.7 and legacy ast
                     if "unitAlias" in top_level_data:
                         import_directive.alias = top_level_data["unitAlias"]
                 else:
                     import_directive = Import(
                         Path(
-                            self._compilation_unit.crytic_compile.working_dir,
                             top_level_data["attributes"].get("absolutePath", ""),
+                        ),
+                        scope,
                     )
-                    )
+                    scope.imports.add(import_directive)
                     # TODO investigate unitAlias in version < 0.7 and legacy ast
                     if (
                         "attributes" in top_level_data
@@ -212,17 +221,22 @@ class SlitherCompilationUnitSolc:
                 import_directive.set_offset(top_level_data["src"], self._compilation_unit)
                 self._compilation_unit.import_directives.append(import_directive)
 
+                get_imported_scope = self.compilation_unit.get_scope(import_directive.filename)
+                scope.accessible_scopes.append(get_imported_scope)
+
             elif top_level_data[self.get_key()] == "StructDefinition":
-                st = StructureTopLevel()
+                scope = self.compilation_unit.get_scope(filename)
+                st = StructureTopLevel(self.compilation_unit, scope)
                 st.set_offset(top_level_data["src"], self._compilation_unit)
                 st_parser = StructureTopLevelSolc(st, top_level_data, self)
+                scope.structures[st.name] = st
 
                 self._compilation_unit.structures_top_level.append(st)
                 self._structures_top_level_parser.append(st_parser)
 
             elif top_level_data[self.get_key()] == "EnumDefinition":
                 # Note enum don't need a complex parser, so everything is directly done
-                self._parse_enum(top_level_data)
+                self._parse_enum(top_level_data, filename)
 
             elif top_level_data[self.get_key()] == "VariableDeclaration":
                 var = TopLevelVariable()
@@ -232,7 +246,9 @@ class SlitherCompilationUnitSolc:
                 self._compilation_unit.variables_top_level.append(var)
                 self._variables_top_level_parser.append(var_parser)
             elif top_level_data[self.get_key()] == "FunctionDefinition":
-                func = FunctionTopLevel(self._compilation_unit)
+                scope = self.compilation_unit.get_scope(filename)
+                func = FunctionTopLevel(self._compilation_unit, scope)
+                scope.functions.add(func)
                 func.set_offset(top_level_data["src"], self._compilation_unit)
                 func_parser = FunctionSolc(func, top_level_data, None, self)
 
@@ -241,10 +257,12 @@ class SlitherCompilationUnitSolc:
                 self.add_function_or_modifier_parser(func_parser)
 
             elif top_level_data[self.get_key()] == "ErrorDefinition":
-                custom_error = CustomErrorTopLevel(self._compilation_unit)
+                scope = self.compilation_unit.get_scope(filename)
+                custom_error = CustomErrorTopLevel(self._compilation_unit, scope)
                 custom_error.set_offset(top_level_data["src"], self._compilation_unit)
 
                 custom_error_parser = CustomErrorSolc(custom_error, top_level_data, self)
+                scope.custom_errors.add(custom_error)
                 self._compilation_unit.custom_errors.append(custom_error)
                 self._custom_error_parser.append(custom_error_parser)
 
@@ -322,17 +340,8 @@ class SlitherCompilationUnitSolc:
 Please rename it, this name is reserved for Slither's internals"""
                     # endregion multi-line
                 )
-            if contract.name in self._compilation_unit.contracts_as_dict:
-                if contract.id != self._compilation_unit.contracts_as_dict[contract.name].id:
-                    self._compilation_unit.contract_name_collisions[contract.name].append(
-                        contract.source_mapping_str
-                    )
-                    self._compilation_unit.contract_name_collisions[contract.name].append(
-                        self._compilation_unit.contracts_as_dict[contract.name].source_mapping_str
-                    )
-            else:
             self._contracts_by_id[contract.id] = contract
-                self._compilation_unit.contracts_as_dict[contract.name] = contract
+            self._compilation_unit.contracts.append(contract)
 
         # Update of the inheritance
         for contract_parser in self._underlying_contract_to_parser.values():
@@ -347,7 +356,10 @@ Please rename it, this name is reserved for Slither's internals"""
             for i in contract_parser.linearized_base_contracts[1:]:
                 if i in contract_parser.remapping:
                     ancestors.append(
-                        self._compilation_unit.get_contract_from_name(contract_parser.remapping[i])
+                        contract_parser.underlying_contract.file_scope.get_contract_from_name(
+                            contract_parser.remapping[i]
+                        )
+                        # self._compilation_unit.get_contract_from_name(contract_parser.remapping[i])
                     )
                 elif i in self._contracts_by_id:
                     ancestors.append(self._contracts_by_id[i])
@@ -358,7 +370,10 @@ Please rename it, this name is reserved for Slither's internals"""
             for i in contract_parser.baseContracts:
                 if i in contract_parser.remapping:
                     fathers.append(
-                        self._compilation_unit.get_contract_from_name(contract_parser.remapping[i])
+                        contract_parser.underlying_contract.file_scope.get_contract_from_name(
+                            contract_parser.remapping[i]
+                        )
+                        # self._compilation_unit.get_contract_from_name(contract_parser.remapping[i])
                     )
                 elif i in self._contracts_by_id:
                     fathers.append(self._contracts_by_id[i])
@@ -369,7 +384,10 @@ Please rename it, this name is reserved for Slither's internals"""
             for i in contract_parser.baseConstructorContractsCalled:
                 if i in contract_parser.remapping:
                     father_constructors.append(
-                        self._compilation_unit.get_contract_from_name(contract_parser.remapping[i])
+                        contract_parser.underlying_contract.file_scope.get_contract_from_name(
+                            contract_parser.remapping[i]
+                        )
+                        # self._compilation_unit.get_contract_from_name(contract_parser.remapping[i])
                     )
                 elif i in self._contracts_by_id:
                     father_constructors.append(self._contracts_by_id[i])

slither/solc_parsing/solidity_types/type_parsing.py

@@ -1,7 +1,9 @@
 import logging
 import re
-from typing import List, TYPE_CHECKING, Union, Dict
+from typing import List, TYPE_CHECKING, Union, Dict, ValuesView
 
+from slither.core.declarations.custom_error_contract import CustomErrorContract
+from slither.core.declarations.custom_error_top_level import CustomErrorTopLevel
 from slither.core.declarations.function_contract import FunctionContract
 from slither.core.expressions.literal import Literal
 from slither.core.solidity_types.array_type import ArrayType
@@ -16,11 +18,13 @@ from slither.core.solidity_types.user_defined_type import UserDefinedType
 from slither.core.variables.function_type_variable import FunctionTypeVariable
 from slither.exceptions import SlitherError
 from slither.solc_parsing.exceptions import ParsingError
+from slither.solc_parsing.expressions.expression_parsing import CallerContextExpression
 
 if TYPE_CHECKING:
     from slither.core.declarations import Structure, Enum
     from slither.core.declarations.contract import Contract
     from slither.core.compilation_unit import SlitherCompilationUnit
+    from slither.solc_parsing.slither_compilation_unit_solc import SlitherCompilationUnitSolc
 
 logger = logging.getLogger("TypeParsing")
 
@@ -41,9 +45,9 @@ def _find_from_type_name(  # pylint: disable=too-many-locals,too-many-branches,t
     functions_direct_access: List["Function"],
     contracts_direct_access: List["Contract"],
     structures_direct_access: List["Structure"],
-    all_structures: List["Structure"],
+    all_structures: ValuesView["Structure"],
     enums_direct_access: List["Enum"],
-    all_enums: List["Enum"],
+    all_enums: ValuesView["Enum"],
 ) -> Type:
     name_elementary = name.split(" ")[0]
     if "[" in name_elementary:
@@ -190,12 +194,22 @@ def _find_from_type_name(  # pylint: disable=too-many-locals,too-many-branches,t
     return UserDefinedType(var_type)
 
 
+# TODO: since the add of FileScope, we can probably refactor this function and makes it a lot simpler
 def parse_type(
     t: Union[Dict, UnknownType],
-    caller_context: Union[
+    caller_context: Union[CallerContextExpression, "SlitherCompilationUnitSolc"],
-        "SlitherCompilationUnitSolc", "FunctionSolc", "ContractSolc", "CustomSolc"
-    ],
 ):
+    """
+    caller_context can be a SlitherCompilationUnitSolc because we recursively call the function
+    and go up in the context's scope. If we are really lost we just go over the SlitherCompilationUnitSolc
+
+    :param t:
+    :type t:
+    :param caller_context:
+    :type caller_context:
+    :return:
+    :rtype:
+    """
     # local import to avoid circular dependency
     # pylint: disable=too-many-locals,too-many-branches,too-many-statements
     # pylint: disable=import-outside-toplevel
@@ -204,21 +218,19 @@ def parse_type(
     from slither.solc_parsing.declarations.contract import ContractSolc
     from slither.solc_parsing.declarations.function import FunctionSolc
     from slither.solc_parsing.declarations.custom_error import CustomErrorSolc
+    from slither.solc_parsing.declarations.structure_top_level import StructureTopLevelSolc
     from slither.solc_parsing.slither_compilation_unit_solc import SlitherCompilationUnitSolc
 
     sl: "SlitherCompilationUnit"
     # Note: for convenicence top level functions use the same parser than function in contract
     # but contract_parser is set to None
-    if isinstance(caller_context, (SlitherCompilationUnitSolc, CustomErrorSolc)) or (
+    if isinstance(caller_context, SlitherCompilationUnitSolc) or (
         isinstance(caller_context, FunctionSolc) and caller_context.contract_parser is None
     ):
         structures_direct_access: List["Structure"]
         if isinstance(caller_context, SlitherCompilationUnitSolc):
             sl = caller_context.compilation_unit
             next_context = caller_context
-        elif isinstance(caller_context, CustomErrorSolc):
-            sl = caller_context.underlying_custom_error.compilation_unit
-            next_context = caller_context.slither_parser
         else:
             assert isinstance(caller_context, FunctionSolc)
             sl = caller_context.underlying_function.compilation_unit
@@ -233,6 +245,25 @@ def parse_type(
         all_enums += enums_direct_access
         contracts = sl.contracts
         functions = []
+    elif isinstance(caller_context, (StructureTopLevelSolc, CustomErrorSolc)):
+        if isinstance(caller_context, StructureTopLevelSolc):
+            scope = caller_context.underlying_structure.file_scope
+        else:
+            assert isinstance(caller_context, CustomErrorSolc)
+            custom_error = caller_context.underlying_custom_error
+            if isinstance(custom_error, CustomErrorTopLevel):
+                scope = custom_error.file_scope
+            else:
+                assert isinstance(custom_error, CustomErrorContract)
+                scope = custom_error.contract.file_scope
+
+        next_context = caller_context.slither_parser
+        structures_direct_access = []
+        all_structures = scope.structures.values()
+        enums_direct_access = []
+        all_enums = scope.enums.values()
+        contracts = scope.contracts.values()
+        functions = list(scope.functions)
     elif isinstance(caller_context, (ContractSolc, FunctionSolc)):
         if isinstance(caller_context, FunctionSolc):
             underlying_func = caller_context.underlying_function
@@ -246,16 +277,16 @@ def parse_type(
             next_context = caller_context
 
         structures_direct_access = contract.structures
-        structures_direct_access += contract.compilation_unit.structures_top_level
+        structures_direct_access += contract.file_scope.structures.values()
-        all_structuress = [c.structures for c in contract.compilation_unit.contracts]
+        all_structuress = [c.structures for c in contract.file_scope.contracts.values()]
         all_structures = [item for sublist in all_structuress for item in sublist]
-        all_structures += contract.compilation_unit.structures_top_level
+        all_structures += contract.file_scope.structures.values()
         enums_direct_access: List["Enum"] = contract.enums
-        enums_direct_access += contract.compilation_unit.enums_top_level
+        enums_direct_access += contract.file_scope.enums.values()
-        all_enumss = [c.enums for c in contract.compilation_unit.contracts]
+        all_enumss = [c.enums for c in contract.file_scope.contracts.values()]
         all_enums = [item for sublist in all_enumss for item in sublist]
-        all_enums += contract.compilation_unit.enums_top_level
+        all_enums += contract.file_scope.enums.values()
-        contracts = contract.compilation_unit.contracts
+        contracts = contract.file_scope.contracts.values()
         functions = contract.functions + contract.modifiers
     else:
         raise ParsingError(f"Incorrect caller context: {type(caller_context)}")

slither/solc_parsing/variables/variable_declaration.py

@@ -1,6 +1,7 @@
 import logging
 from typing import Dict
 
+from slither.solc_parsing.declarations.caller_context import CallerContextExpression
 from slither.solc_parsing.expressions.expression_parsing import parse_expression
 
 from slither.core.variables.variable import Variable
@@ -179,7 +180,7 @@ class VariableDeclarationSolc:
                 self._variable.initialized = True
                 self._initializedNotParsed = var["children"][1]
 
-    def analyze(self, caller_context):
+    def analyze(self, caller_context: CallerContextExpression):
         # Can be re-analyzed due to inheritance
         if self._was_analyzed:
             return

slither/solc_parsing/yul/parse_yul.py

@@ -223,7 +223,7 @@ class YulFunction(YulScope):
             func.set_contract(root.contract)
             func.set_contract_declarer(root.contract)
         func.compilation_unit = root.compilation_unit
-        func.scope = root.id
+        func.internal_scope = root.id
         func.is_implemented = True
         self.node_scope = node_scope
 
@@ -359,8 +359,14 @@ def convert_yul_function_definition(
     while not isinstance(top_node_scope, Function):
         top_node_scope = top_node_scope.father
 
-    assert isinstance(top_node_scope, (FunctionTopLevel, FunctionContract))
+    if isinstance(top_node_scope, FunctionTopLevel):
-    func = type(top_node_scope)(root.compilation_unit)
+        scope = root.contract.file_scope
+        func = FunctionTopLevel(root.compilation_unit, scope)
+        # Note: we do not add the function in the scope
+        # While its a top level function, it is not accessible outside of the function definition
+        # In practice we should probably have a specific function type for function defined within a function
+    else:
+        func = FunctionContract(root.compilation_unit)
     func.function_language = FunctionLanguage.Yul
     yul_function = YulFunction(func, root, ast, node_scope)
 

slither/tools/upgradeability/checks/initialization.py

@@ -71,7 +71,7 @@ Consider using a `Initializable` contract to follow [standard practice](https://
     # endregion wiki_recommendation
 
     def _check(self):
-        initializable = self.contract.compilation_unit.get_contract_from_name("Initializable")
+        initializable = self.contract.file_scope.get_contract_from_name("Initializable")
         if initializable is None:
             info = [
                 "Initializable contract not found, the contract does not follow a standard initalization schema.\n"
@@ -104,7 +104,7 @@ Review manually the contract's initialization. Consider inheriting `Initializabl
     REQUIRE_CONTRACT = True
 
     def _check(self):
-        initializable = self.contract.compilation_unit.get_contract_from_name("Initializable")
+        initializable = self.contract.file_scope.get_contract_from_name("Initializable")
         # See InitializablePresent
         if initializable is None:
             return []
@@ -138,7 +138,7 @@ Review manually the contract's initialization. Consider inheriting a `Initializa
     REQUIRE_CONTRACT = True
 
     def _check(self):
-        initializable = self.contract.compilation_unit.get_contract_from_name("Initializable")
+        initializable = self.contract.file_scope.get_contract_from_name("Initializable")
         # See InitializablePresent
         if initializable is None:
             return []
@@ -191,7 +191,7 @@ Use `Initializable.initializer()`.
     REQUIRE_CONTRACT = True
 
     def _check(self):
-        initializable = self.contract.compilation_unit.get_contract_from_name("Initializable")
+        initializable = self.contract.file_scope.get_contract_from_name("Initializable")
         # See InitializablePresent
         if initializable is None:
             return []