From e2764a8f278c3574d578469a875e3b05b6157c49 Mon Sep 17 00:00:00 2001
From: tomasavola <108414862+tomasavola@users.noreply.github.com>
Date: Wed, 4 Sep 2024 14:19:04 -0300
Subject: [PATCH] Create 24-storage-change-events.md

---
 .../detectors/24-storage-change-events.md     | 53 +++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 docs/docs/detectors/24-storage-change-events.md

diff --git a/docs/docs/detectors/24-storage-change-events.md b/docs/docs/detectors/24-storage-change-events.md
new file mode 100644
index 00000000..158b6b9c
--- /dev/null
+++ b/docs/docs/detectors/24-storage-change-events.md
@@ -0,0 +1,53 @@
+# Storage change events
+
+## Description 
+
+- Category: `Best practices`
+- Severity: `Minor`
+- Detectors: [`storage-change-events`](https://github.com/CoinFabrik/scout-soroban/tree/main/detectors/storage-change-events)
+- Test Cases: [`storage-change-events-1`](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/storage-change-events/storage-change-events-1)
+
+
+In Rust, it is very important to control storage, since it contains a large part of the information of a contract. For this reason, it is common to control storage movements through events, in order to record the changes that occur. If there is no control over these changes, it can lead to potential problems in the contract.
+
+## Why is this bad? 
+
+If there is no control over storage changes, it can lead to security and transparency issues within the contract.
+
+## Issue example 
+
+Consider the following `Soroban` contract:
+
+```rust
+
+  fn set_counter(env: Env, counter: CounterState) {
+        env.storage().instance().set(&STATE, &counter);
+    }
+
+```
+
+In this example, the `set_counter()` function does not emit an event to notify of a change in the storage.
+
+The code example can be found [here](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/storage-change-events/storage-change-events-1/vulnerable-example).
+
+
+## Remediated example
+
+```rust
+    fn set_counter(env: Env, counter: CounterState) {
+        env.storage().instance().set(&STATE, &counter);
+        env.events()
+            .publish((COUNTER, symbol_short!("set")), counter.count);
+    }
+```
+In this example, the `set_counter()` function emits an event to notify of a change in the storage.
+
+The remediated code example can be found [here](https://github.com/CoinFabrik/scout-soroban/tree/main/test-cases/storage-change-events/storage-change-events-1/remediated-example).
+
+## How is it detected?
+
+Checks if the function emits an event in case a change has occurred in the storage. 
+
+
+
+