From 2df16021bfdfaf6565662dc8afece6a5f2143ff7 Mon Sep 17 00:00:00 2001 From: Matthias Seitz Date: Mon, 10 Apr 2023 14:28:27 +0200 Subject: [PATCH] docs: add note about post state (#2169) --- crates/storage/provider/src/traits/state.rs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/crates/storage/provider/src/traits/state.rs b/crates/storage/provider/src/traits/state.rs index 43449dc205..9f0d5cf5d1 100644 --- a/crates/storage/provider/src/traits/state.rs +++ b/crates/storage/provider/src/traits/state.rs @@ -91,9 +91,13 @@ pub trait StateProviderFactory: Send + Sync { ) -> Result>; } -/// Blockchain trait provider +/// Blockchain trait provider that gives access to the blockchain state that is not yet committed +/// (pending). pub trait BlockchainTreePendingStateProvider: Send + Sync { - /// Return state provider over pending state. + /// Returns a state provider that includes all state changes of the given (pending) block hash. + /// + /// In other words, the state provider will return the state after all transactions of the given + /// hash have been executed. fn pending_state_provider( &self, block_hash: BlockHash,