docs: clarify StateWriteConfig is about database (MDBX) writes vs static files (#22299)

Co-authored-by: Amp <amp@ampcode.com>
This commit is contained in:
Georgios Konstantopoulos
2026-02-17 17:13:31 -08:00
committed by GitHub
parent a195b777eb
commit 5b1010322c

View File

@@ -127,16 +127,25 @@ pub trait StateWriter {
) -> ProviderResult<ExecutionOutcome<Self::Receipt>>;
}
/// Configuration for what to write when calling [`StateWriter::write_state`].
/// Configuration for what to write to the database (MDBX) when calling
/// [`StateWriter::write_state`].
///
/// Used to skip writing certain data types, when they are being written separately.
/// Some types (receipts, changesets) may be written directly to
/// static files instead of the database depending on the storage settings. This config allows
/// skipping those types in the database write to avoid duplication.
#[derive(Debug, Clone, Copy)]
pub struct StateWriteConfig {
/// Whether to write receipts.
/// Whether to write receipts to the database.
///
/// Set to `false` when receipts are being written to static files instead.
pub write_receipts: bool,
/// Whether to write account changesets.
/// Whether to write account changesets to the database.
///
/// Set to `false` when account changesets are being written to static files instead.
pub write_account_changesets: bool,
/// Whether to write storage changesets.
/// Whether to write storage changesets to the database.
///
/// Set to `false` when storage changesets are being written to static files instead.
pub write_storage_changesets: bool,
}