From 64e3a57dd98b8c9e9ed97f40a433e3d2ee90b925 Mon Sep 17 00:00:00 2001 From: Matthias Seitz Date: Thu, 20 Apr 2023 09:24:09 +0200 Subject: [PATCH] docs: add a few clarifying docs (#2310) --- crates/storage/provider/src/chain.rs | 3 ++- crates/storage/provider/src/post_state.rs | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/crates/storage/provider/src/chain.rs b/crates/storage/provider/src/chain.rs index f754c46c5f3d..900854a8982a 100644 --- a/crates/storage/provider/src/chain.rs +++ b/crates/storage/provider/src/chain.rs @@ -16,7 +16,8 @@ use std::collections::BTreeMap; /// Used inside the BlockchainTree. #[derive(Clone, Debug, Default, PartialEq, Eq)] pub struct Chain { - /// The state of accounts after execution of the blocks in this chain (tip of the chain). + /// The state of all accounts after execution of the _all_ blocks in this chain's range from + /// [Chain::first] to [Chain::tip], inclusive. /// /// This state also contains the individual changes that lead to the current state. pub state: PostState, diff --git a/crates/storage/provider/src/post_state.rs b/crates/storage/provider/src/post_state.rs index 48bf3ef9db27..c008134edccc 100644 --- a/crates/storage/provider/src/post_state.rs +++ b/crates/storage/provider/src/post_state.rs @@ -217,7 +217,7 @@ impl PostState { } } - /// Get the latest state of accounts. + /// Get the latest state of all changed accounts. pub fn accounts(&self) -> &BTreeMap> { &self.accounts }