Merge with dev

Author: montyly

slither/detectors/assembly/shift_parameter_mixup.py

@@ -17,6 +17,8 @@ class ShiftParameterMixup(AbstractDetector):
 
     WIKI_TITLE = "Incorrect shift in assembly."
     WIKI_DESCRIPTION = "Detect if the values in a shift operation are reversed"
+
+    # region wiki_exploit_scenario
     WIKI_EXPLOIT_SCENARIO = """
 ```solidity
 contract C {
@@ -28,6 +30,7 @@ class ShiftParameterMixup(AbstractDetector):
 }
 ```
 The shift statement will right-shift the constant 8 by `a` bits"""
+    # endregion wiki_exploit_scenario
 
     WIKI_RECOMMENDATION = "Swap the order of parameters."
 

slither/detectors/attributes/const_functions_asm.py

@@ -19,14 +19,18 @@ class ConstantFunctionsAsm(AbstractDetector):
     WIKI = "https://github.com/crytic/slither/wiki/Detector-Documentation#constant-functions-using-assembly-code"
 
     WIKI_TITLE = "Constant functions using assembly code"
+
+    # region wiki_description
     WIKI_DESCRIPTION = """
 Functions declared as `constant`/`pure`/`view` using assembly code.
 
 `constant`/`pure`/`view` was not enforced prior to Solidity 0.5.
 Starting from Solidity 0.5, a call to a `constant`/`pure`/`view` function uses the `STATICCALL` opcode, which reverts in case of state modification.
 
 As a result, a call to an [incorrectly labeled function may trap a contract compiled with Solidity 0.5](https://solidity.readthedocs.io/en/develop/050-breaking-changes.html#interoperability-with-older-contracts)."""
+    # endregion wiki_description
 
+    # region wiki_exploit_scenario
     WIKI_EXPLOIT_SCENARIO = """
 ```solidity
 contract Constant{
@@ -39,6 +43,7 @@ class ConstantFunctionsAsm(AbstractDetector):
 ```
 `Constant` was deployed with Solidity 0.4.25. Bob writes a smart contract that interacts with `Constant` in Solidity 0.5.0. 
 All the calls to `get` revert, breaking Bob's smart contract execution."""
+    # endregion wiki_exploit_scenario
 
     WIKI_RECOMMENDATION = (
         "Ensure the attributes of contracts compiled prior to Solidity 0.5.0 are correct."

slither/detectors/attributes/const_functions_state.py

@@ -19,14 +19,18 @@ class ConstantFunctionsState(AbstractDetector):
     WIKI = "https://github.com/crytic/slither/wiki/Detector-Documentation#constant-functions-changing-the-state"
 
     WIKI_TITLE = "Constant functions changing the state"
+
+    # region wiki_description
     WIKI_DESCRIPTION = """
 Functions declared as `constant`/`pure`/`view` change the state.
 
 `constant`/`pure`/`view` was not enforced prior to Solidity 0.5.
 Starting from Solidity 0.5, a call to a `constant`/`pure`/`view` function uses the `STATICCALL` opcode, which reverts in case of state modification.
 
 As a result, a call to an [incorrectly labeled function may trap a contract compiled with Solidity 0.5](https://solidity.readthedocs.io/en/develop/050-breaking-changes.html#interoperability-with-older-contracts)."""
+    # endregion wiki_description
 
+    # region wiki_exploit_scenario
     WIKI_EXPLOIT_SCENARIO = """
 ```solidity
 contract Constant{
@@ -39,6 +43,7 @@ class ConstantFunctionsState(AbstractDetector):
 ```
 `Constant` was deployed with Solidity 0.4.25. Bob writes a smart contract that interacts with `Constant` in Solidity 0.5.0. 
 All the calls to `get` revert, breaking Bob's smart contract execution."""
+    # endregion wiki_exploit_scenario
 
     WIKI_RECOMMENDATION = (
         "Ensure that attributes of contracts compiled prior to Solidity 0.5.0 are correct."

slither/detectors/attributes/incorrect_solc.py

@@ -30,16 +30,22 @@ class IncorrectSolc(AbstractDetector):
     WIKI = "https://github.com/crytic/slither/wiki/Detector-Documentation#incorrect-versions-of-solidity"
 
     WIKI_TITLE = "Incorrect versions of Solidity"
+
+    # region wiki_description
     WIKI_DESCRIPTION = """
 `solc` frequently releases new compiler versions. Using an old version prevents access to new Solidity security checks.
 We also recommend avoiding complex `pragma` statement."""
+    # endregion wiki_description
+
+    # region wiki_recommendation
     WIKI_RECOMMENDATION = """
 Deploy with any of the following Solidity versions:
 - 0.5.16 - 0.5.17
 - 0.6.11 - 0.6.12
 - 0.7.5 - 0.7.6
 Use a simple pragma version that allows any of these versions.
 Consider using the latest version of Solidity for testing."""
+    # endregion wiki_recommendation
 
     COMPLEX_PRAGMA_TXT = "is too complex"
     OLD_VERSION_TXT = "allows old versions"

slither/detectors/attributes/locked_ether.py

@@ -25,6 +25,8 @@ class LockedEther(AbstractDetector):  # pylint: disable=too-many-nested-blocks
 
     WIKI_TITLE = "Contracts that lock Ether"
     WIKI_DESCRIPTION = "Contract with a `payable` function, but without a withdrawal capacity."
+
+    # region wiki_exploit_scenario
     WIKI_EXPLOIT_SCENARIO = """
 ```solidity
 pragma solidity 0.4.24;
@@ -34,6 +36,7 @@ class LockedEther(AbstractDetector):  # pylint: disable=too-many-nested-blocks
 }
 ```
 Every Ether sent to `Locked` will be lost."""
+    # endregion wiki_exploit_scenario
 
     WIKI_RECOMMENDATION = "Remove the payable attribute or add a withdraw function."
 

slither/detectors/attributes/unimplemented_interface.py

@@ -21,6 +21,8 @@ class MissingInheritance(AbstractDetector):
     WIKI = "https://github.com/crytic/slither/wiki/Detector-Documentation#missing-inheritance"
     WIKI_TITLE = "Missing inheritance"
     WIKI_DESCRIPTION = "Detect missing inheritance."
+
+    # region wiki_exploit_scenario
     WIKI_EXPLOIT_SCENARIO = """
 ```solidity
 interface ISomething {
@@ -35,6 +37,7 @@ class MissingInheritance(AbstractDetector):
 ```
 `Something` should inherit from `ISomething`. 
 """
+    # endregion wiki_exploit_scenario
 
     WIKI_RECOMMENDATION = "Inherit from the missing interface or contract."
 

slither/detectors/compiler_bugs/array_by_reference.py

@@ -26,6 +26,8 @@ class ArrayByReference(AbstractDetector):
     WIKI_DESCRIPTION = (
         "Detect arrays passed to a function that expects reference to a storage array"
     )
+
+    # region wiki_exploit_scenario
     WIKI_EXPLOIT_SCENARIO = """
 ```solidity
 contract Memory {
@@ -48,6 +50,7 @@ class ArrayByReference(AbstractDetector):
 
 Bob calls `f()`. Bob assumes that at the end of the call `x[0]` is 2, but it is 1.
 As a result, Bob's usage of the contract is incorrect."""
+    # endregion wiki_exploit_scenario
 
     WIKI_RECOMMENDATION = "Ensure the correct usage of `memory` and `storage` in the function parameters. Make all the locations explicit."
 

slither/detectors/compiler_bugs/enum_conversion.py

@@ -48,6 +48,8 @@ class EnumConversion(AbstractDetector):
     WIKI = "https://github.com/crytic/slither/wiki/Detector-Documentation#dangerous-enum-conversion"
     WIKI_TITLE = "Dangerous enum conversion"
     WIKI_DESCRIPTION = "Detect out-of-range `enum` conversion (`solc` < `0.4.5`)."
+
+    # region wiki_exploit_scenario
     WIKI_EXPLOIT_SCENARIO = """
 ```solidity
     pragma solidity 0.4.2;
@@ -61,6 +63,7 @@ class EnumConversion(AbstractDetector):
 }
 ```
 Attackers can trigger unexpected behaviour by calling `bug(1)`."""
+    # endregion wiki_exploit_scenario
 
     WIKI_RECOMMENDATION = "Use a recent compiler version. If `solc` <`0.4.5` is required, check the `enum` conversion range."
 

slither/detectors/compiler_bugs/multiple_constructor_schemes.py

@@ -20,6 +20,8 @@ class MultipleConstructorSchemes(AbstractDetector):
     WIKI_DESCRIPTION = (
         "Detect multiple constructor definitions in the same contract (using new and old schemes)."
     )
+
+    # region wiki_exploit_scenario
     WIKI_EXPLOIT_SCENARIO = """
 ```solidity
 contract A {
@@ -37,6 +39,7 @@ class MultipleConstructorSchemes(AbstractDetector):
 }
 ```
 In Solidity [0.4.22](https://github.com/ethereum/solidity/releases/tag/v0.4.23), a contract with both constructor schemes will compile. The first constructor will take precedence over the second, which may be unintended."""
+    # endregion wiki_exploit_scenario
 
     WIKI_RECOMMENDATION = "Only declare one constructor, preferably using the new scheme `constructor(...)` instead of `function <contractName>(...)`."
 

slither/detectors/compiler_bugs/reused_base_constructor.py

@@ -34,6 +34,8 @@ class ReusedBaseConstructor(AbstractDetector):
 
     WIKI_TITLE = "Reused base constructors"
     WIKI_DESCRIPTION = "Detects if the same base constructor is called with arguments from two different locations in the same inheritance hierarchy."
+
+    # region wiki_exploit_scenario
     WIKI_EXPLOIT_SCENARIO = """
 ```solidity
 pragma solidity ^0.4.0;
@@ -65,6 +67,8 @@ class ReusedBaseConstructor(AbstractDetector):
 - `D` inherits from `B` and `C`, both of which construct `A`.
 - `E` only inherits from `B`, but `B` and `E` construct `A`.
 ."""
+    # endregion wiki_exploit_scenario
+
     WIKI_RECOMMENDATION = "Remove the duplicate constructor call."
 
     def _detect_explicitly_called_base_constructors(self, contract):