Merge pull request #134 from CoinFabrik/122-write-assert-violation-do…

…cumentation

122 write assert violation documentation

README.md

@@ -62,7 +62,9 @@ Visit [Scout's website](https://coinfabrik.github.io/scout-soroban/) to view the
 | [dos-unbounded-operation](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/dos-unbounded-operation)                           | DoS due to unbounded operation. | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/dos-unbounded-operation/dos-unbounded-operation-1), [2](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/dos-unbounded-operation/dos-unbounded-operation-2), [3](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/dos-unbounded-operation/dos-unbounded-operation-3)                                                                                                                                              | Medium  |
 | [soroban-version](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/soroban-version)                           | Using an old version of Soroban can be dangerous, as it may have bugs or security issues. Use the latest version available. | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/soroban-version/soroban-version-1)                 | Enhancement  |
 | [unused-return-enum](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/unused-return-enum)                           | Return enum from a function is not completely used. | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/unused-return-enum/unused-return-enum-1), [2](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/unused-return-enum/unused-return-enum-2)                   | Minor  |
-[iterators-over-indexing](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/iterators-over-indexing)                           |Iterating with hardcoded indexes is slower than using an iterator. Also, if the index is out of bounds, it will panic. | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/iterators-over-indexing-1),                   | Enhancement  |
+| [iterators-over-indexing](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/iterators-over-indexing)             |Iterating with hardcoded indexes is slower than using an iterator. Also, if the index is out of bounds, it will panic. | [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/iterators-over-indexing-1)                   | Enhancement  |
+| [assert-violation](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/assert-violation)                           | Avoid the usage of the macro assert!, it can panic.| [1](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/assert-violation/assert-violation-1)                                                                            | Enhancement    |
+
 
 ## Tests
 

docs/docs/detectors/15-assert-violation.md

@@ -0,0 +1,33 @@
+# Assert  violation
+
+### What it does​
+
+Checks for `assert!` macro usage.
+
+### Why is this bad?​
+
+The `assert!` macro can cause the contract to panic.
+
+### Example​
+
+```rust
+pub fn assert_if_greater_than_10(_env: Env, value: u128) -> bool {
+       assert!(value <= 10, "value should be less than 10");
+       true
+   }
+
+```
+Use instead:
+
+```rust
+pub fn assert_if_greater_than_10(_env: Env, value: u128) -> Result<bool, AVError> {
+       if value <= 10 {
+           Ok(true)
+       } else {
+           Err(AVError::GreaterThan10)
+       }
+   }
+```
+### Implementation
+
+The detector's implementation can be found at [this link](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/assert-violation).

docs/docs/vulnerabilities/README.md

@@ -200,8 +200,7 @@ definition of the `Result` type enum consists of two variants: Ok and Err. If
 any of the variants is not used, the code could be simplified or it could imply
 a bug.
 
-We put this vulnerability under the [Validations and error handling category](#vulnerability-categories)
-with a Minor severity.
+We put this vulnerability under the [Validations and error handling category](#vulnerability-categories) with a Minor severity.
 
 ###  Iterators-over-indexing
 
@@ -211,3 +210,10 @@ This could lead to potential integer overflow vulnerabilities, which would trigg
 
 This vulnerability falls under the [Best practices](#vulnerability-categories) category and has an Enhancement severity.
 
+### Assert violation
+
+The assert! macro is used in Rust to ensure that a certain condition holds true at a certain point in your code. The `assert!` macro can cause the contract to panic. Therefore, the detector suggests replacing `assert!` constructs with `Error` enum structures.
+
+This vulnerability falls under the category [Validations and error handling](#vulnerability-categories) and has an Enhancement severity.
+
+