From 95f698b70ade73796a7dc6d08a73ba14dbb5c929 Mon Sep 17 00:00:00 2001
From: Matthias Seitz <matthias.seitz@outlook.de>
Date: Sun, 28 Jan 2024 19:39:36 +0100
Subject: [PATCH] docs: add some prestate docs

---
 crates/rpc-trace-types/src/geth/pre_state.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/crates/rpc-trace-types/src/geth/pre_state.rs b/crates/rpc-trace-types/src/geth/pre_state.rs
index f50d2705471..ab1d0694bfc 100644
--- a/crates/rpc-trace-types/src/geth/pre_state.rs
+++ b/crates/rpc-trace-types/src/geth/pre_state.rs
@@ -49,6 +49,11 @@ impl PreStateFrame {
     }
 }
 
+/// Includes all the account states necessary to execute a given transaction.
+///
+/// This corresponds to the default mode of the [PreStateConfig].
+///
+/// The [AccountState]'s storage will include all non-zero slots that are modified by a transaction.
 #[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
 pub struct PreStateMode(pub BTreeMap<Address, AccountState>);