Merge branch 'dev' of github.com:crytic/slither into dev

.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        type: ["4", "5", "cli", "dapp", "data_dependency", "embark", "erc", "etherlime", "find_paths", "kspec", "printers", "simil", "slither_config", "truffle", "upgradability", "prop"]
+        type: ["4", "5", "cli", "data_dependency", "embark", "erc", "etherlime", "find_paths", "kspec", "printers", "simil", "slither_config", "truffle", "upgradability", "prop"]
     steps:
     - uses: actions/checkout@v1
     - name: Set up Python 3.6

slither/core/children/child_contract.py

@@ -1,14 +1,17 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from slither.core.declarations import Contract
 
-class ChildContract:
 
+class ChildContract:
     def __init__(self):
         super(ChildContract, self).__init__()
         self._contract = None
 
-    def set_contract(self, contract):
+    def set_contract(self, contract: "Contract"):
         self._contract = contract
 
     @property
-    def contract(self):
+    def contract(self) -> "Contract":
         return self._contract
-

slither/core/children/child_event.py

@@ -1,12 +1,17 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from slither.core.declarations import Event
+
 
 class ChildEvent:
     def __init__(self):
         super(ChildEvent, self).__init__()
         self._event = None
 
-    def set_event(self, event):
+    def set_event(self, event: "Event"):
         self._event = event
 
     @property
-    def event(self):
+    def event(self) -> "Event":
         return self._event

slither/core/children/child_expression.py

@@ -1,12 +1,17 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from slither.core.expressions.expression import Expression
+
 
 class ChildExpression:
     def __init__(self):
         super(ChildExpression, self).__init__()
         self._expression = None
 
-    def set_expression(self, expression):
+    def set_expression(self, expression: "Expression"):
         self._expression = expression
 
     @property
-    def expression(self):
+    def expression(self) -> "Expression":
         return self._expression

slither/core/children/child_function.py

@@ -1,12 +1,17 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from slither.core.declarations import Function
+
 
 class ChildFunction:
     def __init__(self):
         super(ChildFunction, self).__init__()
         self._function = None
 
-    def set_function(self, function):
+    def set_function(self, function: "Function"):
         self._function = function
 
     @property
-    def function(self):
+    def function(self) -> "Function":
         return self._function

slither/core/children/child_inheritance.py

@@ -1,13 +1,17 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from slither.core.declarations import Contract
 
-class ChildInheritance:
 
+class ChildInheritance:
     def __init__(self):
         super(ChildInheritance, self).__init__()
         self._contract_declarer = None
 
-    def set_contract_declarer(self, contract):
+    def set_contract_declarer(self, contract: "Contract"):
         self._contract_declarer = contract
 
     @property
-    def contract_declarer(self):
+    def contract_declarer(self) -> "Contract":
         return self._contract_declarer

slither/core/children/child_node.py

@@ -1,24 +1,31 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from slither import Slither
+    from slither.core.cfg.node import Node
+    from slither.core.declarations import Function, Contract
+
 
 class ChildNode(object):
     def __init__(self):
         super(ChildNode, self).__init__()
         self._node = None
 
-    def set_node(self, node):
+    def set_node(self, node: "Node"):
         self._node = node
 
     @property
-    def node(self):
+    def node(self) -> "Node":
         return self._node
 
     @property
-    def function(self):
+    def function(self) -> "Function":
         return self.node.function
 
     @property
-    def contract(self):
+    def contract(self) -> "Contract":
         return self.node.function.contract
 
     @property
-    def slither(self):
+    def slither(self) -> "Slither":
         return self.contract.slither

slither/core/children/child_slither.py

@@ -1,13 +1,17 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from slither import Slither
 
-class ChildSlither:
 
+class ChildSlither:
     def __init__(self):
         super(ChildSlither, self).__init__()
         self._slither = None
 
-    def set_slither(self, slither):
+    def set_slither(self, slither: "Slither"):
         self._slither = slither
 
     @property
-    def slither(self):
+    def slither(self) -> "Slither":
         return self._slither

slither/core/children/child_structure.py

@@ -1,13 +1,17 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from slither.core.declarations import Structure
 
-class ChildStructure:
 
+class ChildStructure:
     def __init__(self):
         super(ChildStructure, self).__init__()
         self._structure = None
 
-    def set_structure(self, structure):
+    def set_structure(self, structure: "Structure"):
         self._structure = structure
 
     @property
-    def structure(self):
+    def structure(self) -> "Structure":
         return self._structure

slither/core/context/context.py

@@ -1,14 +1,15 @@
-class Context:
+from collections import defaultdict
+from typing import Dict
+
 
+class Context:
     def __init__(self):
         super(Context, self).__init__()
-        self._context = {}
+        self._context = {"MEMBERS": defaultdict(None)}
 
     @property
-    def context(self):
-        '''
+    def context(self) -> Dict:
+        """
         Dict used by analysis
-        '''
+        """
         return self._context
-
-

slither/core/declarations/enum.py

@@ -1,25 +1,32 @@
+from typing import List, TYPE_CHECKING
+
 from slither.core.source_mapping.source_mapping import SourceMapping
 from slither.core.children.child_contract import ChildContract
 
+if TYPE_CHECKING:
+    from slither.core.declarations import Contract
+
+
 class Enum(ChildContract, SourceMapping):
-    def __init__(self, name, canonical_name, values):
+    def __init__(self, name: str, canonical_name: str, values: List[str]):
+        super().__init__()
         self._name = name
         self._canonical_name = canonical_name
         self._values = values
 
     @property
-    def canonical_name(self):
+    def canonical_name(self) -> str:
         return self._canonical_name
 
     @property
-    def name(self):
+    def name(self) -> str:
         return self._name
 
     @property
-    def values(self):
+    def values(self) -> List[str]:
         return self._values
 
-    def is_declared_by(self, contract):
+    def is_declared_by(self, contract: "Contract") -> bool:
         """
         Check if the element is declared by the contract
         :param contract:

slither/core/declarations/event.py

@@ -1,47 +1,57 @@
+from typing import List, Tuple, TYPE_CHECKING
+
 from slither.core.children.child_contract import ChildContract
 from slither.core.source_mapping.source_mapping import SourceMapping
+from slither.core.variables.event_variable import EventVariable
 
-class Event(ChildContract, SourceMapping):
+if TYPE_CHECKING:
+    from slither.core.declarations import Contract
 
+
+class Event(ChildContract, SourceMapping):
     def __init__(self):
         super(Event, self).__init__()
         self._name = None
-        self._elems = []
+        self._elems: List[EventVariable] = []
 
     @property
-    def name(self):
+    def name(self) -> str:
         return self._name
 
+    @name.setter
+    def name(self, name: str):
+        self._name = name
+
     @property
-    def signature(self):
-        ''' Return the function signature
+    def signature(self) -> Tuple[str, List[str]]:
+        """ Return the function signature
         Returns:
             (str, list(str)): name, list parameters type
-        '''
+        """
         return self.name, [str(x.type) for x in self.elems]
 
     @property
-    def full_name(self):
-        ''' Return the function signature as a str
+    def full_name(self) -> str:
+        """ Return the function signature as a str
         Returns:
             str: func_name(type1,type2)
-        '''
+        """
         name, parameters = self.signature
-        return name+'('+','.join(parameters)+')'
+        return name + "(" + ",".join(parameters) + ")"
 
     @property
-    def canonical_name(self):
-        ''' Return the function signature as a str
+    def canonical_name(self) -> str:
+        """ Return the function signature as a str
         Returns:
             str: contract.func_name(type1,type2)
-        '''
+        """
         return self.contract.name + self.full_name
 
     @property
-    def elems(self):
+    def elems(self) -> List["EventVariable"]:
         return self._elems
 
-    def is_declared_by(self, contract):
+    def is_declared_by(self, contract: "Contract") -> bool:
         """
         Check if the element is declared by the contract
         :param contract:

slither/core/declarations/import_directive.py

@@ -1,13 +1,13 @@
 from slither.core.source_mapping.source_mapping import SourceMapping
 
-class Import(SourceMapping):
 
-    def __init__(self, filename):
+class Import(SourceMapping):
+    def __init__(self, filename: str):
         super(Import, self).__init__()
         self._filename = filename
 
     @property
-    def filename(self):
+    def filename(self) -> str:
         return self._filename
 
     def __str__(self):

slither/core/declarations/modifier.py

@@ -3,5 +3,6 @@
 """
 from .function import Function
 
-class Modifier(Function): pass
 
+class Modifier(Function):
+    pass

slither/core/declarations/pragma_directive.py

@@ -1,37 +1,39 @@
+from typing import List
+
 from slither.core.source_mapping.source_mapping import SourceMapping
 
-class Pragma(SourceMapping):
 
-    def __init__(self, directive):
+class Pragma(SourceMapping):
+    def __init__(self, directive: List[str]):
         super(Pragma, self).__init__()
         self._directive = directive
 
     @property
-    def directive(self):
-        '''
+    def directive(self) -> List[str]:
+        """
             list(str)
-        '''
+        """
         return self._directive
 
     @property
-    def version(self):
-        return ''.join(self.directive[1:])
+    def version(self) -> str:
+        return "".join(self.directive[1:])
 
     @property
-    def name(self):
+    def name(self) -> str:
         return self.version
 
     @property
-    def is_solidity_version(self):
+    def is_solidity_version(self) -> bool:
         if len(self._directive) > 0:
-            return self._directive[0].lower() == 'solidity'
+            return self._directive[0].lower() == "solidity"
         return False
 
     @property
-    def is_abi_encoder_v2(self):
+    def is_abi_encoder_v2(self) -> bool:
         if len(self._directive) == 2:
-            return self._directive[0] == 'experimental' and self._directive[1] == 'ABIEncoderV2'
+            return self._directive[0] == "experimental" and self._directive[1] == "ABIEncoderV2"
         return False
 
     def __str__(self):
-        return 'pragma '+''.join(self.directive)
+        return "pragma " + "".join(self.directive)

slither/core/declarations/solidity_variables.py

@@ -1,64 +1,73 @@
 # https://solidity.readthedocs.io/en/v0.4.24/units-and-global-variables.html
+from typing import List, Dict, Union
+
 from slither.core.context.context import Context
 from slither.core.solidity_types import ElementaryType, TypeInformation
 
-SOLIDITY_VARIABLES = {"now":'uint256',
-                      "this":'address',
-                      'abi':'address', # to simplify the conversion, assume that abi return an address
-                      'msg':'',
-                      'tx':'',
-                      'block':'',
-                      'super':''}
-
-SOLIDITY_VARIABLES_COMPOSED = {"block.coinbase":"address",
-                               "block.difficulty":"uint256",
-                               "block.gaslimit":"uint256",
-                               "block.number":"uint256",
-                               "block.timestamp":"uint256",
-                               "block.blockhash":"uint256", # alias for blockhash. It's a call
-                               "msg.data":"bytes",
-                               "msg.gas":"uint256",
-                               "msg.sender":"address",
-                               "msg.sig":"bytes4",
-                               "msg.value":"uint256",
-                               "tx.gasprice":"uint256",
-                               "tx.origin":"address"}
-
-
-SOLIDITY_FUNCTIONS = {"gasleft()":['uint256'],
-                      "assert(bool)":[],
-                      "require(bool)":[],
-                      "require(bool,string)":[],
-                      "revert()":[],
-                      "revert(string)":[],
-                      "addmod(uint256,uint256,uint256)":['uint256'],
-                      "mulmod(uint256,uint256,uint256)":['uint256'],
-                      "keccak256()":['bytes32'],
-                      "keccak256(bytes)":['bytes32'], # Solidity 0.5
-                      "sha256()":['bytes32'],
-                      "sha256(bytes)":['bytes32'], # Solidity 0.5
-                      "sha3()":['bytes32'],
-                      "ripemd160()":['bytes32'],
-                      "ripemd160(bytes)":['bytes32'], # Solidity 0.5
-                      "ecrecover(bytes32,uint8,bytes32,bytes32)":['address'],
-                      "selfdestruct(address)":[],
-                      "suicide(address)":[],
-                      "log0(bytes32)":[],
-                      "log1(bytes32,bytes32)":[],
-                      "log2(bytes32,bytes32,bytes32)":[],
-                      "log3(bytes32,bytes32,bytes32,bytes32)":[],
-                      "blockhash(uint256)":['bytes32'],
-                      # the following need a special handling
-                      # as they are recognized as a SolidityVariableComposed
-                      # and converted to a SolidityFunction by SlithIR
-                      "this.balance()":['uint256'],
-                      "abi.encode()":['bytes'],
-                      "abi.encodePacked()":['bytes'],
-                      "abi.encodeWithSelector()":["bytes"],
-                      "abi.encodeWithSignature()":["bytes"],
-                      # abi.decode returns an a list arbitrary types
-                      "abi.decode()":[],
-                      "type(address)":[]}
+SOLIDITY_VARIABLES = {
+    "now": "uint256",
+    "this": "address",
+    "abi": "address",  # to simplify the conversion, assume that abi return an address
+    "msg": "",
+    "tx": "",
+    "block": "",
+    "super": "",
+}
+
+SOLIDITY_VARIABLES_COMPOSED = {
+    "block.coinbase": "address",
+    "block.difficulty": "uint256",
+    "block.gaslimit": "uint256",
+    "block.number": "uint256",
+    "block.timestamp": "uint256",
+    "block.blockhash": "uint256",  # alias for blockhash. It's a call
+    "msg.data": "bytes",
+    "msg.gas": "uint256",
+    "msg.sender": "address",
+    "msg.sig": "bytes4",
+    "msg.value": "uint256",
+    "tx.gasprice": "uint256",
+    "tx.origin": "address",
+}
+
+
+SOLIDITY_FUNCTIONS: Dict[str, List[str]] = {
+    "gasleft()": ["uint256"],
+    "assert(bool)": [],
+    "require(bool)": [],
+    "require(bool,string)": [],
+    "revert()": [],
+    "revert(string)": [],
+    "addmod(uint256,uint256,uint256)": ["uint256"],
+    "mulmod(uint256,uint256,uint256)": ["uint256"],
+    "keccak256()": ["bytes32"],
+    "keccak256(bytes)": ["bytes32"],  # Solidity 0.5
+    "sha256()": ["bytes32"],
+    "sha256(bytes)": ["bytes32"],  # Solidity 0.5
+    "sha3()": ["bytes32"],
+    "ripemd160()": ["bytes32"],
+    "ripemd160(bytes)": ["bytes32"],  # Solidity 0.5
+    "ecrecover(bytes32,uint8,bytes32,bytes32)": ["address"],
+    "selfdestruct(address)": [],
+    "suicide(address)": [],
+    "log0(bytes32)": [],
+    "log1(bytes32,bytes32)": [],
+    "log2(bytes32,bytes32,bytes32)": [],
+    "log3(bytes32,bytes32,bytes32,bytes32)": [],
+    "blockhash(uint256)": ["bytes32"],
+    # the following need a special handling
+    # as they are recognized as a SolidityVariableComposed
+    # and converted to a SolidityFunction by SlithIR
+    "this.balance()": ["uint256"],
+    "abi.encode()": ["bytes"],
+    "abi.encodePacked()": ["bytes"],
+    "abi.encodeWithSelector()": ["bytes"],
+    "abi.encodeWithSignature()": ["bytes"],
+    # abi.decode returns an a list arbitrary types
+    "abi.decode()": [],
+    "type(address)": [],
+}
+
 
 def solidity_function_signature(name):
     """
@@ -70,25 +79,25 @@ def solidity_function_signature(name):
     Returns:
         str
     """
-    return name+' returns({})'.format(','.join(SOLIDITY_FUNCTIONS[name]))
+    return name + " returns({})".format(",".join(SOLIDITY_FUNCTIONS[name]))
 
-class SolidityVariable(Context):
 
-    def __init__(self, name):
+class SolidityVariable(Context):
+    def __init__(self, name: str):
         super(SolidityVariable, self).__init__()
         self._check_name(name)
         self._name = name
 
     # dev function, will be removed once the code is stable
-    def _check_name(self, name):
+    def _check_name(self, name: str):
         assert name in SOLIDITY_VARIABLES
 
     @property
-    def name(self):
+    def name(self) -> str:
         return self._name
 
     @property
-    def type(self):
+    def type(self) -> ElementaryType:
         return ElementaryType(SOLIDITY_VARIABLES[self.name])
 
     def __str__(self):
@@ -100,19 +109,20 @@ class SolidityVariable(Context):
     def __hash__(self):
         return hash(self.name)
 
+
 class SolidityVariableComposed(SolidityVariable):
-    def __init__(self, name):
+    def __init__(self, name: str):
         super(SolidityVariableComposed, self).__init__(name)
 
-    def _check_name(self, name):
+    def _check_name(self, name: str):
         assert name in SOLIDITY_VARIABLES_COMPOSED
 
     @property
-    def name(self):
+    def name(self) -> str:
         return self._name
 
     @property
-    def type(self):
+    def type(self) -> ElementaryType:
         return ElementaryType(SOLIDITY_VARIABLES_COMPOSED[self.name])
 
     def __str__(self):
@@ -131,25 +141,28 @@ class SolidityFunction:
     # https://solidity.readthedocs.io/en/latest/units-and-global-variables.html#type-information
     # As a result, we set return_type during the Ir conversion
 
-    def __init__(self, name):
+    def __init__(self, name: str):
         assert name in SOLIDITY_FUNCTIONS
         self._name = name
-        self._return_type = [ElementaryType(x) for x in SOLIDITY_FUNCTIONS[self.name]]
+        # Can be TypeInformation if type(address) is used
+        self._return_type: List[Union[TypeInformation, ElementaryType]] = [
+            ElementaryType(x) for x in SOLIDITY_FUNCTIONS[self.name]
+        ]
 
     @property
-    def name(self):
+    def name(self) -> str:
         return self._name
 
     @property
-    def full_name(self):
+    def full_name(self) -> str:
         return self.name
 
     @property
-    def return_type(self):
+    def return_type(self) -> List[Union[TypeInformation, ElementaryType]]:
         return self._return_type
 
     @return_type.setter
-    def return_type(self, r):
+    def return_type(self, r: List[Union[TypeInformation, ElementaryType]]):
         self._return_type = r
 
     def __str__(self):

slither/core/declarations/structure.py

@@ -1,30 +1,43 @@
-from slither.core.source_mapping.source_mapping import SourceMapping
+from typing import List, TYPE_CHECKING, Dict
+
 from slither.core.children.child_contract import ChildContract
+from slither.core.source_mapping.source_mapping import SourceMapping
 
-from slither.core.variables.variable import Variable
+if TYPE_CHECKING:
+    from slither.core.variables.structure_variable import StructureVariable
 
-class Structure(ChildContract, SourceMapping):
 
+class Structure(ChildContract, SourceMapping):
     def __init__(self):
         super(Structure, self).__init__()
         self._name = None
         self._canonical_name = None
-        self._elems = None
+        self._elems: Dict[str, "StructureVariable"] = dict()
         # Name of the elements in the order of declaration
-        self._elems_ordered = None
+        self._elems_ordered: List[str] = []
 
     @property
-    def canonical_name(self):
+    def canonical_name(self) -> str:
         return self._canonical_name
 
+    @canonical_name.setter
+    def canonical_name(self, name: str):
+        self._canonical_name = name
+
     @property
-    def name(self):
+    def name(self) -> str:
         return self._name
 
+    @name.setter
+    def name(self, new_name: str):
+        self._name = new_name
+
     @property
-    def elems(self):
+    def elems(self) -> Dict[str, "StructureVariable"]:
         return self._elems
 
+    def add_elem_in_order(self, s: str):
+        self._elems_ordered.append(s)
 
     def is_declared_by(self, contract):
         """
@@ -35,12 +48,11 @@ class Structure(ChildContract, SourceMapping):
         return self.contract == contract
 
     @property
-    def elems_ordered(self):
+    def elems_ordered(self) -> List["StructureVariable"]:
         ret = []
         for e in self._elems_ordered:
             ret.append(self._elems[e])
         return ret
 
-
     def __str__(self):
         return self.name

slither/core/dominators/node_dominator_tree.py

@@ -1,37 +1,27 @@
-'''
+"""
     Nodes of the dominator tree
-'''
+"""
+from typing import TYPE_CHECKING, Set, List
 
-from slither.core.children.child_function import ChildFunction
+if TYPE_CHECKING:
+    from slither.core.cfg.node import Node
 
-class DominatorNode(object):
 
+class DominatorNode(object):
     def __init__(self):
-        self._succ = set()
-        self._nodes = []
+        self._succ: Set["Node"] = set()
+        self._nodes: List["Node"] = []
 
-    def add_node(self, node):
+    def add_node(self, node: "Node"):
         self._nodes.append(node)
 
-    def add_successor(self, succ):
+    def add_successor(self, succ: "Node"):
         self._succ.add(succ)
 
     @property
-    def cfg_nodes(self):
+    def cfg_nodes(self) -> List["Node"]:
         return self._nodes
 
     @property
-    def sucessors(self):
-        '''
-            Returns:
-                dict(Node)
-        '''
+    def sucessors(self) -> Set["Node"]:
         return self._succ
-
-class DominatorTree(ChildFunction):
-
-    def __init__(self, entry_point):
-        super(DominatorTree, self).__init__()
-        
-
-        

slither/core/dominators/utils.py

@@ -1,6 +1,12 @@
+from typing import List, TYPE_CHECKING
+
 from slither.core.cfg.node import NodeType
 
-def intersection_predecessor(node):
+if TYPE_CHECKING:
+    from slither.core.cfg.node import Node
+
+
+def intersection_predecessor(node: "Node"):
     if not node.fathers:
         return set()
     ret = node.fathers[0].dominators
@@ -8,13 +14,14 @@ def intersection_predecessor(node):
         ret = ret.intersection(pred.dominators)
     return ret
 
-def compute_dominators(nodes):
-    '''
+
+def compute_dominators(nodes: List["Node"]):
+    """
         Naive implementation of Cooper, Harvey, Kennedy algo
         See 'A Simple,Fast Dominance Algorithm'
 
         Compute strict domniators
-    '''
+    """
     changed = True
 
     for n in nodes:
@@ -36,33 +43,38 @@ def compute_dominators(nodes):
 
         for dominator in node.dominators:
             if dominator != node:
-                [idom_candidates.remove(d) for d in dominator.dominators if d in idom_candidates and d!=dominator]
+                [
+                    idom_candidates.remove(d)
+                    for d in dominator.dominators
+                    if d in idom_candidates and d != dominator
+                ]
 
-        assert len(idom_candidates)<=1
+        assert len(idom_candidates) <= 1
         if idom_candidates:
             idom = idom_candidates.pop()
             node.immediate_dominator = idom
             idom.dominator_successors.add(node)
 
 
-
-def compute_dominance_frontier(nodes):
-    '''
+def compute_dominance_frontier(nodes: List["Node"]):
+    """
         Naive implementation of Cooper, Harvey, Kennedy algo
         See 'A Simple,Fast Dominance Algorithm'
 
         Compute dominance frontier
-    '''
+    """
     for node in nodes:
         if len(node.fathers) >= 2:
             for father in node.fathers:
                 runner = father
                 # Corner case: if there is a if without else
                 # we need to add update the conditional node
-                if runner == node.immediate_dominator and runner.type == NodeType.IF and node.type == NodeType.ENDIF:
+                if (
+                    runner == node.immediate_dominator
+                    and runner.type == NodeType.IF
+                    and node.type == NodeType.ENDIF
+                ):
                     runner.dominance_frontier = runner.dominance_frontier.union({node})
                 while runner != node.immediate_dominator:
                     runner.dominance_frontier = runner.dominance_frontier.union({node})
                     runner = runner.immediate_dominator
-
-

slither/core/exceptions.py

@@ -1,3 +1,5 @@
 from slither.exceptions import SlitherException
 
-class SlitherCoreError(SlitherException): pass
+
+class SlitherCoreError(SlitherException):
+    pass

slither/core/expressions/assignment_operation.py

@@ -1,111 +1,118 @@
 import logging
+from enum import Enum
+from typing import Optional, TYPE_CHECKING, List
+
 from slither.core.expressions.expression_typed import ExpressionTyped
 from slither.core.expressions.expression import Expression
 from slither.core.exceptions import SlitherCoreError
 
+if TYPE_CHECKING:
+    from slither.core.solidity_types.type import Type
+
 logger = logging.getLogger("AssignmentOperation")
 
-class AssignmentOperationType:
-    ASSIGN =                0 # =
-    ASSIGN_OR =             1 # |=
-    ASSIGN_CARET =          2 # ^=
-    ASSIGN_AND =            3 # &=
-    ASSIGN_LEFT_SHIFT =     4 # <<=
-    ASSIGN_RIGHT_SHIFT =    5 # >>=
-    ASSIGN_ADDITION =       6 # +=
-    ASSIGN_SUBTRACTION =   7 # -=
-    ASSIGN_MULTIPLICATION = 8 # *=
-    ASSIGN_DIVISION =       9 # /=
-    ASSIGN_MODULO =         10 # %=
+
+class AssignmentOperationType(Enum):
+    ASSIGN = 0  # =
+    ASSIGN_OR = 1  # |=
+    ASSIGN_CARET = 2  # ^=
+    ASSIGN_AND = 3  # &=
+    ASSIGN_LEFT_SHIFT = 4  # <<=
+    ASSIGN_RIGHT_SHIFT = 5  # >>=
+    ASSIGN_ADDITION = 6  # +=
+    ASSIGN_SUBTRACTION = 7  # -=
+    ASSIGN_MULTIPLICATION = 8  # *=
+    ASSIGN_DIVISION = 9  # /=
+    ASSIGN_MODULO = 10  # %=
 
     @staticmethod
-    def get_type(operation_type):
-        if operation_type == '=':
+    def get_type(operation_type: "AssignmentOperationType"):
+        if operation_type == "=":
             return AssignmentOperationType.ASSIGN
-        if operation_type == '|=':
+        if operation_type == "|=":
             return AssignmentOperationType.ASSIGN_OR
-        if operation_type == '^=':
+        if operation_type == "^=":
             return AssignmentOperationType.ASSIGN_CARET
-        if operation_type == '&=':
+        if operation_type == "&=":
             return AssignmentOperationType.ASSIGN_AND
-        if operation_type == '<<=':
+        if operation_type == "<<=":
             return AssignmentOperationType.ASSIGN_LEFT_SHIFT
-        if operation_type == '>>=':
+        if operation_type == ">>=":
             return AssignmentOperationType.ASSIGN_RIGHT_SHIFT
-        if operation_type == '+=':
+        if operation_type == "+=":
             return AssignmentOperationType.ASSIGN_ADDITION
-        if operation_type == '-=':
+        if operation_type == "-=":
             return AssignmentOperationType.ASSIGN_SUBTRACTION
-        if operation_type == '*=':
+        if operation_type == "*=":
             return AssignmentOperationType.ASSIGN_MULTIPLICATION
-        if operation_type == '/=':
+        if operation_type == "/=":
             return AssignmentOperationType.ASSIGN_DIVISION
-        if operation_type == '%=':
+        if operation_type == "%=":
             return AssignmentOperationType.ASSIGN_MODULO
 
-        raise SlitherCoreError('get_type: Unknown operation type {})'.format(operation_type))
+        raise SlitherCoreError("get_type: Unknown operation type {})".format(operation_type))
 
-    @staticmethod
-    def str(operation_type):
-        if operation_type == AssignmentOperationType.ASSIGN:
-            return '='
-        if operation_type == AssignmentOperationType.ASSIGN_OR:
-            return '|='
-        if operation_type == AssignmentOperationType.ASSIGN_CARET:
-            return '^='
-        if operation_type == AssignmentOperationType.ASSIGN_AND:
-            return '&='
-        if operation_type == AssignmentOperationType.ASSIGN_LEFT_SHIFT:
-            return '<<='
-        if operation_type == AssignmentOperationType.ASSIGN_RIGHT_SHIFT:
-            return '>>='
-        if operation_type == AssignmentOperationType.ASSIGN_ADDITION:
-            return '+='
-        if operation_type == AssignmentOperationType.ASSIGN_SUBTRACTION:
-            return '-='
-        if operation_type == AssignmentOperationType.ASSIGN_MULTIPLICATION:
-            return '*='
-        if operation_type == AssignmentOperationType.ASSIGN_DIVISION:
-            return '/='
-        if operation_type == AssignmentOperationType.ASSIGN_MODULO:
-            return '%='
-
-        raise SlitherCoreError('str: Unknown operation type {})'.format(operation_type))
+    def __str__(self):
+        if self == AssignmentOperationType.ASSIGN:
+            return "="
+        if self == AssignmentOperationType.ASSIGN_OR:
+            return "|="
+        if self == AssignmentOperationType.ASSIGN_CARET:
+            return "^="
+        if self == AssignmentOperationType.ASSIGN_AND:
+            return "&="
+        if self == AssignmentOperationType.ASSIGN_LEFT_SHIFT:
+            return "<<="
+        if self == AssignmentOperationType.ASSIGN_RIGHT_SHIFT:
+            return ">>="
+        if self == AssignmentOperationType.ASSIGN_ADDITION:
+            return "+="
+        if self == AssignmentOperationType.ASSIGN_SUBTRACTION:
+            return "-="
+        if self == AssignmentOperationType.ASSIGN_MULTIPLICATION:
+            return "*="
+        if self == AssignmentOperationType.ASSIGN_DIVISION:
+            return "/="
+        if self == AssignmentOperationType.ASSIGN_MODULO:
+            return "%="
+        raise SlitherCoreError("str: Unknown operation type {})".format(self))
 
-class AssignmentOperation(ExpressionTyped):
 
-    def __init__(self, left_expression, right_expression, expression_type, expression_return_type):
+class AssignmentOperation(ExpressionTyped):
+    def __init__(
+        self,
+        left_expression: Expression,
+        right_expression: Expression,
+        expression_type: AssignmentOperationType,
+        expression_return_type: Optional["Type"],
+    ):
         assert isinstance(left_expression, Expression)
         assert isinstance(right_expression, Expression)
         super(AssignmentOperation, self).__init__()
         left_expression.set_lvalue()
         self._expressions = [left_expression, right_expression]
         self._type = expression_type
-        self._expression_return_type = expression_return_type
+        self._expression_return_type: Optional["Type"] = expression_return_type
 
     @property
-    def expressions(self):
+    def expressions(self) -> List[Expression]:
         return self._expressions
 
     @property
-    def expression_return_type(self):
+    def expression_return_type(self) -> Optional["Type"]:
         return self._expression_return_type
 
     @property
-    def expression_left(self):
+    def expression_left(self) -> Expression:
         return self._expressions[0]
 
     @property
-    def expression_right(self):
+    def expression_right(self) -> Expression:
         return self._expressions[1]
 
     @property
-    def type(self):
+    def type(self) -> AssignmentOperationType:
         return self._type
 
-    @property
-    def type_str(self):
-        return AssignmentOperationType.str(self._type)
-
     def __str__(self):
-        return str(self.expression_left) + " "+ self.type_str  + " " + str(self.expression_right)
+        return str(self.expression_left) + " " + str(self.type) + " " + str(self.expression_right)

slither/core/expressions/binary_operation.py

@@ -1,145 +1,144 @@
 import logging
+from enum import Enum
+from typing import List
+
 from slither.core.expressions.expression_typed import ExpressionTyped
 from slither.core.expressions.expression import Expression
 from slither.core.exceptions import SlitherCoreError
 
+
 logger = logging.getLogger("BinaryOperation")
 
-class BinaryOperationType:
-    POWER =             0 # **
-    MULTIPLICATION =    1 # *
-    DIVISION =          2 # /
-    MODULO =            3 # %
-    ADDITION =          4 # +
-    SUBTRACTION =      5 # -
-    LEFT_SHIFT =        6 # <<
-    RIGHT_SHIFT =        7 # >>>
-    AND =               8 # &
-    CARET =             9 # ^
-    OR =                10 # | 
-    LESS =              11 # <
-    GREATER =           12 # >
-    LESS_EQUAL =        13 # <=
-    GREATER_EQUAL =     14 # >=
-    EQUAL =             15 # ==
-    NOT_EQUAL =         16 # !=
-    ANDAND =            17 # &&
-    OROR =              18 # ||
+
+class BinaryOperationType(Enum):
+    POWER = 0  # **
+    MULTIPLICATION = 1  # *
+    DIVISION = 2  # /
+    MODULO = 3  # %
+    ADDITION = 4  # +
+    SUBTRACTION = 5  # -
+    LEFT_SHIFT = 6  # <<
+    RIGHT_SHIFT = 7  # >>>
+    AND = 8  # &
+    CARET = 9  # ^
+    OR = 10  # |
+    LESS = 11  # <
+    GREATER = 12  # >
+    LESS_EQUAL = 13  # <=
+    GREATER_EQUAL = 14  # >=
+    EQUAL = 15  # ==
+    NOT_EQUAL = 16  # !=
+    ANDAND = 17  # &&
+    OROR = 18  # ||
 
     @staticmethod
-    def get_type(operation_type):
-        if operation_type == '**':
+    def get_type(operation_type: "BinaryOperation"):
+        if operation_type == "**":
             return BinaryOperationType.POWER
-        if operation_type == '*':
+        if operation_type == "*":
             return BinaryOperationType.MULTIPLICATION
-        if operation_type == '/':
+        if operation_type == "/":
             return BinaryOperationType.DIVISION
-        if operation_type == '%':
+        if operation_type == "%":
             return BinaryOperationType.MODULO
-        if operation_type == '+':
+        if operation_type == "+":
             return BinaryOperationType.ADDITION
-        if operation_type == '-':
+        if operation_type == "-":
             return BinaryOperationType.SUBTRACTION
-        if operation_type == '<<':
+        if operation_type == "<<":
             return BinaryOperationType.LEFT_SHIFT
-        if operation_type == '>>':
+        if operation_type == ">>":
             return BinaryOperationType.RIGHT_SHIFT
-        if operation_type == '&':
+        if operation_type == "&":
             return BinaryOperationType.AND
-        if operation_type == '^':
+        if operation_type == "^":
             return BinaryOperationType.CARET
-        if operation_type == '|':
+        if operation_type == "|":
             return BinaryOperationType.OR
-        if operation_type == '<':
+        if operation_type == "<":
             return BinaryOperationType.LESS
-        if operation_type == '>':
+        if operation_type == ">":
             return BinaryOperationType.GREATER
-        if operation_type == '<=':
+        if operation_type == "<=":
             return BinaryOperationType.LESS_EQUAL
-        if operation_type == '>=':
+        if operation_type == ">=":
             return BinaryOperationType.GREATER_EQUAL
-        if operation_type == '==':
+        if operation_type == "==":
             return BinaryOperationType.EQUAL
-        if operation_type == '!=':
+        if operation_type == "!=":
             return BinaryOperationType.NOT_EQUAL
-        if operation_type == '&&':
+        if operation_type == "&&":
             return BinaryOperationType.ANDAND
-        if operation_type == '||':
+        if operation_type == "||":
             return BinaryOperationType.OROR
 
-        raise SlitherCoreError('get_type: Unknown operation type {})'.format(operation_type))
+        raise SlitherCoreError("get_type: Unknown operation type {})".format(operation_type))
 
-    @staticmethod
-    def str(operation_type):
-        if operation_type == BinaryOperationType.POWER:
-            return '**'
-        if operation_type == BinaryOperationType.MULTIPLICATION:
-            return '*'
-        if operation_type == BinaryOperationType.DIVISION:
-            return '/'
-        if operation_type == BinaryOperationType.MODULO:
-            return '%'
-        if operation_type == BinaryOperationType.ADDITION:
-            return '+'
-        if operation_type == BinaryOperationType.SUBTRACTION:
-            return '-'
-        if operation_type == BinaryOperationType.LEFT_SHIFT:
-            return '<<'
-        if operation_type == BinaryOperationType.RIGHT_SHIFT:
-            return '>>'
-        if operation_type == BinaryOperationType.AND:
-            return '&'
-        if operation_type == BinaryOperationType.CARET:
-            return '^'
-        if operation_type == BinaryOperationType.OR:
-            return '|'
-        if operation_type == BinaryOperationType.LESS:
-            return '<'
-        if operation_type == BinaryOperationType.GREATER:
-            return '>'
-        if operation_type == BinaryOperationType.LESS_EQUAL:
-            return '<='
-        if operation_type == BinaryOperationType.GREATER_EQUAL:
-            return '>='
-        if operation_type == BinaryOperationType.EQUAL:
-            return '=='
-        if operation_type == BinaryOperationType.NOT_EQUAL:
-            return '!='
-        if operation_type == BinaryOperationType.ANDAND:
-            return '&&'
-        if operation_type == BinaryOperationType.OROR:
-            return '||'
-        raise SlitherCoreError('str: Unknown operation type {})'.format(operation_type))
+    def __str__(self):
+        if self == BinaryOperationType.POWER:
+            return "**"
+        if self == BinaryOperationType.MULTIPLICATION:
+            return "*"
+        if self == BinaryOperationType.DIVISION:
+            return "/"
+        if self == BinaryOperationType.MODULO:
+            return "%"
+        if self == BinaryOperationType.ADDITION:
+            return "+"
+        if self == BinaryOperationType.SUBTRACTION:
+            return "-"
+        if self == BinaryOperationType.LEFT_SHIFT:
+            return "<<"
+        if self == BinaryOperationType.RIGHT_SHIFT:
+            return ">>"
+        if self == BinaryOperationType.AND:
+            return "&"
+        if self == BinaryOperationType.CARET:
+            return "^"
+        if self == BinaryOperationType.OR:
+            return "|"
+        if self == BinaryOperationType.LESS:
+            return "<"
+        if self == BinaryOperationType.GREATER:
+            return ">"
+        if self == BinaryOperationType.LESS_EQUAL:
+            return "<="
+        if self == BinaryOperationType.GREATER_EQUAL:
+            return ">="
+        if self == BinaryOperationType.EQUAL:
+            return "=="
+        if self == BinaryOperationType.NOT_EQUAL:
+            return "!="
+        if self == BinaryOperationType.ANDAND:
+            return "&&"
+        if self == BinaryOperationType.OROR:
+            return "||"
+        raise SlitherCoreError("str: Unknown operation type {})".format(self))
 
-class BinaryOperation(ExpressionTyped):
 
+class BinaryOperation(ExpressionTyped):
     def __init__(self, left_expression, right_expression, expression_type):
         assert isinstance(left_expression, Expression)
         assert isinstance(right_expression, Expression)
         super(BinaryOperation, self).__init__()
         self._expressions = [left_expression, right_expression]
-        self._type = expression_type
+        self._type: BinaryOperationType = expression_type
 
     @property
-    def expressions(self):
+    def expressions(self) -> List[Expression]:
         return self._expressions
 
     @property
-    def expression_left(self):
+    def expression_left(self) -> Expression:
         return self._expressions[0]
 
     @property
-    def expression_right(self):
+    def expression_right(self) -> Expression:
         return self._expressions[1]
 
     @property
-    def type(self):
+    def type(self) -> BinaryOperationType:
         return self._type
 
-    @property
-    def type_str(self):
-        return BinaryOperationType.str(self._type)
-
     def __str__(self):
-        return str(self.expression_left) + ' ' + self.type_str + ' ' + str(self.expression_right)
-
+        return str(self.expression_left) + " " + str(self.type) + " " + str(self.expression_right)

slither/core/expressions/call_expression.py

@@ -1,23 +1,24 @@
+from typing import Optional, List
+
 from slither.core.expressions.expression import Expression
 
 
 class CallExpression(Expression):
-
     def __init__(self, called, arguments, type_call):
         assert isinstance(called, Expression)
         super(CallExpression, self).__init__()
-        self._called = called
-        self._arguments = arguments
-        self._type_call = type_call
+        self._called: Expression = called
+        self._arguments: List[Expression] = arguments
+        self._type_call: str = type_call
         # gas and value are only available if the syntax is {gas: , value: }
         # For the .gas().value(), the member are considered as function call
         # And converted later to the correct info (convert.py)
-        self._gas = None
-        self._value = None
-        self._salt = None
+        self._gas: Optional[Expression] = None
+        self._value: Optional[Expression] = None
+        self._salt: Optional[Expression] = None
 
     @property
-    def call_value(self):
+    def call_value(self) -> Optional[Expression]:
         return self._value
 
     @call_value.setter
@@ -25,7 +26,7 @@ class CallExpression(Expression):
         self._value = v
 
     @property
-    def call_gas(self):
+    def call_gas(self) -> Optional[Expression]:
         return self._gas
 
     @call_gas.setter
@@ -41,24 +42,32 @@ class CallExpression(Expression):
         self._salt = salt
 
     @property
-    def called(self):
+    def call_salt(self):
+        return self._salt
+
+    @call_salt.setter
+    def call_salt(self, salt):
+        self._salt = salt
+
+    @property
+    def called(self) -> Expression:
         return self._called
 
     @property
-    def arguments(self):
+    def arguments(self) -> List[Expression]:
         return self._arguments
 
     @property
-    def type_call(self):
+    def type_call(self) -> str:
         return self._type_call
 
     def __str__(self):
         txt = str(self._called)
         if self.call_gas or self.call_value:
-            gas = f'gas: {self.call_gas}' if self.call_gas else ''
-            value = f'value: {self.call_value}' if self.call_value else ''
-            salt = f'salt: {self.call_salt}' if self.call_salt else ''
+            gas = f"gas: {self.call_gas}" if self.call_gas else ""
+            value = f"value: {self.call_value}" if self.call_value else ""
+            salt = f"salt: {self.call_salt}" if self.call_salt else ""
             if gas or value or salt:
                 options = [gas, value, salt]
-                txt += '{' + ','.join([o for o in options if o != '']) + '}'
-        return txt + '(' + ','.join([str(a) for a in self._arguments]) + ')'
+                txt += "{" + ",".join([o for o in options if o != ""]) + "}"
+        return txt + "(" + ",".join([str(a) for a in self._arguments]) + ")"

slither/core/expressions/conditional_expression.py

@@ -1,32 +1,40 @@
+from typing import List
+
 from .expression import Expression
 
-class ConditionalExpression(Expression):
 
+class ConditionalExpression(Expression):
     def __init__(self, if_expression, then_expression, else_expression):
         assert isinstance(if_expression, Expression)
         assert isinstance(then_expression, Expression)
         assert isinstance(else_expression, Expression)
         super(ConditionalExpression, self).__init__()
-        self._if_expression = if_expression
-        self._then_expression = then_expression
-        self._else_expression = else_expression
+        self._if_expression: Expression = if_expression
+        self._then_expression: Expression = then_expression
+        self._else_expression: Expression = else_expression
 
     @property
-    def expressions(self):
+    def expressions(self) -> List[Expression]:
         return [self._if_expression, self._then_expression, self._else_expression]
 
     @property
-    def if_expression(self):
+    def if_expression(self) -> Expression:
         return self._if_expression
 
     @property
-    def else_expression(self):
+    def else_expression(self) -> Expression:
         return self._else_expression
 
     @property
-    def then_expression(self):
+    def then_expression(self) -> Expression:
         return self._then_expression
 
     def __str__(self):
-       return 'if ' + str(self._if_expression) + ' then ' + str(self._then_expression) + ' else ' + str(self._else_expression)
-
+        return (
+            "if "
+            + str(self._if_expression)
+            + " then "
+            + str(self._then_expression)
+            + " else "
+            + str(self._else_expression)
+        )

slither/core/expressions/elementary_type_name_expression.py

@@ -4,17 +4,16 @@
 from slither.core.expressions.expression import Expression
 from slither.core.solidity_types.type import Type
 
-class ElementaryTypeNameExpression(Expression):
 
+class ElementaryTypeNameExpression(Expression):
     def __init__(self, t):
         assert isinstance(t, Type)
         super(ElementaryTypeNameExpression, self).__init__()
         self._type = t
 
     @property
-    def type(self):
+    def type(self) -> Type:
         return self._type
 
     def __str__(self):
         return str(self._type)
-

slither/core/expressions/expression.py

@@ -1,15 +1,14 @@
 from slither.core.source_mapping.source_mapping import SourceMapping
 
-class Expression( SourceMapping):
 
+class Expression(SourceMapping):
     def __init__(self):
         super(Expression, self).__init__()
         self._is_lvalue = False
 
     @property
-    def is_lvalue(self):
+    def is_lvalue(self) -> bool:
         return self._is_lvalue
 
     def set_lvalue(self):
         self._is_lvalue = True
-

slither/core/expressions/expression_typed.py

@@ -1,13 +1,16 @@
+from typing import Optional, TYPE_CHECKING
 
 from .expression import Expression
 
-class ExpressionTyped(Expression):
+if TYPE_CHECKING:
+    from ..solidity_types.type import Type
+
 
+class ExpressionTyped(Expression):
     def __init__(self):
         super(ExpressionTyped, self).__init__()
-        self._type = None
+        self._type: Optional["Type"] = None
 
     @property
     def type(self):
         return self._type
-

slither/core/expressions/identifier.py

@@ -1,15 +1,19 @@
+from typing import TYPE_CHECKING
+
 from slither.core.expressions.expression_typed import ExpressionTyped
 
-class Identifier(ExpressionTyped):
+if TYPE_CHECKING:
+    from slither.core.variables.variable import Variable
+
 
+class Identifier(ExpressionTyped):
     def __init__(self, value):
         super(Identifier, self).__init__()
-        self._value = value
+        self._value: "Variable" = value
 
     @property
-    def value(self):
+    def value(self) -> "Variable":
         return self._value
 
     def __str__(self):
         return str(self._value)
-

slither/core/expressions/index_access.py

@@ -1,32 +1,36 @@
+from typing import List, TYPE_CHECKING
+
 from slither.core.expressions.expression_typed import ExpressionTyped
-from slither.core.solidity_types.type import Type
 
 
-class IndexAccess(ExpressionTyped):
+if TYPE_CHECKING:
+    from slither.core.expressions.expression import Expression
+    from slither.core.solidity_types.type import Type
+
 
+class IndexAccess(ExpressionTyped):
     def __init__(self, left_expression, right_expression, index_type):
         super(IndexAccess, self).__init__()
         self._expressions = [left_expression, right_expression]
         # TODO type of undexAccess is not always a Type
-#        assert isinstance(index_type, Type)
-        self._type = index_type
+        #        assert isinstance(index_type, Type)
+        self._type: "Type" = index_type
 
     @property
-    def expressions(self):
+    def expressions(self) -> List["Expression"]:
         return self._expressions
 
     @property
-    def expression_left(self):
+    def expression_left(self) -> "Expression":
         return self._expressions[0]
 
     @property
-    def expression_right(self):
+    def expression_right(self) -> "Expression":
         return self._expressions[1]
 
     @property
-    def type(self):
+    def type(self) -> "Type":
         return self._type
 
     def __str__(self):
-        return str(self.expression_left) + '[' + str(self.expression_right) + ']'
-
+        return str(self.expression_left) + "[" + str(self.expression_right) + "]"

slither/core/expressions/literal.py

@@ -1,24 +1,29 @@
+from typing import Optional, Union, TYPE_CHECKING
+
 from slither.core.expressions.expression import Expression
 from slither.utils.arithmetic import convert_subdenomination
 
-class Literal(Expression):
+if TYPE_CHECKING:
+    from slither.core.solidity_types.type import Type
 
+
+class Literal(Expression):
     def __init__(self, value, type, subdenomination=None):
         super(Literal, self).__init__()
-        self._value = value
+        self._value: Union[int, str] = value
         self._type = type
-        self._subdenomination = subdenomination
+        self._subdenomination: Optional[str] = subdenomination
 
     @property
-    def value(self):
+    def value(self) -> Union[int, str]:
         return self._value
 
     @property
-    def type(self):
+    def type(self) -> "Type":
         return self._type
 
     @property
-    def subdenomination(self):
+    def subdenomination(self) -> Optional[str]:
         return self._subdenomination
 
     def __str__(self):

slither/core/expressions/member_access.py

@@ -1,29 +1,33 @@
+from typing import TYPE_CHECKING
+
 from slither.core.expressions.expression import Expression
 from slither.core.expressions.expression_typed import ExpressionTyped
 
+if TYPE_CHECKING:
+    from slither.core.solidity_types.type import Type
 
-class MemberAccess(ExpressionTyped):
 
+class MemberAccess(ExpressionTyped):
     def __init__(self, member_name, member_type, expression):
         # assert isinstance(member_type, Type)
         # TODO member_type is not always a Type
         assert isinstance(expression, Expression)
         super(MemberAccess, self).__init__()
-        self._type = member_type
-        self._member_name = member_name
-        self._expression = expression
+        self._type: "Type" = member_type
+        self._member_name: str = member_name
+        self._expression: Expression = expression
 
     @property
-    def expression(self):
+    def expression(self) -> Expression:
         return self._expression
 
     @property
-    def member_name(self):
+    def member_name(self) -> str:
         return self._member_name
 
     @property
-    def type(self):
+    def type(self) -> "Type":
         return self._type
 
     def __str__(self):
-        return str(self.expression) + '.' + self.member_name
+        return str(self.expression) + "." + self.member_name

slither/core/expressions/new_array.py

@@ -1,23 +1,23 @@
 from slither.core.expressions.expression import Expression
 from slither.core.solidity_types.type import Type
 
+
 class NewArray(Expression):
 
     # note: dont conserve the size of the array if provided
     def __init__(self, depth, array_type):
         super(NewArray, self).__init__()
         assert isinstance(array_type, Type)
-        self._depth = depth
-        self._array_type = array_type
+        self._depth: int = depth
+        self._array_type: Type = array_type
 
     @property
-    def array_type(self):
+    def array_type(self) -> Type:
         return self._array_type
 
     @property
-    def depth(self):
+    def depth(self) -> int:
         return self._depth
 
     def __str__(self):
-        return 'new ' + str(self._array_type) + '[]'* self._depth
-
+        return "new " + str(self._array_type) + "[]" * self._depth

slither/core/expressions/new_contract.py

@@ -1,17 +1,16 @@
 from .expression import Expression
 
-class NewContract(Expression):
 
+class NewContract(Expression):
     def __init__(self, contract_name):
         super(NewContract, self).__init__()
-        self._contract_name = contract_name
+        self._contract_name: str = contract_name
         self._gas = None
         self._value = None
         self._salt = None
 
-
     @property
-    def contract_name(self):
+    def contract_name(self) -> str:
         return self._contract_name
 
     @property
@@ -30,7 +29,5 @@ class NewContract(Expression):
     def call_salt(self, salt):
         self._salt = salt
 
-
     def __str__(self):
-        return 'new ' + str(self._contract_name)
-
+        return "new " + str(self._contract_name)

slither/core/expressions/new_elementary_type.py

@@ -1,17 +1,16 @@
 from slither.core.expressions.expression import Expression
 from slither.core.solidity_types.elementary_type import ElementaryType
 
-class NewElementaryType(Expression):
 
+class NewElementaryType(Expression):
     def __init__(self, new_type):
         assert isinstance(new_type, ElementaryType)
         super(NewElementaryType, self).__init__()
         self._type = new_type
 
     @property
-    def type(self):
+    def type(self) -> ElementaryType:
         return self._type
 
     def __str__(self):
-        return 'new ' + str(self._type)
-
+        return "new " + str(self._type)

slither/core/expressions/super_call_expression.py

@@ -1,4 +1,6 @@
 from slither.core.expressions.expression import Expression
 from slither.core.expressions.call_expression import CallExpression
 
-class SuperCallExpression(CallExpression): pass
+
+class SuperCallExpression(CallExpression):
+    pass

slither/core/expressions/super_identifier.py

@@ -1,8 +1,6 @@
-from slither.core.expressions.expression_typed import ExpressionTyped
 from slither.core.expressions.identifier import Identifier
 
-class SuperIdentifier(Identifier):
 
+class SuperIdentifier(Identifier):
     def __str__(self):
-        return 'super.' + str(self._value)
-
+        return "super." + str(self._value)

slither/core/expressions/tuple_expression.py

@@ -1,17 +1,18 @@
+from typing import List
+
 from slither.core.expressions.expression import Expression
 
-class TupleExpression(Expression):
 
+class TupleExpression(Expression):
     def __init__(self, expressions):
         assert all(isinstance(x, Expression) for x in expressions if x)
         super(TupleExpression, self).__init__()
         self._expressions = expressions
 
     @property
-    def expressions(self):
+    def expressions(self) -> List[Expression]:
         return self._expressions
 
     def __str__(self):
         expressions_str = [str(e) for e in self.expressions]
-        return '(' + ','.join(expressions_str) + ')'
-
+        return "(" + ",".join(expressions_str) + ")"

slither/core/expressions/type_conversion.py

@@ -4,18 +4,16 @@ from slither.core.solidity_types.type import Type
 
 
 class TypeConversion(ExpressionTyped):
-
     def __init__(self, expression, expression_type):
         super(TypeConversion, self).__init__()
         assert isinstance(expression, Expression)
         assert isinstance(expression_type, Type)
-        self._expression = expression
-        self._type = expression_type
+        self._expression: Expression = expression
+        self._type: Type = expression_type
 
     @property
-    def expression(self):
+    def expression(self) -> Expression:
         return self._expression
 
     def __str__(self):
-        return str(self.type) + '(' + str(self.expression) + ')'
-
+        return str(self.type) + "(" + str(self.expression) + ")"

slither/core/expressions/unary_operation.py

@@ -1,114 +1,121 @@
 import logging
+from enum import Enum
+
 from slither.core.expressions.expression_typed import ExpressionTyped
 from slither.core.expressions.expression import Expression
 from slither.core.exceptions import SlitherCoreError
 
 logger = logging.getLogger("UnaryOperation")
 
-class UnaryOperationType:
-    BANG =              0 # ! 
-    TILD =              1 # ~ 
-    DELETE =            2 # delete
-    PLUSPLUS_PRE =      3 # ++ 
-    MINUSMINUS_PRE =    4 # --
-    PLUSPLUS_POST =     5 # ++
-    MINUSMINUS_POST =   6 # --
-    PLUS_PRE =          7 # for stuff like uint(+1)
-    MINUS_PRE =         8 # for stuff like uint(-1)
+
+class UnaryOperationType(Enum):
+    BANG = 0  # !
+    TILD = 1  # ~
+    DELETE = 2  # delete
+    PLUSPLUS_PRE = 3  # ++
+    MINUSMINUS_PRE = 4  # --
+    PLUSPLUS_POST = 5  # ++
+    MINUSMINUS_POST = 6  # --
+    PLUS_PRE = 7  # for stuff like uint(+1)
+    MINUS_PRE = 8  # for stuff like uint(-1)
 
     @staticmethod
     def get_type(operation_type, isprefix):
         if isprefix:
-            if operation_type == '!':
+            if operation_type == "!":
                 return UnaryOperationType.BANG
-            if operation_type == '~':
+            if operation_type == "~":
                 return UnaryOperationType.TILD
-            if operation_type == 'delete':
+            if operation_type == "delete":
                 return UnaryOperationType.DELETE
-            if operation_type == '++':
+            if operation_type == "++":
                 return UnaryOperationType.PLUSPLUS_PRE
-            if operation_type == '--':
+            if operation_type == "--":
                 return UnaryOperationType.MINUSMINUS_PRE
-            if operation_type == '+':
+            if operation_type == "+":
                 return UnaryOperationType.PLUS_PRE
-            if operation_type == '-':
+            if operation_type == "-":
                 return UnaryOperationType.MINUS_PRE
         else:
-            if operation_type == '++':
+            if operation_type == "++":
                 return UnaryOperationType.PLUSPLUS_POST
-            if operation_type == '--':
+            if operation_type == "--":
                 return UnaryOperationType.MINUSMINUS_POST
-        raise SlitherCoreError('get_type: Unknown operation type {}'.format(operation_type))
+        raise SlitherCoreError("get_type: Unknown operation type {}".format(operation_type))
 
-    @staticmethod
-    def str(operation_type):
-        if operation_type == UnaryOperationType.BANG:
-            return '!'
-        if operation_type == UnaryOperationType.TILD:
-            return '~'
-        if operation_type == UnaryOperationType.DELETE:
-            return 'delete'
-        if operation_type == UnaryOperationType.PLUS_PRE:
-            return '+'
-        if operation_type == UnaryOperationType.MINUS_PRE:
-            return '-'
-        if operation_type in [UnaryOperationType.PLUSPLUS_PRE, UnaryOperationType.PLUSPLUS_POST]:
-            return '++'
-        if operation_type in [UnaryOperationType.MINUSMINUS_PRE, UnaryOperationType.MINUSMINUS_POST]:
-            return '--'
+    def __str__(self):
+        if self == UnaryOperationType.BANG:
+            return "!"
+        if self == UnaryOperationType.TILD:
+            return "~"
+        if self == UnaryOperationType.DELETE:
+            return "delete"
+        if self == UnaryOperationType.PLUS_PRE:
+            return "+"
+        if self == UnaryOperationType.MINUS_PRE:
+            return "-"
+        if self in [UnaryOperationType.PLUSPLUS_PRE, UnaryOperationType.PLUSPLUS_POST]:
+            return "++"
+        if self in [
+            UnaryOperationType.MINUSMINUS_PRE,
+            UnaryOperationType.MINUSMINUS_POST,
+        ]:
+            return "--"
 
-        raise SlitherCoreError('str: Unknown operation type {}'.format(operation_type))
+        raise SlitherCoreError("str: Unknown operation type {}".format(self))
 
     @staticmethod
     def is_prefix(operation_type):
-        if operation_type in [UnaryOperationType.BANG,
-                              UnaryOperationType.TILD,
-                              UnaryOperationType.DELETE,
-                              UnaryOperationType.PLUSPLUS_PRE,
-                              UnaryOperationType.MINUSMINUS_PRE,
-                              UnaryOperationType.PLUS_PRE,
-                              UnaryOperationType.MINUS_PRE]:
+        if operation_type in [
+            UnaryOperationType.BANG,
+            UnaryOperationType.TILD,
+            UnaryOperationType.DELETE,
+            UnaryOperationType.PLUSPLUS_PRE,
+            UnaryOperationType.MINUSMINUS_PRE,
+            UnaryOperationType.PLUS_PRE,
+            UnaryOperationType.MINUS_PRE,
+        ]:
             return True
-        elif operation_type in [UnaryOperationType.PLUSPLUS_POST, UnaryOperationType.MINUSMINUS_POST]:
+        elif operation_type in [
+            UnaryOperationType.PLUSPLUS_POST,
+            UnaryOperationType.MINUSMINUS_POST,
+        ]:
             return False
 
-        raise SlitherCoreError('is_prefix: Unknown operation type {}'.format(operation_type))
+        raise SlitherCoreError("is_prefix: Unknown operation type {}".format(operation_type))
 
-class UnaryOperation(ExpressionTyped):
 
+class UnaryOperation(ExpressionTyped):
     def __init__(self, expression, expression_type):
         assert isinstance(expression, Expression)
         super(UnaryOperation, self).__init__()
-        self._expression = expression
-        self._type = expression_type
-        if expression_type in [UnaryOperationType.DELETE,
-                               UnaryOperationType.PLUSPLUS_PRE,
-                               UnaryOperationType.MINUSMINUS_PRE,
-                               UnaryOperationType.PLUSPLUS_POST,
-                               UnaryOperationType.MINUSMINUS_POST,
-                               UnaryOperationType.PLUS_PRE,
-                               UnaryOperationType.MINUS_PRE]:
+        self._expression: Expression = expression
+        self._type: UnaryOperationType = expression_type
+        if expression_type in [
+            UnaryOperationType.DELETE,
+            UnaryOperationType.PLUSPLUS_PRE,
+            UnaryOperationType.MINUSMINUS_PRE,
+            UnaryOperationType.PLUSPLUS_POST,
+            UnaryOperationType.MINUSMINUS_POST,
+            UnaryOperationType.PLUS_PRE,
+            UnaryOperationType.MINUS_PRE,
+        ]:
             expression.set_lvalue()
 
     @property
-    def expression(self):
+    def expression(self) -> Expression:
         return self._expression
 
     @property
-    def type_str(self):
-        return UnaryOperationType.str(self._type)
-
-    @property
-    def type(self):
+    def type(self) -> UnaryOperationType:
         return self._type
 
     @property
-    def is_prefix(self):
+    def is_prefix(self) -> bool:
         return UnaryOperationType.is_prefix(self._type)
 
     def __str__(self):
         if self.is_prefix:
-            return self.type_str + ' ' + str(self._expression)
+            return str(self.type) + " " + str(self._expression)
         else:
-            return str(self._expression) + ' ' + self.type_str
-
+            return str(self._expression) + " " + str(self.type)

slither/core/slither_core.py

@@ -6,39 +6,47 @@ import logging
 import json
 import re
 from collections import defaultdict
+from typing import Optional, Dict, List, Set, Union
+
+from crytic_compile import CryticCompile
 
 from slither.core.context.context import Context
+from slither.core.declarations import Contract, Pragma, Import, Function, Modifier
+from slither.core.variables.state_variable import StateVariable
 from slither.slithir.operations import InternalCall
+from slither.slithir.variables import Constant
 from slither.utils.colors import red
 
 logger = logging.getLogger("Slither")
 logging.basicConfig()
 
-class Slither(Context):
+
+class SlitherCore(Context):
     """
     Slither static analyzer
     """
 
     def __init__(self):
-        super(Slither, self).__init__()
-        self._contracts = {}
-        self._filename = None
-        self._source_units = {}
-        self._solc_version = None  # '0.3' or '0.4':!
-        self._pragma_directives = []
-        self._import_directives = []
-        self._raw_source_code = {}
-        self._all_functions = set()
-        self._all_modifiers = set()
-        self._all_state_variables = None
-
-        self._previous_results_filename = 'slither.db.json'
-        self._results_to_hide = []
-        self._previous_results = []
-        self._previous_results_ids = set()
-        self._paths_to_filter = set()
-
-        self._crytic_compile = None
+        super(SlitherCore, self).__init__()
+        self._contracts: Dict[str, Contract] = {}
+        self._filename: Optional[str] = None
+        self._source_units: Dict[int, str] = {}
+        self._solc_version: Optional[str] = None  # '0.3' or '0.4':!
+        self._pragma_directives: List[Pragma] = []
+        self._import_directives: List[Import] = []
+        self._raw_source_code: Dict[str, str] = {}
+        self._all_functions: Set[Function] = set()
+        self._all_modifiers: Set[Modifier] = set()
+        # Memoize
+        self._all_state_variables: Optional[Set[StateVariable]] = None
+
+        self._previous_results_filename: str = "slither.db.json"
+        self._results_to_hide: List = []
+        self._previous_results: List = []
+        self._previous_results_ids: Set[str] = set()
+        self._paths_to_filter: Set[str] = set()
+
+        self._crytic_compile: Optional[CryticCompile] = None
 
         self._generate_patches = False
         self._exclude_dependencies = False
@@ -55,20 +63,24 @@ class Slither(Context):
     ###################################################################################
 
     @property
-    def source_code(self):
+    def source_code(self) -> Dict[str, str]:
         """ {filename: source_code (str)}: source code """
         return self._raw_source_code
 
     @property
-    def source_units(self):
+    def source_units(self) -> Dict[int, str]:
         return self._source_units
 
     @property
-    def filename(self):
+    def filename(self) -> Optional[str]:
         """str: Filename."""
         return self._filename
 
-    def _add_source_code(self, path):
+    @filename.setter
+    def filename(self, filename: str):
+        self._filename = filename
+
+    def add_source_code(self, path):
         """
         :param path:
         :return:
@@ -76,11 +88,11 @@ class Slither(Context):
         if self.crytic_compile and path in self.crytic_compile.src_content:
             self.source_code[path] = self.crytic_compile.src_content[path]
         else:
-            with open(path, encoding='utf8', newline='') as f:
+            with open(path, encoding="utf8", newline="") as f:
                 self.source_code[path] = f.read()
 
     @property
-    def markdown_root(self):
+    def markdown_root(self) -> str:
         return self._markdown_root
 
     # endregion
@@ -91,19 +103,19 @@ class Slither(Context):
     ###################################################################################
 
     @property
-    def solc_version(self):
+    def solc_version(self) -> str:
         """str: Solidity version."""
         if self.crytic_compile:
             return self.crytic_compile.compiler_version.version
         return self._solc_version
 
     @property
-    def pragma_directives(self):
+    def pragma_directives(self) -> List[Pragma]:
         """ list(core.declarations.Pragma): Pragma directives."""
         return self._pragma_directives
 
     @property
-    def import_directives(self):
+    def import_directives(self) -> List[Import]:
         """ list(core.declarations.Import): Import directives"""
         return self._import_directives
 
@@ -115,22 +127,23 @@ class Slither(Context):
     ###################################################################################
 
     @property
-    def contracts(self):
+    def contracts(self) -> List[Contract]:
         """list(Contract): List of contracts."""
         return list(self._contracts.values())
 
     @property
-    def contracts_derived(self):
+    def contracts_derived(self) -> List[Contract]:
         """list(Contract): List of contracts that are derived and not inherited."""
         inheritance = (x.inheritance for x in self.contracts)
         inheritance = [item for sublist in inheritance for item in sublist]
         return [c for c in self._contracts.values() if c not in inheritance]
 
-    def contracts_as_dict(self):
+    @property
+    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):
+    def get_contract_from_name(self, contract_name: Union[str, Constant]) -> Optional[Contract]:
         """
             Return a contract from a name
         Args:
@@ -148,24 +161,24 @@ class Slither(Context):
     ###################################################################################
 
     @property
-    def functions(self):
+    def functions(self) -> List[Function]:
         return list(self._all_functions)
 
-    def add_function(self, func):
+    def add_function(self, func: Function):
         self._all_functions.add(func)
 
     @property
-    def modifiers(self):
+    def modifiers(self) -> List[Modifier]:
         return list(self._all_modifiers)
 
-    def add_modifier(self, modif):
+    def add_modifier(self, modif: Modifier):
         self._all_modifiers.add(modif)
 
     @property
-    def functions_and_modifiers(self):
+    def functions_and_modifiers(self) -> List[Function]:
         return self.functions + self.modifiers
 
-    def _propagate_function_calls(self):
+    def propagate_function_calls(self):
         for f in self.functions_and_modifiers:
             for node in f.nodes:
                 for ir in node.irs_ssa:
@@ -180,7 +193,7 @@ class Slither(Context):
     ###################################################################################
 
     @property
-    def state_variables(self):
+    def state_variables(self) -> List[StateVariable]:
         if self._all_state_variables is None:
             state_variables = [c.state_variables for c in self.contracts]
             state_variables = [item for sublist in state_variables for item in sublist]
@@ -194,13 +207,13 @@ class Slither(Context):
     ###################################################################################
     ###################################################################################
 
-    def print_functions(self, d):
+    def print_functions(self, d: str):
         """
             Export all the functions to dot files
         """
         for c in self.contracts:
             for f in c.functions:
-                f.cfg_to_dot(os.path.join(d, '{}.{}.dot'.format(c.name, f.name)))
+                f.cfg_to_dot(os.path.join(d, "{}.{}.dot".format(c.name, f.name)))
 
     # endregion
     ###################################################################################
@@ -209,44 +222,53 @@ class Slither(Context):
     ###################################################################################
     ###################################################################################
 
-    def relative_path_format(self, path):
+    def relative_path_format(self, path: str) -> str:
         """
            Strip relative paths of "." and ".."
         """
-        return path.split('..')[-1].strip('.').strip('/')
+        return path.split("..")[-1].strip(".").strip("/")
 
-    def valid_result(self, r):
-        '''
+    def valid_result(self, r: Dict) -> bool:
+        """
             Check if the result is valid
             A result is invalid if:
                 - All its source paths belong to the source path filtered
                 - Or a similar result was reported and saved during a previous run
                 - The --exclude-dependencies flag is set and results are only related to dependencies
-        '''
-        source_mapping_elements = [elem['source_mapping']['filename_absolute']
-                                   for elem in r['elements'] if 'source_mapping' in elem]
-        source_mapping_elements = map(lambda x: os.path.normpath(x) if x else x, source_mapping_elements)
+        """
+        source_mapping_elements = [
+            elem["source_mapping"]["filename_absolute"]
+            for elem in r["elements"]
+            if "source_mapping" in elem
+        ]
+        source_mapping_elements = map(
+            lambda x: os.path.normpath(x) if x else x, source_mapping_elements
+        )
         matching = False
 
         for path in self._paths_to_filter:
             try:
-                if any(bool(re.search(self.relative_path_format(path), src_mapping))
-                       for src_mapping in source_mapping_elements):
+                if any(
+                    bool(re.search(self.relative_path_format(path), src_mapping))
+                    for src_mapping in source_mapping_elements
+                ):
                     matching = True
                     break
             except re.error:
-                logger.error(f'Incorrect regular expression for --filter-paths {path}.'
-                             '\nSlither supports the Python re format'
-                             ': https://docs.python.org/3/library/re.html')
+                logger.error(
+                    f"Incorrect regular expression for --filter-paths {path}."
+                    "\nSlither supports the Python re format"
+                    ": https://docs.python.org/3/library/re.html"
+                )
 
-        if r['elements'] and matching:
+        if r["elements"] and matching:
             return False
-        if r['elements'] and self._exclude_dependencies:
-            return not all(element['source_mapping']['is_dependency'] for element in r['elements'])
-        if r['id'] in self._previous_results_ids:
+        if r["elements"] and self._exclude_dependencies:
+            return not all(element["source_mapping"]["is_dependency"] for element in r["elements"])
+        if r["id"] in self._previous_results_ids:
             return False
         # Conserve previous result filtering. This is conserved for compatibility, but is meant to be removed
-        return not r['description'] in [pr['description'] for pr in self._previous_results]
+        return not r["description"] in [pr["description"] for pr in self._previous_results]
 
     def load_previous_results(self):
         filename = self._previous_results_filename
@@ -256,27 +278,29 @@ class Slither(Context):
                     self._previous_results = json.load(f)
                     if self._previous_results:
                         for r in self._previous_results:
-                            if 'id' in r:
-                                self._previous_results_ids.add(r['id'])
+                            if "id" in r:
+                                self._previous_results_ids.add(r["id"])
         except json.decoder.JSONDecodeError:
-            logger.error(red('Impossible to decode {}. Consider removing the file'.format(filename)))
+            logger.error(
+                red("Impossible to decode {}. Consider removing the file".format(filename))
+            )
 
     def write_results_to_hide(self):
         if not self._results_to_hide:
             return
         filename = self._previous_results_filename
-        with open(filename, 'w', encoding='utf8') as f:
+        with open(filename, "w", encoding="utf8") as f:
             results = self._results_to_hide + self._previous_results
             json.dump(results, f)
 
-    def save_results_to_hide(self, results):
+    def save_results_to_hide(self, results: List[Dict]):
         self._results_to_hide += results
 
-    def add_path_to_filter(self, path):
-        '''
+    def add_path_to_filter(self, path: str):
+        """
             Add path to filter
             Path are used through direct comparison (no regex)
-        '''
+        """
         self._paths_to_filter.add(path)
 
     # endregion
@@ -287,7 +311,7 @@ class Slither(Context):
     ###################################################################################
 
     @property
-    def crytic_compile(self):
+    def crytic_compile(self) -> Optional[CryticCompile]:
         return self._crytic_compile
 
     # endregion
@@ -298,14 +322,13 @@ class Slither(Context):
     ###################################################################################
 
     @property
-    def generate_patches(self):
+    def generate_patches(self) -> bool:
         return self._generate_patches
 
     @generate_patches.setter
-    def generate_patches(self, p):
+    def generate_patches(self, p: bool):
         self._generate_patches = p
 
-
     # endregion
     ###################################################################################
     ###################################################################################
@@ -314,10 +337,11 @@ class Slither(Context):
     ###################################################################################
 
     @property
-    def contract_name_collisions(self):
+    def contract_name_collisions(self) -> Dict:
         return self._contract_name_collisions
 
     @property
-    def contracts_with_missing_inheritance(self):
+    def contracts_with_missing_inheritance(self) -> Set:
         return self._contract_with_missing_inheritance
+
     # endregion

slither/core/solidity_types/array_type.py

@@ -1,20 +1,21 @@
-from slither.core.variables.variable import Variable
-from slither.core.solidity_types.type import Type
-from slither.core.expressions.expression import Expression
+from typing import Optional
+
 from slither.core.expressions import Literal
+from slither.core.expressions.expression import Expression
+from slither.core.solidity_types.type import Type
 from slither.visitors.expression.constants_folding import ConstantFolding
 
-class ArrayType(Type):
 
+class ArrayType(Type):
     def __init__(self, t, length):
         assert isinstance(t, Type)
         if length:
             if isinstance(length, int):
-                length = Literal(length, 'uint256')
+                length = Literal(length, "uint256")
             assert isinstance(length, Expression)
         super(ArrayType, self).__init__()
-        self._type = t
-        self._length = length
+        self._type: Type = t
+        self._length: Optional[Expression] = length
 
         if length:
             if not isinstance(length, Literal):
@@ -25,18 +26,21 @@ class ArrayType(Type):
             self._length_value = None
 
     @property
-    def type(self):
+    def type(self) -> Type:
         return self._type
 
     @property
-    def length(self):
+    def length(self) -> Optional[Expression]:
         return self._length
 
+    @property
+    def lenght_value(self) -> Optional[Literal]:
+        return self._length_value
+
     def __str__(self):
         if self._length:
-            return str(self._type)+'[{}]'.format(str(self._length_value))
-        return str(self._type)+'[]'
-
+            return str(self._type) + "[{}]".format(str(self._length_value))
+        return str(self._type) + "[]"
 
     def __eq__(self, other):
         if not isinstance(other, ArrayType):

slither/core/solidity_types/elementary_type.py

@@ -1,69 +1,175 @@
 import itertools
+from typing import Optional
 
 from slither.core.solidity_types.type import Type
 
 
 # see https://solidity.readthedocs.io/en/v0.4.24/miscellaneous.html?highlight=grammar
 
-Int = ['int', 'int8', 'int16', 'int24', 'int32', 'int40', 'int48', 'int56', 'int64', 'int72', 'int80', 'int88', 'int96', 'int104', 'int112', 'int120', 'int128', 'int136', 'int144', 'int152', 'int160', 'int168', 'int176', 'int184', 'int192', 'int200', 'int208', 'int216', 'int224', 'int232', 'int240', 'int248', 'int256']
-
-Uint = ['uint', 'uint8', 'uint16', 'uint24', 'uint32', 'uint40', 'uint48', 'uint56', 'uint64', 'uint72', 'uint80', 'uint88', 'uint96', 'uint104', 'uint112', 'uint120', 'uint128', 'uint136', 'uint144', 'uint152', 'uint160', 'uint168', 'uint176', 'uint184', 'uint192', 'uint200', 'uint208', 'uint216', 'uint224', 'uint232', 'uint240', 'uint248', 'uint256']
-
-Byte = ['byte', 'bytes', 'bytes1', 'bytes2', 'bytes3', 'bytes4', 'bytes5', 'bytes6', 'bytes7', 'bytes8', 'bytes9', 'bytes10', 'bytes11', 'bytes12', 'bytes13', 'bytes14', 'bytes15', 'bytes16', 'bytes17', 'bytes18', 'bytes19', 'bytes20', 'bytes21', 'bytes22', 'bytes23', 'bytes24', 'bytes25', 'bytes26', 'bytes27', 'bytes28', 'bytes29', 'bytes30', 'bytes31', 'bytes32']
+Int = [
+    "int",
+    "int8",
+    "int16",
+    "int24",
+    "int32",
+    "int40",
+    "int48",
+    "int56",
+    "int64",
+    "int72",
+    "int80",
+    "int88",
+    "int96",
+    "int104",
+    "int112",
+    "int120",
+    "int128",
+    "int136",
+    "int144",
+    "int152",
+    "int160",
+    "int168",
+    "int176",
+    "int184",
+    "int192",
+    "int200",
+    "int208",
+    "int216",
+    "int224",
+    "int232",
+    "int240",
+    "int248",
+    "int256",
+]
+
+Uint = [
+    "uint",
+    "uint8",
+    "uint16",
+    "uint24",
+    "uint32",
+    "uint40",
+    "uint48",
+    "uint56",
+    "uint64",
+    "uint72",
+    "uint80",
+    "uint88",
+    "uint96",
+    "uint104",
+    "uint112",
+    "uint120",
+    "uint128",
+    "uint136",
+    "uint144",
+    "uint152",
+    "uint160",
+    "uint168",
+    "uint176",
+    "uint184",
+    "uint192",
+    "uint200",
+    "uint208",
+    "uint216",
+    "uint224",
+    "uint232",
+    "uint240",
+    "uint248",
+    "uint256",
+]
+
+Byte = [
+    "byte",
+    "bytes",
+    "bytes1",
+    "bytes2",
+    "bytes3",
+    "bytes4",
+    "bytes5",
+    "bytes6",
+    "bytes7",
+    "bytes8",
+    "bytes9",
+    "bytes10",
+    "bytes11",
+    "bytes12",
+    "bytes13",
+    "bytes14",
+    "bytes15",
+    "bytes16",
+    "bytes17",
+    "bytes18",
+    "bytes19",
+    "bytes20",
+    "bytes21",
+    "bytes22",
+    "bytes23",
+    "bytes24",
+    "bytes25",
+    "bytes26",
+    "bytes27",
+    "bytes28",
+    "bytes29",
+    "bytes30",
+    "bytes31",
+    "bytes32",
+]
 
 # https://solidity.readthedocs.io/en/v0.4.24/types.html#fixed-point-numbers
 M = list(range(8, 257, 8))
 N = list(range(0, 81))
-MN = list(itertools.product(M,N))
+MN = list(itertools.product(M, N))
 
-Fixed = ['fixed{}x{}'.format(m,n) for (m,n) in MN] + ['fixed']
-Ufixed = ['ufixed{}x{}'.format(m,n) for (m,n) in MN] + ['ufixed']
+Fixed = ["fixed{}x{}".format(m, n) for (m, n) in MN] + ["fixed"]
+Ufixed = ["ufixed{}x{}".format(m, n) for (m, n) in MN] + ["ufixed"]
 
-ElementaryTypeName = ['address', 'bool', 'string', 'var'] + Int + Uint + Byte + Fixed + Ufixed
+ElementaryTypeName = ["address", "bool", "string", "var"] + Int + Uint + Byte + Fixed + Ufixed
 
-class NonElementaryType(Exception): pass
 
-class ElementaryType(Type):
+class NonElementaryType(Exception):
+    pass
 
+
+class ElementaryType(Type):
     def __init__(self, t):
         if t not in ElementaryTypeName:
             raise NonElementaryType
         super(ElementaryType, self).__init__()
-        if t == 'uint':
-            t = 'uint256'
-        elif t == 'int':
-            t = 'int256'
-        elif t == 'byte':
-            t = 'bytes1'
+        if t == "uint":
+            t = "uint256"
+        elif t == "int":
+            t = "int256"
+        elif t == "byte":
+            t = "bytes1"
         self._type = t
 
     @property
-    def type(self):
+    def type(self) -> str:
         return self._type
 
     @property
-    def name(self):
+    def name(self) -> str:
         return self.type
 
     @property
-    def size(self):
-        '''
+    def size(self) -> Optional[int]:
+        """
             Return the size in bits
             Return None if the size is not known
         Returns:
             int
-        '''
+        """
         t = self._type
-        if t.startswith('uint'):
-            return int(t[len('uint'):])
-        if t.startswith('int'):
-            return int(t[len('int'):])
-        if t == 'bool':
+        if t.startswith("uint"):
+            return int(t[len("uint") :])
+        if t.startswith("int"):
+            return int(t[len("int") :])
+        if t == "bool":
             return int(8)
-        if t == 'address':
+        if t == "address":
             return int(160)
-        if t.startswith('bytes'):
-            return int(t[len('bytes'):])
+        if t.startswith("bytes"):
+            return int(t[len("bytes") :])
         return None
 
     def __str__(self):
@@ -76,4 +182,3 @@ class ElementaryType(Type):
 
     def __hash__(self):
         return hash(str(self))
-

slither/core/solidity_types/function_type.py

@@ -1,25 +1,29 @@
+from typing import List
+
 from slither.core.solidity_types.type import Type
 from slither.core.variables.function_type_variable import FunctionTypeVariable
 
-class FunctionType(Type):
 
-    def __init__(self, params, return_values):
+class FunctionType(Type):
+    def __init__(
+        self, params: List[FunctionTypeVariable], return_values: List[FunctionTypeVariable]
+    ):
         assert all(isinstance(x, FunctionTypeVariable) for x in params)
         assert all(isinstance(x, FunctionTypeVariable) for x in return_values)
         super(FunctionType, self).__init__()
-        self._params = params
-        self._return_values = return_values
+        self._params: List[FunctionTypeVariable] = params
+        self._return_values: List[FunctionTypeVariable] = return_values
 
     @property
-    def params(self):
+    def params(self) -> List[FunctionTypeVariable]:
         return self._params
 
     @property
-    def return_values(self):
+    def return_values(self) -> List[FunctionTypeVariable]:
         return self._return_values
 
     @property
-    def return_type(self):
+    def return_type(self) -> List[Type]:
         return [x.type for x in self.return_values]
 
     def __str__(self):
@@ -28,33 +32,31 @@ class FunctionType(Type):
         params = ",".join([str(x.type) for x in self._params])
         return_values = ",".join([str(x.type) for x in self._return_values])
         if return_values:
-            return 'function({}) returns({})'.format(params, return_values)
-        return 'function({})'.format(params)
+            return "function({}) returns({})".format(params, return_values)
+        return "function({})".format(params)
 
     @property
-    def parameters_signature(self):
-        '''
+    def parameters_signature(self) -> str:
+        """
             Return the parameters signature(without the return statetement)
-        '''
+        """
         # Use x.type
         # x.name may be empty
         params = ",".join([str(x.type) for x in self._params])
-        return '({})'.format(params)
+        return "({})".format(params)
 
     @property
-    def signature(self):
-        '''
+    def signature(self) -> str:
+        """
             Return the signature(with the return statetement if it exists)
-        '''
+        """
         # Use x.type
         # x.name may be empty
         params = ",".join([str(x.type) for x in self._params])
         return_values = ",".join([str(x.type) for x in self._return_values])
         if return_values:
-            return '({}) returns({})'.format(params, return_values)
-        return '({})'.format(params)
-
-
+            return "({}) returns({})".format(params, return_values)
+        return "({})".format(params)
 
     def __eq__(self, other):
         if not isinstance(other, FunctionType):

slither/core/solidity_types/mapping_type.py

@@ -1,7 +1,7 @@
 from slither.core.solidity_types.type import Type
 
-class MappingType(Type):
 
+class MappingType(Type):
     def __init__(self, type_from, type_to):
         assert isinstance(type_from, Type)
         assert isinstance(type_to, Type)
@@ -10,15 +10,15 @@ class MappingType(Type):
         self._to = type_to
 
     @property
-    def type_from(self):
+    def type_from(self) -> Type:
         return self._from
 
     @property
-    def type_to(self):
+    def type_to(self) -> Type:
         return self._to
 
     def __str__(self):
-        return 'mapping({} => {})'.format(str(self._from), str(self._to))
+        return "mapping({} => {})".format(str(self._from), str(self._to))
 
     def __eq__(self, other):
         if not isinstance(other, MappingType):
@@ -27,4 +27,3 @@ class MappingType(Type):
 
     def __hash__(self):
         return hash(str(self))
-

slither/core/solidity_types/type.py

@@ -1,3 +1,5 @@
 from slither.core.source_mapping.source_mapping import SourceMapping
 
-class Type(SourceMapping): pass
+
+class Type(SourceMapping):
+    pass

slither/core/solidity_types/type_information.py

@@ -1,21 +1,27 @@
+from typing import TYPE_CHECKING
+
 from slither.core.solidity_types.type import Type
 
+if TYPE_CHECKING:
+    from slither.core.declarations.contract import Contract
+
+
 # Use to model the Type(X) function, which returns an undefined type
 # https://solidity.readthedocs.io/en/latest/units-and-global-variables.html#type-information
 class TypeInformation(Type):
     def __init__(self, c):
         from slither.core.declarations.contract import Contract
 
-        assert isinstance(c, (Contract))
+        assert isinstance(c, Contract)
         super(TypeInformation, self).__init__()
         self._type = c
 
     @property
-    def type(self):
+    def type(self) -> "Contract":
         return self._type
 
     def __str__(self):
-        return f'type({self.type.name})'
+        return f"type({self.type.name})"
 
     def __eq__(self, other):
         if not isinstance(other, TypeInformation):

slither/core/solidity_types/user_defined_type.py

@@ -1,8 +1,14 @@
+from typing import Union, TYPE_CHECKING
+
 from slither.core.solidity_types.type import Type
 
+if TYPE_CHECKING:
+    from slither.core.declarations.structure import Structure
+    from slither.core.declarations.enum import Enum
+    from slither.core.declarations.contract import Contract
 
-class UserDefinedType(Type):
 
+class UserDefinedType(Type):
     def __init__(self, t):
         from slither.core.declarations.structure import Structure
         from slither.core.declarations.enum import Enum
@@ -13,7 +19,7 @@ class UserDefinedType(Type):
         self._type = t
 
     @property
-    def type(self):
+    def type(self) -> Union["Contract", "Enum", "Structure"]:
         return self._type
 
     def __str__(self):
@@ -21,7 +27,7 @@ class UserDefinedType(Type):
         from slither.core.declarations.enum import Enum
 
         if isinstance(self.type, (Enum, Structure)):
-            return str(self.type.contract)+'.'+str(self.type.name)
+            return str(self.type.contract) + "." + str(self.type.name)
         return str(self.type.name)
 
     def __eq__(self, other):
@@ -29,7 +35,5 @@ class UserDefinedType(Type):
             return False
         return self.type == other.type
 
-
     def __hash__(self):
         return hash(str(self))
-

slither/core/source_mapping/source_mapping.py

@@ -1,16 +1,17 @@
 import re
+from typing import Dict, Union, Optional
 
 from slither.core.context.context import Context
 
 
 class SourceMapping(Context):
-
     def __init__(self):
         super(SourceMapping, self).__init__()
-        self._source_mapping = None
+        # TODO create a namedtuple for the source mapping rather than a dict
+        self._source_mapping: Optional[Dict] = None
 
     @property
-    def source_mapping(self):
+    def source_mapping(self) -> Optional[Dict]:
         return self._source_mapping
 
     @staticmethod
@@ -21,7 +22,7 @@ class SourceMapping(Context):
 
             Not done in an efficient way
         """
-        source_code = source_code.encode('utf-8')
+        source_code = source_code.encode("utf-8")
         total_length = len(source_code)
         source_code = source_code.splitlines(True)
         counter = 0
@@ -38,7 +39,11 @@ class SourceMapping(Context):
             # Determine our column numbers.
             if starting_column is None and counter + line_length > start:
                 starting_column = (start - counter) + 1
-            if starting_column is not None and ending_column is None and counter + line_length > start + length:
+            if (
+                starting_column is not None
+                and ending_column is None
+                and counter + line_length > start + length
+            ):
                 ending_column = ((start + length) - counter) + 1
 
             # Advance the current position counter, and determine line numbers.
@@ -50,19 +55,19 @@ class SourceMapping(Context):
             if counter > start + length:
                 break
 
-        return (lines, starting_column, ending_column)
+        return lines, starting_column, ending_column
 
     @staticmethod
-    def _convert_source_mapping(offset, slither):
-        '''
+    def _convert_source_mapping(offset: str, slither):
+        """
         Convert a text offset to a real offset
         see https://solidity.readthedocs.io/en/develop/miscellaneous.html#source-mappings
         Returns:
             (dict): {'start':0, 'length':0, 'filename': 'file.sol'}
-        '''
+        """
         sourceUnits = slither.source_units
 
-        position = re.findall('([0-9]*):([0-9]*):([-]?[0-9]*)', offset)
+        position = re.findall("([0-9]*):([0-9]*):([-]?[0-9]*)", offset)
         if len(position) != 1:
             return {}
 
@@ -72,7 +77,7 @@ class SourceMapping(Context):
         f = int(f)
 
         if f not in sourceUnits:
-            return {'start':s, 'length':l}
+            return {"start": s, "length": l}
         filename_used = sourceUnits[f]
         filename_absolute = None
         filename_relative = None
@@ -91,7 +96,10 @@ class SourceMapping(Context):
 
             is_dependency = slither.crytic_compile.is_dependency(filename_absolute)
 
-            if filename_absolute in slither.source_code or filename_absolute in slither.crytic_compile.src_content:
+            if (
+                filename_absolute in slither.source_code
+                or filename_absolute in slither.crytic_compile.src_content
+            ):
                 filename = filename_absolute
             elif filename_relative in slither.source_code:
                 filename = filename_relative
@@ -104,51 +112,47 @@ class SourceMapping(Context):
 
         if slither.crytic_compile and filename in slither.crytic_compile.src_content:
             source_code = slither.crytic_compile.src_content[filename]
-            (lines, starting_column, ending_column) = SourceMapping._compute_line(source_code,
-                                                                                  s,
-                                                                                  l)
+            (lines, starting_column, ending_column) = SourceMapping._compute_line(source_code, s, l)
         elif filename in slither.source_code:
             source_code = slither.source_code[filename]
-            (lines, starting_column, ending_column) = SourceMapping._compute_line(source_code,
-                                                                                  s,
-                                                                                  l)
+            (lines, starting_column, ending_column) = SourceMapping._compute_line(source_code, s, l)
         else:
             (lines, starting_column, ending_column) = ([], None, None)
 
-        return {'start':s,
-                'length':l,
-                'filename_used': filename_used,
-                'filename_relative': filename_relative,
-                'filename_absolute': filename_absolute,
-                'filename_short': filename_short,
-                'is_dependency': is_dependency,
-                'lines' : lines,
-                'starting_column': starting_column,
-                'ending_column': ending_column
-                }
-
-    def set_offset(self, offset, slither):
+        return {
+            "start": s,
+            "length": l,
+            "filename_used": filename_used,
+            "filename_relative": filename_relative,
+            "filename_absolute": filename_absolute,
+            "filename_short": filename_short,
+            "is_dependency": is_dependency,
+            "lines": lines,
+            "starting_column": starting_column,
+            "ending_column": ending_column,
+        }
+
+    def set_offset(self, offset: Union[Dict, str], slither):
         if isinstance(offset, dict):
             self._source_mapping = offset
         else:
             self._source_mapping = self._convert_source_mapping(offset, slither)
 
     def _get_lines_str(self, line_descr=""):
-        lines = self.source_mapping.get('lines', None)
+        lines = self.source_mapping.get("lines", None)
         if not lines:
-            lines = ''
+            lines = ""
         elif len(lines) == 1:
-            lines = '#{}{}'.format(line_descr, lines[0])
+            lines = "#{}{}".format(line_descr, lines[0])
         else:
-            lines = '#{}{}-{}{}'.format(line_descr, lines[0], line_descr, lines[-1])
+            lines = "#{}{}-{}{}".format(line_descr, lines[0], line_descr, lines[-1])
         return lines
 
-    def source_mapping_to_markdown(self, markdown_root):
+    def source_mapping_to_markdown(self, markdown_root: str) -> str:
         lines = self._get_lines_str(line_descr="L")
         return f'{markdown_root}{self.source_mapping["filename_relative"]}{lines}'
 
     @property
-    def source_mapping_str(self):
+    def source_mapping_str(self) -> str:
         lines = self._get_lines_str()
         return f'{self.source_mapping["filename_short"]}{lines}'
-

slither/core/variables/event_variable.py

@@ -1,16 +1,20 @@
 from .variable import Variable
 from slither.core.children.child_event import ChildEvent
 
+
 class EventVariable(ChildEvent, Variable):
     def __init__(self):
         super(EventVariable, self).__init__()
         self._indexed = False
 
     @property
-    def indexed(self):
+    def indexed(self) -> bool:
         """
         Indicates whether the event variable is indexed in the bloom filter.
         :return: Returns True if the variable is indexed in bloom filter, False otherwise.
         """
         return self._indexed
 
+    @indexed.setter
+    def indexed(self, is_indexed: bool):
+        self._indexed = is_indexed

slither/core/variables/function_type_variable.py

@@ -8,5 +8,6 @@
 
 from .variable import Variable
 
-class FunctionTypeVariable(Variable): pass
 
+class FunctionTypeVariable(Variable):
+    pass

slither/core/variables/local_variable.py

@@ -1,45 +1,51 @@
+from typing import Optional
+
 from .variable import Variable
 from slither.core.children.child_function import ChildFunction
 from slither.core.solidity_types.user_defined_type import UserDefinedType
 from slither.core.solidity_types.array_type import ArrayType
 from slither.core.solidity_types.mapping_type import MappingType
+from slither.core.solidity_types.elementary_type import ElementaryType
 
 from slither.core.declarations.structure import Structure
 
 
 class LocalVariable(ChildFunction, Variable):
-
     def __init__(self):
         super(LocalVariable, self).__init__()
-        self._location = None
+        self._location: Optional[str] = None
 
-    def set_location(self, loc):
+    def set_location(self, loc: str):
         self._location = loc
 
     @property
-    def location(self):
-        '''
+    def location(self) -> Optional[str]:
+        """
             Variable Location
             Can be storage/memory or default
         Returns:
             (str)
-        '''
+        """
         return self._location
 
     @property
-    def is_storage(self):
+    def is_scalar(self) -> bool:
+        return isinstance(self.type, ElementaryType) and not self.is_storage
+
+    @property
+    def is_storage(self) -> bool:
         """
             Return true if the variable is located in storage
             See https://solidity.readthedocs.io/en/v0.4.24/types.html?highlight=storage%20location#data-location
         Returns:
             (bool)
         """
-        if self.location == 'memory':
+        if self.location == "memory":
             return False
         # Use by slithIR SSA
-        if self.location == 'reference_to_storage':
+        if self.location == "reference_to_storage":
             return False
-        if self.location == 'storage':
+        if self.location == "storage":
             return True
 
         if isinstance(self.type, (ArrayType, MappingType)):
@@ -51,7 +57,5 @@ class LocalVariable(ChildFunction, Variable):
         return False
 
     @property
-    def canonical_name(self):
-        return '{}.{}'.format(self.function.canonical_name, self.name)
-
-
+    def canonical_name(self) -> str:
+        return "{}.{}".format(self.function.canonical_name, self.name)

slither/core/variables/local_variable_init_from_tuple.py

@@ -1,5 +1,8 @@
+from typing import Optional
+
 from slither.core.variables.local_variable import LocalVariable
 
+
 class LocalVariableInitFromTuple(LocalVariable):
     """
         Use on this pattern:
@@ -12,8 +15,12 @@ class LocalVariableInitFromTuple(LocalVariable):
 
     def __init__(self):
         super(LocalVariableInitFromTuple, self).__init__()
-        self._tuple_index = None
+        self._tuple_index: Optional[int] = None
 
     @property
-    def tuple_index(self):
+    def tuple_index(self) -> Optional[int]:
         return self._tuple_index
+
+    @tuple_index.setter
+    def tuple_index(self, idx: int):
+        self._tuple_index = idx

slither/core/variables/state_variable.py

@@ -1,14 +1,20 @@
+from typing import Optional, TYPE_CHECKING, Tuple, List
+
 from .variable import Variable
 from slither.core.children.child_contract import ChildContract
 from slither.utils.type import export_nested_types_from_variable
 
-class StateVariable(ChildContract, Variable):
+if TYPE_CHECKING:
+    from ..cfg.node import Node
+    from ..declarations import Contract
 
+
+class StateVariable(ChildContract, Variable):
     def __init__(self):
         super(StateVariable, self).__init__()
-        self._node_initialization = None
+        self._node_initialization: Optional["Node"] = None
 
-    def is_declared_by(self, contract):
+    def is_declared_by(self, contract: "Contract") -> bool:
         """
         Check if the element is declared by the contract
         :param contract:
@@ -16,7 +22,6 @@ class StateVariable(ChildContract, Variable):
         """
         return self.contract == contract
 
-
     ###################################################################################
     ###################################################################################
     # region Signature
@@ -24,21 +29,21 @@ class StateVariable(ChildContract, Variable):
     ###################################################################################
 
     @property
-    def signature(self):
+    def signature(self) -> Tuple[str, List[str], str]:
         """
             Return the signature of the state variable as a function signature
             :return: (str, list(str), list(str)), as (name, list parameters type, list return values type)
         """
-        return self.name, [str(x) for x in export_nested_types_from_variable(self)], self.type
+        return self.name, [str(x) for x in export_nested_types_from_variable(self)], str(self.type)
 
     @property
-    def signature_str(self):
+    def signature_str(self) -> str:
         """
             Return the signature of the state variable as a function signature
             :return: str: func_name(type1,type2) returns(type3)
         """
         name, parameters, returnVars = self.signature
-        return name+'('+','.join(parameters)+') returns('+','.join(returnVars)+')'
+        return name + "(" + ",".join(parameters) + ") returns(" + ",".join(returnVars) + ")"
 
     # endregion
     ###################################################################################
@@ -48,18 +53,18 @@ class StateVariable(ChildContract, Variable):
     ###################################################################################
 
     @property
-    def canonical_name(self):
-        return '{}.{}'.format(self.contract.name, self.name)
+    def canonical_name(self) -> str:
+        return "{}.{}".format(self.contract.name, self.name)
 
     @property
-    def full_name(self):
+    def full_name(self) -> str:
         """
             Return the name of the state variable as a function signaure
             str: func_name(type1,type2)
             :return: the function signature without the return values
         """
         name, parameters, _ = self.signature
-        return name+'('+','.join(parameters)+')'
+        return name + "(" + ",".join(parameters) + ")"
 
     # endregion
     ###################################################################################
@@ -69,7 +74,7 @@ class StateVariable(ChildContract, Variable):
     ###################################################################################
 
     @property
-    def node_initialization(self):
+    def node_initialization(self) -> Optional["Node"]:
         """
         Node for the state variable initalization
         :return:
@@ -80,8 +85,6 @@ class StateVariable(ChildContract, Variable):
     def node_initialization(self, node_initialization):
         self._node_initialization = node_initialization
 
-
     # endregion
     ###################################################################################
     ###################################################################################
-

slither/core/variables/structure_variable.py

@@ -1,5 +1,6 @@
 from .variable import Variable
 from slither.core.children.child_structure import ChildStructure
 
-class StructureVariable(ChildStructure, Variable): pass
 
+class StructureVariable(ChildStructure, Variable):
+    pass

slither/core/variables/variable.py

@@ -1,24 +1,32 @@
 """
     Variable module
 """
+from typing import Optional, TYPE_CHECKING, List, Union
 
 from slither.core.source_mapping.source_mapping import SourceMapping
 from slither.core.solidity_types.type import Type
 from slither.core.solidity_types.elementary_type import ElementaryType
 
-class Variable(SourceMapping):
+if TYPE_CHECKING:
+    from slither.core.expressions.expression import Expression
+
 
+class Variable(SourceMapping):
     def __init__(self):
         super(Variable, self).__init__()
-        self._name = None
-        self._initial_expression = None
-        self._type = None
-        self._initialized = None
-        self._visibility = None
+        self._name: Optional[str] = None
+        self._initial_expression: Optional["Expression"] = None
+        self._type: Optional[Type] = None
+        self._initialized: Optional[bool] = None
+        self._visibility: Optional[str] = None
         self._is_constant = False
 
     @property
-    def expression(self):
+    def is_scalar(self) -> bool:
+        return isinstance(self.type, ElementaryType)
+
+    @property
+    def expression(self) -> Optional["Expression"]:
         """
             Expression: Expression of the node (if initialized)
             Initial expression may be different than the expression of the node
@@ -32,25 +40,33 @@ class Variable(SourceMapping):
         """
         return self._initial_expression
 
+    @expression.setter
+    def expression(self, expr: "Expression"):
+        self._initial_expression = expr
+
     @property
-    def initialized(self):
+    def initialized(self) -> Optional[bool]:
         """
             boolean: True if the variable is initialized at construction
         """
         return self._initialized
 
+    @initialized.setter
+    def initialized(self, is_init: bool):
+        self._initialized = is_init
+
     @property
-    def uninitialized(self):
+    def uninitialized(self) -> bool:
         """
             boolean: True if the variable is not initialized
         """
         return not self._initialized
 
     @property
-    def name(self):
-        '''
+    def name(self) -> str:
+        """
             str: variable name
-        '''
+        """
         return self._name
 
     @name.setter
@@ -58,20 +74,32 @@ class Variable(SourceMapping):
         self._name = name
 
     @property
-    def type(self):
+    def type(self) -> Optional[Union[Type, List[Type]]]:
         return self._type
 
+    @type.setter
+    def type(self, types: Union[Type, List[Type]]):
+        self._type = types
+
     @property
-    def is_constant(self):
+    def is_constant(self) -> bool:
         return self._is_constant
 
+    @is_constant.setter
+    def is_constant(self, is_cst: bool):
+        self._is_constant = is_cst
+
     @property
-    def visibility(self):
-        '''
+    def visibility(self) -> Optional[str]:
+        """
             str: variable visibility
-        '''
+        """
         return self._visibility
 
+    @visibility.setter
+    def visibility(self, v: str):
+        self._visibility = v
+
     def set_type(self, t):
         if isinstance(t, str):
             t = ElementaryType(t)
@@ -80,25 +108,21 @@ class Variable(SourceMapping):
 
     @property
     def function_name(self):
-        '''
+        """
         Return the name of the variable as a function signature
         :return:
-        '''
+        """
         from slither.core.solidity_types import ArrayType, MappingType
+        from slither.utils.type import export_nested_types_from_variable
+
         variable_getter_args = ""
-        if type(self.type) is ArrayType:
-            length = 0
-            v = self
-            while type(v.type) is ArrayType:
-                length += 1
-                v = v.type
-            variable_getter_args = ','.join(["uint256"] * length)
-        elif type(self.type) is MappingType:
-            variable_getter_args = self.type.type_from
+        return_type = self.type
+        assert return_type
+
+        if isinstance(return_type, (ArrayType, MappingType)):
+            variable_getter_args = ",".join(map(str, export_nested_types_from_variable(self)))
 
         return f"{self.name}({variable_getter_args})"
 
     def __str__(self):
         return self._name
-
-

slither/printers/guidance/echidna.py

@@ -10,7 +10,7 @@ from slither.core.cfg.node import Node
 from slither.core.declarations import Function
 from slither.core.declarations.solidity_variables import SolidityVariableComposed, SolidityFunction, SolidityVariable
 from slither.core.expressions import NewContract
-from slither.core.slither_core import Slither
+from slither.core.slither_core import SlitherCore
 from slither.core.variables.state_variable import StateVariable
 from slither.core.variables.variable import Variable
 from slither.printers.abstract_printer import AbstractPrinter
@@ -26,7 +26,7 @@ def _get_name(f: Function) -> str:
     return f.solidity_signature
 
 
-def _extract_payable(slither: Slither) -> Dict[str, List[str]]:
+def _extract_payable(slither: SlitherCore) -> Dict[str, List[str]]:
     ret: Dict[str, List[str]] = {}
     for contract in slither.contracts:
         payable_functions = [_get_name(f) for f in contract.functions_entry_points if f.payable]
@@ -35,7 +35,7 @@ def _extract_payable(slither: Slither) -> Dict[str, List[str]]:
     return ret
 
 
-def _extract_solidity_variable_usage(slither: Slither, sol_var: SolidityVariable) -> Dict[str, List[str]]:
+def _extract_solidity_variable_usage(slither: SlitherCore, sol_var: SolidityVariable) -> Dict[str, List[str]]:
     ret: Dict[str, List[str]] = {}
     for contract in slither.contracts:
         functions_using_sol_var = []
@@ -53,7 +53,7 @@ def _is_constant(f: Function) -> bool:
     """
     Heuristic:
     - If view/pure with Solidity >= 0.4 -> Return true
-    - If it contains assembly -> Return false (Slither doesn't analyze asm)
+    - If it contains assembly -> Return false (SlitherCore doesn't analyze asm)
     - Otherwise check for the rules from
     https://solidity.readthedocs.io/en/v0.5.0/contracts.html?highlight=pure#view-functions
     with an exception: internal dynamic call are not correctly handled, so we consider them as non-constant
@@ -93,7 +93,7 @@ def _is_constant(f: Function) -> bool:
     return True
 
 
-def _extract_constant_functions(slither: Slither) -> Dict[str, List[str]]:
+def _extract_constant_functions(slither: SlitherCore) -> Dict[str, List[str]]:
     ret: Dict[str, List[str]] = {}
     for contract in slither.contracts:
         cst_functions = [_get_name(f) for f in contract.functions_entry_points if _is_constant(f)]
@@ -103,7 +103,7 @@ def _extract_constant_functions(slither: Slither) -> Dict[str, List[str]]:
     return ret
 
 
-def _extract_assert(slither: Slither) -> Dict[str, List[str]]:
+def _extract_assert(slither: SlitherCore) -> Dict[str, List[str]]:
     ret: Dict[str, List[str]] = {}
     for contract in slither.contracts:
         functions_using_assert = []
@@ -145,7 +145,7 @@ def _extract_constants_from_irs(irs: List[Operation],
         if isinstance(ir, Binary):
             for r in ir.read:
                 if isinstance(r, Constant):
-                    all_cst_used_in_binary[BinaryType.str(ir.type)].append(ConstantValue(str(r.value), str(r.type)))
+                    all_cst_used_in_binary[str(ir.type)].append(ConstantValue(str(r.value), str(r.type)))
         if isinstance(ir, TypeConversion):
             if isinstance(ir.variable, Constant):
                 all_cst_used.append(ConstantValue(str(ir.variable.value), str(ir.type)))
@@ -169,7 +169,7 @@ def _extract_constants_from_irs(irs: List[Operation],
                                                         context_explored)
 
 
-def _extract_constants(slither: Slither) -> Tuple[Dict[str, Dict[str, List]], Dict[str, Dict[str, Dict]]]:
+def _extract_constants(slither: SlitherCore) -> Tuple[Dict[str, Dict[str, List]], Dict[str, Dict[str, Dict]]]:
     # contract -> function -> [ {"value": value, "type": type} ]
     ret_cst_used: Dict[str, Dict[str, List[ConstantValue]]] = defaultdict(dict)
     # contract -> function -> binary_operand -> [ {"value": value, "type": type ]
@@ -196,7 +196,7 @@ def _extract_constants(slither: Slither) -> Tuple[Dict[str, Dict[str, List]], Di
     return ret_cst_used, ret_cst_used_in_binary
 
 
-def _extract_function_relations(slither: Slither) -> Dict[str, Dict[str, Dict[str, List[str]]]]:
+def _extract_function_relations(slither: SlitherCore) -> Dict[str, Dict[str, Dict[str, List[str]]]]:
     # contract -> function -> [functions]
     ret: Dict[str, Dict[str, Dict[str, List[str]]]] = defaultdict(dict)
     for contract in slither.contracts:
@@ -217,7 +217,7 @@ def _extract_function_relations(slither: Slither) -> Dict[str, Dict[str, Dict[st
     return ret
 
 
-def _have_external_calls(slither: Slither) -> Dict[str, List[str]]:
+def _have_external_calls(slither: SlitherCore) -> Dict[str, List[str]]:
     """
     Detect the functions with external calls
     :param slither:
@@ -233,7 +233,7 @@ def _have_external_calls(slither: Slither) -> Dict[str, List[str]]:
     return ret
 
 
-def _use_balance(slither: Slither) -> Dict[str, List[str]]:
+def _use_balance(slither: SlitherCore) -> Dict[str, List[str]]:
     """
     Detect the functions with external calls
     :param slither:
@@ -250,7 +250,7 @@ def _use_balance(slither: Slither) -> Dict[str, List[str]]:
     return ret
 
 
-def _call_a_parameter(slither: Slither) -> Dict[str, List[Dict]]:
+def _call_a_parameter(slither: SlitherCore) -> Dict[str, List[Dict]]:
     """
     Detect the functions with external calls
     :param slither:

slither/slither.py

@@ -1,18 +1,13 @@
 import logging
 import os
-import subprocess
-import sys
-import glob
-import json
-import platform
 
 from crytic_compile import CryticCompile, InvalidCompilation
 
 from slither.detectors.abstract_detector import AbstractDetector, DetectorClassification
 from slither.printers.abstract_printer import AbstractPrinter
-from .solc_parsing.exceptions import VariableNotFound
-from .solc_parsing.slitherSolc import SlitherSolc
+from .core.slither_core import SlitherCore
 from .exceptions import SlitherError
+from .solc_parsing.slitherSolc import SlitherSolc
 
 logger = logging.getLogger("Slither")
 logging.basicConfig()
@@ -21,10 +16,9 @@ logger_detector = logging.getLogger("Detectors")
 logger_printer = logging.getLogger("Printers")
 
 
-class Slither(SlitherSolc):
-
+class Slither(SlitherCore):
     def __init__(self, target, **kwargs):
-        '''
+        """
             Args:
                 target (str | list(json) | CryticCompile)
             Keyword Args:
@@ -46,14 +40,16 @@ class Slither(SlitherSolc):
                 embark_ignore_compile (bool): do not run embark build (default False)
                 embark_overwrite_config (bool): overwrite original config file (default false)
 
-        '''
+        """
+        super().__init__()
+        self._parser: SlitherSolc  #  This could be another parser, like SlitherVyper, interface needs to be determined
         # list of files provided (see --splitted option)
         if isinstance(target, list):
             self._init_from_list(target)
-        elif isinstance(target, str) and target.endswith('.json'):
+        elif isinstance(target, str) and target.endswith(".json"):
             self._init_from_raw_json(target)
         else:
-            super(Slither, self).__init__('')
+            self._parser = SlitherSolc("", self)
             try:
                 if isinstance(target, CryticCompile):
                     crytic_compile = target
@@ -61,54 +57,55 @@ class Slither(SlitherSolc):
                     crytic_compile = CryticCompile(target, **kwargs)
                 self._crytic_compile = crytic_compile
             except InvalidCompilation as e:
-                raise SlitherError('Invalid compilation: \n'+str(e))
+                raise SlitherError("Invalid compilation: \n" + str(e))
             for path, ast in crytic_compile.asts.items():
-                self._parse_contracts_from_loaded_json(ast, path)
-                self._add_source_code(path)
+                self._parser.parse_contracts_from_loaded_json(ast, path)
+                self.add_source_code(path)
 
-        if kwargs.get('generate_patches', False):
+        if kwargs.get("generate_patches", False):
             self.generate_patches = True
 
-        self._markdown_root = kwargs.get('markdown_root', "")
+        self._markdown_root = kwargs.get("markdown_root", "")
 
         self._detectors = []
         self._printers = []
 
-        filter_paths = kwargs.get('filter_paths', [])
+        filter_paths = kwargs.get("filter_paths", [])
         for p in filter_paths:
             self.add_path_to_filter(p)
 
-        self._exclude_dependencies = kwargs.get('exclude_dependencies', False)
+        self._exclude_dependencies = kwargs.get("exclude_dependencies", False)
 
-        triage_mode = kwargs.get('triage_mode', False)
+        triage_mode = kwargs.get("triage_mode", False)
         self._triage_mode = triage_mode
 
-        self._analyze_contracts()
-
+        self._parser.analyze_contracts()
 
     def _init_from_raw_json(self, filename):
         if not os.path.isfile(filename):
-            raise SlitherError('{} does not exist (are you in the correct directory?)'.format(filename))
-        assert filename.endswith('json')
-        with open(filename, encoding='utf8') as astFile:
+            raise SlitherError(
+                "{} does not exist (are you in the correct directory?)".format(filename)
+            )
+        assert filename.endswith("json")
+        with open(filename, encoding="utf8") as astFile:
             stdout = astFile.read()
             if not stdout:
-                raise SlitherError('Empty AST file: %s', filename)
-        contracts_json = stdout.split('\n=')
+                raise SlitherError("Empty AST file: %s", filename)
+        contracts_json = stdout.split("\n=")
 
-        super(Slither, self).__init__(filename)
+        self._parser = SlitherSolc(filename, self)
 
         for c in contracts_json:
-            self._parse_contracts_from_json(c)
+            self._parser.parse_contracts_from_json(c)
 
     def _init_from_list(self, contract):
-        super(Slither, self).__init__('')
+        self._parser = SlitherSolc("", self)
         for c in contract:
-            if 'absolutePath' in c:
-                path = c['absolutePath']
+            if "absolutePath" in c:
+                path = c["absolutePath"]
             else:
-                path = c['attributes']['absolutePath']
-            self._parse_contracts_from_loaded_json(c, path)
+                path = c["attributes"]["absolutePath"]
+            self._parser.parse_contracts_from_loaded_json(c, path)
 
     @property
     def detectors(self):
@@ -138,7 +135,7 @@ class Slither(SlitherSolc):
         """
         :param detector_class: Class inheriting from `AbstractDetector`.
         """
-        self._check_common_things('detector', detector_class, AbstractDetector, self._detectors)
+        self._check_common_things("detector", detector_class, AbstractDetector, self._detectors)
 
         instance = detector_class(self, logger_detector)
         self._detectors.append(instance)
@@ -147,7 +144,7 @@ class Slither(SlitherSolc):
         """
         :param printer_class: Class inheriting from `AbstractPrinter`.
         """
-        self._check_common_things('printer', printer_class, AbstractPrinter, self._printers)
+        self._check_common_things("printer", printer_class, AbstractPrinter, self._printers)
 
         instance = printer_class(self, logger_printer)
         self._printers.append(instance)
@@ -179,19 +176,19 @@ class Slither(SlitherSolc):
             )
 
         if any(type(obj) == cls for obj in instances_list):
-            raise Exception(
-                "You can't register {!r} twice.".format(cls)
-            )
+            raise Exception("You can't register {!r} twice.".format(cls))
 
     def _run_solc(self, filename, solc, disable_solc_warnings, solc_arguments, ast_format):
         if not os.path.isfile(filename):
-            raise SlitherError('{} does not exist (are you in the correct directory?)'.format(filename))
-        assert filename.endswith('json')
-        with open(filename, encoding='utf8') as astFile:
+            raise SlitherError(
+                "{} does not exist (are you in the correct directory?)".format(filename)
+            )
+        assert filename.endswith("json")
+        with open(filename, encoding="utf8") as astFile:
             stdout = astFile.read()
             if not stdout:
-                raise SlitherError('Empty AST file: %s', filename)
-        stdout = stdout.split('\n=')
+                raise SlitherError("Empty AST file: %s", filename)
+        stdout = stdout.split("\n=")
 
         return stdout
 

slither/slithir/operations/binary.py

@@ -1,4 +1,5 @@
 import logging
+from enum import Enum
 
 from slither.core.solidity_types import ElementaryType
 from slither.slithir.exceptions import SlithIRError
@@ -8,26 +9,27 @@ from slither.slithir.variables import ReferenceVariable
 
 logger = logging.getLogger("BinaryOperationIR")
 
-class BinaryType(object):
-    POWER =             0 # **
-    MULTIPLICATION =    1 # *
-    DIVISION =          2 # /
-    MODULO =            3 # %
-    ADDITION =          4 # +
-    SUBTRACTION =      5 # -
-    LEFT_SHIFT =        6 # <<
-    RIGHT_SHIFT =       7 # >>
-    AND =               8 # &
-    CARET =             9 # ^
-    OR =                10 # | 
-    LESS =              11 # <
-    GREATER =           12 # >
-    LESS_EQUAL =        13 # <=
-    GREATER_EQUAL =     14 # >=
-    EQUAL =             15 # ==
-    NOT_EQUAL =         16 # !=
-    ANDAND =            17 # &&
-    OROR =              18 # ||
+
+class BinaryType(Enum):
+    POWER = 0  # **
+    MULTIPLICATION = 1  # *
+    DIVISION = 2  # /
+    MODULO = 3  # %
+    ADDITION = 4  # +
+    SUBTRACTION = 5  # -
+    LEFT_SHIFT = 6  # <<
+    RIGHT_SHIFT = 7  # >>
+    AND = 8  # &
+    CARET = 9  # ^
+    OR = 10  # |
+    LESS = 11  # <
+    GREATER = 12  # >
+    LESS_EQUAL = 13  # <=
+    GREATER_EQUAL = 14  # >=
+    EQUAL = 15  # ==
+    NOT_EQUAL = 16  # !=
+    ANDAND = 17  # &&
+    OROR = 18  # ||
 
     @staticmethod
     def return_bool(operation_type):
@@ -83,47 +85,47 @@ class BinaryType(object):
 
         raise SlithIRError('get_type: Unknown operation type {})'.format(operation_type))
 
-    @staticmethod
-    def str(operation_type):
-        if operation_type == BinaryType.POWER:
-            return '**'
-        if operation_type == BinaryType.MULTIPLICATION:
-            return '*'
-        if operation_type == BinaryType.DIVISION:
-            return '/'
-        if operation_type == BinaryType.MODULO:
-            return '%'
-        if operation_type == BinaryType.ADDITION:
-            return '+'
-        if operation_type == BinaryType.SUBTRACTION:
-            return '-'
-        if operation_type == BinaryType.LEFT_SHIFT:
-            return '<<'
-        if operation_type == BinaryType.RIGHT_SHIFT:
-            return '>>'
-        if operation_type == BinaryType.AND:
-            return '&'
-        if operation_type == BinaryType.CARET:
-            return '^'
-        if operation_type == BinaryType.OR:
-            return '|'
-        if operation_type == BinaryType.LESS:
-            return '<'
-        if operation_type == BinaryType.GREATER:
-            return '>'
-        if operation_type == BinaryType.LESS_EQUAL:
-            return '<='
-        if operation_type == BinaryType.GREATER_EQUAL:
-            return '>='
-        if operation_type == BinaryType.EQUAL:
-            return '=='
-        if operation_type == BinaryType.NOT_EQUAL:
-            return '!='
-        if operation_type == BinaryType.ANDAND:
-            return '&&'
-        if operation_type == BinaryType.OROR:
-            return '||'
-        raise SlithIRError('str: Unknown operation type {})'.format(operation_type))
+    def __str__(self):
+        if self == BinaryType.POWER:
+            return "**"
+        if self == BinaryType.MULTIPLICATION:
+            return "*"
+        if self == BinaryType.DIVISION:
+            return "/"
+        if self == BinaryType.MODULO:
+            return "%"
+        if self == BinaryType.ADDITION:
+            return "+"
+        if self == BinaryType.SUBTRACTION:
+            return "-"
+        if self == BinaryType.LEFT_SHIFT:
+            return "<<"
+        if self == BinaryType.RIGHT_SHIFT:
+            return ">>"
+        if self == BinaryType.AND:
+            return "&"
+        if self == BinaryType.CARET:
+            return "^"
+        if self == BinaryType.OR:
+            return "|"
+        if self == BinaryType.LESS:
+            return "<"
+        if self == BinaryType.GREATER:
+            return ">"
+        if self == BinaryType.LESS_EQUAL:
+            return "<="
+        if self == BinaryType.GREATER_EQUAL:
+            return ">="
+        if self == BinaryType.EQUAL:
+            return "=="
+        if self == BinaryType.NOT_EQUAL:
+            return "!="
+        if self == BinaryType.ANDAND:
+            return "&&"
+        if self == BinaryType.OROR:
+            return "||"
+        raise SlithIRError("str: Unknown operation type {} {})".format(self, type(self)))
+
 
 class Binary(OperationWithLValue):
 
@@ -131,6 +133,7 @@ class Binary(OperationWithLValue):
         assert is_valid_rvalue(left_variable)
         assert is_valid_rvalue(right_variable)
         assert is_valid_lvalue(result)
+        assert isinstance(operation_type, BinaryType)
         super(Binary, self).__init__()
         self._variables = [left_variable, right_variable]
         self._type = operation_type
@@ -162,7 +165,7 @@ class Binary(OperationWithLValue):
 
     @property
     def type_str(self):
-        return BinaryType.str(self._type)
+        return str(self._type)
 
     def __str__(self):
         if isinstance(self.lvalue, ReferenceVariable):
@@ -170,10 +173,10 @@ class Binary(OperationWithLValue):
             while isinstance(points, ReferenceVariable):
                 points = points.points_to
             return '{}(-> {}) = {} {} {}'.format(str(self.lvalue),
-                                              points,
-                                              self.variable_left,
-                                              self.type_str,
-                                              self.variable_right)
+                                                 points,
+                                                 self.variable_left,
+                                                 self.type_str,
+                                                 self.variable_right)
         return '{}({}) = {} {} {}'.format(str(self.lvalue),
                                           self.lvalue.type,
                                           self.variable_left,

slither/slithir/operations/unary.py

@@ -1,4 +1,6 @@
 import logging
+from enum import Enum
+
 from slither.slithir.operations.lvalue import OperationWithLValue
 from slither.slithir.utils.utils import is_valid_lvalue, is_valid_rvalue
 from slither.slithir.exceptions import SlithIRError
@@ -6,7 +8,7 @@ from slither.slithir.exceptions import SlithIRError
 logger = logging.getLogger("BinaryOperationIR")
 
 
-class UnaryType:
+class UnaryType(Enum):
     BANG = 0  # !
     TILD = 1  # ~
 
@@ -19,14 +21,13 @@ class UnaryType:
                 return UnaryType.TILD
         raise SlithIRError('get_type: Unknown operation type {}'.format(operation_type))
 
-    @staticmethod
-    def str(operation_type):
-        if operation_type == UnaryType.BANG:
-            return '!'
-        if operation_type == UnaryType.TILD:
-            return '~'
+    def __str__(self):
+        if self == UnaryType.BANG:
+            return "!"
+        if self == UnaryType.TILD:
+            return "~"
 
-        raise SlithIRError('str: Unknown operation type {}'.format(operation_type))
+        raise SlithIRError("str: Unknown operation type {}".format(self))
 
 
 class Unary(OperationWithLValue):
@@ -53,7 +54,7 @@ class Unary(OperationWithLValue):
 
     @property
     def type_str(self):
-        return UnaryType.str(self._type)
+        return str(self._type)
 
     def __str__(self):
         return "{} = {} {} ".format(self.lvalue, self.type_str, self.rvalue)

slither/solc_parsing/cfg/node.py

@@ -1,68 +1,64 @@
+from typing import Optional, Dict
+
 from slither.core.cfg.node import Node
 from slither.core.cfg.node import NodeType
+from slither.core.expressions.assignment_operation import (
+    AssignmentOperation,
+    AssignmentOperationType,
+)
+from slither.core.expressions.identifier import Identifier
 from slither.solc_parsing.expressions.expression_parsing import parse_expression
+from slither.visitors.expression.find_calls import FindCalls
 from slither.visitors.expression.read_var import ReadVar
 from slither.visitors.expression.write_var import WriteVar
-from slither.visitors.expression.find_calls import FindCalls
-
-from slither.visitors.expression.export_values import ExportValues
-from slither.core.declarations.solidity_variables import SolidityVariable, SolidityFunction
-from slither.core.declarations.function import Function
 
-from slither.core.variables.state_variable import StateVariable
 
-from slither.core.expressions.identifier import Identifier
-from slither.core.expressions.assignment_operation import AssignmentOperation, AssignmentOperationType
-
-class NodeSolc(Node):
+class NodeSolc:
+    def __init__(self, node: Node):
+        self._unparsed_expression: Optional[Dict] = None
+        self._node = node
 
-    def __init__(self, nodeType, nodeId):
-        super(NodeSolc, self).__init__(nodeType, nodeId)
-        self._unparsed_expression = None
+    @property
+    def underlying_node(self) -> Node:
+        return self._node
 
-    def add_unparsed_expression(self, expression):
+    def add_unparsed_expression(self, expression: Dict):
         assert self._unparsed_expression is None
         self._unparsed_expression = expression
 
     def analyze_expressions(self, caller_context):
-        if self.type == NodeType.VARIABLE and not self._expression:
-            self._expression = self.variable_declaration.expression
+        if self._node.type == NodeType.VARIABLE and not self._node.expression:
+            self._node.add_expression(self._node.variable_declaration.expression)
         if self._unparsed_expression:
             expression = parse_expression(self._unparsed_expression, caller_context)
-            self._expression = expression
-            self._unparsed_expression = None
+            self._node.add_expression(expression)
+            # self._unparsed_expression = None
 
-        if self.expression:
+        if self._node.expression:
 
-            if self.type == NodeType.VARIABLE:
+            if self._node.type == NodeType.VARIABLE:
                 # Update the expression to be an assignement to the variable
-                #print(self.variable_declaration)
-                _expression = AssignmentOperation(Identifier(self.variable_declaration),
-                                                  self.expression,
-                                                  AssignmentOperationType.ASSIGN,
-                                                  self.variable_declaration.type)
-                _expression.set_offset(self.expression.source_mapping, self.slither)
-                self._expression = _expression
-
-            expression = self.expression
-            pp = ReadVar(expression)
-            self._expression_vars_read = pp.result()
-
-#            self._vars_read = [item for sublist in vars_read for item in sublist]
-#            self._state_vars_read = [x for x in self.variables_read if\
-#                                     isinstance(x, (StateVariable))]
-#            self._solidity_vars_read = [x for x in self.variables_read if\
-#                                        isinstance(x, (SolidityVariable))]
-
-            pp = WriteVar(expression)
-            self._expression_vars_written = pp.result()
+                _expression = AssignmentOperation(
+                    Identifier(self._node.variable_declaration),
+                    self._node.expression,
+                    AssignmentOperationType.ASSIGN,
+                    self._node.variable_declaration.type,
+                )
+                _expression.set_offset(self._node.expression.source_mapping, self._node.slither)
+                self._node.add_expression(_expression, bypass_verif_empty=True)
 
-#            self._vars_written = [item for sublist in vars_written for item in sublist]
-#            self._state_vars_written = [x for x in self.variables_written if\
-#                                        isinstance(x, StateVariable)]
+            expression = self._node.expression
+            read_var = ReadVar(expression)
+            self._node.variables_read_as_expression = read_var.result()
 
-            pp = FindCalls(expression)
-            self._expression_calls = pp.result()
-            self._external_calls_as_expressions = [c for c in self.calls_as_expression if not isinstance(c.called, Identifier)]
-            self._internal_calls_as_expressions = [c for c in self.calls_as_expression if isinstance(c.called, Identifier)]
+            write_var = WriteVar(expression)
+            self._node.variables_written_as_expression = write_var.result()
 
+            find_call = FindCalls(expression)
+            self._node.calls_as_expression = find_call.result()
+            self._node.external_calls_as_expressions = [
+                c for c in self._node.calls_as_expression if not isinstance(c.called, Identifier)
+            ]
+            self._node.internal_calls_as_expressions = [
+                c for c in self._node.calls_as_expression if isinstance(c.called, Identifier)
+            ]

slither/solc_parsing/declarations/contract.py

@@ -1,55 +1,67 @@
 import logging
+from typing import List, Dict, Callable, TYPE_CHECKING, Union
 
+from slither.core.declarations import Modifier, Structure, Event
 from slither.core.declarations.contract import Contract
-from slither.core.declarations.function import Function, FunctionType
 from slither.core.declarations.enum import Enum
-from slither.core.cfg.node import Node, NodeType
-from slither.core.expressions import AssignmentOperation, Identifier, AssignmentOperationType
-from slither.slithir.variables import StateIRVariable
+from slither.core.declarations.function import Function
+from slither.core.variables.state_variable import StateVariable
 from slither.solc_parsing.declarations.event import EventSolc
 from slither.solc_parsing.declarations.function import FunctionSolc
 from slither.solc_parsing.declarations.modifier import ModifierSolc
 from slither.solc_parsing.declarations.structure import StructureSolc
+from slither.solc_parsing.exceptions import ParsingError, VariableNotFound
 from slither.solc_parsing.solidity_types.type_parsing import parse_type
 from slither.solc_parsing.variables.state_variable import StateVariableSolc
-from slither.solc_parsing.exceptions import ParsingError, VariableNotFound
 
-logger = logging.getLogger("ContractSolcParsing")
+LOGGER = logging.getLogger("ContractSolcParsing")
 
+if TYPE_CHECKING:
+    from slither.solc_parsing.slitherSolc import SlitherSolc
+    from slither.core.slither_core import SlitherCore
 
-class ContractSolc04(Contract):
 
-    def __init__(self, slitherSolc, data):
+class ContractSolc:
+    def __init__(self, slither_parser: "SlitherSolc", contract: Contract, data):
         # assert slitherSolc.solc_version.startswith('0.4')
-        super(ContractSolc04, self).__init__()
 
-        self.set_slither(slitherSolc)
+        self._contract = contract
+        self._contract.set_slither(slither_parser.core)
+        self._slither_parser = slither_parser
         self._data = data
 
-        self._functionsNotParsed = []
-        self._modifiersNotParsed = []
-        self._functions_no_params = []
-        self._modifiers_no_params = []
-        self._eventsNotParsed = []
-        self._variablesNotParsed = []
-        self._enumsNotParsed = []
-        self._structuresNotParsed = []
-        self._usingForNotParsed = []
+        self._functionsNotParsed: List[Dict] = []
+        self._modifiersNotParsed: List[Dict] = []
+        self._functions_no_params: List[FunctionSolc] = []
+        self._modifiers_no_params: List[ModifierSolc] = []
+        self._eventsNotParsed: List[EventSolc] = []
+        self._variablesNotParsed: List[Dict] = []
+        self._enumsNotParsed: List[Dict] = []
+        self._structuresNotParsed: List[Dict] = []
+        self._usingForNotParsed: List[Dict] = []
+
+        self._functions_parser: List[FunctionSolc] = []
+        self._modifiers_parser: List[ModifierSolc] = []
+        self._structures_parser: List[StructureSolc] = []
 
-        self._is_analyzed = False
+        self._is_analyzed: bool = False
 
         # use to remap inheritance id
-        self._remapping = {}
+        self._remapping: Dict[str, str] = {}
+
+        self.baseContracts = []
+        self.baseConstructorContractsCalled = []
+        self._linearized_base_contracts: List[int]
+
+        self._variables_parser: List[StateVariableSolc] = []
 
         # Export info
         if self.is_compact_ast:
-            self._name = self._data['name']
+            self._contract.name = self._data["name"]
         else:
-            self._name = self._data['attributes'][self.get_key()]
+            self._contract.name = self._data["attributes"][self.get_key()]
 
-        self._id = self._data['id']
-
-        self._inheritance = []
+        self._contract.id = self._data["id"]
 
         self._parse_contract_info()
         self._parse_contract_items()
@@ -61,33 +73,57 @@ class ContractSolc04(Contract):
     ###################################################################################
 
     @property
-    def is_analyzed(self):
+    def is_analyzed(self) -> bool:
         return self._is_analyzed
 
-    def set_is_analyzed(self, is_analyzed):
+    def set_is_analyzed(self, is_analyzed: bool):
         self._is_analyzed = is_analyzed
 
+    @property
+    def underlying_contract(self) -> Contract:
+        return self._contract
+
+    @property
+    def linearized_base_contracts(self) -> List[int]:
+        return self._linearized_base_contracts
+
+    @property
+    def slither(self) -> "SlitherCore":
+        return self._contract.slither
+
+    @property
+    def slither_parser(self) -> "SlitherSolc":
+        return self._slither_parser
+
+    @property
+    def functions_parser(self) -> List["FunctionSolc"]:
+        return self._functions_parser
+
+    @property
+    def modifiers_parser(self) -> List["ModifierSolc"]:
+        return self._modifiers_parser
+
     ###################################################################################
     ###################################################################################
     # region AST
     ###################################################################################
     ###################################################################################
 
-    def get_key(self):
-        return self.slither.get_key()
+    def get_key(self) -> str:
+        return self._slither_parser.get_key()
 
-    def get_children(self, key='nodes'):
+    def get_children(self, key="nodes") -> str:
         if self.is_compact_ast:
             return key
-        return 'children'
+        return "children"
 
     @property
-    def remapping(self):
+    def remapping(self) -> Dict[str, str]:
         return self._remapping
 
     @property
-    def is_compact_ast(self):
-        return self.slither.is_compact_ast
+    def is_compact_ast(self) -> bool:
+        return self._slither_parser.is_compact_ast
 
     # endregion
     ###################################################################################
@@ -100,162 +136,190 @@ class ContractSolc04(Contract):
         if self.is_compact_ast:
             attributes = self._data
         else:
-            attributes = self._data['attributes']
+            attributes = self._data["attributes"]
 
-        self.isInterface = False
-        if 'contractKind' in attributes:
-            if attributes['contractKind'] == 'interface':
-                self.isInterface = True
-            self._kind = attributes['contractKind']
-        self.linearizedBaseContracts = attributes['linearizedBaseContracts']
-        self.fullyImplemented = attributes['fullyImplemented']
+        self._contract.is_interface = False
+        if "contractKind" in attributes:
+            if attributes["contractKind"] == "interface":
+                self._contract.is_interface = True
+            self._contract.kind = attributes["contractKind"]
+        self._linearized_base_contracts = attributes["linearizedBaseContracts"]
+        # self._contract.fullyImplemented = attributes["fullyImplemented"]
 
         # Parse base contract information
         self._parse_base_contract_info()
 
         # trufle does some re-mapping of id
-        if 'baseContracts' in self._data:
-            for elem in self._data['baseContracts']:
-                if elem['nodeType'] == 'InheritanceSpecifier':
-                    self._remapping[elem['baseName']['referencedDeclaration']] = elem['baseName']['name']
+        if "baseContracts" in self._data:
+            for elem in self._data["baseContracts"]:
+                if elem["nodeType"] == "InheritanceSpecifier":
+                    self._remapping[elem["baseName"]["referencedDeclaration"]] = elem["baseName"][
+                        "name"
+                    ]
 
     def _parse_base_contract_info(self):
         # Parse base contracts (immediate, non-linearized)
-        self.baseContracts = []
-        self.baseConstructorContractsCalled = []
         if self.is_compact_ast:
             # Parse base contracts + constructors in compact-ast
-            if 'baseContracts' in self._data:
-                for base_contract in self._data['baseContracts']:
-                    if base_contract['nodeType'] != 'InheritanceSpecifier':
+            if "baseContracts" in self._data:
+                for base_contract in self._data["baseContracts"]:
+                    if base_contract["nodeType"] != "InheritanceSpecifier":
                         continue
-                    if 'baseName' not in base_contract or 'referencedDeclaration' not in base_contract['baseName']:
+                    if (
+                        "baseName" not in base_contract
+                        or "referencedDeclaration" not in base_contract["baseName"]
+                    ):
                         continue
 
                     # Obtain our contract reference and add it to our base contract list
-                    referencedDeclaration = base_contract['baseName']['referencedDeclaration']
+                    referencedDeclaration = base_contract["baseName"]["referencedDeclaration"]
                     self.baseContracts.append(referencedDeclaration)
 
                     # If we have defined arguments in our arguments object, this is a constructor invocation.
                     # (note: 'arguments' can be [], which is not the same as None. [] implies a constructor was
                     #  called with no arguments, while None implies no constructor was called).
-                    if 'arguments' in base_contract and base_contract['arguments'] is not None:
+                    if "arguments" in base_contract and base_contract["arguments"] is not None:
                         self.baseConstructorContractsCalled.append(referencedDeclaration)
         else:
             # Parse base contracts + constructors in legacy-ast
-            if 'children' in self._data:
-                for base_contract in self._data['children']:
-                    if base_contract['name'] != 'InheritanceSpecifier':
+            if "children" in self._data:
+                for base_contract in self._data["children"]:
+                    if base_contract["name"] != "InheritanceSpecifier":
                         continue
-                    if 'children' not in base_contract or len(base_contract['children']) == 0:
+                    if "children" not in base_contract or len(base_contract["children"]) == 0:
                         continue
                     # Obtain all items for this base contract specification (base contract, followed by arguments)
-                    base_contract_items = base_contract['children']
-                    if 'name' not in base_contract_items[0] or base_contract_items[0]['name'] != 'UserDefinedTypeName':
+                    base_contract_items = base_contract["children"]
+                    if (
+                        "name" not in base_contract_items[0]
+                        or base_contract_items[0]["name"] != "UserDefinedTypeName"
+                    ):
                         continue
-                    if 'attributes' not in base_contract_items[0] or 'referencedDeclaration' not in \
-                            base_contract_items[0]['attributes']:
+                    if (
+                        "attributes" not in base_contract_items[0]
+                        or "referencedDeclaration" not in base_contract_items[0]["attributes"]
+                    ):
                         continue
 
                     # Obtain our contract reference and add it to our base contract list
-                    referencedDeclaration = base_contract_items[0]['attributes']['referencedDeclaration']
+                    referencedDeclaration = base_contract_items[0]["attributes"][
+                        "referencedDeclaration"
+                    ]
                     self.baseContracts.append(referencedDeclaration)
 
                     # If we have an 'attributes'->'arguments' which is None, this is not a constructor call.
-                    if 'attributes' not in base_contract or 'arguments' not in base_contract['attributes'] or \
-                            base_contract['attributes']['arguments'] is not None:
+                    if (
+                        "attributes" not in base_contract
+                        or "arguments" not in base_contract["attributes"]
+                        or base_contract["attributes"]["arguments"] is not None
+                    ):
                         self.baseConstructorContractsCalled.append(referencedDeclaration)
 
     def _parse_contract_items(self):
         if not self.get_children() in self._data:  # empty contract
             return
         for item in self._data[self.get_children()]:
-            if item[self.get_key()] == 'FunctionDefinition':
+            if item[self.get_key()] == "FunctionDefinition":
                 self._functionsNotParsed.append(item)
-            elif item[self.get_key()] == 'EventDefinition':
+            elif item[self.get_key()] == "EventDefinition":
                 self._eventsNotParsed.append(item)
-            elif item[self.get_key()] == 'InheritanceSpecifier':
+            elif item[self.get_key()] == "InheritanceSpecifier":
                 # we dont need to parse it as it is redundant
                 # with self.linearizedBaseContracts
                 continue
-            elif item[self.get_key()] == 'VariableDeclaration':
+            elif item[self.get_key()] == "VariableDeclaration":
                 self._variablesNotParsed.append(item)
-            elif item[self.get_key()] == 'EnumDefinition':
+            elif item[self.get_key()] == "EnumDefinition":
                 self._enumsNotParsed.append(item)
-            elif item[self.get_key()] == 'ModifierDefinition':
+            elif item[self.get_key()] == "ModifierDefinition":
                 self._modifiersNotParsed.append(item)
-            elif item[self.get_key()] == 'StructDefinition':
+            elif item[self.get_key()] == "StructDefinition":
                 self._structuresNotParsed.append(item)
-            elif item[self.get_key()] == 'UsingForDirective':
+            elif item[self.get_key()] == "UsingForDirective":
                 self._usingForNotParsed.append(item)
             else:
-                raise ParsingError('Unknown contract item: ' + item[self.get_key()])
+                raise ParsingError("Unknown contract item: " + item[self.get_key()])
         return
 
-    def _parse_struct(self, struct):
+    def _parse_struct(self, struct: Dict):
         if self.is_compact_ast:
-            name = struct['name']
+            name = struct["name"]
             attributes = struct
         else:
-            name = struct['attributes'][self.get_key()]
-            attributes = struct['attributes']
-        if 'canonicalName' in attributes:
-            canonicalName = attributes['canonicalName']
+            name = struct["attributes"][self.get_key()]
+            attributes = struct["attributes"]
+        if "canonicalName" in attributes:
+            canonicalName = attributes["canonicalName"]
         else:
-            canonicalName = self.name + '.' + name
+            canonicalName = self._contract.name + "." + name
 
-        if self.get_children('members') in struct:
-            children = struct[self.get_children('members')]
+        if self.get_children("members") in struct:
+            children = struct[self.get_children("members")]
         else:
             children = []  # empty struct
-        st = StructureSolc(name, canonicalName, children)
-        st.set_contract(self)
-        st.set_offset(struct['src'], self.slither)
-        self._structures[name] = st
+
+        st = Structure()
+        st.set_contract(self._contract)
+        st.set_offset(struct["src"], self._contract.slither)
+
+        st_parser = StructureSolc(st, name, canonicalName, children, self)
+        self._contract.structures_as_dict[name] = st
+        self._structures_parser.append(st_parser)
 
     def parse_structs(self):
-        for father in self.inheritance_reverse:
-            self._structures.update(father.structures_as_dict())
+        for father in self._contract.inheritance_reverse:
+            self._contract.structures_as_dict.update(father.structures_as_dict)
 
         for struct in self._structuresNotParsed:
             self._parse_struct(struct)
         self._structuresNotParsed = None
 
     def parse_state_variables(self):
-        for father in self.inheritance_reverse:
-            self._variables.update(father.variables_as_dict())
-            self._variables_ordered += father.state_variables_ordered
+        for father in self._contract.inheritance_reverse:
+            self._contract.variables_as_dict.update(father.variables_as_dict)
+            self._contract.add_variables_ordered(father.state_variables_ordered)
 
         for varNotParsed in self._variablesNotParsed:
-            var = StateVariableSolc(varNotParsed)
-            var.set_offset(varNotParsed['src'], self.slither)
-            var.set_contract(self)
+            var = StateVariable()
+            var.set_offset(varNotParsed["src"], self._contract.slither)
+            var.set_contract(self._contract)
 
-            self._variables[var.name] = var
-            self._variables_ordered.append(var)
+            var_parser = StateVariableSolc(var, varNotParsed)
+            self._variables_parser.append(var_parser)
 
-    def _parse_modifier(self, modifier):
+            self._contract.variables_as_dict[var.name] = var
+            self._contract.add_variables_ordered([var])
 
-        modif = ModifierSolc(modifier, self, self)
-        modif.set_contract(self)
-        modif.set_contract_declarer(self)
-        modif.set_offset(modifier['src'], self.slither)
-        self.slither.add_modifier(modif)
-        self._modifiers_no_params.append(modif)
+    def _parse_modifier(self, modifier_data: Dict):
+        modif = Modifier()
+        modif.set_offset(modifier_data["src"], self._contract.slither)
+        modif.set_contract(self._contract)
+        modif.set_contract_declarer(self._contract)
 
-    def parse_modifiers(self):
+        modif_parser = ModifierSolc(modif, modifier_data, self)
+        self._contract.slither.add_modifier(modif)
+        self._modifiers_no_params.append(modif_parser)
+        self._modifiers_parser.append(modif_parser)
+
+        self._slither_parser.add_functions_parser(modif_parser)
 
+    def parse_modifiers(self):
         for modifier in self._modifiersNotParsed:
             self._parse_modifier(modifier)
         self._modifiersNotParsed = None
 
-        return
+    def _parse_function(self, function_data: Dict):
+        func = Function()
+        func.set_offset(function_data["src"], self._contract.slither)
+        func.set_contract(self._contract)
+        func.set_contract_declarer(self._contract)
 
-    def _parse_function(self, function):
-        func = FunctionSolc(function, self, self)
-        func.set_offset(function['src'], self.slither)
-        self.slither.add_function(func)
-        self._functions_no_params.append(func)
+        func_parser = FunctionSolc(func, function_data, self)
+        self._contract.slither.add_function(func)
+        self._functions_no_params.append(func_parser)
+        self._functions_parser.append(func_parser)
+
+        self._slither_parser.add_functions_parser(func_parser)
 
     def parse_functions(self):
 
@@ -264,8 +328,6 @@ class ContractSolc04(Contract):
 
         self._functionsNotParsed = None
 
-        return
-
     # endregion
     ###################################################################################
     ###################################################################################
@@ -274,56 +336,78 @@ class ContractSolc04(Contract):
     ###################################################################################
 
     def log_incorrect_parsing(self, error):
-        logger.error(error)
-        self._is_incorrectly_parsed = True
+        LOGGER.error(error)
+        self._contract.is_incorrectly_parsed = True
 
     def analyze_content_modifiers(self):
         try:
-            for modifier in self.modifiers:
-                modifier.analyze_content()
+            for modifier_parser in self._modifiers_parser:
+                modifier_parser.analyze_content()
         except (VariableNotFound, KeyError) as e:
-            self.log_incorrect_parsing(f'Missing modifier {e}')
-        return
+            self.log_incorrect_parsing(f"Missing modifier {e}")
 
     def analyze_content_functions(self):
         try:
-            for function in self.functions:
-                function.analyze_content()
+            for function_parser in self._functions_parser:
+                function_parser.analyze_content()
         except (VariableNotFound, KeyError, ParsingError) as e:
-            self.log_incorrect_parsing(f'Missing function {e}')
+            self.log_incorrect_parsing(f"Missing function {e}")
         return
 
     def analyze_params_modifiers(self):
-
         try:
             elements_no_params = self._modifiers_no_params
-            getter = lambda f: f.modifiers
-            getter_available = lambda f: f.modifiers_declared
-            Cls = ModifierSolc
-            self._modifiers = self._analyze_params_elements(elements_no_params, getter, getter_available, Cls)
+            getter = lambda c: c.modifiers_parser
+            getter_available = lambda c: c.modifiers_declared
+            Cls = Modifier
+            Cls_parser = ModifierSolc
+            modifiers = self._analyze_params_elements(
+                elements_no_params,
+                getter,
+                getter_available,
+                Cls,
+                Cls_parser,
+                self._modifiers_parser,
+            )
+            self._contract.set_modifiers(modifiers)
         except (VariableNotFound, KeyError) as e:
-            self.log_incorrect_parsing(f'Missing params {e}')
+            self.log_incorrect_parsing(f"Missing params {e}")
         self._modifiers_no_params = []
 
-        return
-
     def analyze_params_functions(self):
         try:
             elements_no_params = self._functions_no_params
-            getter = lambda f: f.functions
-            getter_available = lambda f: f.functions_declared
-            Cls = FunctionSolc
-            self._functions = self._analyze_params_elements(elements_no_params, getter, getter_available, Cls)
+            getter = lambda c: c.functions_parser
+            getter_available = lambda c: c.functions_declared
+            Cls = Function
+            Cls_parser = FunctionSolc
+            functions = self._analyze_params_elements(
+                elements_no_params,
+                getter,
+                getter_available,
+                Cls,
+                Cls_parser,
+                self._functions_parser,
+            )
+            self._contract.set_functions(functions)
         except (VariableNotFound, KeyError) as e:
-            self.log_incorrect_parsing(f'Missing params {e}')
+            self.log_incorrect_parsing(f"Missing params {e}")
         self._functions_no_params = []
-        return
 
-    def _analyze_params_elements(self, elements_no_params, getter, getter_available, Cls):
+    def _analyze_params_elements(
+        self,
+        elements_no_params: List[FunctionSolc],
+        getter: Callable[["ContractSolc"], List[FunctionSolc]],
+        getter_available: Callable[[Contract], List[Function]],
+        Cls: Callable,
+        Cls_parser: Callable,
+        parser: List[FunctionSolc],
+    ) -> Dict[str, Union[Function, Modifier]]:
         """
         Analyze the parameters of the given elements (Function or Modifier).
         The function iterates over the inheritance to create an instance or inherited elements (Function or Modifier)
         If the element is shadowed, set is_shadowed to True
+
         :param elements_no_params: list of elements to analyzer
         :param getter: fun x
         :param getter_available: fun x
@@ -333,15 +417,31 @@ class ContractSolc04(Contract):
         all_elements = {}
 
         try:
-            for father in self.inheritance:
-                for element in getter(father):
-                    elem = Cls(element._functionNotParsed, self, element.contract_declarer)
-                    elem.set_offset(element._functionNotParsed['src'], self.slither)
-                    elem.analyze_params()
-                    self.slither.add_function(elem)
+            for father in self._contract.inheritance:
+                father_parser = self._slither_parser.underlying_contract_to_parser[father]
+                for element_parser in getter(father_parser):
+                    elem = Cls()
+                    elem.set_contract(self._contract)
+                    elem.set_contract_declarer(element_parser.underlying_function.contract_declarer)
+                    elem.set_offset(
+                        element_parser.function_not_parsed["src"], self._contract.slither
+                    )
+
+                    elem_parser = Cls_parser(elem, element_parser.function_not_parsed, self,)
+                    elem_parser.analyze_params()
+                    if isinstance(elem, Modifier):
+                        self._contract.slither.add_modifier(elem)
+                    else:
+                        self._contract.slither.add_function(elem)
+
+                    self._slither_parser.add_functions_parser(elem_parser)
+
                     all_elements[elem.canonical_name] = elem
+                    parser.append(elem_parser)
 
-            accessible_elements = self.available_elements_from_inheritances(all_elements, getter_available)
+            accessible_elements = self._contract.available_elements_from_inheritances(
+                all_elements, getter_available
+            )
 
             # If there is a constructor in the functions
             # We remove the previous constructor
@@ -349,128 +449,65 @@ class ContractSolc04(Contract):
             #
             # Note: contract.all_functions_called returns the constructors of the base contracts
             has_constructor = False
-            for element in elements_no_params:
-                element.analyze_params()
-                if element.is_constructor:
+            for element_parser in elements_no_params:
+                element_parser.analyze_params()
+                if element_parser.underlying_function.is_constructor:
                     has_constructor = True
 
             if has_constructor:
-                _accessible_functions = {k: v for (k, v) in accessible_elements.items() if not v.is_constructor}
-
-            for element in elements_no_params:
-                accessible_elements[element.full_name] = element
-                all_elements[element.canonical_name] = element
+                _accessible_functions = {
+                    k: v for (k, v) in accessible_elements.items() if not v.is_constructor
+                }
+
+            for element_parser in elements_no_params:
+                accessible_elements[
+                    element_parser.underlying_function.full_name
+                ] = element_parser.underlying_function
+                all_elements[
+                    element_parser.underlying_function.canonical_name
+                ] = element_parser.underlying_function
 
             for element in all_elements.values():
                 if accessible_elements[element.full_name] != all_elements[element.canonical_name]:
                     element.is_shadowed = True
                     accessible_elements[element.full_name].shadows = True
         except (VariableNotFound, KeyError) as e:
-            self.log_incorrect_parsing(f'Missing params {e}')
+            self.log_incorrect_parsing(f"Missing params {e}")
         return all_elements
 
     def analyze_constant_state_variables(self):
-        for var in self.variables:
-            if var.is_constant:
+        for var_parser in self._variables_parser:
+            if var_parser.underlying_variable.is_constant:
                 # cant parse constant expression based on function calls
                 try:
-                    var.analyze(self)
+                    var_parser.analyze(self)
                 except (VariableNotFound, KeyError) as e:
-                    logger.error(e)
+                    LOGGER.error(e)
                     pass
-        return
-
-    def _create_node(self, func, counter, variable):
-        # Function uses to create node for state variable declaration statements
-        node = Node(NodeType.OTHER_ENTRYPOINT, counter)
-        node.set_offset(variable.source_mapping, self.slither)
-        node.set_function(func)
-        func.add_node(node)
-        expression = AssignmentOperation(Identifier(variable),
-                                         variable.expression,
-                                         AssignmentOperationType.ASSIGN,
-                                         variable.type)
-
-        expression.set_offset(variable.source_mapping, self.slither)
-        node.add_expression(expression)
-        return node
-
-    def add_constructor_variables(self):
-        if self.state_variables:
-            for (idx, variable_candidate) in enumerate(self.state_variables):
-                if variable_candidate.expression and not variable_candidate.is_constant:
-
-                    constructor_variable = Function()
-                    constructor_variable.set_function_type(FunctionType.CONSTRUCTOR_VARIABLES)
-                    constructor_variable.set_contract(self)
-                    constructor_variable.set_contract_declarer(self)
-                    constructor_variable.set_visibility('internal')
-                    # For now, source mapping of the constructor variable is the whole contract
-                    # Could be improved with a targeted source mapping
-                    constructor_variable.set_offset(self.source_mapping, self.slither)
-                    self._functions[constructor_variable.canonical_name] = constructor_variable
-
-                    prev_node = self._create_node(constructor_variable, 0, variable_candidate)
-                    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)
-                            v.node_initialization = next_node
-                            prev_node.add_son(next_node)
-                            next_node.add_father(prev_node)
-                            counter += 1
-                    break
-
-            for (idx, variable_candidate) in enumerate(self.state_variables):
-                if variable_candidate.expression and variable_candidate.is_constant:
-
-                    constructor_variable = Function()
-                    constructor_variable.set_function_type(FunctionType.CONSTRUCTOR_CONSTANT_VARIABLES)
-                    constructor_variable.set_contract(self)
-                    constructor_variable.set_contract_declarer(self)
-                    constructor_variable.set_visibility('internal')
-                    # For now, source mapping of the constructor variable is the whole contract
-                    # Could be improved with a targeted source mapping
-                    constructor_variable.set_offset(self.source_mapping, self.slither)
-                    self._functions[constructor_variable.canonical_name] = constructor_variable
-
-                    prev_node = self._create_node(constructor_variable, 0, variable_candidate)
-                    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)
-                            v.node_initialization = next_node
-                            prev_node.add_son(next_node)
-                            next_node.add_father(prev_node)
-                            counter += 1
-
-                    break
 
     def analyze_state_variables(self):
         try:
-            for var in self.variables:
-                var.analyze(self)
+            for var_parser in self._variables_parser:
+                var_parser.analyze(self)
             return
         except (VariableNotFound, KeyError) as e:
-            self.log_incorrect_parsing(f'Missing state variable {e}')
+            self.log_incorrect_parsing(f"Missing state variable {e}")
 
     def analyze_using_for(self):
         try:
-            for father in self.inheritance:
-                self._using_for.update(father.using_for)
+            for father in self._contract.inheritance:
+                self._contract.using_for.update(father.using_for)
 
             if self.is_compact_ast:
                 for using_for in self._usingForNotParsed:
-                    lib_name = parse_type(using_for['libraryName'], self)
-                    if 'typeName' in using_for and using_for['typeName']:
-                        type_name = parse_type(using_for['typeName'], self)
+                    lib_name = parse_type(using_for["libraryName"], self)
+                    if "typeName" in using_for and using_for["typeName"]:
+                        type_name = parse_type(using_for["typeName"], self)
                     else:
-                        type_name = '*'
-                    if not type_name in self._using_for:
-                        self.using_for[type_name] = []
-                    self._using_for[type_name].append(lib_name)
+                        type_name = "*"
+                    if type_name not in self._contract.using_for:
+                        self._contract.using_for[type_name] = []
+                    self._contract.using_for[type_name].append(lib_name)
             else:
                 for using_for in self._usingForNotParsed:
                     children = using_for[self.get_children()]
@@ -480,18 +517,18 @@ class ContractSolc04(Contract):
                         old = parse_type(children[1], self)
                     else:
                         new = parse_type(children[0], self)
-                        old = '*'
-                    if not old in self._using_for:
-                        self.using_for[old] = []
-                    self._using_for[old].append(new)
+                        old = "*"
+                    if old not in self._contract.using_for:
+                        self._contract.using_for[old] = []
+                    self._contract.using_for[old].append(new)
             self._usingForNotParsed = []
         except (VariableNotFound, KeyError) as e:
-            self.log_incorrect_parsing(f'Missing using for {e}')
+            self.log_incorrect_parsing(f"Missing using for {e}")
 
     def analyze_enums(self):
         try:
-            for father in self.inheritance:
-                self._enums.update(father.enums_as_dict())
+            for father in self._contract.inheritance:
+                self._contract.enums_as_dict.update(father.enums_as_dict)
 
             for enum in self._enumsNotParsed:
                 # for enum, we can parse and analyze it
@@ -499,107 +536,60 @@ class ContractSolc04(Contract):
                 self._analyze_enum(enum)
             self._enumsNotParsed = None
         except (VariableNotFound, KeyError) as e:
-            self.log_incorrect_parsing(f'Missing enum {e}')
+            self.log_incorrect_parsing(f"Missing enum {e}")
 
     def _analyze_enum(self, enum):
         # Enum can be parsed in one pass
         if self.is_compact_ast:
-            name = enum['name']
-            canonicalName = enum['canonicalName']
+            name = enum["name"]
+            canonicalName = enum["canonicalName"]
         else:
-            name = enum['attributes'][self.get_key()]
-            if 'canonicalName' in enum['attributes']:
-                canonicalName = enum['attributes']['canonicalName']
+            name = enum["attributes"][self.get_key()]
+            if "canonicalName" in enum["attributes"]:
+                canonicalName = enum["attributes"]["canonicalName"]
             else:
-                canonicalName = self.name + '.' + name
+                canonicalName = self._contract.name + "." + name
         values = []
-        for child in enum[self.get_children('members')]:
-            assert child[self.get_key()] == 'EnumValue'
+        for child in enum[self.get_children("members")]:
+            assert child[self.get_key()] == "EnumValue"
             if self.is_compact_ast:
-                values.append(child['name'])
+                values.append(child["name"])
             else:
-                values.append(child['attributes'][self.get_key()])
+                values.append(child["attributes"][self.get_key()])
 
         new_enum = Enum(name, canonicalName, values)
-        new_enum.set_contract(self)
-        new_enum.set_offset(enum['src'], self.slither)
-        self._enums[canonicalName] = new_enum
+        new_enum.set_contract(self._contract)
+        new_enum.set_offset(enum["src"], self._contract.slither)
+        self._contract.enums_as_dict[canonicalName] = new_enum
 
-    def _analyze_struct(self, struct):
+    def _analyze_struct(self, struct: StructureSolc):
         struct.analyze()
 
     def analyze_structs(self):
         try:
-            for struct in self.structures:
+            for struct in self._structures_parser:
                 self._analyze_struct(struct)
         except (VariableNotFound, KeyError) as e:
-            self.log_incorrect_parsing(f'Missing struct {e}')
+            self.log_incorrect_parsing(f"Missing struct {e}")
 
     def analyze_events(self):
         try:
-            for father in self.inheritance_reverse:
-                self._events.update(father.events_as_dict())
+            for father in self._contract.inheritance_reverse:
+                self._contract.events_as_dict.update(father.events_as_dict)
 
             for event_to_parse in self._eventsNotParsed:
-                event = EventSolc(event_to_parse, self)
-                event.analyze(self)
-                event.set_contract(self)
-                event.set_offset(event_to_parse['src'], self.slither)
-                self._events[event.full_name] = event
+                event = Event()
+                event.set_contract(self._contract)
+                event.set_offset(event_to_parse["src"], self._contract.slither)
+
+                event_parser = EventSolc(event, event_to_parse, self)
+                event_parser.analyze(self)
+                self._contract.events_as_dict[event.full_name] = event
         except (VariableNotFound, KeyError) as e:
-            self.log_incorrect_parsing(f'Missing event {e}')
+            self.log_incorrect_parsing(f"Missing event {e}")
 
         self._eventsNotParsed = None
 
-    # endregion
-    ###################################################################################
-    ###################################################################################
-    # region SlithIR
-    ###################################################################################
-    ###################################################################################
-
-    def convert_expression_to_slithir(self):
-        for func in self.functions + self.modifiers:
-            try:
-                func.generate_slithir_and_analyze()
-            except AttributeError:
-                # This can happens for example if there is a call to an interface
-                # And the interface is redefined due to contract's name reuse
-                # But the available version misses some functions
-                self.log_incorrect_parsing(f'Impossible to generate IR for {self.name}.{func.name}')
-
-        all_ssa_state_variables_instances = dict()
-
-        for contract in self.inheritance:
-            for v in contract.state_variables_declared:
-                new_var = StateIRVariable(v)
-                all_ssa_state_variables_instances[v.canonical_name] = new_var
-                self._initial_state_variables.append(new_var)
-
-        for v in self.variables:
-            if v.contract == self:
-                new_var = StateIRVariable(v)
-                all_ssa_state_variables_instances[v.canonical_name] = new_var
-                self._initial_state_variables.append(new_var)
-
-        for func in self.functions + self.modifiers:
-            func.generate_slithir_ssa(all_ssa_state_variables_instances)
-
-    def fix_phi(self):
-        last_state_variables_instances = dict()
-        initial_state_variables_instances = dict()
-        for v in self._initial_state_variables:
-            last_state_variables_instances[v.canonical_name] = []
-            initial_state_variables_instances[v.canonical_name] = v
-
-        for func in self.functions + self.modifiers:
-            result = func.get_last_ssa_state_variables_instances()
-            for variable_name, instances in result.items():
-                last_state_variables_instances[variable_name] += instances
-
-        for func in self.functions + self.modifiers:
-            func.fix_phi(last_state_variables_instances, initial_state_variables_instances)
-
     # endregion
     ###################################################################################
     ###################################################################################
@@ -631,6 +621,6 @@ class ContractSolc04(Contract):
     ###################################################################################
 
     def __hash__(self):
-        return self._id
+        return self._contract.id
 
     # endregion

slither/solc_parsing/declarations/event.py

@@ -1,43 +1,55 @@
 """
     Event module
 """
+from typing import TYPE_CHECKING, Dict
+
+from slither.core.variables.event_variable import EventVariable
 from slither.solc_parsing.variables.event_variable import EventVariableSolc
 from slither.core.declarations.event import Event
 
-class EventSolc(Event):
+if TYPE_CHECKING:
+    from slither.solc_parsing.declarations.contract import ContractSolc
+
+
+class EventSolc:
     """
     Event class
     """
 
-    def __init__(self, event, contract):
-        super(EventSolc, self).__init__()
-        self._contract = contract
+    def __init__(self, event: Event, event_data: Dict, contract_parser: "ContractSolc"):
+
+        self._event = event
+        event.set_contract(contract_parser.underlying_contract)
+        self._parser_contract = contract_parser
 
-        self._elems = []
         if self.is_compact_ast:
-            self._name = event['name']
-            elems = event['parameters']
-            assert elems['nodeType'] == 'ParameterList'
-            self._elemsNotParsed = elems['parameters']
+            self._event.name = event_data["name"]
+            elems = event_data["parameters"]
+            assert elems["nodeType"] == "ParameterList"
+            self._elemsNotParsed = elems["parameters"]
         else:
-            self._name = event['attributes']['name']
-            elems = event['children'][0]
+            self._event.name = event_data["attributes"]["name"]
+            elems = event_data["children"][0]
 
-            assert elems['name'] == 'ParameterList'
-            if 'children' in elems:
-                self._elemsNotParsed = elems['children']
+            assert elems["name"] == "ParameterList"
+            if "children" in elems:
+                self._elemsNotParsed = elems["children"]
             else:
                 self._elemsNotParsed = []
 
     @property
-    def is_compact_ast(self):
-        return self.contract.is_compact_ast
+    def is_compact_ast(self) -> bool:
+        return self._parser_contract.is_compact_ast
 
-    def analyze(self, contract):
+    def analyze(self, contract: "ContractSolc"):
         for elem_to_parse in self._elemsNotParsed:
-            elem = EventVariableSolc(elem_to_parse)
-            elem.analyze(contract)
-            self._elems.append(elem)
+            elem = EventVariable()
+            # Todo: check if the source offset is always here
+            if "src" in elem_to_parse:
+                elem.set_offset(elem_to_parse["src"], self._parser_contract.slither)
+            elem_parser = EventVariableSolc(elem, elem_to_parse)
+            elem_parser.analyze(contract)
 
-        self._elemsNotParsed = []
+            self._event.elems.append(elem)
 
+        self._elemsNotParsed = []

slither/solc_parsing/declarations/modifier.py

@@ -1,15 +1,29 @@
 """
     Event module
 """
-from slither.core.declarations.modifier import Modifier
-from slither.solc_parsing.declarations.function import FunctionSolc
+from typing import Dict, TYPE_CHECKING
 
 from slither.core.cfg.node import NodeType
 from slither.core.cfg.node import link_nodes
+from slither.core.declarations.modifier import Modifier
+from slither.solc_parsing.cfg.node import NodeSolc
+from slither.solc_parsing.declarations.function import FunctionSolc
 
-class ModifierSolc(Modifier, FunctionSolc):
+if TYPE_CHECKING:
+    from slither.solc_parsing.declarations.contract import ContractSolc
 
 
+class ModifierSolc(FunctionSolc):
+    def __init__(self, modifier: Modifier, function_data: Dict, contract_parser: "ContractSolc"):
+        super().__init__(modifier, function_data, contract_parser)
+        # _modifier is equal to _function, but keep it here to prevent
+        # confusion for mypy in underlying_function
+        self._modifier = modifier
+
+    @property
+    def underlying_function(self) -> Modifier:
+        return self._modifier
+
     def analyze_params(self):
         # Can be re-analyzed due to inheritance
         if self._params_was_analyzed:
@@ -20,9 +34,9 @@ class ModifierSolc(Modifier, FunctionSolc):
         self._analyze_attributes()
 
         if self.is_compact_ast:
-            params = self._functionNotParsed['parameters']
+            params = self._functionNotParsed["parameters"]
         else:
-            children = self._functionNotParsed['children']
+            children = self._functionNotParsed["children"]
             params = children[0]
 
         if params:
@@ -34,41 +48,40 @@ class ModifierSolc(Modifier, FunctionSolc):
 
         self._content_was_analyzed = True
 
-
         if self.is_compact_ast:
-            body = self._functionNotParsed['body']
+            body = self._functionNotParsed["body"]
 
-            if body and body[self.get_key()] == 'Block':
-                self._is_implemented = True
+            if body and body[self.get_key()] == "Block":
+                self._function.is_implemented = True
                 self._parse_cfg(body)
 
         else:
-            children = self._functionNotParsed['children']
+            children = self._functionNotParsed["children"]
 
-            self._isImplemented = False
+            self._function.is_implemented = False
             if len(children) > 1:
                 assert len(children) == 2
                 block = children[1]
-                assert block['name'] == 'Block'
-                self._is_implemented = True
+                assert block["name"] == "Block"
+                self._function.is_implemented = True
                 self._parse_cfg(block)
 
-        for local_vars in self.variables:
-            local_vars.analyze(self)
+        for local_var_parser in self._local_variables_parser:
+            local_var_parser.analyze(self)
 
-        for node in self.nodes:
+        for node in self._node_to_nodesolc.values():
             node.analyze_expressions(self)
 
         self._filter_ternary()
         self._remove_alone_endif()
 
-        self._analyze_read_write()
-        self._analyze_calls()
+        # self._analyze_read_write()
+        # self._analyze_calls()
 
-    def _parse_statement(self, statement, node):
+    def _parse_statement(self, statement: Dict, node: NodeSolc) -> NodeSolc:
         name = statement[self.get_key()]
-        if name == 'PlaceholderStatement':
-            placeholder_node = self._new_node(NodeType.PLACEHOLDER, statement['src'])
-            link_nodes(node, placeholder_node)
+        if name == "PlaceholderStatement":
+            placeholder_node = self._new_node(NodeType.PLACEHOLDER, statement["src"])
+            link_nodes(node.underlying_node, placeholder_node.underlying_node)
             return placeholder_node
         return super(ModifierSolc, self)._parse_statement(statement, node)

slither/solc_parsing/declarations/structure.py

@@ -1,34 +1,47 @@
 """
     Structure module
 """
+from typing import List, TYPE_CHECKING
+
+from slither.core.variables.structure_variable import StructureVariable
 from slither.solc_parsing.variables.structure_variable import StructureVariableSolc
 from slither.core.declarations.structure import Structure
 
-class StructureSolc(Structure):
+if TYPE_CHECKING:
+    from slither.solc_parsing.declarations.contract import ContractSolc
+
+
+class StructureSolc:
     """
     Structure class
     """
-    # elems = [(type, name)]
 
+    # elems = [(type, name)]
 
-    def __init__(self, name, canonicalName, elems):
-        super(StructureSolc, self).__init__()
-        self._name = name
-        self._canonical_name = canonicalName
-        self._elems = {}
-        self._elems_ordered = []
+    def __init__(
+        self,
+        st: Structure,
+        name: str,
+        canonicalName: str,
+        elems: List[str],
+        contract_parser: "ContractSolc",
+    ):
+        self._structure = st
+        st.name = name
+        st.canonical_name = canonicalName
+        self._contract_parser = contract_parser
 
         self._elemsNotParsed = elems
 
     def analyze(self):
         for elem_to_parse in self._elemsNotParsed:
-            elem = StructureVariableSolc(elem_to_parse)
-            elem.set_structure(self)
-            elem.set_offset(elem_to_parse['src'], self.contract.slither)
+            elem = StructureVariable()
+            elem.set_structure(self._structure)
+            elem.set_offset(elem_to_parse["src"], self._structure.contract.slither)
 
-            elem.analyze(self.contract)
+            elem_parser = StructureVariableSolc(elem, elem_to_parse)
+            elem_parser.analyze(self._contract_parser)
 
-            self._elems[elem.name] = elem
-            self._elems_ordered.append(elem.name)
+            self._structure.elems[elem.name] = elem
+            self._structure.add_elem_in_order(elem.name)
         self._elemsNotParsed = []
-

slither/solc_parsing/exceptions.py

@@ -1,5 +1,9 @@
 from slither.exceptions import SlitherException
 
-class ParsingError(SlitherException): pass
 
-class VariableNotFound(SlitherException): pass
+class ParsingError(SlitherException):
+    pass
+
+
+class VariableNotFound(SlitherException):
+    pass

slither/solc_parsing/expressions/expression_parsing.py

@@ -1,23 +1,26 @@
 import logging
 import re
+from typing import Dict, TYPE_CHECKING, Optional, Union
 
+from slither.core.declarations import Event, Enum, Structure
 from slither.core.declarations.contract import Contract
 from slither.core.declarations.function import Function
-from slither.core.declarations.solidity_variables import (SOLIDITY_FUNCTIONS,
-                                                          SOLIDITY_VARIABLES,
-                                                          SOLIDITY_VARIABLES_COMPOSED,
-                                                          SolidityFunction,
-                                                          SolidityVariable,
-                                                          SolidityVariableComposed)
-from slither.core.expressions.assignment_operation import (AssignmentOperation,
-                                                           AssignmentOperationType)
-from slither.core.expressions.binary_operation import (BinaryOperation,
-                                                       BinaryOperationType)
+from slither.core.declarations.solidity_variables import (
+    SOLIDITY_FUNCTIONS,
+    SOLIDITY_VARIABLES,
+    SOLIDITY_VARIABLES_COMPOSED,
+    SolidityFunction,
+    SolidityVariable,
+    SolidityVariableComposed,
+)
+from slither.core.expressions.assignment_operation import (
+    AssignmentOperation,
+    AssignmentOperationType,
+)
+from slither.core.expressions.binary_operation import BinaryOperation, BinaryOperationType
 from slither.core.expressions.call_expression import CallExpression
-from slither.core.expressions.conditional_expression import \
-    ConditionalExpression
-from slither.core.expressions.elementary_type_name_expression import \
-    ElementaryTypeNameExpression
+from slither.core.expressions.conditional_expression import ConditionalExpression
+from slither.core.expressions.elementary_type_name_expression import ElementaryTypeNameExpression
 from slither.core.expressions.identifier import Identifier
 from slither.core.expressions.index_access import IndexAccess
 from slither.core.expressions.literal import Literal
@@ -29,16 +32,18 @@ from slither.core.expressions.super_call_expression import SuperCallExpression
 from slither.core.expressions.super_identifier import SuperIdentifier
 from slither.core.expressions.tuple_expression import TupleExpression
 from slither.core.expressions.type_conversion import TypeConversion
-from slither.core.expressions.unary_operation import (UnaryOperation,
-                                                      UnaryOperationType)
-from slither.core.solidity_types import (ArrayType, ElementaryType,
-                                         FunctionType, MappingType)
-from slither.solc_parsing.solidity_types.type_parsing import (UnknownType,
-                                                              parse_type)
+from slither.core.expressions.unary_operation import UnaryOperation, UnaryOperationType
+from slither.core.solidity_types import ArrayType, ElementaryType, FunctionType, MappingType
+from slither.core.variables.variable import Variable
 from slither.solc_parsing.exceptions import ParsingError, VariableNotFound
+from slither.solc_parsing.solidity_types.type_parsing import UnknownType, parse_type
 
-logger = logging.getLogger("ExpressionParsing")
+if TYPE_CHECKING:
+    from slither.core.expressions.expression import Expression
+    from slither.solc_parsing.declarations.function import FunctionSolc
+    from slither.solc_parsing.declarations.contract import ContractSolc
 
+logger = logging.getLogger("ExpressionParsing")
 
 ###################################################################################
 ###################################################################################
@@ -46,21 +51,34 @@ logger = logging.getLogger("ExpressionParsing")
 ###################################################################################
 ###################################################################################
 
-def get_pointer_name(variable):
+CallerContext = Union["ContractSolc", "FunctionSolc"]
+
+
+def get_pointer_name(variable: Variable):
     curr_type = variable.type
-    while (isinstance(curr_type, (ArrayType, MappingType))):
+    while isinstance(curr_type, (ArrayType, MappingType)):
         if isinstance(curr_type, ArrayType):
             curr_type = curr_type.type
         else:
             assert isinstance(curr_type, MappingType)
             curr_type = curr_type.type_to
 
-    if isinstance(curr_type, (FunctionType)):
+    if isinstance(curr_type, FunctionType):
         return variable.name + curr_type.parameters_signature
     return None
 
 
-def find_variable(var_name, caller_context, referenced_declaration=None, is_super=False):
+def find_variable(
+    var_name: str,
+    caller_context: CallerContext,
+    referenced_declaration: Optional[int] = None,
+    is_super=False,
+) -> Union[
+    Variable, Function, Contract, SolidityVariable, SolidityFunction, Event, Enum, Structure
+]:
+    from slither.solc_parsing.declarations.contract import ContractSolc
+    from slither.solc_parsing.declarations.function import FunctionSolc
+
     # variable are looked from the contract declarer
     # functions can be shadowed, but are looked from the contract instance, rather than the contract declarer
     # the difference between function and variable come from the fact that an internal call, or an variable access
@@ -76,24 +94,24 @@ def find_variable(var_name, caller_context, referenced_declaration=None, is_supe
     # 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
 
-    if isinstance(caller_context, Contract):
-        function = None
-        contract = caller_context
-        contract_declarer = caller_context
-    elif isinstance(caller_context, Function):
+    if isinstance(caller_context, ContractSolc):
+        function: Optional[FunctionSolc] = None
+        contract = caller_context.underlying_contract
+        contract_declarer = caller_context.underlying_contract
+    elif isinstance(caller_context, FunctionSolc):
         function = caller_context
-        contract = function.contract
-        contract_declarer = function.contract_declarer
+        contract = function.underlying_function.contract
+        contract_declarer = function.underlying_function.contract_declarer
     else:
-        raise ParsingError('Incorrect caller context')
+        raise ParsingError("Incorrect caller context")
 
     if function:
         # We look for variable declared with the referencedDeclaration attr
         func_variables = function.variables_renamed
         if referenced_declaration and referenced_declaration in func_variables:
-            return func_variables[referenced_declaration]
+            return func_variables[referenced_declaration].underlying_variable
         # If not found, check for name
-        func_variables = function.variables_as_dict()
+        func_variables = function.underlying_function.variables_as_dict
         if var_name in func_variables:
             return func_variables[var_name]
         # A local variable can be a pointer
@@ -101,12 +119,14 @@ def find_variable(var_name, caller_context, referenced_declaration=None, is_supe
         # function test(function(uint) internal returns(bool) t) interna{
         # Will have a local variable t which will match the signature
         # t(uint256)
-        func_variables_ptr = {get_pointer_name(f): f for f in function.variables}
+        func_variables_ptr = {
+            get_pointer_name(f): f for f in function.underlying_function.variables
+        }
         if var_name and var_name in func_variables_ptr:
             return func_variables_ptr[var_name]
 
     # variable are looked from the contract declarer
-    contract_variables = contract_declarer.variables_as_dict()
+    contract_variables = contract_declarer.variables_as_dict
     if var_name in contract_variables:
         return contract_variables[var_name]
 
@@ -118,8 +138,12 @@ def find_variable(var_name, caller_context, referenced_declaration=None, is_supe
     if is_super:
         getter_available = lambda f: f.functions_declared
         d = {f.canonical_name: f for f in contract.functions}
-        functions = {f.full_name: f for f in
-                     contract_declarer.available_elements_from_inheritances(d, getter_available).values()}
+        functions = {
+            f.full_name: f
+            for f in contract_declarer.available_elements_from_inheritances(
+                d, getter_available
+            ).values()
+        }
     else:
         functions = contract.available_functions_as_dict()
     if var_name in functions:
@@ -128,23 +152,27 @@ def find_variable(var_name, caller_context, referenced_declaration=None, is_supe
     if is_super:
         getter_available = lambda m: m.modifiers_declared
         d = {m.canonical_name: m for m in contract.modifiers}
-        modifiers = {m.full_name: m for m in
-                     contract_declarer.available_elements_from_inheritances(d, getter_available).values()}
+        modifiers = {
+            m.full_name: m
+            for m in contract_declarer.available_elements_from_inheritances(
+                d, getter_available
+            ).values()
+        }
     else:
         modifiers = contract.available_modifiers_as_dict()
     if var_name in modifiers:
         return modifiers[var_name]
 
     # structures are looked on the contract declarer
-    structures = contract.structures_as_dict()
+    structures = contract.structures_as_dict
     if var_name in structures:
         return structures[var_name]
 
-    events = contract.events_as_dict()
+    events = contract.events_as_dict
     if var_name in events:
         return events[var_name]
 
-    enums = contract.enums_as_dict()
+    enums = contract.enums_as_dict
     if var_name in enums:
         return enums[var_name]
 
@@ -154,7 +182,7 @@ def find_variable(var_name, caller_context, referenced_declaration=None, is_supe
         return enums[var_name]
 
     # Could refer to any enum
-    all_enums = [c.enums_as_dict() for c in contract.slither.contracts]
+    all_enums = [c.enums_as_dict for c in contract.slither.contracts]
     all_enums = {k: v for d in all_enums for k, v in d.items()}
     if var_name in all_enums:
         return all_enums[var_name]
@@ -165,19 +193,22 @@ def find_variable(var_name, caller_context, referenced_declaration=None, is_supe
     if var_name in SOLIDITY_FUNCTIONS:
         return SolidityFunction(var_name)
 
-    contracts = contract.slither.contracts_as_dict()
+    contracts = contract.slither.contracts_as_dict
     if var_name in contracts:
         return contracts[var_name]
 
     if referenced_declaration:
-        for contract in contract.slither.contracts:
-            if contract.id == referenced_declaration:
-                return contract
-        for function in contract.slither.functions:
-            if function.referenced_declaration == referenced_declaration:
-                return function
+        # id of the contracts is the referenced 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 contract.slither.contracts:
+            if contract_candidate.id == referenced_declaration:
+                return contract_candidate
+        for function_candidate in caller_context.slither_parser.all_functions_parser:
+            if function_candidate.referenced_declaration == referenced_declaration:
+                return function_candidate.underlying_function
 
-    raise VariableNotFound('Variable not found: {} (context {})'.format(var_name, caller_context))
+    raise VariableNotFound("Variable not found: {} (context {})".format(var_name, caller_context))
 
 
 # endregion
@@ -187,38 +218,39 @@ def find_variable(var_name, caller_context, referenced_declaration=None, is_supe
 ###################################################################################
 ###################################################################################
 
-def filter_name(value):
-    value = value.replace(' memory', '')
-    value = value.replace(' storage', '')
-    value = value.replace(' external', '')
-    value = value.replace(' internal', '')
-    value = value.replace('struct ', '')
-    value = value.replace('contract ', '')
-    value = value.replace('enum ', '')
-    value = value.replace(' ref', '')
-    value = value.replace(' pointer', '')
-    value = value.replace(' pure', '')
-    value = value.replace(' view', '')
-    value = value.replace(' constant', '')
-    value = value.replace(' payable', '')
-    value = value.replace('function (', 'function(')
-    value = value.replace('returns (', 'returns(')
+
+def filter_name(value: str) -> str:
+    value = value.replace(" memory", "")
+    value = value.replace(" storage", "")
+    value = value.replace(" external", "")
+    value = value.replace(" internal", "")
+    value = value.replace("struct ", "")
+    value = value.replace("contract ", "")
+    value = value.replace("enum ", "")
+    value = value.replace(" ref", "")
+    value = value.replace(" pointer", "")
+    value = value.replace(" pure", "")
+    value = value.replace(" view", "")
+    value = value.replace(" constant", "")
+    value = value.replace(" payable", "")
+    value = value.replace("function (", "function(")
+    value = value.replace("returns (", "returns(")
 
     # remove the text remaining after functio(...)
     # which should only be ..returns(...)
     # nested parenthesis so we use a system of counter on parenthesis
-    idx = value.find('(')
+    idx = value.find("(")
     if idx:
         counter = 1
         max_idx = len(value)
         while counter:
             assert idx < max_idx
             idx = idx + 1
-            if value[idx] == '(':
+            if value[idx] == "(":
                 counter += 1
-            elif value[idx] == ')':
+            elif value[idx] == ")":
                 counter -= 1
-        value = value[:idx + 1]
+        value = value[: idx + 1]
     return value
 
 
@@ -230,35 +262,38 @@ def filter_name(value):
 ###################################################################################
 ###################################################################################
 
-def parse_call(expression, caller_context):
-    src = expression['src']
+
+def parse_call(expression: Dict, caller_context):
+    src = expression["src"]
     if caller_context.is_compact_ast:
         attributes = expression
-        type_conversion = expression['kind'] == 'typeConversion'
-        type_return = attributes['typeDescriptions']['typeString']
+        type_conversion = expression["kind"] == "typeConversion"
+        type_return = attributes["typeDescriptions"]["typeString"]
 
     else:
-        attributes = expression['attributes']
-        type_conversion = attributes['type_conversion']
-        type_return = attributes['type']
+        attributes = expression["attributes"]
+        type_conversion = attributes["type_conversion"]
+        type_return = attributes["type"]
 
     if type_conversion:
         type_call = parse_type(UnknownType(type_return), caller_context)
 
         if caller_context.is_compact_ast:
-            assert len(expression['arguments']) == 1
-            expression_to_parse = expression['arguments'][0]
+            assert len(expression["arguments"]) == 1
+            expression_to_parse = expression["arguments"][0]
         else:
-            children = expression['children']
+            children = expression["children"]
             assert len(children) == 2
             type_info = children[0]
             expression_to_parse = children[1]
-            assert type_info['name'] in ['ElementaryTypenameExpression',
-                                         'ElementaryTypeNameExpression',
-                                         'Identifier',
-                                         'TupleExpression',
-                                         'IndexAccess',
-                                         'MemberAccess']
+            assert type_info["name"] in [
+                "ElementaryTypenameExpression",
+                "ElementaryTypeNameExpression",
+                "Identifier",
+                "TupleExpression",
+                "IndexAccess",
+                "MemberAccess",
+            ]
 
         expression = parse_expression(expression_to_parse, caller_context)
         t = TypeConversion(expression, type_call)
@@ -269,33 +304,33 @@ def parse_call(expression, caller_context):
     call_value = None
     call_salt = None
     if caller_context.is_compact_ast:
-        called = parse_expression(expression['expression'], caller_context)
+        called = parse_expression(expression["expression"], caller_context)
         # If the next expression is a FunctionCallOptions
         # We can here the gas/value information
         # This is only available if the syntax is {gas: , value: }
         # For the .gas().value(), the member are considered as function call
         # And converted later to the correct info (convert.py)
-        if expression['expression'][caller_context.get_key()] == 'FunctionCallOptions':
-            call_with_options = expression['expression']
-            for idx, name in enumerate(call_with_options.get('names', [])):
-                option = parse_expression(call_with_options['options'][idx], caller_context)
-                if name == 'value':
+        if expression["expression"][caller_context.get_key()] == "FunctionCallOptions":
+            call_with_options = expression["expression"]
+            for idx, name in enumerate(call_with_options.get("names", [])):
+                option = parse_expression(call_with_options["options"][idx], caller_context)
+                if name == "value":
                     call_value = option
-                if name == 'gas':
+                if name == "gas":
                     call_gas = option
-                if name == 'salt':
+                if name == "salt":
                     call_salt = option
         arguments = []
-        if expression['arguments']:
-            arguments = [parse_expression(a, caller_context) for a in expression['arguments']]
+        if expression["arguments"]:
+            arguments = [parse_expression(a, caller_context) for a in expression["arguments"]]
     else:
-        children = expression['children']
+        children = expression["children"]
         called = parse_expression(children[0], caller_context)
         arguments = [parse_expression(a, caller_context) for a in children[1::]]
 
     if isinstance(called, SuperCallExpression):
         sp = SuperCallExpression(called, arguments, type_return)
-        sp.set_offset(expression['src'], caller_context.slither)
+        sp.set_offset(expression["src"], caller_context.slither)
         return sp
     call_expression = CallExpression(called, arguments, type_return)
     call_expression.set_offset(src, caller_context.slither)
@@ -307,46 +342,48 @@ def parse_call(expression, caller_context):
     return call_expression
 
 
-def parse_super_name(expression, is_compact_ast):
+def parse_super_name(expression: Dict, is_compact_ast: bool) -> str:
     if is_compact_ast:
-        assert expression['nodeType'] == 'MemberAccess'
-        base_name = expression['memberName']
-        arguments = expression['typeDescriptions']['typeString']
+        assert expression["nodeType"] == "MemberAccess"
+        base_name = expression["memberName"]
+        arguments = expression["typeDescriptions"]["typeString"]
     else:
-        assert expression['name'] == 'MemberAccess'
-        attributes = expression['attributes']
-        base_name = attributes['member_name']
-        arguments = attributes['type']
+        assert expression["name"] == "MemberAccess"
+        attributes = expression["attributes"]
+        base_name = attributes["member_name"]
+        arguments = attributes["type"]
 
-    assert arguments.startswith('function ')
+    assert arguments.startswith("function ")
     # remove function (...()
-    arguments = arguments[len('function '):]
+    arguments = arguments[len("function ") :]
 
     arguments = filter_name(arguments)
-    if ' ' in arguments:
-        arguments = arguments[:arguments.find(' ')]
+    if " " in arguments:
+        arguments = arguments[: arguments.find(" ")]
 
     return base_name + arguments
 
 
-def _parse_elementary_type_name_expression(expression, is_compact_ast, caller_context):
+def _parse_elementary_type_name_expression(
+    expression: Dict, is_compact_ast: bool, caller_context
+) -> ElementaryTypeNameExpression:
     # nop exression
     # uint;
     if is_compact_ast:
-        value = expression['typeName']
+        value = expression["typeName"]
     else:
-        assert 'children' not in expression
-        value = expression['attributes']['value']
+        assert "children" not in expression
+        value = expression["attributes"]["value"]
     if isinstance(value, dict):
         t = parse_type(value, caller_context)
     else:
         t = parse_type(UnknownType(value), caller_context)
     e = ElementaryTypeNameExpression(t)
-    e.set_offset(expression['src'], caller_context.slither)
+    e.set_offset(expression["src"], caller_context.slither)
     return e
 
 
-def parse_expression(expression, caller_context):
+def parse_expression(expression: Dict, caller_context: CallerContext) -> "Expression":
     """
 
     Returns:
@@ -378,53 +415,53 @@ def parse_expression(expression, caller_context):
     # The AST naming does not follow the spec
     name = expression[caller_context.get_key()]
     is_compact_ast = caller_context.is_compact_ast
-    src = expression['src']
+    src = expression["src"]
 
-    if name == 'UnaryOperation':
+    if name == "UnaryOperation":
         if is_compact_ast:
             attributes = expression
         else:
-            attributes = expression['attributes']
-        assert 'prefix' in attributes
-        operation_type = UnaryOperationType.get_type(attributes['operator'], attributes['prefix'])
+            attributes = expression["attributes"]
+        assert "prefix" in attributes
+        operation_type = UnaryOperationType.get_type(attributes["operator"], attributes["prefix"])
 
         if is_compact_ast:
-            expression = parse_expression(expression['subExpression'], caller_context)
+            expression = parse_expression(expression["subExpression"], caller_context)
         else:
-            assert len(expression['children']) == 1
-            expression = parse_expression(expression['children'][0], caller_context)
+            assert len(expression["children"]) == 1
+            expression = parse_expression(expression["children"][0], caller_context)
         unary_op = UnaryOperation(expression, operation_type)
         unary_op.set_offset(src, caller_context.slither)
         return unary_op
 
-    elif name == 'BinaryOperation':
+    elif name == "BinaryOperation":
         if is_compact_ast:
             attributes = expression
         else:
-            attributes = expression['attributes']
-        operation_type = BinaryOperationType.get_type(attributes['operator'])
+            attributes = expression["attributes"]
+        operation_type = BinaryOperationType.get_type(attributes["operator"])
 
         if is_compact_ast:
-            left_expression = parse_expression(expression['leftExpression'], caller_context)
-            right_expression = parse_expression(expression['rightExpression'], caller_context)
+            left_expression = parse_expression(expression["leftExpression"], caller_context)
+            right_expression = parse_expression(expression["rightExpression"], caller_context)
         else:
-            assert len(expression['children']) == 2
-            left_expression = parse_expression(expression['children'][0], caller_context)
-            right_expression = parse_expression(expression['children'][1], caller_context)
+            assert len(expression["children"]) == 2
+            left_expression = parse_expression(expression["children"][0], caller_context)
+            right_expression = parse_expression(expression["children"][1], caller_context)
         binary_op = BinaryOperation(left_expression, right_expression, operation_type)
         binary_op.set_offset(src, caller_context.slither)
         return binary_op
 
-    elif name in 'FunctionCall':
+    elif name in "FunctionCall":
         return parse_call(expression, caller_context)
 
-    elif name == 'FunctionCallOptions':
+    elif name == "FunctionCallOptions":
         # call/gas info are handled in parse_call
-        called = parse_expression(expression['expression'], caller_context)
+        called = parse_expression(expression["expression"], caller_context)
         assert isinstance(called, (MemberAccess, NewContract))
         return called
 
-    elif name == 'TupleExpression':
+    elif name == "TupleExpression":
         """
             For expression like
             (a,,c) = (1,2,3)
@@ -437,35 +474,39 @@ def parse_expression(expression, caller_context):
             Note: this is only possible with Solidity >= 0.4.12
         """
         if is_compact_ast:
-            expressions = [parse_expression(e, caller_context) if e else None for e in expression['components']]
+            expressions = [
+                parse_expression(e, caller_context) if e else None for e in expression["components"]
+            ]
         else:
-            if 'children' not in expression:
-                attributes = expression['attributes']
-                components = attributes['components']
-                expressions = [parse_expression(c, caller_context) if c else None for c in components]
+            if "children" not in expression:
+                attributes = expression["attributes"]
+                components = attributes["components"]
+                expressions = [
+                    parse_expression(c, caller_context) if c else None for c in components
+                ]
             else:
-                expressions = [parse_expression(e, caller_context) for e in expression['children']]
+                expressions = [parse_expression(e, caller_context) for e in expression["children"]]
         # Add none for empty tuple items
         if "attributes" in expression:
-            if "type" in expression['attributes']:
-                t = expression['attributes']['type']
-                if ',,' in t or '(,' in t or ',)' in t:
-                    t = t[len('tuple('):-1]
-                    elems = t.split(',')
+            if "type" in expression["attributes"]:
+                t = expression["attributes"]["type"]
+                if ",," in t or "(," in t or ",)" in t:
+                    t = t[len("tuple(") : -1]
+                    elems = t.split(",")
                     for idx in range(len(elems)):
-                        if elems[idx] == '':
+                        if elems[idx] == "":
                             expressions.insert(idx, None)
         t = TupleExpression(expressions)
         t.set_offset(src, caller_context.slither)
         return t
 
-    elif name == 'Conditional':
+    elif name == "Conditional":
         if is_compact_ast:
-            if_expression = parse_expression(expression['condition'], caller_context)
-            then_expression = parse_expression(expression['trueExpression'], caller_context)
-            else_expression = parse_expression(expression['falseExpression'], caller_context)
+            if_expression = parse_expression(expression["condition"], caller_context)
+            then_expression = parse_expression(expression["trueExpression"], caller_context)
+            else_expression = parse_expression(expression["falseExpression"], caller_context)
         else:
-            children = expression['children']
+            children = expression["children"]
             assert len(children) == 3
             if_expression = parse_expression(children[0], caller_context)
             then_expression = parse_expression(children[1], caller_context)
@@ -474,100 +515,103 @@ def parse_expression(expression, caller_context):
         conditional.set_offset(src, caller_context.slither)
         return conditional
 
-    elif name == 'Assignment':
+    elif name == "Assignment":
         if is_compact_ast:
-            left_expression = parse_expression(expression['leftHandSide'], caller_context)
-            right_expression = parse_expression(expression['rightHandSide'], caller_context)
+            left_expression = parse_expression(expression["leftHandSide"], caller_context)
+            right_expression = parse_expression(expression["rightHandSide"], caller_context)
 
-            operation_type = AssignmentOperationType.get_type(expression['operator'])
+            operation_type = AssignmentOperationType.get_type(expression["operator"])
 
-            operation_return_type = expression['typeDescriptions']['typeString']
+            operation_return_type = expression["typeDescriptions"]["typeString"]
         else:
-            attributes = expression['attributes']
-            children = expression['children']
-            assert len(expression['children']) == 2
+            attributes = expression["attributes"]
+            children = expression["children"]
+            assert len(expression["children"]) == 2
             left_expression = parse_expression(children[0], caller_context)
             right_expression = parse_expression(children[1], caller_context)
 
-            operation_type = AssignmentOperationType.get_type(attributes['operator'])
-            operation_return_type = attributes['type']
+            operation_type = AssignmentOperationType.get_type(attributes["operator"])
+            operation_return_type = attributes["type"]
 
-        assignement = AssignmentOperation(left_expression, right_expression, operation_type, operation_return_type)
+        assignement = AssignmentOperation(
+            left_expression, right_expression, operation_type, operation_return_type
+        )
         assignement.set_offset(src, caller_context.slither)
         return assignement
 
-
-
-    elif name == 'Literal':
+    elif name == "Literal":
 
         subdenomination = None
 
-        assert 'children' not in expression
+        assert "children" not in expression
 
         if is_compact_ast:
-            value = expression['value']
+            value = expression["value"]
             if value:
-                if 'subdenomination' in expression and expression['subdenomination']:
-                    subdenomination = expression['subdenomination']
+                if "subdenomination" in expression and expression["subdenomination"]:
+                    subdenomination = expression["subdenomination"]
             elif not value and value != "":
-                value = '0x' + expression['hexValue']
-            type = expression['typeDescriptions']['typeString']
+                value = "0x" + expression["hexValue"]
+            type_candidate = expression["typeDescriptions"]["typeString"]
 
             # Length declaration for array was None until solc 0.5.5
-            if type is None:
-                if expression['kind'] == 'number':
-                    type = 'int_const'
+            if type_candidate is None:
+                if expression["kind"] == "number":
+                    type_candidate = "int_const"
         else:
-            value = expression['attributes']['value']
+            value = expression["attributes"]["value"]
             if value:
-                if 'subdenomination' in expression['attributes'] and expression['attributes']['subdenomination']:
-                    subdenomination = expression['attributes']['subdenomination']
+                if (
+                    "subdenomination" in expression["attributes"]
+                    and expression["attributes"]["subdenomination"]
+                ):
+                    subdenomination = expression["attributes"]["subdenomination"]
             elif value is None:
                 # for literal declared as hex
                 # see https://solidity.readthedocs.io/en/v0.4.25/types.html?highlight=hex#hexadecimal-literals
-                assert 'hexvalue' in expression['attributes']
-                value = '0x' + expression['attributes']['hexvalue']
-            type = expression['attributes']['type']
+                assert "hexvalue" in expression["attributes"]
+                value = "0x" + expression["attributes"]["hexvalue"]
+            type_candidate = expression["attributes"]["type"]
 
-        if type is None:
+        if type_candidate is None:
             if value.isdecimal():
-                type = ElementaryType('uint256')
+                type_candidate = ElementaryType("uint256")
             else:
-                type = ElementaryType('string')
-        elif type.startswith('int_const '):
-            type = ElementaryType('uint256')
-        elif type.startswith('bool'):
-            type = ElementaryType('bool')
-        elif type.startswith('address'):
-            type = ElementaryType('address')
+                type_candidate = ElementaryType("string")
+        elif type_candidate.startswith("int_const "):
+            type_candidate = ElementaryType("uint256")
+        elif type_candidate.startswith("bool"):
+            type_candidate = ElementaryType("bool")
+        elif type_candidate.startswith("address"):
+            type_candidate = ElementaryType("address")
         else:
-            type = ElementaryType('string')
-        literal = Literal(value, type, subdenomination)
+            type_candidate = ElementaryType("string")
+        literal = Literal(value, type_candidate, subdenomination)
         literal.set_offset(src, caller_context.slither)
         return literal
 
-    elif name == 'Identifier':
-        assert 'children' not in expression
+    elif name == "Identifier":
+        assert "children" not in expression
 
         t = None
 
         if caller_context.is_compact_ast:
-            value = expression['name']
-            t = expression['typeDescriptions']['typeString']
+            value = expression["name"]
+            t = expression["typeDescriptions"]["typeString"]
         else:
-            value = expression['attributes']['value']
-            if 'type' in expression['attributes']:
-                t = expression['attributes']['type']
+            value = expression["attributes"]["value"]
+            if "type" in expression["attributes"]:
+                t = expression["attributes"]["type"]
 
         if t:
-            found = re.findall('[struct|enum|function|modifier] \(([\[\] ()a-zA-Z0-9\.,_]*)\)', t)
+            found = re.findall("[struct|enum|function|modifier] \(([\[\] ()a-zA-Z0-9\.,_]*)\)", t)
             assert len(found) <= 1
             if found:
-                value = value + '(' + found[0] + ')'
+                value = value + "(" + found[0] + ")"
                 value = filter_name(value)
 
-        if 'referencedDeclaration' in expression:
-            referenced_declaration = expression['referencedDeclaration']
+        if "referencedDeclaration" in expression:
+            referenced_declaration = expression["referencedDeclaration"]
         else:
             referenced_declaration = None
 
@@ -577,14 +621,14 @@ def parse_expression(expression, caller_context):
         identifier.set_offset(src, caller_context.slither)
         return identifier
 
-    elif name == 'IndexAccess':
+    elif name == "IndexAccess":
         if is_compact_ast:
-            index_type = expression['typeDescriptions']['typeString']
-            left = expression['baseExpression']
-            right = expression['indexExpression']
+            index_type = expression["typeDescriptions"]["typeString"]
+            left = expression["baseExpression"]
+            right = expression["indexExpression"]
         else:
-            index_type = expression['attributes']['type']
-            children = expression['children']
+            index_type = expression["attributes"]["type"]
+            children = expression["children"]
             assert len(children) == 2
             left = children[0]
             right = children[1]
@@ -600,22 +644,22 @@ def parse_expression(expression, caller_context):
         index.set_offset(src, caller_context.slither)
         return index
 
-    elif name == 'MemberAccess':
+    elif name == "MemberAccess":
         if caller_context.is_compact_ast:
-            member_name = expression['memberName']
-            member_type = expression['typeDescriptions']['typeString']
-            member_expression = parse_expression(expression['expression'], caller_context)
+            member_name = expression["memberName"]
+            member_type = expression["typeDescriptions"]["typeString"]
+            member_expression = parse_expression(expression["expression"], caller_context)
         else:
-            member_name = expression['attributes']['member_name']
-            member_type = expression['attributes']['type']
-            children = expression['children']
+            member_name = expression["attributes"]["member_name"]
+            member_type = expression["attributes"]["type"]
+            children = expression["children"]
             assert len(children) == 1
             member_expression = parse_expression(children[0], caller_context)
-        if str(member_expression) == 'super':
+        if str(member_expression) == "super":
             super_name = parse_super_name(expression, is_compact_ast)
             var = find_variable(super_name, caller_context, is_super=True)
             if var is None:
-                raise VariableNotFound('Variable not found: {}'.format(super_name))
+                raise VariableNotFound("Variable not found: {}".format(super_name))
             sup = SuperIdentifier(var)
             sup.set_offset(src, caller_context.slither)
             return sup
@@ -627,81 +671,82 @@ def parse_expression(expression, caller_context):
             return idx
         return member_access
 
-    elif name == 'ElementaryTypeNameExpression':
+    elif name == "ElementaryTypeNameExpression":
         return _parse_elementary_type_name_expression(expression, is_compact_ast, caller_context)
 
-
     # NewExpression is not a root expression, it's always the child of another expression
-    elif name == 'NewExpression':
+    elif name == "NewExpression":
 
         if is_compact_ast:
-            type_name = expression['typeName']
+            type_name = expression["typeName"]
         else:
-            children = expression['children']
+            children = expression["children"]
             assert len(children) == 1
             type_name = children[0]
 
-        if type_name[caller_context.get_key()] == 'ArrayTypeName':
+        if type_name[caller_context.get_key()] == "ArrayTypeName":
             depth = 0
-            while type_name[caller_context.get_key()] == 'ArrayTypeName':
+            while type_name[caller_context.get_key()] == "ArrayTypeName":
                 # Note: dont conserve the size of the array if provided
                 # We compute it directly
                 if is_compact_ast:
-                    type_name = type_name['baseType']
+                    type_name = type_name["baseType"]
                 else:
-                    type_name = type_name['children'][0]
+                    type_name = type_name["children"][0]
                 depth += 1
-            if type_name[caller_context.get_key()] == 'ElementaryTypeName':
+            if type_name[caller_context.get_key()] == "ElementaryTypeName":
                 if is_compact_ast:
-                    array_type = ElementaryType(type_name['name'])
+                    array_type = ElementaryType(type_name["name"])
                 else:
-                    array_type = ElementaryType(type_name['attributes']['name'])
-            elif type_name[caller_context.get_key()] == 'UserDefinedTypeName':
+                    array_type = ElementaryType(type_name["attributes"]["name"])
+            elif type_name[caller_context.get_key()] == "UserDefinedTypeName":
                 if is_compact_ast:
-                    array_type = parse_type(UnknownType(type_name['name']), caller_context)
+                    array_type = parse_type(UnknownType(type_name["name"]), caller_context)
                 else:
-                    array_type = parse_type(UnknownType(type_name['attributes']['name']), caller_context)
-            elif type_name[caller_context.get_key()] == 'FunctionTypeName':
+                    array_type = parse_type(
+                        UnknownType(type_name["attributes"]["name"]), caller_context
+                    )
+            elif type_name[caller_context.get_key()] == "FunctionTypeName":
                 array_type = parse_type(type_name, caller_context)
             else:
-                raise ParsingError('Incorrect type array {}'.format(type_name))
+                raise ParsingError("Incorrect type array {}".format(type_name))
             array = NewArray(depth, array_type)
             array.set_offset(src, caller_context.slither)
             return array
 
-        if type_name[caller_context.get_key()] == 'ElementaryTypeName':
+        if type_name[caller_context.get_key()] == "ElementaryTypeName":
             if is_compact_ast:
-                elem_type = ElementaryType(type_name['name'])
+                elem_type = ElementaryType(type_name["name"])
             else:
-                elem_type = ElementaryType(type_name['attributes']['name'])
+                elem_type = ElementaryType(type_name["attributes"]["name"])
             new_elem = NewElementaryType(elem_type)
             new_elem.set_offset(src, caller_context.slither)
             return new_elem
 
-        assert type_name[caller_context.get_key()] == 'UserDefinedTypeName'
+        assert type_name[caller_context.get_key()] == "UserDefinedTypeName"
 
         if is_compact_ast:
-            contract_name = type_name['name']
+            contract_name = type_name["name"]
         else:
-            contract_name = type_name['attributes']['name']
+            contract_name = type_name["attributes"]["name"]
         new = NewContract(contract_name)
         new.set_offset(src, caller_context.slither)
         return new
 
-    elif name == 'ModifierInvocation':
+    elif name == "ModifierInvocation":
 
         if is_compact_ast:
-            called = parse_expression(expression['modifierName'], caller_context)
+            called = parse_expression(expression["modifierName"], caller_context)
             arguments = []
-            if expression['arguments']:
-                arguments = [parse_expression(a, caller_context) for a in expression['arguments']]
+            if expression["arguments"]:
+                arguments = [parse_expression(a, caller_context) for a in expression["arguments"]]
         else:
-            children = expression['children']
+            children = expression["children"]
             called = parse_expression(children[0], caller_context)
             arguments = [parse_expression(a, caller_context) for a in children[1::]]
 
-        call = CallExpression(called, arguments, 'Modifier')
+        call = CallExpression(called, arguments, "Modifier")
         call.set_offset(src, caller_context.slither)
         return call
 
-    raise ParsingError('Expression not parsed %s' % name)
+    raise ParsingError("Expression not parsed %s" % name)

slither/solc_parsing/slitherSolc.py

@@ -1,8 +1,8 @@
-import os
 import json
-import re
 import logging
-from typing import Optional, List
+import os
+import re
+from typing import List, Dict
 
 from slither.core.declarations import Contract
 from slither.exceptions import SlitherException
@@ -11,44 +11,63 @@ logging.basicConfig()
 logger = logging.getLogger("SlitherSolcParsing")
 logger.setLevel(logging.INFO)
 
-from slither.solc_parsing.declarations.contract import ContractSolc04
-from slither.core.slither_core import Slither
+from slither.solc_parsing.declarations.contract import ContractSolc
+from slither.solc_parsing.declarations.function import FunctionSolc
+from slither.core.slither_core import SlitherCore
 from slither.core.declarations.pragma_directive import Pragma
 from slither.core.declarations.import_directive import Import
 from slither.analyses.data_dependency.data_dependency import compute_dependency
 
 
-class SlitherSolc(Slither):
-
-    def __init__(self, filename):
+class SlitherSolc:
+    def __init__(self, filename: str, core: SlitherCore):
         super(SlitherSolc, self).__init__()
-        self._filename = filename
-        self._contractsNotParsed = []
-        self._contracts_by_id = {}
+        core.filename = filename
+        self._contracts_by_id: Dict[int, ContractSolc] = {}
         self._analyzed = False
 
+        self._underlying_contract_to_parser: Dict[Contract, ContractSolc] = dict()
+
         self._is_compact_ast = False
+        self._core: SlitherCore = core
+
+        self._all_functions_parser: List[FunctionSolc] = []
 
         self._top_level_contracts_counter = 0
 
+    @property
+    def core(self):
+        return self._core
+
+    @property
+    def all_functions_parser(self) -> List[FunctionSolc]:
+        return self._all_functions_parser
+
+    def add_functions_parser(self, f: FunctionSolc):
+        self._all_functions_parser.append(f)
+
+    @property
+    def underlying_contract_to_parser(self) -> Dict[Contract, ContractSolc]:
+        return self._underlying_contract_to_parser
+
     ###################################################################################
     ###################################################################################
     # region AST
     ###################################################################################
     ###################################################################################
 
-    def get_key(self):
+    def get_key(self) -> str:
         if self._is_compact_ast:
-            return 'nodeType'
-        return 'name'
+            return "nodeType"
+        return "name"
 
-    def get_children(self):
+    def get_children(self) -> str:
         if self._is_compact_ast:
-            return 'nodes'
-        return 'children'
+            return "nodes"
+        return "children"
 
     @property
-    def is_compact_ast(self):
+    def is_compact_ast(self) -> bool:
         return self._is_compact_ast
 
     # endregion
@@ -58,139 +77,147 @@ class SlitherSolc(Slither):
     ###################################################################################
     ###################################################################################
 
-    def _parse_contracts_from_json(self, json_data):
+    def parse_contracts_from_json(self, json_data: str) -> bool:
         try:
             data_loaded = json.loads(json_data)
             # Truffle AST
-            if 'ast' in data_loaded:
-                self._parse_contracts_from_loaded_json(data_loaded['ast'], data_loaded['sourcePath'])
+            if "ast" in data_loaded:
+                self.parse_contracts_from_loaded_json(data_loaded["ast"], data_loaded["sourcePath"])
                 return True
             # solc AST, where the non-json text was removed
             else:
-                if 'attributes' in data_loaded:
-                    filename = data_loaded['attributes']['absolutePath']
+                if "attributes" in data_loaded:
+                    filename = data_loaded["attributes"]["absolutePath"]
                 else:
-                    filename = data_loaded['absolutePath']
-                self._parse_contracts_from_loaded_json(data_loaded, filename)
+                    filename = data_loaded["absolutePath"]
+                self.parse_contracts_from_loaded_json(data_loaded, filename)
                 return True
         except ValueError:
 
-            first = json_data.find('{')
+            first = json_data.find("{")
             if first != -1:
-                last = json_data.rfind('}') + 1
+                last = json_data.rfind("}") + 1
                 filename = json_data[0:first]
                 json_data = json_data[first:last]
 
                 data_loaded = json.loads(json_data)
-                self._parse_contracts_from_loaded_json(data_loaded, filename)
+                self.parse_contracts_from_loaded_json(data_loaded, filename)
                 return True
             return False
 
-    def _parse_contracts_from_loaded_json(self, data_loaded, filename):
-        if 'nodeType' in data_loaded:
+    def parse_contracts_from_loaded_json(self, data_loaded: Dict, filename: str):
+        if "nodeType" in data_loaded:
             self._is_compact_ast = True
 
-        if 'sourcePaths' in data_loaded:
-            for sourcePath in data_loaded['sourcePaths']:
+        if "sourcePaths" in data_loaded:
+            for sourcePath in data_loaded["sourcePaths"]:
                 if os.path.isfile(sourcePath):
-                    self._add_source_code(sourcePath)
+                    self._core.add_source_code(sourcePath)
 
-        if data_loaded[self.get_key()] == 'root':
-            self._solc_version = '0.3'
-            logger.error('solc <0.4 is not supported')
+        if data_loaded[self.get_key()] == "root":
+            self._solc_version = "0.3"
+            logger.error("solc <0.4 is not supported")
             return
-        elif data_loaded[self.get_key()] == 'SourceUnit':
-            self._solc_version = '0.4'
+        elif data_loaded[self.get_key()] == "SourceUnit":
+            self._solc_version = "0.4"
             self._parse_source_unit(data_loaded, filename)
         else:
-            logger.error('solc version is not supported')
+            logger.error("solc version is not supported")
             return
 
         for contract_data in data_loaded[self.get_children()]:
 
-            assert contract_data[self.get_key()] in ['ContractDefinition',
-                                                     'PragmaDirective',
-                                                     'ImportDirective',
-                                                     'StructDefinition',
-                                                     'EnumDefinition']
-            if contract_data[self.get_key()] == 'ContractDefinition':
-                contract = ContractSolc04(self, contract_data)
-                if 'src' in contract_data:
-                    contract.set_offset(contract_data['src'], self)
-                self._contractsNotParsed.append(contract)
-            elif contract_data[self.get_key()] == 'PragmaDirective':
+            assert contract_data[self.get_key()] in [
+                "ContractDefinition",
+                "PragmaDirective",
+                "ImportDirective",
+                "StructDefinition",
+                "EnumDefinition",
+            ]
+            if contract_data[self.get_key()] == "ContractDefinition":
+                contract = Contract()
+                contract_parser = ContractSolc(self, contract, contract_data)
+                if "src" in contract_data:
+                    contract.set_offset(contract_data["src"], self._core)
+
+                self._underlying_contract_to_parser[contract] = contract_parser
+
+            elif contract_data[self.get_key()] == "PragmaDirective":
                 if self._is_compact_ast:
-                    pragma = Pragma(contract_data['literals'])
+                    pragma = Pragma(contract_data["literals"])
                 else:
-                    pragma = Pragma(contract_data['attributes']["literals"])
-                pragma.set_offset(contract_data['src'], self)
-                self._pragma_directives.append(pragma)
-            elif contract_data[self.get_key()] == 'ImportDirective':
+                    pragma = Pragma(contract_data["attributes"]["literals"])
+                pragma.set_offset(contract_data["src"], self._core)
+                self._core.pragma_directives.append(pragma)
+            elif contract_data[self.get_key()] == "ImportDirective":
                 if self.is_compact_ast:
                     import_directive = Import(contract_data["absolutePath"])
                 else:
-                    import_directive = Import(contract_data['attributes']["absolutePath"])
-                import_directive.set_offset(contract_data['src'], self)
-                self._import_directives.append(import_directive)
+                    import_directive = Import(contract_data["attributes"]["absolutePath"])
+                import_directive.set_offset(contract_data["src"], self._core)
+                self._core.import_directives.append(import_directive)
 
-            elif contract_data[self.get_key()] in ['StructDefinition', 'EnumDefinition']:
+            elif contract_data[self.get_key()] in ["StructDefinition", "EnumDefinition"]:
                 # This can only happen for top-level structure and enum
                 # They were introduced with 0.6.5
-                assert self._is_compact_ast # Do not support top level definition for legacy AST
+                assert self._is_compact_ast  # Do not support top level definition for legacy AST
                 fake_contract_data = {
-                    'name': f'SlitherInternalTopLevelContract{self._top_level_contracts_counter}',
-                    'id': -1000, # TODO: determine if collission possible
-                    'linearizedBaseContracts': [],
-                    'fullyImplemented': True,
-                    'contractKind': 'SLitherInternal'
+                    "name": f"SlitherInternalTopLevelContract{self._top_level_contracts_counter}",
+                    "id": -1000,  # TODO: determine if collission possible
+                    "linearizedBaseContracts": [],
+                    "fullyImplemented": True,
+                    "contractKind": "SLitherInternal",
                 }
                 self._top_level_contracts_counter += 1
-                top_level_contract = ContractSolc04(self, fake_contract_data)
+                top_level_contract = ContractSolc(self, fake_contract_data)
                 top_level_contract.is_top_level = True
-                top_level_contract.set_offset(contract_data['src'], self)
+                top_level_contract.set_offset(contract_data["src"], self)
 
-                if contract_data[self.get_key()] == 'StructDefinition':
-                    top_level_contract._structuresNotParsed.append(contract_data)  # Todo add proper setters
+                if contract_data[self.get_key()] == "StructDefinition":
+                    top_level_contract._structuresNotParsed.append(
+                        contract_data
+                    )  # Todo add proper setters
                 else:
-                    top_level_contract._enumsNotParsed.append(contract_data)  # Todo add proper setters
+                    top_level_contract._enumsNotParsed.append(
+                        contract_data
+                    )  # Todo add proper setters
 
                 self._contractsNotParsed.append(top_level_contract)
 
-
-    def _parse_source_unit(self, data, filename):
-        if data[self.get_key()] != 'SourceUnit':
+    def _parse_source_unit(self, data: Dict, filename: str):
+        if data[self.get_key()] != "SourceUnit":
             return -1  # handle solc prior 0.3.6
 
         # match any char for filename
         # filename can contain space, /, -, ..
-        name = re.findall('=+ (.+) =+', filename)
-        if name:
-            assert len(name) == 1
-            name = name[0]
+        name_candidates = re.findall("=+ (.+) =+", filename)
+        if name_candidates:
+            assert len(name_candidates) == 1
+            name: str = name_candidates[0]
         else:
             name = filename
 
         sourceUnit = -1  # handle old solc, or error
-        if 'src' in data:
-            sourceUnit = re.findall('[0-9]*:[0-9]*:([0-9]*)', data['src'])
-            if len(sourceUnit) == 1:
-                sourceUnit = int(sourceUnit[0])
+        if "src" in data:
+            sourceUnit_candidates = re.findall("[0-9]*:[0-9]*:([0-9]*)", data["src"])
+            if len(sourceUnit_candidates) == 1:
+                sourceUnit = int(sourceUnit_candidates[0])
         if sourceUnit == -1:
             # if source unit is not found
             # We can still deduce it, by assigning to the last source_code added
             # This works only for crytic compile.
             # which used --combined-json ast, rather than --ast-json
             # As a result -1 is not used as index
-            if self.crytic_compile is not None:
-                sourceUnit = len(self.source_code)
+            if self._core.crytic_compile is not None:
+                sourceUnit = len(self._core.source_code)
 
-        self._source_units[sourceUnit] = name
-        if os.path.isfile(name) and not name in self.source_code:
-            self._add_source_code(name)
+        self._core.source_units[sourceUnit] = name
+        if os.path.isfile(name) and not name in self._core.source_code:
+            self._core.add_source_code(name)
         else:
-            lib_name = os.path.join('node_modules', name)
-            if os.path.isfile(lib_name) and not name in self.source_code:
-                self._add_source_code(lib_name)
+            lib_name = os.path.join("node_modules", name)
+            if os.path.isfile(lib_name) and not name in self._core.source_code:
+                self._core.add_source_code(lib_name)
 
     # endregion
     ###################################################################################
@@ -200,32 +227,42 @@ class SlitherSolc(Slither):
     ###################################################################################
 
     @property
-    def analyzed(self):
+    def analyzed(self) -> bool:
         return self._analyzed
 
-    def _analyze_contracts(self):
-        if not self._contractsNotParsed:
-            logger.info(f'No contract were found in {self.filename}, check the correct compilation')
+    def analyze_contracts(self):
+        if not self._underlying_contract_to_parser:
+            logger.info(
+                f"No contract were found in {self._core.filename}, check the correct compilation"
+            )
         if self._analyzed:
-            raise Exception('Contract analysis can be run only once!')
+            raise Exception("Contract analysis can be run only once!")
 
         # First we save all the contracts in a dict
         # the key is the contractid
-        for contract in self._contractsNotParsed:
-            if contract.name.startswith('SlitherInternalTopLevelContract') and not contract.is_top_level:
-                raise SlitherException("""Your codebase has a contract named 'SlitherInternalTopLevelContract'.
-Please rename it, this name is reserved for Slither's internals""")
-            if contract.name in self._contracts:
-                if contract.id != self._contracts[contract.name].id:
-                    self._contract_name_collisions[contract.name].append(contract.source_mapping_str)
-                    self._contract_name_collisions[contract.name].append(
-                        self._contracts[contract.name].source_mapping_str)
+        for contract in self._underlying_contract_to_parser.keys():
+            if (
+                    contract.name.startswith("SlitherInternalTopLevelContract")
+                    and not contract.is_top_level
+            ):
+                raise SlitherException(
+                    """Your codebase has a contract named 'SlitherInternalTopLevelContract'.
+Please rename it, this name is reserved for Slither's internals"""
+                )
+            if contract.name in self._core.contracts_as_dict:
+                if contract.id != self._core.contracts_as_dict[contract.name].id:
+                    self._core.contract_name_collisions[contract.name].append(
+                        contract.source_mapping_str
+                    )
+                    self._core.contract_name_collisions[contract.name].append(
+                        self._core.contracts_as_dict[contract.name].source_mapping_str
+                    )
             else:
                 self._contracts_by_id[contract.id] = contract
-                self._contracts[contract.name] = contract
+                self._core.contracts_as_dict[contract.name] = contract
 
         # Update of the inheritance
-        for contract in self._contractsNotParsed:
+        for contract_parser in self._underlying_contract_to_parser.values():
             # remove the first elem in linearizedBaseContracts as it is the contract itself
             ancestors = []
             fathers = []
@@ -234,58 +271,70 @@ Please rename it, this name is reserved for Slither's internals""")
             # Resolve linearized base contracts.
             missing_inheritance = False
 
-            for i in contract.linearizedBaseContracts[1:]:
-                if i in contract.remapping:
-                    ancestors.append(self.get_contract_from_name(contract.remapping[i]))
+            for i in contract_parser.linearized_base_contracts[1:]:
+                if i in contract_parser.remapping:
+                    ancestors.append(
+                        self._core.get_contract_from_name(contract_parser.remapping[i])
+                    )
                 elif i in self._contracts_by_id:
                     ancestors.append(self._contracts_by_id[i])
                 else:
                     missing_inheritance = True
 
             # Resolve immediate base contracts
-            for i in contract.baseContracts:
-                if i in contract.remapping:
-                    fathers.append(self.get_contract_from_name(contract.remapping[i]))
+            for i in contract_parser.baseContracts:
+                if i in contract_parser.remapping:
+                    fathers.append(self._core.get_contract_from_name(contract_parser.remapping[i]))
                 elif i in self._contracts_by_id:
                     fathers.append(self._contracts_by_id[i])
                 else:
                     missing_inheritance = True
 
             # Resolve immediate base constructor calls
-            for i in contract.baseConstructorContractsCalled:
-                if i in contract.remapping:
-                    father_constructors.append(self.get_contract_from_name(contract.remapping[i]))
+            for i in contract_parser.baseConstructorContractsCalled:
+                if i in contract_parser.remapping:
+                    father_constructors.append(
+                        self._core.get_contract_from_name(contract_parser.remapping[i])
+                    )
                 elif i in self._contracts_by_id:
                     father_constructors.append(self._contracts_by_id[i])
                 else:
                     missing_inheritance = True
 
-            contract.setInheritance(ancestors, fathers, father_constructors)
+            contract_parser.underlying_contract.set_inheritance(
+                ancestors, fathers, father_constructors
+            )
 
             if missing_inheritance:
-                self._contract_with_missing_inheritance.add(contract)
-                contract.log_incorrect_parsing(f'Missing inheritance {contract}')
-                contract.set_is_analyzed(True)
-                contract.delete_content()
+                self._core.contracts_with_missing_inheritance.add(
+                    contract_parser.underlying_contract
+                )
+                contract_parser.log_incorrect_parsing(f"Missing inheritance {contract_parser}")
+                contract_parser.set_is_analyzed(True)
+                contract_parser.delete_content()
 
-        contracts_to_be_analyzed = self.contracts
+        contracts_to_be_analyzed = list(self._underlying_contract_to_parser.values())
 
         # Any contract can refer another contract enum without need for inheritance
         self._analyze_all_enums(contracts_to_be_analyzed)
-        [c.set_is_analyzed(False) for c in self.contracts]
+        [c.set_is_analyzed(False) for c in self._underlying_contract_to_parser.values()]
 
-        libraries = [c for c in contracts_to_be_analyzed if c.contract_kind == 'library']
-        contracts_to_be_analyzed = [c for c in contracts_to_be_analyzed if c.contract_kind != 'library']
+        libraries = [
+            c for c in contracts_to_be_analyzed if c.underlying_contract.contract_kind == "library"
+        ]
+        contracts_to_be_analyzed = [
+            c for c in contracts_to_be_analyzed if c.underlying_contract.contract_kind != "library"
+        ]
 
         # We first parse the struct/variables/functions/contract
         self._analyze_first_part(contracts_to_be_analyzed, libraries)
-        [c.set_is_analyzed(False) for c in self.contracts]
+        [c.set_is_analyzed(False) for c in self._underlying_contract_to_parser.values()]
 
         # We analyze the struct and parse and analyze the events
         # A contract can refer in the variables a struct or a event from any contract
         # (without inheritance link)
         self._analyze_second_part(contracts_to_be_analyzed, libraries)
-        [c.set_is_analyzed(False) for c in self.contracts]
+        [c.set_is_analyzed(False) for c in self._underlying_contract_to_parser.values()]
 
         # Then we analyse state variables, functions and modifiers
         self._analyze_third_part(contracts_to_be_analyzed, libraries)
@@ -294,22 +343,27 @@ Please rename it, this name is reserved for Slither's internals""")
 
         self._convert_to_slithir()
 
-        compute_dependency(self)
+        compute_dependency(self._core)
 
-    def _analyze_all_enums(self, contracts_to_be_analyzed):
+    def _analyze_all_enums(self, contracts_to_be_analyzed: List[ContractSolc]):
         while contracts_to_be_analyzed:
             contract = contracts_to_be_analyzed[0]
 
             contracts_to_be_analyzed = contracts_to_be_analyzed[1:]
-            all_father_analyzed = all(father.is_analyzed for father in contract.inheritance)
+            all_father_analyzed = all(
+                self._underlying_contract_to_parser[father].is_analyzed
+                for father in contract.underlying_contract.inheritance
+            )
 
-            if not contract.inheritance or all_father_analyzed:
+            if not contract.underlying_contract.inheritance or all_father_analyzed:
                 self._analyze_enums(contract)
             else:
                 contracts_to_be_analyzed += [contract]
         return
 
-    def _analyze_first_part(self, contracts_to_be_analyzed, libraries):
+    def _analyze_first_part(
+            self, contracts_to_be_analyzed: List[ContractSolc], libraries: List[ContractSolc]
+    ):
         for lib in libraries:
             self._parse_struct_var_modifiers_functions(lib)
 
@@ -321,16 +375,21 @@ Please rename it, this name is reserved for Slither's internals""")
             contract = contracts_to_be_analyzed[0]
 
             contracts_to_be_analyzed = contracts_to_be_analyzed[1:]
-            all_father_analyzed = all(father.is_analyzed for father in contract.inheritance)
+            all_father_analyzed = all(
+                self._underlying_contract_to_parser[father].is_analyzed
+                for father in contract.underlying_contract.inheritance
+            )
 
-            if not contract.inheritance or all_father_analyzed:
+            if not contract.underlying_contract.inheritance or all_father_analyzed:
                 self._parse_struct_var_modifiers_functions(contract)
 
             else:
                 contracts_to_be_analyzed += [contract]
         return
 
-    def _analyze_second_part(self, contracts_to_be_analyzed, libraries):
+    def _analyze_second_part(
+            self, contracts_to_be_analyzed: List[ContractSolc], libraries: List[ContractSolc]
+    ):
         for lib in libraries:
             self._analyze_struct_events(lib)
 
@@ -342,16 +401,21 @@ Please rename it, this name is reserved for Slither's internals""")
             contract = contracts_to_be_analyzed[0]
 
             contracts_to_be_analyzed = contracts_to_be_analyzed[1:]
-            all_father_analyzed = all(father.is_analyzed for father in contract.inheritance)
+            all_father_analyzed = all(
+                self._underlying_contract_to_parser[father].is_analyzed
+                for father in contract.underlying_contract.inheritance
+            )
 
-            if not contract.inheritance or all_father_analyzed:
+            if not contract.underlying_contract.inheritance or all_father_analyzed:
                 self._analyze_struct_events(contract)
 
             else:
                 contracts_to_be_analyzed += [contract]
         return
 
-    def _analyze_third_part(self, contracts_to_be_analyzed, libraries):
+    def _analyze_third_part(
+            self, contracts_to_be_analyzed: List[ContractSolc], libraries: List[ContractSolc]
+    ):
         for lib in libraries:
             self._analyze_variables_modifiers_functions(lib)
 
@@ -363,28 +427,31 @@ Please rename it, this name is reserved for Slither's internals""")
             contract = contracts_to_be_analyzed[0]
 
             contracts_to_be_analyzed = contracts_to_be_analyzed[1:]
-            all_father_analyzed = all(father.is_analyzed for father in contract.inheritance)
+            all_father_analyzed = all(
+                self._underlying_contract_to_parser[father].is_analyzed
+                for father in contract.underlying_contract.inheritance
+            )
 
-            if not contract.inheritance or all_father_analyzed:
+            if not contract.underlying_contract.inheritance or all_father_analyzed:
                 self._analyze_variables_modifiers_functions(contract)
 
             else:
                 contracts_to_be_analyzed += [contract]
         return
 
-    def _analyze_enums(self, contract):
+    def _analyze_enums(self, contract: ContractSolc):
         # Enum must be analyzed first
         contract.analyze_enums()
         contract.set_is_analyzed(True)
 
-    def _parse_struct_var_modifiers_functions(self, contract):
+    def _parse_struct_var_modifiers_functions(self, contract: ContractSolc):
         contract.parse_structs()  # struct can refer another struct
         contract.parse_state_variables()
         contract.parse_modifiers()
         contract.parse_functions()
         contract.set_is_analyzed(True)
 
-    def _analyze_struct_events(self, contract):
+    def _analyze_struct_events(self, contract: ContractSolc):
 
         contract.analyze_constant_state_variables()
 
@@ -397,7 +464,7 @@ Please rename it, this name is reserved for Slither's internals""")
 
         contract.set_is_analyzed(True)
 
-    def _analyze_variables_modifiers_functions(self, contract):
+    def _analyze_variables_modifiers_functions(self, contract: ContractSolc):
         # State variables, modifiers and functions can refer to anything
 
         contract.analyze_params_modifiers()
@@ -412,11 +479,23 @@ Please rename it, this name is reserved for Slither's internals""")
 
     def _convert_to_slithir(self):
 
-        for contract in self.contracts:
+        for contract in self._core.contracts:
             contract.add_constructor_variables()
-            contract.convert_expression_to_slithir()
-        self._propagate_function_calls()
-        for contract in self.contracts:
+
+            for func in contract.functions + contract.modifiers:
+                try:
+                    func.generate_slithir_and_analyze()
+                except AttributeError:
+                    # This can happens for example if there is a call to an interface
+                    # And the interface is redefined due to contract's name reuse
+                    # But the available version misses some functions
+                    self._underlying_contract_to_parser[contract].log_incorrect_parsing(
+                        f"Impossible to generate IR for {contract.name}.{func.name}"
+                    )
+
+            contract.convert_expression_to_slithir_ssa()
+        self._core.propagate_function_calls()
+        for contract in self._core.contracts:
             contract.fix_phi()
             contract.update_read_write_using_ssa()
 

slither/solc_parsing/solidity_types/type_parsing.py

@@ -1,6 +1,8 @@
 import logging
+from typing import List, TYPE_CHECKING, Union, Dict
 
 from slither.core.solidity_types.elementary_type import ElementaryType, ElementaryTypeName
+from slither.core.solidity_types.type import Type
 from slither.core.solidity_types.user_defined_type import UserDefinedType
 from slither.core.solidity_types.array_type import ArrayType
 from slither.core.solidity_types.mapping_type import MappingType
@@ -9,14 +11,17 @@ from slither.core.solidity_types.function_type import FunctionType
 from slither.core.variables.function_type_variable import FunctionTypeVariable
 
 from slither.core.declarations.contract import Contract
-from slither.core.declarations.function import Function
 
 from slither.core.expressions.literal import Literal
 
 from slither.solc_parsing.exceptions import ParsingError
 import re
 
-logger = logging.getLogger('TypeParsing')
+if TYPE_CHECKING:
+    from slither.core.declarations import Structure, Enum
+
+logger = logging.getLogger("TypeParsing")
+
 
 class UnknownType:
     def __init__(self, name):
@@ -26,24 +31,31 @@ class UnknownType:
     def name(self):
         return self._name
 
-def _find_from_type_name(name, contract, contracts, structures, enums):
-    name_elementary = name.split(' ')[0]
-    if '[' in name_elementary:
-        name_elementary = name_elementary[0:name_elementary.find('[')]
+
+def _find_from_type_name(
+    name: str,
+    contract: Contract,
+    contracts: List[Contract],
+    structures: List["Structure"],
+    enums: List["Enum"],
+) -> Type:
+    name_elementary = name.split(" ")[0]
+    if "[" in name_elementary:
+        name_elementary = name_elementary[0 : name_elementary.find("[")]
     if name_elementary in ElementaryTypeName:
-        depth = name.count('[')
+        depth = name.count("[")
         if depth:
-            return ArrayType(ElementaryType(name_elementary), Literal(depth, 'uint256'))
+            return ArrayType(ElementaryType(name_elementary), Literal(depth, "uint256"))
         else:
             return ElementaryType(name_elementary)
     # We first look for contract
     # To avoid collision
     # Ex: a structure with the name of a contract
     name_contract = name
-    if name_contract.startswith('contract '):
-        name_contract = name_contract[len('contract '):]
-    if name_contract.startswith('library '):
-        name_contract = name_contract[len('library '):]
+    if name_contract.startswith("contract "):
+        name_contract = name_contract[len("contract ") :]
+    if name_contract.startswith("library "):
+        name_contract = name_contract[len("library ") :]
     var_type = next((c for c in contracts if c.name == name_contract), None)
 
     if not var_type:
@@ -53,8 +65,8 @@ def _find_from_type_name(name, contract, contracts, structures, enums):
     if not var_type:
         # any contract can refer to another contract's enum
         enum_name = name
-        if enum_name.startswith('enum '):
-            enum_name = enum_name[len('enum '):]
+        if enum_name.startswith("enum "):
+            enum_name = enum_name[len("enum ") :]
         all_enums = [c.enums for c in contracts]
         all_enums = [item for sublist in all_enums for item in sublist]
         var_type = next((e for e in all_enums if e.name == enum_name), None)
@@ -63,9 +75,9 @@ def _find_from_type_name(name, contract, contracts, structures, enums):
     if not var_type:
         # any contract can refer to another contract's structure
         name_struct = name
-        if name_struct.startswith('struct '):
-            name_struct = name_struct[len('struct '):]
-            name_struct = name_struct.split(' ')[0] # remove stuff like storage pointer at the end
+        if name_struct.startswith("struct "):
+            name_struct = name_struct[len("struct ") :]
+            name_struct = name_struct.split(" ")[0]  # remove stuff like storage pointer at the end
         all_structures = [c.structures for c in contracts]
         all_structures = [item for sublist in all_structures for item in sublist]
         var_type = next((st for st in all_structures if st.name == name_struct), None)
@@ -74,41 +86,50 @@ def _find_from_type_name(name, contract, contracts, structures, enums):
         # case where struct xxx.xx[] where not well formed in the AST
         if not var_type:
             depth = 0
-            while name_struct.endswith('[]'):
+            while name_struct.endswith("[]"):
                 name_struct = name_struct[0:-2]
-                depth+=1
+                depth += 1
             var_type = next((st for st in all_structures if st.canonical_name == name_struct), None)
             if var_type:
-                return ArrayType(UserDefinedType(var_type), Literal(depth, 'uint256'))
+                return ArrayType(UserDefinedType(var_type), Literal(depth, "uint256"))
 
     if not var_type:
         var_type = next((f for f in contract.functions if f.name == name), None)
     if not var_type:
-        if name.startswith('function '):
-            found = re.findall('function \(([ ()a-zA-Z0-9\.,]*)\) returns \(([a-zA-Z0-9\.,]*)\)', name)
+        if name.startswith("function "):
+            found = re.findall(
+                "function \(([ ()a-zA-Z0-9\.,]*)\) returns \(([a-zA-Z0-9\.,]*)\)", name
+            )
             assert len(found) == 1
-            params = found[0][0].split(',')
-            return_values = found[0][1].split(',')
-            params = [_find_from_type_name(p, contract, contracts, structures, enums) for p in params]
-            return_values = [_find_from_type_name(r, contract, contracts, structures, enums) for r in return_values]
+            params = found[0][0].split(",")
+            return_values = found[0][1].split(",")
+            params = [
+                _find_from_type_name(p, contract, contracts, structures, enums) for p in params
+            ]
+            return_values = [
+                _find_from_type_name(r, contract, contracts, structures, enums)
+                for r in return_values
+            ]
             params_vars = []
             return_vars = []
             for p in params:
-               var = FunctionTypeVariable()
-               var.set_type(p)
-               params_vars.append(var)
+                var = FunctionTypeVariable()
+                var.set_type(p)
+                params_vars.append(var)
             for r in return_values:
-               var = FunctionTypeVariable()
-               var.set_type(r)
-               return_vars.append(var)
+                var = FunctionTypeVariable()
+                var.set_type(r)
+                return_vars.append(var)
             return FunctionType(params_vars, return_vars)
     if not var_type:
-        if name.startswith('mapping('):
+        if name.startswith("mapping("):
             # nested mapping declared with var
-            if name.count('mapping(') == 1 :
-                found = re.findall('mapping\(([a-zA-Z0-9\.]*) => ([a-zA-Z0-9\.\[\]]*)\)', name)
+            if name.count("mapping(") == 1:
+                found = re.findall("mapping\(([a-zA-Z0-9\.]*) => ([a-zA-Z0-9\.\[\]]*)\)", name)
             else:
-                found = re.findall('mapping\(([a-zA-Z0-9\.]*) => (mapping\([=> a-zA-Z0-9\.\[\]]*\))\)', name)
+                found = re.findall(
+                    "mapping\(([a-zA-Z0-9\.]*) => (mapping\([=> a-zA-Z0-9\.\[\]]*\))\)", name
+                )
             assert len(found) == 1
             from_ = found[0][0]
             to_ = found[0][1]
@@ -119,30 +140,32 @@ def _find_from_type_name(name, contract, contracts, structures, enums):
             return MappingType(from_type, to_type)
 
     if not var_type:
-        raise ParsingError('Type not found '+str(name))
+        raise ParsingError("Type not found " + str(name))
     return UserDefinedType(var_type)
 
 
-
-def parse_type(t, caller_context):
+def parse_type(t: Union[Dict, UnknownType], caller_context):
     # local import to avoid circular dependency
     from slither.solc_parsing.expressions.expression_parsing import parse_expression
     from slither.solc_parsing.variables.function_type_variable import FunctionTypeVariableSolc
-
-    if isinstance(caller_context, Contract):
-        contract = caller_context
-    elif isinstance(caller_context, Function):
-        contract = caller_context.contract
+    from slither.solc_parsing.declarations.contract import ContractSolc
+    from slither.solc_parsing.declarations.function import FunctionSolc
+
+    if isinstance(caller_context, ContractSolc):
+        contract = caller_context.underlying_contract
+        contract_parser = caller_context
+        is_compact_ast = caller_context.is_compact_ast
+    elif isinstance(caller_context, FunctionSolc):
+        contract = caller_context.underlying_function.contract
+        contract_parser = caller_context.contract_parser
+        is_compact_ast = caller_context.is_compact_ast
     else:
-        raise ParsingError('Incorrect caller context')
-
-
-    is_compact_ast = caller_context.is_compact_ast
+        raise ParsingError(f"Incorrect caller context: {type(caller_context)}")
 
     if is_compact_ast:
-        key = 'nodeType'
+        key = "nodeType"
     else:
-        key = 'name'
+        key = "name"
 
     structures = contract.structures
     enums = contract.enums
@@ -151,75 +174,84 @@ def parse_type(t, caller_context):
     if isinstance(t, UnknownType):
         return _find_from_type_name(t.name, contract, contracts, structures, enums)
 
-    elif t[key] == 'ElementaryTypeName':
+    elif t[key] == "ElementaryTypeName":
         if is_compact_ast:
-            return ElementaryType(t['name'])
-        return ElementaryType(t['attributes'][key])
+            return ElementaryType(t["name"])
+        return ElementaryType(t["attributes"][key])
 
-    elif t[key] == 'UserDefinedTypeName':
+    elif t[key] == "UserDefinedTypeName":
         if is_compact_ast:
-            return _find_from_type_name(t['typeDescriptions']['typeString'], contract, contracts, structures, enums)
+            return _find_from_type_name(
+                t["typeDescriptions"]["typeString"], contract, contracts, structures, enums
+            )
 
         # Determine if we have a type node (otherwise we use the name node, as some older solc did not have 'type').
-        type_name_key = 'type' if 'type' in t['attributes'] else key
-        return _find_from_type_name(t['attributes'][type_name_key], contract, contracts, structures, enums)
+        type_name_key = "type" if "type" in t["attributes"] else key
+        return _find_from_type_name(
+            t["attributes"][type_name_key], contract, contracts, structures, enums
+        )
 
-    elif t[key] == 'ArrayTypeName':
+    elif t[key] == "ArrayTypeName":
         length = None
         if is_compact_ast:
-            if t['length']:
-                length = parse_expression(t['length'], caller_context)
-            array_type = parse_type(t['baseType'], contract)
+            if t["length"]:
+                length = parse_expression(t["length"], caller_context)
+            array_type = parse_type(t["baseType"], contract_parser)
         else:
-            if len(t['children']) == 2:
-                length = parse_expression(t['children'][1], caller_context)
+            if len(t["children"]) == 2:
+                length = parse_expression(t["children"][1], caller_context)
             else:
-                assert len(t['children']) == 1
-            array_type = parse_type(t['children'][0], contract)
+                assert len(t["children"]) == 1
+            array_type = parse_type(t["children"][0], contract_parser)
         return ArrayType(array_type, length)
 
-    elif t[key] == 'Mapping':
+    elif t[key] == "Mapping":
 
         if is_compact_ast:
-            mappingFrom = parse_type(t['keyType'], contract)
-            mappingTo = parse_type(t['valueType'], contract)
+            mappingFrom = parse_type(t["keyType"], contract_parser)
+            mappingTo = parse_type(t["valueType"], contract_parser)
         else:
-            assert len(t['children']) == 2
+            assert len(t["children"]) == 2
 
-            mappingFrom = parse_type(t['children'][0], contract)
-            mappingTo = parse_type(t['children'][1], contract)
+            mappingFrom = parse_type(t["children"][0], contract_parser)
+            mappingTo = parse_type(t["children"][1], contract_parser)
 
         return MappingType(mappingFrom, mappingTo)
 
-    elif t[key] == 'FunctionTypeName':
+    elif t[key] == "FunctionTypeName":
 
         if is_compact_ast:
-            params = t['parameterTypes']
-            return_values = t['returnParameterTypes']
-            index =  'parameters'
+            params = t["parameterTypes"]
+            return_values = t["returnParameterTypes"]
+            index = "parameters"
         else:
-            assert len(t['children']) == 2
-            params = t['children'][0]
-            return_values = t['children'][1]
-            index = 'children'
+            assert len(t["children"]) == 2
+            params = t["children"][0]
+            return_values = t["children"][1]
+            index = "children"
 
-        assert params[key] == 'ParameterList'
-        assert return_values[key] == 'ParameterList'
+        assert params[key] == "ParameterList"
+        assert return_values[key] == "ParameterList"
 
-        params_vars = []
-        return_values_vars = []
+        params_vars: List[FunctionTypeVariable] = []
+        return_values_vars: List[FunctionTypeVariable] = []
         for p in params[index]:
-            var = FunctionTypeVariableSolc(p)
-            var.set_offset(p['src'], caller_context.slither)
-            var.analyze(caller_context)
+            var = FunctionTypeVariable()
+            var.set_offset(p["src"], caller_context.slither)
+
+            var_parser = FunctionTypeVariableSolc(var, p)
+            var_parser.analyze(caller_context)
+
             params_vars.append(var)
         for p in return_values[index]:
-            var = FunctionTypeVariableSolc(p)
+            var = FunctionTypeVariable()
+            var.set_offset(p["src"], caller_context.slither)
+
+            var_parser = FunctionTypeVariableSolc(var, p)
+            var_parser.analyze(caller_context)
 
-            var.set_offset(p['src'], caller_context.slither)
-            var.analyze(caller_context)
             return_values_vars.append(var)
 
         return FunctionType(params_vars, return_values_vars)
 
-    raise ParsingError('Type name not found '+str(t))
+    raise ParsingError("Type name not found " + str(t))

slither/solc_parsing/variables/event_variable.py

@@ -1,10 +1,20 @@
+from typing import Dict
 
 from .variable_declaration import VariableDeclarationSolc
 from slither.core.variables.event_variable import EventVariable
 
-class EventVariableSolc(VariableDeclarationSolc, EventVariable):
 
-    def _analyze_variable_attributes(self, attributes):
+class EventVariableSolc(VariableDeclarationSolc):
+    def __init__(self, variable: EventVariable, variable_data: Dict):
+        super(EventVariableSolc, self).__init__(variable, variable_data)
+
+    @property
+    def underlying_variable(self) -> EventVariable:
+        # Todo: Not sure how to overcome this with mypy
+        assert isinstance(self._variable, EventVariable)
+        return self._variable
+
+    def _analyze_variable_attributes(self, attributes: Dict):
         """
         Analyze event variable attributes
         :param attributes: The event variable attributes to parse.
@@ -12,8 +22,7 @@ class EventVariableSolc(VariableDeclarationSolc, EventVariable):
         """
 
         # Check for the indexed attribute
-        if 'indexed' in attributes:
-            self._indexed = attributes['indexed']
+        if "indexed" in attributes:
+            self.underlying_variable.indexed = attributes["indexed"]
 
         super(EventVariableSolc, self)._analyze_variable_attributes(attributes)
-

slither/solc_parsing/variables/function_type_variable.py

@@ -1,5 +1,15 @@
+from typing import Dict
 
 from slither.solc_parsing.variables.variable_declaration import VariableDeclarationSolc
 from slither.core.variables.function_type_variable import FunctionTypeVariable
 
-class FunctionTypeVariableSolc(VariableDeclarationSolc, FunctionTypeVariable): pass
+
+class FunctionTypeVariableSolc(VariableDeclarationSolc):
+    def __init__(self, variable: FunctionTypeVariable, variable_data: Dict):
+        super(FunctionTypeVariableSolc, self).__init__(variable, variable_data)
+
+    @property
+    def underlying_variable(self) -> FunctionTypeVariable:
+        # Todo: Not sure how to overcome this with mypy
+        assert isinstance(self._variable, FunctionTypeVariable)
+        return self._variable

slither/solc_parsing/variables/local_variable.py

@@ -1,24 +1,33 @@
+from typing import Dict
 
 from .variable_declaration import VariableDeclarationSolc
 from slither.core.variables.local_variable import LocalVariable
 
-class LocalVariableSolc(VariableDeclarationSolc, LocalVariable):
 
-    def _analyze_variable_attributes(self, attributes):
-        ''''
+class LocalVariableSolc(VariableDeclarationSolc):
+    def __init__(self, variable: LocalVariable, variable_data: Dict):
+        super(LocalVariableSolc, self).__init__(variable, variable_data)
+
+    @property
+    def underlying_variable(self) -> LocalVariable:
+        # Todo: Not sure how to overcome this with mypy
+        assert isinstance(self._variable, LocalVariable)
+        return self._variable
+
+    def _analyze_variable_attributes(self, attributes: Dict):
+        """'
             Variable Location
             Can be storage/memory or default
-        '''
-        if 'storageLocation' in attributes:
-            location = attributes['storageLocation']
-            self._location = location
+        """
+        if "storageLocation" in attributes:
+            location = attributes["storageLocation"]
+            self.underlying_variable.set_location(location)
         else:
-            if 'memory' in attributes['type']:
-                self._location = 'memory'
-            elif'storage' in attributes['type']:
-                self._location = 'storage'
+            if "memory" in attributes["type"]:
+                self.underlying_variable.set_location("memory")
+            elif "storage" in attributes["type"]:
+                self.underlying_variable.set_location("storage")
             else:
-                self._location = 'default'
+                self.underlying_variable.set_location("default")
 
         super(LocalVariableSolc, self)._analyze_variable_attributes(attributes)
-

slither/solc_parsing/variables/local_variable_init_from_tuple.py

@@ -1,11 +1,16 @@
+from typing import Dict
 
 from .variable_declaration import VariableDeclarationSolc
 from slither.core.variables.local_variable_init_from_tuple import LocalVariableInitFromTuple
 
-class LocalVariableInitFromTupleSolc(VariableDeclarationSolc, LocalVariableInitFromTuple):
-
-    def __init__(self, var, index):
-        super(LocalVariableInitFromTupleSolc, self).__init__(var)
-        self._tuple_index = index
 
+class LocalVariableInitFromTupleSolc(VariableDeclarationSolc):
+    def __init__(self, variable: LocalVariableInitFromTuple, variable_data: Dict, index: int):
+        super(LocalVariableInitFromTupleSolc, self).__init__(variable, variable_data)
+        variable.tuple_index = index
 
+    @property
+    def underlying_variable(self) -> LocalVariableInitFromTuple:
+        # Todo: Not sure how to overcome this with mypy
+        assert isinstance(self._variable, LocalVariableInitFromTuple)
+        return self._variable

slither/solc_parsing/variables/state_variable.py

@@ -1,5 +1,15 @@
+from typing import Dict
 
 from .variable_declaration import VariableDeclarationSolc
 from slither.core.variables.state_variable import StateVariable
 
-class StateVariableSolc(VariableDeclarationSolc, StateVariable): pass
+
+class StateVariableSolc(VariableDeclarationSolc):
+    def __init__(self, variable: StateVariable, variable_data: Dict):
+        super(StateVariableSolc, self).__init__(variable, variable_data)
+
+    @property
+    def underlying_variable(self) -> StateVariable:
+        # Todo: Not sure how to overcome this with mypy
+        assert isinstance(self._variable, StateVariable)
+        return self._variable

slither/solc_parsing/variables/structure_variable.py

@@ -1,5 +1,15 @@
+from typing import Dict
 
 from .variable_declaration import VariableDeclarationSolc
 from slither.core.variables.structure_variable import StructureVariable
 
-class StructureVariableSolc(VariableDeclarationSolc, StructureVariable): pass
+
+class StructureVariableSolc(VariableDeclarationSolc):
+    def __init__(self, variable: StructureVariable, variable_data: Dict):
+        super(StructureVariableSolc, self).__init__(variable, variable_data)
+
+    @property
+    def underlying_variable(self) -> StructureVariable:
+        # Todo: Not sure how to overcome this with mypy
+        assert isinstance(self._variable, StructureVariable)
+        return self._variable

slither/solc_parsing/variables/variable_declaration.py

@@ -1,4 +1,6 @@
 import logging
+from typing import Dict
+
 from slither.solc_parsing.expressions.expression_parsing import parse_expression
 
 from slither.core.variables.variable import Variable
@@ -7,28 +9,31 @@ from slither.solc_parsing.solidity_types.type_parsing import parse_type, Unknown
 
 from slither.core.solidity_types.elementary_type import ElementaryType, NonElementaryType
 from slither.solc_parsing.exceptions import ParsingError
+
 logger = logging.getLogger("VariableDeclarationSolcParsing")
 
+
 class MultipleVariablesDeclaration(Exception):
-    '''
+    """
     This is raised on
     var (a,b) = ...
     It should occur only on local variable definition
-    '''
+    """
+
     pass
 
-class VariableDeclarationSolc(Variable):
 
-    def __init__(self, var):
-        '''
+class VariableDeclarationSolc:
+    def __init__(self, variable: Variable, variable_data: Dict):
+        """
             A variable can be declared through a statement, or directly.
             If it is through a statement, the following children may contain
             the init value.
             It may be possible that the variable is declared through a statement,
             but the init value is declared at the VariableDeclaration children level
-        '''
+        """
 
-        super(VariableDeclarationSolc, self).__init__()
+        self._variable = variable
         self._was_analyzed = False
         self._elem_to_parse = None
         self._initializedNotParsed = None
@@ -37,125 +42,122 @@ class VariableDeclarationSolc(Variable):
 
         self._reference_id = None
 
-
-        if 'nodeType' in var:
+        if "nodeType" in variable_data:
             self._is_compact_ast = True
-            nodeType = var['nodeType']
-            if nodeType in ['VariableDeclarationStatement', 'VariableDefinitionStatement']:
-                if len(var['declarations'])>1:
+            nodeType = variable_data["nodeType"]
+            if nodeType in ["VariableDeclarationStatement", "VariableDefinitionStatement"]:
+                if len(variable_data["declarations"]) > 1:
                     raise MultipleVariablesDeclaration
                 init = None
-                if 'initialValue' in var:
-                    init = var['initialValue']
-                self._init_from_declaration(var['declarations'][0], init)
-            elif  nodeType == 'VariableDeclaration':
-                self._init_from_declaration(var, var['value'])
+                if "initialValue" in variable_data:
+                    init = variable_data["initialValue"]
+                self._init_from_declaration(variable_data["declarations"][0], init)
+            elif nodeType == "VariableDeclaration":
+                self._init_from_declaration(variable_data, variable_data["value"])
             else:
-                raise ParsingError('Incorrect variable declaration type {}'.format(nodeType))
+                raise ParsingError("Incorrect variable declaration type {}".format(nodeType))
 
         else:
-            nodeType = var['name']
+            nodeType = variable_data["name"]
 
-            if nodeType in ['VariableDeclarationStatement', 'VariableDefinitionStatement']:
-                if len(var['children']) == 2:
-                    init = var['children'][1]
-                elif len(var['children']) == 1:
+            if nodeType in ["VariableDeclarationStatement", "VariableDefinitionStatement"]:
+                if len(variable_data["children"]) == 2:
+                    init = variable_data["children"][1]
+                elif len(variable_data["children"]) == 1:
                     init = None
-                elif len(var['children']) > 2:
+                elif len(variable_data["children"]) > 2:
                     raise MultipleVariablesDeclaration
                 else:
-                    raise ParsingError('Variable declaration without children?'+var)
-                declaration = var['children'][0]
+                    raise ParsingError(
+                        "Variable declaration without children?" + str(variable_data)
+                    )
+                declaration = variable_data["children"][0]
                 self._init_from_declaration(declaration, init)
-            elif  nodeType == 'VariableDeclaration':
-                self._init_from_declaration(var, None)
+            elif nodeType == "VariableDeclaration":
+                self._init_from_declaration(variable_data, False)
             else:
-                raise ParsingError('Incorrect variable declaration type {}'.format(nodeType))
-
-    @property
-    def initialized(self):
-        return self._initialized
+                raise ParsingError("Incorrect variable declaration type {}".format(nodeType))
 
     @property
-    def uninitialized(self):
-        return not self._initialized
+    def underlying_variable(self) -> Variable:
+        return self._variable
 
     @property
-    def reference_id(self):
-        '''
+    def reference_id(self) -> int:
+        """
             Return the solc id. It can be compared with the referencedDeclaration attr
             Returns None if it was not parsed (legacy AST)
-        '''
+        """
         return self._reference_id
 
-    def _analyze_variable_attributes(self, attributes):
-        if 'visibility' in attributes:
-            self._visibility = attributes['visibility']
+    def _analyze_variable_attributes(self, attributes: Dict):
+        if "visibility" in attributes:
+            self._variable.visibility = attributes["visibility"]
         else:
-            self._visibility = 'internal'
+            self._variable.visibility = "internal"
 
-    def _init_from_declaration(self, var, init):
+    def _init_from_declaration(self, var: Dict, init: bool):
         if self._is_compact_ast:
             attributes = var
-            self._typeName = attributes['typeDescriptions']['typeString']
+            self._typeName = attributes["typeDescriptions"]["typeString"]
         else:
-            assert len(var['children']) <= 2
-            assert var['name'] == 'VariableDeclaration'
+            assert len(var["children"]) <= 2
+            assert var["name"] == "VariableDeclaration"
 
-            attributes = var['attributes']
-            self._typeName = attributes['type']
+            attributes = var["attributes"]
+            self._typeName = attributes["type"]
 
-        self._name = attributes['name']
-        self._arrayDepth = 0
-        self._isMapping = False
-        self._mappingFrom = None
-        self._mappingTo = False
-        self._initial_expression = None
-        self._type = None
+        self._variable.name = attributes["name"]
+        # self._arrayDepth = 0
+        # self._isMapping = False
+        # self._mappingFrom = None
+        # self._mappingTo = False
+        # self._initial_expression = None
+        # self._type = None
 
         # Only for comapct ast format
         # the id can be used later if referencedDeclaration
         # is provided
-        if 'id' in var:
-            self._reference_id = var['id']
+        if "id" in var:
+            self._reference_id = var["id"]
 
-        if 'constant' in attributes:
-            self._is_constant = attributes['constant']
+        if "constant" in attributes:
+            self._variable.is_constant = attributes["constant"]
 
         self._analyze_variable_attributes(attributes)
 
         if self._is_compact_ast:
-            if var['typeName']:
-                self._elem_to_parse = var['typeName']
+            if var["typeName"]:
+                self._elem_to_parse = var["typeName"]
             else:
-                self._elem_to_parse = UnknownType(var['typeDescriptions']['typeString'])
+                self._elem_to_parse = UnknownType(var["typeDescriptions"]["typeString"])
         else:
-            if not var['children']:
+            if not var["children"]:
                 # It happens on variable declared inside loop declaration
                 try:
-                    self._type = ElementaryType(self._typeName)
+                    self._variable.type = ElementaryType(self._typeName)
                     self._elem_to_parse = None
                 except NonElementaryType:
                     self._elem_to_parse = UnknownType(self._typeName)
             else:
-                self._elem_to_parse = var['children'][0]
+                self._elem_to_parse = var["children"][0]
 
         if self._is_compact_ast:
             self._initializedNotParsed = init
             if init:
-                self._initialized = True
+                self._variable.initialized = True
         else:
-            if init: # there are two way to init a var local in the AST
-                assert len(var['children']) <= 1
-                self._initialized = True
+            if init:  # there are two way to init a var local in the AST
+                assert len(var["children"]) <= 1
+                self._variable.initialized = True
                 self._initializedNotParsed = init
-            elif len(var['children']) in [0, 1]:
-                self._initialized = False
+            elif len(var["children"]) in [0, 1]:
+                self._variable.initialized = False
                 self._initializedNotParsed = []
             else:
-                assert len(var['children']) == 2
-                self._initialized = True
-                self._initializedNotParsed = var['children'][1]
+                assert len(var["children"]) == 2
+                self._variable.initialized = True
+                self._initializedNotParsed = var["children"][1]
 
     def analyze(self, caller_context):
         # Can be re-analyzed due to inheritance
@@ -164,9 +166,9 @@ class VariableDeclarationSolc(Variable):
         self._was_analyzed = True
 
         if self._elem_to_parse:
-            self._type = parse_type(self._elem_to_parse, caller_context)
+            self._variable.type = parse_type(self._elem_to_parse, caller_context)
             self._elem_to_parse = None
 
-        if self._initialized:
-            self._initial_expression = parse_expression(self._initializedNotParsed, caller_context)
+        if self._variable.initialized:
+            self._variable.expression = parse_expression(self._initializedNotParsed, caller_context)
             self._initializedNotParsed = None

slither/tools/demo/__main__.py

@@ -9,16 +9,17 @@ logging.getLogger("Slither").setLevel(logging.INFO)
 
 logger = logging.getLogger("Slither-demo")
 
+
 def parse_args():
     """
     Parse the underlying arguments for the program.
     :return: Returns the arguments for the program.
     """
-    parser = argparse.ArgumentParser(description='Demo',
-                                     usage='slither-demo filename')
+    parser = argparse.ArgumentParser(description="Demo", usage="slither-demo filename")
 
-    parser.add_argument('filename',
-                        help='The filename of the contract or truffle directory to analyze.')
+    parser.add_argument(
+        "filename", help="The filename of the contract or truffle directory to analyze."
+    )
 
     # Add default arguments from crytic-compile
     cryticparser.init(parser)
@@ -32,7 +33,8 @@ def main():
     # Perform slither analysis on the given filename
     slither = Slither(args.filename, **vars(args))
 
-    logger.info('Analysis done!')
+    logger.info("Analysis done!")
+
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

slither/tools/erc_conformance/__main__.py

@@ -17,28 +17,29 @@ logger.setLevel(logging.INFO)
 
 ch = logging.StreamHandler()
 ch.setLevel(logging.INFO)
-formatter = logging.Formatter('%(message)s')
+formatter = logging.Formatter("%(message)s")
 logger.addHandler(ch)
 logger.handlers[0].setFormatter(formatter)
 logger.propagate = False
 
-ADDITIONAL_CHECKS = {
-    "ERC20": check_erc20
-}
+ADDITIONAL_CHECKS = {"ERC20": check_erc20}
+
 
 def parse_args():
     """
     Parse the underlying arguments for the program.
     :return: Returns the arguments for the program.
     """
-    parser = argparse.ArgumentParser(description='Check the ERC 20 conformance',
-                                     usage='slither-erc project contractName')
+    parser = argparse.ArgumentParser(
+        description="Check the ERC 20 conformance", usage="slither-erc project contractName"
+    )
 
-    parser.add_argument('project',
-                        help='The codebase to be tested.')
+    parser.add_argument("project", help="The codebase to be tested.")
 
-    parser.add_argument('contract_name',
-                        help='The name of the contract. Specify the first case contract that follow the standard. Derived contracts will be checked.')
+    parser.add_argument(
+        "contract_name",
+        help="The name of the contract. Specify the first case contract that follow the standard. Derived contracts will be checked.",
+    )
 
     parser.add_argument(
         "--erc",
@@ -47,22 +48,26 @@ def parse_args():
         default="erc20",
     )
 
-    parser.add_argument('--json',
-                        help='Export the results as a JSON file ("--json -" to export to stdout)',
-                        action='store',
-                        default=False)
+    parser.add_argument(
+        "--json",
+        help='Export the results as a JSON file ("--json -" to export to stdout)',
+        action="store",
+        default=False,
+    )
 
     # Add default arguments from crytic-compile
     cryticparser.init(parser)
 
     return parser.parse_args()
 
+
 def _log_error(err, args):
     if args.json:
         output_to_json(args.json, str(err), {"upgradeability-check": []})
 
     logger.error(err)
 
+
 def main():
     args = parse_args()
 
@@ -76,7 +81,7 @@ def main():
         contract = slither.get_contract_from_name(args.contract_name)
 
         if not contract:
-            err = f'Contract not found: {args.contract_name}'
+            err = f"Contract not found: {args.contract_name}"
             _log_error(err, args)
             return
         # First elem is the function, second is the event
@@ -87,7 +92,7 @@ def main():
             ADDITIONAL_CHECKS[args.erc.upper()](contract, ret)
 
     else:
-        err = f'Incorrect ERC selected {args.erc}'
+        err = f"Incorrect ERC selected {args.erc}"
         _log_error(err, args)
         return
 
@@ -95,5 +100,5 @@ def main():
         output_to_json(args.json, None, {"upgradeability-check": ret})
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

slither/tools/erc_conformance/erc/erc20.py

@@ -6,21 +6,25 @@ logger = logging.getLogger("Slither-conformance")
 
 
 def approval_race_condition(contract, ret):
-    increaseAllowance = contract.get_function_from_signature('increaseAllowance(address,uint256)')
+    increaseAllowance = contract.get_function_from_signature("increaseAllowance(address,uint256)")
 
     if not increaseAllowance:
-        increaseAllowance = contract.get_function_from_signature('safeIncreaseAllowance(address,uint256)')
+        increaseAllowance = contract.get_function_from_signature(
+            "safeIncreaseAllowance(address,uint256)"
+        )
 
     if increaseAllowance:
-        txt = f'\t[✓] {contract.name} has {increaseAllowance.full_name}'
+        txt = f"\t[✓] {contract.name} has {increaseAllowance.full_name}"
         logger.info(txt)
     else:
-        txt = f'\t[ ] {contract.name} is not protected for the ERC20 approval race condition'
+        txt = f"\t[ ] {contract.name} is not protected for the ERC20 approval race condition"
         logger.info(txt)
 
         lack_of_erc20_race_condition_protection = output.Output(txt)
         lack_of_erc20_race_condition_protection.add(contract)
-        ret["lack_of_erc20_race_condition_protection"].append(lack_of_erc20_race_condition_protection.data)
+        ret["lack_of_erc20_race_condition_protection"].append(
+            lack_of_erc20_race_condition_protection.data
+        )
 
 
 def check_erc20(contract, ret, explored=None):

slither/tools/erc_conformance/erc/ercs.py

@@ -22,13 +22,15 @@ def _check_signature(erc_function, contract, ret):
         # The check on state variable is needed until we have a better API to handle state variable getters
         state_variable_as_function = contract.get_state_variable_from_name(name)
 
-        if not state_variable_as_function or not state_variable_as_function.visibility in ['public', 'external']:
+        if not state_variable_as_function or not state_variable_as_function.visibility in [
+            "public",
+            "external",
+        ]:
             txt = f'[ ] {sig} is missing {"" if required else "(optional)"}'
             logger.info(txt)
-            missing_func = output.Output(txt, additional_fields={
-                "function": sig,
-                "required": required
-            })
+            missing_func = output.Output(
+                txt, additional_fields={"function": sig, "required": required}
+            )
             missing_func.add(contract)
             ret["missing_function"].append(missing_func.data)
             return
@@ -38,10 +40,9 @@ def _check_signature(erc_function, contract, ret):
         if types != parameters:
             txt = f'[ ] {sig} is missing {"" if required else "(optional)"}'
             logger.info(txt)
-            missing_func = output.Output(txt, additional_fields={
-                "function": sig,
-                "required": required
-            })
+            missing_func = output.Output(
+                txt, additional_fields={"function": sig, "required": required}
+            )
             missing_func.add(contract)
             ret["missing_function"].append(missing_func.data)
             return
@@ -53,45 +54,51 @@ def _check_signature(erc_function, contract, ret):
         function_return_type = function.return_type
         function_view = function.view
 
-    txt = f'[✓] {sig} is present'
+    txt = f"[✓] {sig} is present"
     logger.info(txt)
 
     if function_return_type:
-        function_return_type = ','.join([str(x) for x in function_return_type])
+        function_return_type = ",".join([str(x) for x in function_return_type])
         if function_return_type == return_type:
-            txt = f'\t[✓] {sig} -> () (correct return value)'
+            txt = f"\t[✓] {sig} -> () (correct return value)"
             logger.info(txt)
         else:
-            txt = f'\t[ ] {sig} -> () should return {return_type}'
+            txt = f"\t[ ] {sig} -> () should return {return_type}"
             logger.info(txt)
 
-            incorrect_return = output.Output(txt, additional_fields={
-                "expected_return_type": return_type,
-                "actual_return_type": function_return_type
-            })
+            incorrect_return = output.Output(
+                txt,
+                additional_fields={
+                    "expected_return_type": return_type,
+                    "actual_return_type": function_return_type,
+                },
+            )
             incorrect_return.add(function)
             ret["incorrect_return_type"].append(incorrect_return.data)
 
     elif not return_type:
-        txt = f'\t[✓] {sig} -> () (correct return type)'
+        txt = f"\t[✓] {sig} -> () (correct return type)"
         logger.info(txt)
     else:
-        txt = f'\t[ ] {sig} -> () should return {return_type}'
+        txt = f"\t[ ] {sig} -> () should return {return_type}"
         logger.info(txt)
 
-        incorrect_return = output.Output(txt, additional_fields={
-            "expected_return_type": return_type,
-            "actual_return_type": function_return_type
-        })
+        incorrect_return = output.Output(
+            txt,
+            additional_fields={
+                "expected_return_type": return_type,
+                "actual_return_type": function_return_type,
+            },
+        )
         incorrect_return.add(function)
         ret["incorrect_return_type"].append(incorrect_return.data)
 
     if view:
         if function_view:
-            txt = f'\t[✓] {sig} is view'
+            txt = f"\t[✓] {sig} is view"
             logger.info(txt)
         else:
-            txt = f'\t[ ] {sig} should be view'
+            txt = f"\t[ ] {sig} should be view"
             logger.info(txt)
 
             should_be_view = output.Output(txt)
@@ -103,12 +110,12 @@ def _check_signature(erc_function, contract, ret):
             event_sig = f'{event.name}({",".join(event.parameters)})'
 
             if not function:
-                txt = f'\t[ ] Must emit be view {event_sig}'
+                txt = f"\t[ ] Must emit be view {event_sig}"
                 logger.info(txt)
 
-                missing_event_emmited = output.Output(txt, additional_fields={
-                    "missing_event": event_sig
-                })
+                missing_event_emmited = output.Output(
+                    txt, additional_fields={"missing_event": event_sig}
+                )
                 missing_event_emmited.add(function)
                 ret["missing_event_emmited"].append(missing_event_emmited.data)
 
@@ -121,15 +128,15 @@ def _check_signature(erc_function, contract, ret):
                                 event_found = True
                                 break
                 if event_found:
-                    txt = f'\t[✓] {event_sig} is emitted'
+                    txt = f"\t[✓] {event_sig} is emitted"
                     logger.info(txt)
                 else:
-                    txt = f'\t[ ] Must emit be view {event_sig}'
+                    txt = f"\t[ ] Must emit be view {event_sig}"
                     logger.info(txt)
 
-                    missing_event_emmited = output.Output(txt, additional_fields={
-                        "missing_event": event_sig
-                    })
+                    missing_event_emmited = output.Output(
+                        txt, additional_fields={"missing_event": event_sig}
+                    )
                     missing_event_emmited.add(function)
                     ret["missing_event_emmited"].append(missing_event_emmited.data)
 
@@ -143,31 +150,27 @@ def _check_events(erc_event, contract, ret):
     event = contract.get_event_from_signature(sig)
 
     if not event:
-        txt = f'[ ] {sig} is missing'
+        txt = f"[ ] {sig} is missing"
         logger.info(txt)
 
-        missing_event = output.Output(txt, additional_fields={
-            "event": sig
-        })
+        missing_event = output.Output(txt, additional_fields={"event": sig})
         missing_event.add(contract)
         ret["missing_event"].append(missing_event.data)
         return
 
-    txt = f'[✓] {sig} is present'
+    txt = f"[✓] {sig} is present"
     logger.info(txt)
 
     for i, index in enumerate(indexes):
         if index:
             if event.elems[i].indexed:
-                txt = f'\t[✓] parameter {i} is indexed'
+                txt = f"\t[✓] parameter {i} is indexed"
                 logger.info(txt)
             else:
-                txt = f'\t[ ] parameter {i} should be indexed'
+                txt = f"\t[ ] parameter {i} should be indexed"
                 logger.info(txt)
 
-                missing_event_index = output.Output(txt, additional_fields={
-                    "missing_index": i
-                })
+                missing_event_index = output.Output(txt, additional_fields={"missing_index": i})
                 missing_event_index.add_event(event)
                 ret["missing_event_index"].append(missing_event_index.data)
 
@@ -179,16 +182,16 @@ def generic_erc_checks(contract, erc_functions, erc_events, ret, explored=None):
 
     explored.add(contract)
 
-    logger.info(f'# Check {contract.name}\n')
+    logger.info(f"# Check {contract.name}\n")
 
-    logger.info(f'## Check functions')
+    logger.info(f"## Check functions")
     for erc_function in erc_functions:
         _check_signature(erc_function, contract, ret)
-    logger.info(f'\n## Check events')
+    logger.info(f"\n## Check events")
     for erc_event in erc_events:
         _check_events(erc_event, contract, ret)
 
-    logger.info('\n')
+    logger.info("\n")
 
     for derived_contract in contract.derived_contracts:
         generic_erc_checks(derived_contract, erc_functions, erc_events, ret, explored)

slither/tools/kspec_coverage/__main__.py

@@ -11,27 +11,36 @@ logger.setLevel(logging.INFO)
 
 ch = logging.StreamHandler()
 ch.setLevel(logging.INFO)
-formatter = logging.Formatter('%(message)s')
+formatter = logging.Formatter("%(message)s")
 logger.addHandler(ch)
 logger.handlers[0].setFormatter(formatter)
 logger.propagate = False
 
+
 def parse_args():
     """
     Parse the underlying arguments for the program.
     :return: Returns the arguments for the program.
     """
-    parser = argparse.ArgumentParser(description='slither-kspec-coverage',
-                                     usage='slither-kspec-coverage contract.sol kspec.md')
+    parser = argparse.ArgumentParser(
+        description="slither-kspec-coverage", usage="slither-kspec-coverage contract.sol kspec.md"
+    )
 
-    parser.add_argument('contract', help='The filename of the contract or truffle directory to analyze.')
-    parser.add_argument('kspec', help='The filename of the Klab spec markdown for the analyzed contract(s)')
+    parser.add_argument(
+        "contract", help="The filename of the contract or truffle directory to analyze."
+    )
+    parser.add_argument(
+        "kspec", help="The filename of the Klab spec markdown for the analyzed contract(s)"
+    )
 
-    parser.add_argument('--version', help='displays the current version', version='0.1.0',action='version')
-    parser.add_argument('--json',
-                        help='Export the results as a JSON file ("--json -" to export to stdout)',
-                        action='store',
-                        default=False
+    parser.add_argument(
+        "--version", help="displays the current version", version="0.1.0", action="version"
+    )
+    parser.add_argument(
+        "--json",
+        help='Export the results as a JSON file ("--json -" to export to stdout)',
+        action="store",
+        default=False,
     )
 
     cryticparser.init(parser)
@@ -54,5 +63,6 @@ def main():
 
     kspec_coverage(args)
 
-if __name__ == '__main__':
+
+if __name__ == "__main__":
     main()

slither/tools/kspec_coverage/analysis.py

@@ -7,25 +7,22 @@ from slither.utils.colors import yellow, green, red
 from slither.utils import output
 
 logging.basicConfig(level=logging.WARNING)
-logger = logging.getLogger('Slither.kspec')
+logger = logging.getLogger("Slither.kspec")
 
 
 def _refactor_type(type):
-    return {
-        'uint': 'uint256',
-        'int': 'int256'
-    }.get(type, type)
+    return {"uint": "uint256", "int": "int256"}.get(type, type)
 
 
 def _get_all_covered_kspec_functions(target):
     # Create a set of our discovered functions which are covered
     covered_functions = set()
 
-    BEHAVIOUR_PATTERN = re.compile('behaviour\s+(\S+)\s+of\s+(\S+)')
-    INTERFACE_PATTERN = re.compile('interface\s+([^\r\n]+)')
+    BEHAVIOUR_PATTERN = re.compile("behaviour\s+(\S+)\s+of\s+(\S+)")
+    INTERFACE_PATTERN = re.compile("interface\s+([^\r\n]+)")
 
     # Read the file contents
-    with open(target, 'r', encoding='utf8') as target_file:
+    with open(target, "r", encoding="utf8") as target_file:
         lines = target_file.readlines()
 
     # Loop for each line, if a line matches our behaviour regex, and the next one matches our interface regex,
@@ -38,10 +35,12 @@ def _get_all_covered_kspec_functions(target):
             match = INTERFACE_PATTERN.match(lines[i + 1])
             if match:
                 function_full_name = match.groups()[0]
-                start, end = function_full_name.index('(') + 1, function_full_name.index(')')
-                function_arguments = function_full_name[start:end].split(',')
-                function_arguments = [_refactor_type(arg.strip().split(' ')[0]) for arg in function_arguments]
-                function_full_name = function_full_name[:start] + ','.join(function_arguments) + ')'
+                start, end = function_full_name.index("(") + 1, function_full_name.index(")")
+                function_arguments = function_full_name[start:end].split(",")
+                function_arguments = [
+                    _refactor_type(arg.strip().split(" ")[0]) for arg in function_arguments
+                ]
+                function_full_name = function_full_name[:start] + ",".join(function_arguments) + ")"
                 covered_functions.add((contract_name, function_full_name))
                 i += 1
         i += 1
@@ -50,14 +49,25 @@ def _get_all_covered_kspec_functions(target):
 
 def _get_slither_functions(slither):
     # Use contract == contract_declarer to avoid dupplicate
-    all_functions_declared = [f for f in slither.functions if (f.contract == f.contract_declarer
-                                                               and f.is_implemented
-                                                               and not f.is_constructor
-                                                               and not f.is_constructor_variables)]
+    all_functions_declared = [
+        f
+        for f in slither.functions
+        if (
+            f.contract == f.contract_declarer
+            and f.is_implemented
+            and not f.is_constructor
+            and not f.is_constructor_variables
+        )
+    ]
     # Use list(set()) because same state variable instances can be shared accross contracts
     # TODO: integrate state variables
-    all_functions_declared += list(set([s for s in slither.state_variables if s.visibility in ['public', 'external']]))
-    slither_functions = {(function.contract.name, function.full_name): function for function in all_functions_declared}
+    all_functions_declared += list(
+        set([s for s in slither.state_variables if s.visibility in ["public", "external"]])
+    )
+    slither_functions = {
+        (function.contract.name, function.full_name): function
+        for function in all_functions_declared
+    }
 
     return slither_functions
 
@@ -110,35 +120,42 @@ def _run_coverage_analysis(args, slither, kspec_functions):
         else:
             kspec_missing.append(slither_func)
 
-    logger.info('## Check for functions coverage')
+    logger.info("## Check for functions coverage")
     json_kspec_present = _generate_output(kspec_present, "[✓]", green, args.json)
-    json_kspec_missing_functions = _generate_output([f for f in kspec_missing if isinstance(f, Function)],
-                                                    "[ ] (Missing function)",
-                                                    red,
-                                                    args.json)
-    json_kspec_missing_variables = _generate_output([f for f in kspec_missing if isinstance(f, Variable)],
-                                                    "[ ] (Missing variable)",
-                                                    yellow,
-                                                    args.json)
-    json_kspec_unresolved = _generate_output_unresolved(kspec_functions_unresolved,
-                                                        "[ ] (Unresolved)",
-                                                        yellow,
-                                                        args.json)
+    json_kspec_missing_functions = _generate_output(
+        [f for f in kspec_missing if isinstance(f, Function)],
+        "[ ] (Missing function)",
+        red,
+        args.json,
+    )
+    json_kspec_missing_variables = _generate_output(
+        [f for f in kspec_missing if isinstance(f, Variable)],
+        "[ ] (Missing variable)",
+        yellow,
+        args.json,
+    )
+    json_kspec_unresolved = _generate_output_unresolved(
+        kspec_functions_unresolved, "[ ] (Unresolved)", yellow, args.json
+    )
 
     # Handle unresolved kspecs
     if args.json:
-        output.output_to_json(args.json, None, {
-            "functions_present": json_kspec_present,
-            "functions_missing": json_kspec_missing_functions,
-            "variables_missing": json_kspec_missing_variables,
-            "functions_unresolved": json_kspec_unresolved
-        })
+        output.output_to_json(
+            args.json,
+            None,
+            {
+                "functions_present": json_kspec_present,
+                "functions_missing": json_kspec_missing_functions,
+                "variables_missing": json_kspec_missing_variables,
+                "functions_unresolved": json_kspec_unresolved,
+            },
+        )
 
 
 def run_analysis(args, slither, kspec):
     # Get all of our kspec'd functions (tuple(contract_name, function_name)).
-    if ',' in kspec:
-        kspecs = kspec.split(',')
+    if "," in kspec:
+        kspecs = kspec.split(",")
         kspec_functions = set()
         for kspec in kspecs:
             kspec_functions |= _get_all_covered_kspec_functions(kspec)

slither/tools/kspec_coverage/kspec_coverage.py

@@ -1,6 +1,7 @@
 from slither.tools.kspec_coverage.analysis import run_analysis
 from slither import Slither
 
+
 def kspec_coverage(args):
 
     contract = args.contract
@@ -10,5 +11,3 @@ def kspec_coverage(args):
 
     # Run the analysis on the Klab specs
     run_analysis(args, slither, kspec)
-
-

slither/tools/possible_paths/__main__.py

@@ -9,18 +9,21 @@ from crytic_compile import cryticparser
 logging.basicConfig()
 logging.getLogger("Slither").setLevel(logging.INFO)
 
+
 def parse_args():
     """
     Parse the underlying arguments for the program.
     :return: Returns the arguments for the program.
     """
-    parser = argparse.ArgumentParser(description='PossiblePaths',
-                                     usage='possible_paths.py filename [contract.function targets]')
+    parser = argparse.ArgumentParser(
+        description="PossiblePaths", usage="possible_paths.py filename [contract.function targets]"
+    )
 
-    parser.add_argument('filename',
-                        help='The filename of the contract or truffle directory to analyze.')
+    parser.add_argument(
+        "filename", help="The filename of the contract or truffle directory to analyze."
+    )
 
-    parser.add_argument('targets', nargs='+')
+    parser.add_argument("targets", nargs="+")
 
     cryticparser.init(parser)
 
@@ -62,12 +65,16 @@ def main():
     print("\n")
 
     # Format all function paths.
-    reaching_paths_str = [' -> '.join([f"{f.canonical_name}" for f in reaching_path]) for reaching_path in reaching_paths]
+    reaching_paths_str = [
+        " -> ".join([f"{f.canonical_name}" for f in reaching_path])
+        for reaching_path in reaching_paths
+    ]
 
     # Print a sorted list of all function paths which can reach the targets.
     print(f"The following paths reach the specified targets:")
     for reaching_path in sorted(reaching_paths_str):
         print(f"{reaching_path}\n")
 
-if __name__ == '__main__':
+
+if __name__ == "__main__":
     main()

slither/tools/possible_paths/possible_paths.py

@@ -1,4 +1,5 @@
-class ResolveFunctionException(Exception): pass
+class ResolveFunctionException(Exception):
+    pass
 
 
 def resolve_function(slither, contract_name, function_name):
@@ -16,11 +17,15 @@ def resolve_function(slither, contract_name, function_name):
         raise ResolveFunctionException(f"Could not resolve target contract: {contract_name}")
 
     # Obtain the target function
-    target_function = next((function for function in contract.functions if function.name == function_name), None)
+    target_function = next(
+        (function for function in contract.functions if function.name == function_name), None
+    )
 
     # Verify we have resolved the function specified.
     if target_function is None:
-        raise ResolveFunctionException(f"Could not resolve target function: {contract_name}.{function_name}")
+        raise ResolveFunctionException(
+            f"Could not resolve target function: {contract_name}.{function_name}"
+        )
 
     # Add the resolved function to the new list.
     return target_function
@@ -44,17 +49,23 @@ def resolve_functions(slither, functions):
     for item in functions:
         if isinstance(item, str):
             # If the item is a single string, we assume it is of form 'ContractName.FunctionName'.
-            parts = item.split('.')
+            parts = item.split(".")
             if len(parts) < 2:
-                raise ResolveFunctionException("Provided string descriptor must be of form 'ContractName.FunctionName'")
+                raise ResolveFunctionException(
+                    "Provided string descriptor must be of form 'ContractName.FunctionName'"
+                )
             resolved.append(resolve_function(slither, parts[0], parts[1]))
         elif isinstance(item, tuple):
             # If the item is a tuple, it should be a 2-tuple providing contract and function names.
             if len(item) != 2:
-                raise ResolveFunctionException("Provided tuple descriptor must provide a contract and function name.")
+                raise ResolveFunctionException(
+                    "Provided tuple descriptor must provide a contract and function name."
+                )
             resolved.append(resolve_function(slither, item[0], item[1]))
         else:
-            raise ResolveFunctionException(f"Unexpected function descriptor type to resolve in list: {type(item)}")
+            raise ResolveFunctionException(
+                f"Unexpected function descriptor type to resolve in list: {type(item)}"
+            )
 
     # Return the resolved list.
     return resolved
@@ -66,9 +77,12 @@ def all_function_definitions(function):
     :param function: The function to obtain all definitions at and beneath.
     :return: Returns a list composed of the provided function definition and any base definitions.
     """
-    return [function] + [f for c in function.contract.inheritance
-                         for f in c.functions_and_modifiers_declared
-                         if f.full_name == function.full_name]
+    return [function] + [
+        f
+        for c in function.contract.inheritance
+        for f in c.functions_and_modifiers_declared
+        if f.full_name == function.full_name
+    ]
 
 
 def __find_target_paths(slither, target_function, current_path=[]):
@@ -102,7 +116,7 @@ def __find_target_paths(slither, target_function, current_path=[]):
                     results = results.union(path_results)
 
     # If this path is external accessible from this point, we add the current path to the list.
-    if target_function.visibility in ['public', 'external'] and len(current_path) > 1:
+    if target_function.visibility in ["public", "external"] and len(current_path) > 1:
         results.add(tuple(current_path))
 
     return results
@@ -122,6 +136,3 @@ def find_target_paths(slither, target_functions):
         results = results.union(__find_target_paths(slither, target_function))
 
     return results
-
-
-

slither/tools/properties/__main__.py

@@ -16,20 +16,21 @@ logging.getLogger("Slither").setLevel(logging.INFO)
 logger = logging.getLogger("Slither")
 ch = logging.StreamHandler()
 ch.setLevel(logging.INFO)
-formatter = logging.Formatter('%(message)s')
+formatter = logging.Formatter("%(message)s")
 logger.addHandler(ch)
 logger.handlers[0].setFormatter(formatter)
 logger.propagate = False
 
 
 def _all_scenarios():
-    txt = '\n'
-    txt += '#################### ERC20 ####################\n'
+    txt = "\n"
+    txt += "#################### ERC20 ####################\n"
     for k, value in ERC20_PROPERTIES.items():
-        txt += f'{k} - {value.description}\n'
+        txt += f"{k} - {value.description}\n"
 
     return txt
 
+
 def _all_properties():
     table = MyPrettyTable(["Num", "Description", "Scenario"])
     idx = 0
@@ -39,6 +40,7 @@ def _all_properties():
             idx = idx + 1
     return table
 
+
 class ListScenarios(argparse.Action):
     def __call__(self, parser, *args, **kwargs):
         logger.info(_all_scenarios())
@@ -56,43 +58,51 @@ def parse_args():
     Parse the underlying arguments for the program.
     :return: Returns the arguments for the program.
     """
-    parser = argparse.ArgumentParser(description='Demo',
-                                     usage='slither-demo filename',
-                                     formatter_class=argparse.RawDescriptionHelpFormatter)
-
-    parser.add_argument('filename',
-                        help='The filename of the contract or truffle directory to analyze.')
-
-    parser.add_argument('--contract',
-                        help='The targeted contract.')
-
-    parser.add_argument('--scenario',
-                        help=f'Test a specific scenario. Use --list-scenarios to see the available scenarios. Default Transferable',
-                        default='Transferable')
-
-    parser.add_argument('--list-scenarios',
-                        help='List available scenarios',
-                        action=ListScenarios,
-                        nargs=0,
-                        default=False)
-
-    parser.add_argument('--list-properties',
-                        help='List available properties',
-                        action=ListProperties,
-                        nargs=0,
-                        default=False)
-
-    parser.add_argument('--address-owner',
-                        help=f'Owner address. Default {OWNER_ADDRESS}',
-                        default=None)
-
-    parser.add_argument('--address-user',
-                        help=f'Owner address. Default {USER_ADDRESS}',
-                        default=None)
-
-    parser.add_argument('--address-attacker',
-                        help=f'Attacker address. Default {ATTACKER_ADDRESS}',
-                        default=None)
+    parser = argparse.ArgumentParser(
+        description="Demo",
+        usage="slither-demo filename",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+
+    parser.add_argument(
+        "filename", help="The filename of the contract or truffle directory to analyze."
+    )
+
+    parser.add_argument("--contract", help="The targeted contract.")
+
+    parser.add_argument(
+        "--scenario",
+        help=f"Test a specific scenario. Use --list-scenarios to see the available scenarios. Default Transferable",
+        default="Transferable",
+    )
+
+    parser.add_argument(
+        "--list-scenarios",
+        help="List available scenarios",
+        action=ListScenarios,
+        nargs=0,
+        default=False,
+    )
+
+    parser.add_argument(
+        "--list-properties",
+        help="List available properties",
+        action=ListProperties,
+        nargs=0,
+        default=False,
+    )
+
+    parser.add_argument(
+        "--address-owner", help=f"Owner address. Default {OWNER_ADDRESS}", default=None
+    )
+
+    parser.add_argument(
+        "--address-user", help=f"Owner address. Default {USER_ADDRESS}", default=None
+    )
+
+    parser.add_argument(
+        "--address-attacker", help=f"Attacker address. Default {ATTACKER_ADDRESS}", default=None
+    )
 
     # Add default arguments from crytic-compile
     cryticparser.init(parser)
@@ -116,9 +126,9 @@ def main():
             contract = slither.contracts[0]
         else:
             if args.contract is None:
-                logger.error(f'Specify the target: --contract ContractName')
+                logger.error(f"Specify the target: --contract ContractName")
             else:
-                logger.error(f'{args.contract} not found')
+                logger.error(f"{args.contract} not found")
             return
 
     addresses = Addresses(args.address_owner, args.address_user, args.address_attacker)
@@ -126,5 +136,5 @@ def main():
     generate_erc20(contract, args.scenario, addresses)
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

slither/tools/properties/addresses/address.py

@@ -8,8 +8,12 @@ ATTACKER_ADDRESS = "0xC5fdf4076b8F3A5357c5E395ab970B5B54098Fef"
 
 
 class Addresses:
-
-    def __init__(self, owner: Optional[str] = None, user: Optional[str] = None, attacker: Optional[str] = None):
+    def __init__(
+        self,
+        owner: Optional[str] = None,
+        user: Optional[str] = None,
+        attacker: Optional[str] = None,
+    ):
         self.owner = owner if owner else OWNER_ADDRESS
         self.user = user if user else USER_ADDRESS
         self.attacker = attacker if attacker else ATTACKER_ADDRESS

slither/tools/properties/platforms/echidna.py

@@ -11,11 +11,11 @@ def generate_echidna_config(output_dir: Path, addresses: Addresses) -> str:
     :param addresses:
     :return:
     """
-    content = 'prefix: crytic_\n'
+    content = "prefix: crytic_\n"
     content += f'deployer: "{addresses.owner}"\n'
     content += f'sender: ["{addresses.user}", "{addresses.attacker}"]\n'
     content += f'psender: "{addresses.user}"\n'
-    content += 'coverage: true\n'
-    filename = 'echidna_config.yaml'
+    content += "coverage: true\n"
+    filename = "echidna_config.yaml"
     write_file(output_dir, filename, content)
     return filename

slither/tools/properties/platforms/truffle.py

@@ -7,21 +7,21 @@ from slither.tools.properties.addresses.address import Addresses
 from slither.tools.properties.properties.properties import PropertyReturn, Property, PropertyCaller
 from slither.tools.properties.utils import write_file
 
-PATTERN_TRUFFLE_MIGRATION = re.compile('^[0-9]*_')
+PATTERN_TRUFFLE_MIGRATION = re.compile("^[0-9]*_")
 logger = logging.getLogger("Slither")
 
 
 def _extract_caller(p: PropertyCaller):
     if p == PropertyCaller.OWNER:
-        return ['owner']
+        return ["owner"]
     if p == PropertyCaller.SENDER:
-        return ['user']
+        return ["user"]
     if p == PropertyCaller.ATTACKER:
-        return ['attacker']
+        return ["attacker"]
     if p == PropertyCaller.ALL:
-        return ['owner', 'user', 'attacker']
+        return ["owner", "user", "attacker"]
     assert p == PropertyCaller.ANY
-    return ['user']
+    return ["user"]
 
 
 def _helpers():
@@ -31,7 +31,7 @@ def _helpers():
     - catchRevertThrow: check if the call revert/throw
     :return:
     """
-    return '''
+    return """
     async function catchRevertThrowReturnFalse(promise) {
     try {
         const ret = await promise;
@@ -61,12 +61,17 @@ async function catchRevertThrow(promise) {
     }
     assert(false, "Expected revert/throw/or return false");
 };
-'''
+"""
 
 
-def generate_unit_test(test_contract: str, filename: str,
-                       unit_tests: List[Property], output_dir: Path,
-                       addresses: Addresses, assert_message: str = ''):
+def generate_unit_test(
+    test_contract: str,
+    filename: str,
+    unit_tests: List[Property],
+    output_dir: Path,
+    addresses: Addresses,
+    assert_message: str = "",
+):
     """
     Generate unit tests files
     :param test_contract:
@@ -88,37 +93,37 @@ def generate_unit_test(test_contract: str, filename: str,
     content += f'\tlet attacker = "{addresses.attacker}";\n'
     for unit_test in unit_tests:
         content += f'\tit("{unit_test.description}", async () => {{\n'
-        content += f'\t\tlet instance = await {test_contract}.deployed();\n'
+        content += f"\t\tlet instance = await {test_contract}.deployed();\n"
         callers = _extract_caller(unit_test.caller)
         if unit_test.return_type == PropertyReturn.SUCCESS:
             for caller in callers:
-                content += f'\t\tlet test_{caller} = await instance.{unit_test.name[:-2]}.call({{from: {caller}}});\n'
+                content += f"\t\tlet test_{caller} = await instance.{unit_test.name[:-2]}.call({{from: {caller}}});\n"
                 if assert_message:
                     content += f'\t\tassert.equal(test_{caller}, true, "{assert_message}");\n'
                 else:
-                    content += f'\t\tassert.equal(test_{caller}, true);\n'
+                    content += f"\t\tassert.equal(test_{caller}, true);\n"
         elif unit_test.return_type == PropertyReturn.FAIL:
             for caller in callers:
-                content += f'\t\tlet test_{caller} = await instance.{unit_test.name[:-2]}.call({{from: {caller}}});\n'
+                content += f"\t\tlet test_{caller} = await instance.{unit_test.name[:-2]}.call({{from: {caller}}});\n"
                 if assert_message:
                     content += f'\t\tassert.equal(test_{caller}, false, "{assert_message}");\n'
                 else:
-                    content += f'\t\tassert.equal(test_{caller}, false);\n'
+                    content += f"\t\tassert.equal(test_{caller}, false);\n"
         elif unit_test.return_type == PropertyReturn.FAIL_OR_THROW:
             for caller in callers:
-                content += f'\t\tawait catchRevertThrowReturnFalse(instance.{unit_test.name[:-2]}.call({{from: {caller}}}));\n'
+                content += f"\t\tawait catchRevertThrowReturnFalse(instance.{unit_test.name[:-2]}.call({{from: {caller}}}));\n"
         elif unit_test.return_type == PropertyReturn.THROW:
             callers = _extract_caller(unit_test.caller)
             for caller in callers:
-                content += f'\t\tawait catchRevertThrow(instance.{unit_test.name[:-2]}.call({{from: {caller}}}));\n'
-        content += '\t});\n'
+                content += f"\t\tawait catchRevertThrow(instance.{unit_test.name[:-2]}.call({{from: {caller}}}));\n"
+        content += "\t});\n"
 
-    content += '});\n'
+    content += "});\n"
 
-    output_dir = Path(output_dir, 'test')
+    output_dir = Path(output_dir, "test")
     output_dir.mkdir(exist_ok=True)
 
-    output_dir = Path(output_dir, 'crytic')
+    output_dir = Path(output_dir, "crytic")
     output_dir.mkdir(exist_ok=True)
 
     write_file(output_dir, filename, content)
@@ -133,28 +138,31 @@ def generate_migration(test_contract: str, output_dir: Path, owner_address: str)
     :param owner_address:
     :return:
     """
-    content = f'''{test_contract} = artifacts.require("{test_contract}");
+    content = f"""{test_contract} = artifacts.require("{test_contract}");
 module.exports = function(deployer) {{
   deployer.deploy({test_contract}, {{from: "{owner_address}"}});
 }};
-'''
+"""
 
-    output_dir = Path(output_dir, 'migrations')
+    output_dir = Path(output_dir, "migrations")
 
     output_dir.mkdir(exist_ok=True)
 
-    migration_files = [js_file for js_file in output_dir.iterdir() if js_file.suffix == '.js'
-                       and PATTERN_TRUFFLE_MIGRATION.match(js_file.name)]
+    migration_files = [
+        js_file
+        for js_file in output_dir.iterdir()
+        if js_file.suffix == ".js" and PATTERN_TRUFFLE_MIGRATION.match(js_file.name)
+    ]
 
     idx = len(migration_files)
-    filename = f'{idx + 1}_{test_contract}.js'
-    potential_previous_filename = f'{idx}_{test_contract}.js'
+    filename = f"{idx + 1}_{test_contract}.js"
+    potential_previous_filename = f"{idx}_{test_contract}.js"
 
     for m in migration_files:
         if m.name == potential_previous_filename:
             write_file(output_dir, potential_previous_filename, content)
             return
         if test_contract in m.name:
-            logger.error(f'Potential conflicts with {m.name}')
+            logger.error(f"Potential conflicts with {m.name}")
 
     write_file(output_dir, filename, content)

slither/tools/properties/properties/erc20.py

@@ -12,27 +12,37 @@ from slither.tools.properties.platforms.echidna import generate_echidna_config
 from slither.tools.properties.properties.ercs.erc20.properties.burn import ERC20_NotBurnable
 from slither.tools.properties.properties.ercs.erc20.properties.initialization import ERC20_CONFIG
 from slither.tools.properties.properties.ercs.erc20.properties.mint import ERC20_NotMintable
-from slither.tools.properties.properties.ercs.erc20.properties.mint_and_burn import ERC20_NotMintableNotBurnable
-from slither.tools.properties.properties.ercs.erc20.properties.transfer import ERC20_Transferable, ERC20_Pausable
+from slither.tools.properties.properties.ercs.erc20.properties.mint_and_burn import (
+    ERC20_NotMintableNotBurnable,
+)
+from slither.tools.properties.properties.ercs.erc20.properties.transfer import (
+    ERC20_Transferable,
+    ERC20_Pausable,
+)
 from slither.tools.properties.properties.ercs.erc20.unit_tests.truffle import generate_truffle_test
 from slither.tools.properties.properties.properties import property_to_solidity, Property
-from slither.tools.properties.solidity.generate_properties import generate_solidity_properties, generate_test_contract, \
-    generate_solidity_interface
+from slither.tools.properties.solidity.generate_properties import (
+    generate_solidity_properties,
+    generate_test_contract,
+    generate_solidity_interface,
+)
 from slither.utils.colors import red, green
 
 logger = logging.getLogger("Slither")
 
-PropertyDescription = namedtuple('PropertyDescription', ['properties', 'description'])
+PropertyDescription = namedtuple("PropertyDescription", ["properties", "description"])
 
 ERC20_PROPERTIES = {
-    "Transferable": PropertyDescription(ERC20_Transferable, 'Test the correct tokens transfer'),
-    "Pausable": PropertyDescription(ERC20_Pausable, 'Test the pausable functionality'),
-    "NotMintable": PropertyDescription(ERC20_NotMintable, 'Test that no one can mint tokens'),
-    "NotMintableNotBurnable": PropertyDescription(ERC20_NotMintableNotBurnable,
-                                                  'Test that no one can mint or burn tokens'),
-    "NotBurnable": PropertyDescription(ERC20_NotBurnable, 'Test that no one can burn tokens'),
-    "Burnable": PropertyDescription(ERC20_NotBurnable,
-                                    'Test the burn of tokens. Require the "burn(address) returns()" function')
+    "Transferable": PropertyDescription(ERC20_Transferable, "Test the correct tokens transfer"),
+    "Pausable": PropertyDescription(ERC20_Pausable, "Test the pausable functionality"),
+    "NotMintable": PropertyDescription(ERC20_NotMintable, "Test that no one can mint tokens"),
+    "NotMintableNotBurnable": PropertyDescription(
+        ERC20_NotMintableNotBurnable, "Test that no one can mint or burn tokens"
+    ),
+    "NotBurnable": PropertyDescription(ERC20_NotBurnable, "Test that no one can burn tokens"),
+    "Burnable": PropertyDescription(
+        ERC20_NotBurnable, 'Test the burn of tokens. Require the "burn(address) returns()" function'
+    ),
 }
 
 
@@ -54,7 +64,7 @@ def generate_erc20(contract: Contract, type_property: str, addresses: Addresses)
     :return:
     """
     if contract.slither.crytic_compile.type not in [PlatformType.TRUFFLE, PlatformType.SOLC]:
-        logging.error(f'{contract.slither.crytic_compile.type} not yet supported by slither-prop')
+        logging.error(f"{contract.slither.crytic_compile.type} not yet supported by slither-prop")
         return
 
     # Check if the contract is an ERC20 contract and if the functions have the correct visibility
@@ -65,7 +75,9 @@ def generate_erc20(contract: Contract, type_property: str, addresses: Addresses)
 
     properties = ERC20_PROPERTIES.get(type_property, None)
     if properties is None:
-        logger.error(f'{type_property} unknown. Types available {[x for x in ERC20_PROPERTIES.keys()]}')
+        logger.error(
+            f"{type_property} unknown. Types available {[x for x in ERC20_PROPERTIES.keys()]}"
+        )
         return
     properties = properties.properties
 
@@ -78,51 +90,53 @@ def generate_erc20(contract: Contract, type_property: str, addresses: Addresses)
 
     # Generate the contract containing the properties
     generate_solidity_interface(output_dir, addresses)
-    property_file = generate_solidity_properties(contract, type_property, solidity_properties, output_dir)
+    property_file = generate_solidity_properties(
+        contract, type_property, solidity_properties, output_dir
+    )
 
     # Generate the Test contract
     initialization_recommendation = _initialization_recommendation(type_property)
-    contract_filename, contract_name = generate_test_contract(contract,
-                                                              type_property,
-                                                              output_dir,
-                                                              property_file,
-                                                              initialization_recommendation)
+    contract_filename, contract_name = generate_test_contract(
+        contract, type_property, output_dir, property_file, initialization_recommendation
+    )
 
     # Generate Echidna config file
-    echidna_config_filename = generate_echidna_config(Path(contract.slither.crytic_compile.target).parent, addresses)
+    echidna_config_filename = generate_echidna_config(
+        Path(contract.slither.crytic_compile.target).parent, addresses
+    )
 
-    unit_test_info = ''
+    unit_test_info = ""
 
     # If truffle, generate unit tests
     if contract.slither.crytic_compile.type == PlatformType.TRUFFLE:
         unit_test_info = generate_truffle_test(contract, type_property, unit_tests, addresses)
 
-    logger.info('################################################')
-    logger.info(green(f'Update the constructor in {Path(output_dir, contract_filename)}'))
+    logger.info("################################################")
+    logger.info(green(f"Update the constructor in {Path(output_dir, contract_filename)}"))
 
     if unit_test_info:
         logger.info(green(unit_test_info))
 
-    logger.info(green('To run Echidna:'))
-    txt = f'\t echidna-test {contract.slither.crytic_compile.target} '
-    txt += f'--contract {contract_name} --config {echidna_config_filename}'
+    logger.info(green("To run Echidna:"))
+    txt = f"\t echidna-test {contract.slither.crytic_compile.target} "
+    txt += f"--contract {contract_name} --config {echidna_config_filename}"
     logger.info(green(txt))
 
 
 def _initialization_recommendation(type_property: str) -> str:
-    content = ''
-    content += '\t\t// Add below a minimal configuration:\n'
-    content += '\t\t// - crytic_owner must have some tokens \n'
-    content += '\t\t// - crytic_user must have some tokens \n'
-    content += '\t\t// - crytic_attacker must have some tokens \n'
-    if type_property in ['Pausable']:
-        content += '\t\t// - The contract must be paused \n'
-    if type_property in ['NotMintable', 'NotMintableNotBurnable']:
-        content += '\t\t// - The contract must not be mintable \n'
-    if type_property in ['NotBurnable', 'NotMintableNotBurnable']:
-        content += '\t\t// - The contract must not be burnable \n'
-    content += '\n'
-    content += '\n'
+    content = ""
+    content += "\t\t// Add below a minimal configuration:\n"
+    content += "\t\t// - crytic_owner must have some tokens \n"
+    content += "\t\t// - crytic_user must have some tokens \n"
+    content += "\t\t// - crytic_attacker must have some tokens \n"
+    if type_property in ["Pausable"]:
+        content += "\t\t// - The contract must be paused \n"
+    if type_property in ["NotMintable", "NotMintableNotBurnable"]:
+        content += "\t\t// - The contract must not be mintable \n"
+    if type_property in ["NotBurnable", "NotMintableNotBurnable"]:
+        content += "\t\t// - The contract must not be burnable \n"
+    content += "\n"
+    content += "\n"
 
     return content
 
@@ -130,44 +144,44 @@ def _initialization_recommendation(type_property: str) -> str:
 # TODO: move this to crytic-compile
 def _platform_to_output_dir(platform: AbstractPlatform) -> Path:
     if platform.TYPE == PlatformType.TRUFFLE:
-        return Path(platform.target, 'contracts', 'crytic')
+        return Path(platform.target, "contracts", "crytic")
     if platform.TYPE == PlatformType.SOLC:
         return Path(platform.target).parent
 
 
 def _check_compatibility(contract):
-    errors = ''
+    errors = ""
     if not contract.is_erc20():
-        errors = f'{contract} is not ERC20 compliant. Consider checking the contract with slither-check-erc'
+        errors = f"{contract} is not ERC20 compliant. Consider checking the contract with slither-check-erc"
         return errors
 
-    transfer = contract.get_function_from_signature('transfer(address,uint256)')
+    transfer = contract.get_function_from_signature("transfer(address,uint256)")
 
-    if transfer.visibility != 'public':
-        errors = f'slither-prop requires {transfer.canonical_name} to be public. Please change the visibility'
+    if transfer.visibility != "public":
+        errors = f"slither-prop requires {transfer.canonical_name} to be public. Please change the visibility"
 
-    transfer_from = contract.get_function_from_signature('transferFrom(address,address,uint256)')
-    if transfer_from.visibility != 'public':
+    transfer_from = contract.get_function_from_signature("transferFrom(address,address,uint256)")
+    if transfer_from.visibility != "public":
         if errors:
-            errors += '\n'
-        errors += f'slither-prop requires {transfer_from.canonical_name} to be public. Please change the visibility'
+            errors += "\n"
+        errors += f"slither-prop requires {transfer_from.canonical_name} to be public. Please change the visibility"
 
-    approve = contract.get_function_from_signature('approve(address,uint256)')
-    if approve.visibility != 'public':
+    approve = contract.get_function_from_signature("approve(address,uint256)")
+    if approve.visibility != "public":
         if errors:
-            errors += '\n'
-        errors += f'slither-prop requires {approve.canonical_name} to be public. Please change the visibility'
+            errors += "\n"
+        errors += f"slither-prop requires {approve.canonical_name} to be public. Please change the visibility"
 
     return errors
 
 
 def _get_properties(contract, properties: List[Property]) -> Tuple[str, List[Property]]:
-    solidity_properties = ''
+    solidity_properties = ""
 
     if contract.slither.crytic_compile.type == PlatformType.TRUFFLE:
-        solidity_properties += '\n'.join([property_to_solidity(p) for p in ERC20_CONFIG])
+        solidity_properties += "\n".join([property_to_solidity(p) for p in ERC20_CONFIG])
 
-    solidity_properties += '\n'.join([property_to_solidity(p) for p in properties])
+    solidity_properties += "\n".join([property_to_solidity(p) for p in properties])
     unit_tests = [p for p in properties if p.is_unit_test]
 
     return solidity_properties, unit_tests

slither/tools/properties/properties/ercs/erc20/properties/burn.py

@@ -1,30 +1,38 @@
-from slither.tools.properties.properties.properties import Property, PropertyType, PropertyReturn, PropertyCaller
+from slither.tools.properties.properties.properties import (
+    Property,
+    PropertyType,
+    PropertyReturn,
+    PropertyCaller,
+)
 
 ERC20_NotBurnable = [
-    Property(name='crytic_supply_constant_ERC20PropertiesNotBurnable()',
-             description='The total supply does not decrease.',
-             content='''
-\t\treturn initialTotalSupply == this.totalSupply();''',
-             type=PropertyType.MEDIUM_SEVERITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ANY),
+    Property(
+        name="crytic_supply_constant_ERC20PropertiesNotBurnable()",
+        description="The total supply does not decrease.",
+        content="""
+\t\treturn initialTotalSupply == this.totalSupply();""",
+        type=PropertyType.MEDIUM_SEVERITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ANY,
+    ),
 ]
 
 
 # Require burn(address) returns()
 ERC20_Burnable = [
-    Property(name='crytic_supply_constant_ERC20PropertiesNotBurnable()',
-             description='Cannot burn more than available balance',
-             content='''
+    Property(
+        name="crytic_supply_constant_ERC20PropertiesNotBurnable()",
+        description="Cannot burn more than available balance",
+        content="""
 \t\tuint balance = balanceOf(msg.sender);
 \t\tburn(balance + 1);
-\t\treturn false;''',
-             type=PropertyType.MEDIUM_SEVERITY,
-             return_type=PropertyReturn.THROW,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ALL)
+\t\treturn false;""",
+        type=PropertyType.MEDIUM_SEVERITY,
+        return_type=PropertyReturn.THROW,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ALL,
+    )
 ]
-

slither/tools/properties/properties/ercs/erc20/properties/initialization.py

@@ -1,65 +1,76 @@
-from slither.tools.properties.properties.properties import Property, PropertyType, PropertyReturn, PropertyCaller
+from slither.tools.properties.properties.properties import (
+    Property,
+    PropertyType,
+    PropertyReturn,
+    PropertyCaller,
+)
 
 ERC20_CONFIG = [
-
-    Property(name='init_total_supply()',
-             description='The total supply is correctly initialized.',
-             content='''
-\t\treturn this.totalSupply() >= 0 && this.totalSupply() == initialTotalSupply;''',
-             type=PropertyType.CODE_QUALITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=False,
-             caller=PropertyCaller.ANY),
-
-    Property(name='init_owner_balance()',
-             description="Owner's balance is correctly initialized.",
-             content='''
-\t\treturn initialBalance_owner == this.balanceOf(crytic_owner);''',
-             type=PropertyType.CODE_QUALITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=False,
-             caller=PropertyCaller.ANY),
-
-    Property(name='init_user_balance()',
-             description="User's balance is correctly initialized.",
-             content='''
-\t\treturn initialBalance_user == this.balanceOf(crytic_user);''',
-             type=PropertyType.CODE_QUALITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=False,
-             caller=PropertyCaller.ANY),
-
-    Property(name='init_attacker_balance()',
-             description="Attacker's balance is correctly initialized.",
-             content='''
-\t\treturn initialBalance_attacker == this.balanceOf(crytic_attacker);''',
-             type=PropertyType.CODE_QUALITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=False,
-             caller=PropertyCaller.ANY),
-
-    Property(name='init_caller_balance()',
-             description="All the users have a positive balance.",
-             content='''
-\t\treturn this.balanceOf(msg.sender) >0 ;''',
-             type=PropertyType.CODE_QUALITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=False,
-             caller=PropertyCaller.ALL),
-
+    Property(
+        name="init_total_supply()",
+        description="The total supply is correctly initialized.",
+        content="""
+\t\treturn this.totalSupply() >= 0 && this.totalSupply() == initialTotalSupply;""",
+        type=PropertyType.CODE_QUALITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=False,
+        caller=PropertyCaller.ANY,
+    ),
+    Property(
+        name="init_owner_balance()",
+        description="Owner's balance is correctly initialized.",
+        content="""
+\t\treturn initialBalance_owner == this.balanceOf(crytic_owner);""",
+        type=PropertyType.CODE_QUALITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=False,
+        caller=PropertyCaller.ANY,
+    ),
+    Property(
+        name="init_user_balance()",
+        description="User's balance is correctly initialized.",
+        content="""
+\t\treturn initialBalance_user == this.balanceOf(crytic_user);""",
+        type=PropertyType.CODE_QUALITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=False,
+        caller=PropertyCaller.ANY,
+    ),
+    Property(
+        name="init_attacker_balance()",
+        description="Attacker's balance is correctly initialized.",
+        content="""
+\t\treturn initialBalance_attacker == this.balanceOf(crytic_attacker);""",
+        type=PropertyType.CODE_QUALITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=False,
+        caller=PropertyCaller.ANY,
+    ),
+    Property(
+        name="init_caller_balance()",
+        description="All the users have a positive balance.",
+        content="""
+\t\treturn this.balanceOf(msg.sender) >0 ;""",
+        type=PropertyType.CODE_QUALITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=False,
+        caller=PropertyCaller.ALL,
+    ),
     # Note: there is a potential overflow on the addition, but we dont consider it
-    Property(name='init_total_supply_is_balances()',
-             description="The total supply is the user and owner balance.",
-             content='''
-\t\treturn this.balanceOf(crytic_owner) + this.balanceOf(crytic_user) + this.balanceOf(crytic_attacker) == this.totalSupply();''',
-             type=PropertyType.CODE_QUALITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=False,
-             caller=PropertyCaller.ANY),
+    Property(
+        name="init_total_supply_is_balances()",
+        description="The total supply is the user and owner balance.",
+        content="""
+\t\treturn this.balanceOf(crytic_owner) + this.balanceOf(crytic_user) + this.balanceOf(crytic_attacker) == this.totalSupply();""",
+        type=PropertyType.CODE_QUALITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=False,
+        caller=PropertyCaller.ANY,
+    ),
 ]

slither/tools/properties/properties/ercs/erc20/properties/mint.py

@@ -1,13 +1,20 @@
-from slither.tools.properties.properties.properties import PropertyType, PropertyReturn, Property, PropertyCaller
+from slither.tools.properties.properties.properties import (
+    PropertyType,
+    PropertyReturn,
+    Property,
+    PropertyCaller,
+)
 
 ERC20_NotMintable = [
-    Property(name='crytic_supply_constant_ERC20PropertiesNotMintable()',
-             description='The total supply does not increase.',
-             content='''
-\t\treturn initialTotalSupply >= totalSupply();''',
-             type=PropertyType.MEDIUM_SEVERITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ANY),
+    Property(
+        name="crytic_supply_constant_ERC20PropertiesNotMintable()",
+        description="The total supply does not increase.",
+        content="""
+\t\treturn initialTotalSupply >= totalSupply();""",
+        type=PropertyType.MEDIUM_SEVERITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ANY,
+    ),
 ]

slither/tools/properties/properties/ercs/erc20/properties/mint_and_burn.py

@@ -1,14 +1,20 @@
-from slither.tools.properties.properties.properties import Property, PropertyType, PropertyReturn, PropertyCaller
+from slither.tools.properties.properties.properties import (
+    Property,
+    PropertyType,
+    PropertyReturn,
+    PropertyCaller,
+)
 
 ERC20_NotMintableNotBurnable = [
-
-    Property(name='crytic_supply_constant_ERC20PropertiesNotMintableNotBurnable()',
-             description='The total supply does not change.',
-             content='''
-\t\treturn initialTotalSupply == this.totalSupply();''',
-             type=PropertyType.MEDIUM_SEVERITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ANY),
+    Property(
+        name="crytic_supply_constant_ERC20PropertiesNotMintableNotBurnable()",
+        description="The total supply does not change.",
+        content="""
+\t\treturn initialTotalSupply == this.totalSupply();""",
+        type=PropertyType.MEDIUM_SEVERITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ANY,
+    ),
 ]

slither/tools/properties/properties/ercs/erc20/properties/transfer.py

@@ -1,96 +1,108 @@
-from slither.tools.properties.properties.properties import Property, PropertyType, PropertyReturn, PropertyCaller
+from slither.tools.properties.properties.properties import (
+    Property,
+    PropertyType,
+    PropertyReturn,
+    PropertyCaller,
+)
 
 ERC20_Transferable = [
-
-    Property(name='crytic_zero_always_empty_ERC20Properties()',
-             description='The address 0x0 should not receive tokens.',
-             content='''
-\t\treturn this.balanceOf(address(0x0)) == 0;''',
-             type=PropertyType.CODE_QUALITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ANY),
-
-    Property(name='crytic_approve_overwrites()',
-             description='Allowance can be changed.',
-             content='''
+    Property(
+        name="crytic_zero_always_empty_ERC20Properties()",
+        description="The address 0x0 should not receive tokens.",
+        content="""
+\t\treturn this.balanceOf(address(0x0)) == 0;""",
+        type=PropertyType.CODE_QUALITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ANY,
+    ),
+    Property(
+        name="crytic_approve_overwrites()",
+        description="Allowance can be changed.",
+        content="""
 \t\tbool approve_return; 
 \t\tapprove_return = approve(crytic_user, 10);
 \t\trequire(approve_return);
 \t\tapprove_return = approve(crytic_user, 20);
 \t\trequire(approve_return);
-\t\treturn this.allowance(msg.sender, crytic_user) == 20;''',
-             type=PropertyType.CODE_QUALITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ALL),
-
-    Property(name='crytic_less_than_total_ERC20Properties()',
-             description='Balance of one user must be less or equal to the total supply.',
-             content='''
-\t\treturn this.balanceOf(msg.sender) <= totalSupply();''',
-             type=PropertyType.MEDIUM_SEVERITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ALL),
-
-    Property(name='crytic_totalSupply_consistant_ERC20Properties()',
-             description='Balance of the crytic users must be less or equal to the total supply.',
-             content='''
-\t\treturn this.balanceOf(crytic_owner) + this.balanceOf(crytic_user) + this.balanceOf(crytic_attacker) <= totalSupply();''',
-             type=PropertyType.MEDIUM_SEVERITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ANY),
-
-    Property(name='crytic_revert_transfer_to_zero_ERC20PropertiesTransferable()',
-             description='No one should be able to send tokens to the address 0x0 (transfer).',
-             content='''
+\t\treturn this.allowance(msg.sender, crytic_user) == 20;""",
+        type=PropertyType.CODE_QUALITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ALL,
+    ),
+    Property(
+        name="crytic_less_than_total_ERC20Properties()",
+        description="Balance of one user must be less or equal to the total supply.",
+        content="""
+\t\treturn this.balanceOf(msg.sender) <= totalSupply();""",
+        type=PropertyType.MEDIUM_SEVERITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ALL,
+    ),
+    Property(
+        name="crytic_totalSupply_consistant_ERC20Properties()",
+        description="Balance of the crytic users must be less or equal to the total supply.",
+        content="""
+\t\treturn this.balanceOf(crytic_owner) + this.balanceOf(crytic_user) + this.balanceOf(crytic_attacker) <= totalSupply();""",
+        type=PropertyType.MEDIUM_SEVERITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ANY,
+    ),
+    Property(
+        name="crytic_revert_transfer_to_zero_ERC20PropertiesTransferable()",
+        description="No one should be able to send tokens to the address 0x0 (transfer).",
+        content="""
 \t\tif (this.balanceOf(msg.sender) == 0){
 \t\t\trevert();
 \t\t}
-\t\treturn transfer(address(0x0), this.balanceOf(msg.sender));''',
-             type=PropertyType.CODE_QUALITY,
-             return_type=PropertyReturn.FAIL_OR_THROW,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ALL),
-
-    Property(name='crytic_revert_transferFrom_to_zero_ERC20PropertiesTransferable()',
-             description='No one should be able to send tokens to the address 0x0 (transferFrom).',
-             content='''
+\t\treturn transfer(address(0x0), this.balanceOf(msg.sender));""",
+        type=PropertyType.CODE_QUALITY,
+        return_type=PropertyReturn.FAIL_OR_THROW,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ALL,
+    ),
+    Property(
+        name="crytic_revert_transferFrom_to_zero_ERC20PropertiesTransferable()",
+        description="No one should be able to send tokens to the address 0x0 (transferFrom).",
+        content="""
 \t\tuint balance = this.balanceOf(msg.sender);
 \t\tif (balance == 0){
 \t\t\trevert();
 \t\t}
 \t\tapprove(msg.sender, balance);
-\t\treturn transferFrom(msg.sender, address(0x0), this.balanceOf(msg.sender));''',
-             type=PropertyType.CODE_QUALITY,
-             return_type=PropertyReturn.FAIL_OR_THROW,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ALL),
-
-    Property(name='crytic_self_transferFrom_ERC20PropertiesTransferable()',
-             description='Self transferFrom works.',
-             content='''
+\t\treturn transferFrom(msg.sender, address(0x0), this.balanceOf(msg.sender));""",
+        type=PropertyType.CODE_QUALITY,
+        return_type=PropertyReturn.FAIL_OR_THROW,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ALL,
+    ),
+    Property(
+        name="crytic_self_transferFrom_ERC20PropertiesTransferable()",
+        description="Self transferFrom works.",
+        content="""
 \t\tuint balance = this.balanceOf(msg.sender);
 \t\tbool approve_return = approve(msg.sender, balance);
 \t\tbool transfer_return = transferFrom(msg.sender, msg.sender, balance);
-\t\treturn (this.balanceOf(msg.sender) == balance) && approve_return && transfer_return;''',
-             type=PropertyType.HIGH_SEVERITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ALL),
-
-    Property(name='crytic_self_transferFrom_to_other_ERC20PropertiesTransferable()',
-             description='transferFrom works.',
-             content='''
+\t\treturn (this.balanceOf(msg.sender) == balance) && approve_return && transfer_return;""",
+        type=PropertyType.HIGH_SEVERITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ALL,
+    ),
+    Property(
+        name="crytic_self_transferFrom_to_other_ERC20PropertiesTransferable()",
+        description="transferFrom works.",
+        content="""
 \t\tuint balance = this.balanceOf(msg.sender);
 \t\tbool approve_return = approve(msg.sender, balance);
 \t\taddress other = crytic_user;
@@ -98,29 +110,30 @@ ERC20_Transferable = [
 \t\t\tother = crytic_owner;
 \t\t}
 \t\tbool transfer_return = transferFrom(msg.sender, other, balance);
-\t\treturn (this.balanceOf(msg.sender) == 0) && approve_return && transfer_return;''',
-             type=PropertyType.HIGH_SEVERITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ALL),
-
-
-    Property(name='crytic_self_transfer_ERC20PropertiesTransferable()',
-             description='Self transfer works.',
-             content='''
+\t\treturn (this.balanceOf(msg.sender) == 0) && approve_return && transfer_return;""",
+        type=PropertyType.HIGH_SEVERITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ALL,
+    ),
+    Property(
+        name="crytic_self_transfer_ERC20PropertiesTransferable()",
+        description="Self transfer works.",
+        content="""
 \t\tuint balance = this.balanceOf(msg.sender);
 \t\tbool transfer_return = transfer(msg.sender, balance);
-\t\treturn (this.balanceOf(msg.sender) == balance) && transfer_return;''',
-             type=PropertyType.HIGH_SEVERITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ALL),
-
-    Property(name='crytic_transfer_to_other_ERC20PropertiesTransferable()',
-             description='transfer works.',
-             content='''
+\t\treturn (this.balanceOf(msg.sender) == balance) && transfer_return;""",
+        type=PropertyType.HIGH_SEVERITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ALL,
+    ),
+    Property(
+        name="crytic_transfer_to_other_ERC20PropertiesTransferable()",
+        description="transfer works.",
+        content="""
 \t\tuint balance = this.balanceOf(msg.sender);
 \t\taddress other = crytic_user;
 \t\tif (other == msg.sender) {
@@ -130,74 +143,76 @@ ERC20_Transferable = [
 \t\t\tbool transfer_other = transfer(other, 1);
 \t\t\treturn (this.balanceOf(msg.sender) == balance-1) && (this.balanceOf(other) >= 1) && transfer_other;
 \t\t}
-\t\treturn true;''',
-             type=PropertyType.HIGH_SEVERITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ALL),
-
-    Property(name='crytic_revert_transfer_to_user_ERC20PropertiesTransferable()',
-             description='Cannot transfer more than the balance.',
-             content='''
+\t\treturn true;""",
+        type=PropertyType.HIGH_SEVERITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ALL,
+    ),
+    Property(
+        name="crytic_revert_transfer_to_user_ERC20PropertiesTransferable()",
+        description="Cannot transfer more than the balance.",
+        content="""
 \t\tuint balance = this.balanceOf(msg.sender);
 \t\tif (balance == (2 ** 256 - 1))
 \t\t\treturn true;
 \t\tbool transfer_other = transfer(crytic_user, balance+1);
-\t\treturn transfer_other;''',
-             type=PropertyType.HIGH_SEVERITY,
-             return_type=PropertyReturn.FAIL_OR_THROW,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ALL),
-
+\t\treturn transfer_other;""",
+        type=PropertyType.HIGH_SEVERITY,
+        return_type=PropertyReturn.FAIL_OR_THROW,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ALL,
+    ),
 ]
 
 
 ERC20_Pausable = [
-
-    Property(name='crytic_revert_transfer_ERC20AlwaysTruePropertiesNotTransferable()',
-             description='Cannot transfer.',
-             content='''
-\t\treturn transfer(crytic_user, this.balanceOf(msg.sender));''',
-             type=PropertyType.MEDIUM_SEVERITY,
-             return_type=PropertyReturn.FAIL_OR_THROW,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ALL),
-
-    Property(name='crytic_revert_transferFrom_ERC20AlwaysTruePropertiesNotTransferable()',
-             description='Cannot execute transferFrom.',
-             content='''
+    Property(
+        name="crytic_revert_transfer_ERC20AlwaysTruePropertiesNotTransferable()",
+        description="Cannot transfer.",
+        content="""
+\t\treturn transfer(crytic_user, this.balanceOf(msg.sender));""",
+        type=PropertyType.MEDIUM_SEVERITY,
+        return_type=PropertyReturn.FAIL_OR_THROW,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ALL,
+    ),
+    Property(
+        name="crytic_revert_transferFrom_ERC20AlwaysTruePropertiesNotTransferable()",
+        description="Cannot execute transferFrom.",
+        content="""
 \t\tapprove(msg.sender, this.balanceOf(msg.sender));
-\t\ttransferFrom(msg.sender, msg.sender, this.balanceOf(msg.sender));''',
-             type=PropertyType.MEDIUM_SEVERITY,
-             return_type=PropertyReturn.FAIL_OR_THROW,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ALL),
-
-    Property(name='crytic_constantBalance()',
-             description='Cannot change the balance.',
-             content='''
-\t\treturn this.balanceOf(crytic_user) == initialBalance_user && this.balanceOf(crytic_attacker) == initialBalance_attacker;''',
-             type=PropertyType.MEDIUM_SEVERITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ALL),
-
-    Property(name='crytic_constantAllowance()',
-             description='Cannot change the allowance.',
-             content='''
+\t\ttransferFrom(msg.sender, msg.sender, this.balanceOf(msg.sender));""",
+        type=PropertyType.MEDIUM_SEVERITY,
+        return_type=PropertyReturn.FAIL_OR_THROW,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ALL,
+    ),
+    Property(
+        name="crytic_constantBalance()",
+        description="Cannot change the balance.",
+        content="""
+\t\treturn this.balanceOf(crytic_user) == initialBalance_user && this.balanceOf(crytic_attacker) == initialBalance_attacker;""",
+        type=PropertyType.MEDIUM_SEVERITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ALL,
+    ),
+    Property(
+        name="crytic_constantAllowance()",
+        description="Cannot change the allowance.",
+        content="""
 \t\treturn (this.allowance(crytic_user, crytic_attacker) == initialAllowance_user_attacker) &&
-\t\t\t(this.allowance(crytic_attacker, crytic_attacker) == initialAllowance_attacker_attacker);''',
-             type=PropertyType.MEDIUM_SEVERITY,
-             return_type=PropertyReturn.SUCCESS,
-             is_unit_test=True,
-             is_property_test=True,
-             caller=PropertyCaller.ALL),
-
+\t\t\t(this.allowance(crytic_attacker, crytic_attacker) == initialAllowance_attacker_attacker);""",
+        type=PropertyType.MEDIUM_SEVERITY,
+        return_type=PropertyReturn.SUCCESS,
+        is_unit_test=True,
+        is_property_test=True,
+        caller=PropertyCaller.ALL,
+    ),
 ]
-
-

slither/tools/properties/properties/ercs/erc20/unit_tests/truffle.py

@@ -11,26 +11,32 @@ from slither.tools.properties.properties.properties import Property
 logger = logging.getLogger("Slither")
 
 
-def generate_truffle_test(contract: Contract, type_property: str, unit_tests: List[Property], addresses: Addresses) -> str:
-    test_contract = f'Test{contract.name}{type_property}'
-    filename_init = f'Initialization{test_contract}.js'
-    filename = f'{test_contract}.js'
+def generate_truffle_test(
+    contract: Contract, type_property: str, unit_tests: List[Property], addresses: Addresses
+) -> str:
+    test_contract = f"Test{contract.name}{type_property}"
+    filename_init = f"Initialization{test_contract}.js"
+    filename = f"{test_contract}.js"
 
     output_dir = Path(contract.slither.crytic_compile.target)
 
     generate_migration(test_contract, output_dir, addresses.owner)
 
-    generate_unit_test(test_contract,
-                       filename_init,
-                       ERC20_CONFIG,
-                       output_dir,
-                       addresses,
-                       f'Check the constructor of {test_contract}')
-
-    generate_unit_test(test_contract, filename, unit_tests, output_dir, addresses,)
-
-    log_info = '\n'
-    log_info += 'To run the unit tests:\n'
+    generate_unit_test(
+        test_contract,
+        filename_init,
+        ERC20_CONFIG,
+        output_dir,
+        addresses,
+        f"Check the constructor of {test_contract}",
+    )
+
+    generate_unit_test(
+        test_contract, filename, unit_tests, output_dir, addresses,
+    )
+
+    log_info = "\n"
+    log_info += "To run the unit tests:\n"
     log_info += f"\ttruffle test {Path(output_dir, 'test', 'crytic', filename_init)}\n"
     log_info += f"\ttruffle test {Path(output_dir, 'test', 'crytic', filename)}\n"
     return log_info

slither/tools/properties/properties/properties.py

@@ -36,4 +36,4 @@ class Property(NamedTuple):
 
 
 def property_to_solidity(p: Property):
-    return f'\tfunction {p.name} public returns(bool){{{p.content}\n\t}}\n'
+    return f"\tfunction {p.name} public returns(bool){{{p.content}\n\t}}\n"