use serde_json for storage settings

Author: joshieDo

Cargo.lock

@@ -23,6 +23,14 @@ impl StorageSettings {
         Self { receipts_on_static_files: false }
     }
 
+    /// Creates `StorageSettings` for legacy nodes.
+    ///
+    /// This explicitly sets `receipts_on_static_files` to `false`, ensuring older nodes
+    /// continue writing receipts to the database when receipt pruning is enabled.
+    pub const fn legacy() -> Self {
+        Self { receipts_on_static_files: false }
+    }
+
     /// Sets the `receipts_static_files` flag to true.
     pub const fn with_receipts_on_static_files(mut self) -> Self {
         self.receipts_on_static_files = true;

crates/storage/db-api/src/models/metadata.rs

@@ -84,16 +84,17 @@ impl<N: ProviderNodeTypes> ProviderFactory<N> {
         chain_spec: Arc<N::ChainSpec>,
         static_file_provider: StaticFileProvider<N::Primitives>,
     ) -> ProviderResult<Self> {
+        let legacy_settings = StorageSettings::legacy();
         let storage_settings = DatabaseProvider::<_, N>::new(
             db.tx()?,
             chain_spec.clone(),
             static_file_provider.clone(),
             Default::default(),
             Default::default(),
-            Arc::new(RwLock::new(StorageSettings::default())),
+            Arc::new(RwLock::new(legacy_settings)),
         )
         .storage_settings()?
-        .unwrap_or_default();
+        .unwrap_or(legacy_settings);
 
         Ok(Self {
             db,
@@ -129,7 +130,6 @@ impl<N: NodeTypesWithDB> ProviderFactory<N> {
     pub fn into_db(self) -> N::DB {
         self.db
     }
-
 }
 
 impl<N: NodeTypesWithDB> StorageSettingsCache for ProviderFactory<N> {
@@ -150,15 +150,16 @@ impl<N: NodeTypesWithDB<DB = Arc<DatabaseEnv>>> ProviderFactory<N> {
         chain_spec: Arc<N::ChainSpec>,
         args: DatabaseArguments,
         static_file_provider: StaticFileProvider<N::Primitives>,
-    ) -> RethResult<Self> {
-        Ok(Self {
-            db: Arc::new(init_db(path, args).map_err(RethError::msg)?),
+    ) -> RethResult<Self>
+    where
+        N: ProviderNodeTypes,
+    {
+        Self::new(
+            Arc::new(init_db(path, args).map_err(RethError::msg)?),
             chain_spec,
             static_file_provider,
-            prune_modes: PruneModes::default(),
-            storage: Default::default(),
-            storage_settings: Arc::new(RwLock::new(StorageSettings::default())),
-        })
+        )
+        .map_err(RethError::Provider)
     }
 }
 

crates/storage/provider/src/providers/database/mod.rs

@@ -58,7 +58,9 @@ use reth_prune_types::{
 use reth_stages_types::{StageCheckpoint, StageId};
 use reth_static_file_types::StaticFileSegment;
 use reth_storage_api::{
-    BlockBodyIndicesProvider, BlockBodyReader, MetadataProvider, MetadataWriter, NodePrimitivesProvider, StateProvider, StorageChangeSetReader, StorageSettingsCache, TryIntoHistoricalStateProvider
+    BlockBodyIndicesProvider, BlockBodyReader, MetadataProvider, MetadataWriter,
+    NodePrimitivesProvider, StateProvider, StorageChangeSetReader, StorageSettingsCache,
+    TryIntoHistoricalStateProvider,
 };
 use reth_storage_errors::provider::ProviderResult;
 use reth_trie::{
@@ -497,8 +499,9 @@ impl<TX: DbTx + 'static, N: NodeTypesForProvider> DatabaseProvider<TX, N> {
         static_file_provider: StaticFileProvider<N::Primitives>,
         prune_modes: PruneModes,
         storage: Arc<N::Storage>,
+        storage_settings: Arc<RwLock<StorageSettings>>,
     ) -> Self {
-        Self { tx, chain_spec, static_file_provider, prune_modes, storage }
+        Self { tx, chain_spec, static_file_provider, prune_modes, storage, storage_settings }
     }
 
     /// Consume `DbTx` or `DbTxMut`.

crates/storage/provider/src/providers/database/provider.rs

@@ -13,7 +13,6 @@ workspace = true
 
 [dependencies]
 # reth
-reth-codecs = { workspace = true, optional = true }
 reth-db-models.workspace = true
 reth-chainspec.workspace = true
 reth-db-api = { workspace = true, optional = true }
@@ -33,6 +32,7 @@ alloy-consensus.workspace = true
 alloy-rpc-types-engine.workspace = true
 
 auto_impl.workspace = true
+serde_json = { workspace = true, optional = true }
 
 [features]
 default = ["std"]
@@ -51,15 +51,15 @@ std = [
     "reth-storage-errors/std",
     "reth-db-models/std",
     "reth-trie-common/std",
+    "serde_json?/std",
 ]
 
 db-api = [
-    "dep:reth-codecs",
     "dep:reth-db-api",
+    "dep:serde_json",
 ]
 
 serde = [
-    "reth-codecs/serde",
     "reth-ethereum-primitives/serde",
     "reth-db-models/serde",
     "reth-execution-types/serde",

crates/storage/storage-api/Cargo.toml

@@ -1,8 +1,7 @@
 //! Metadata provider trait for reading and writing node metadata.
 
-use reth_codecs::Compact;
 use reth_db_api::models::StorageSettings;
-use reth_storage_errors::provider::ProviderResult;
+use reth_storage_errors::provider::{ProviderError, ProviderResult};
 
 /// Metadata keys.
 pub mod keys {
@@ -18,9 +17,9 @@ pub trait MetadataProvider: Send + Sync {
 
     /// Get storage settings for this node
     fn storage_settings(&self) -> ProviderResult<Option<StorageSettings>> {
-        Ok(self
-            .get_metadata(keys::STORAGE_SETTINGS)?
-            .map(|bytes| StorageSettings::from_compact(&bytes, bytes.len()).0))
+        self.get_metadata(keys::STORAGE_SETTINGS)?
+            .map(|bytes| serde_json::from_slice(&bytes).map_err(ProviderError::other))
+            .transpose()
     }
 }
 
@@ -34,10 +33,10 @@ pub trait MetadataWriter: Send + Sync {
     /// Be sure to update provider factory cache with
     /// [`StorageSettingsCache::set_storage_settings_cache`].
     fn write_storage_settings(&self, settings: StorageSettings) -> ProviderResult<()> {
-        use reth_codecs::Compact;
-        let mut buf = Vec::new();
-        settings.to_compact(&mut buf);
-        self.write_metadata(keys::STORAGE_SETTINGS, buf)
+        self.write_metadata(
+            keys::STORAGE_SETTINGS,
+            serde_json::to_vec(&settings).map_err(ProviderError::other)?,
+        )
     }
 }