chore(gas_price_service): split into v0 and v1 and squash FuelGasPric…

…eUpdater type into GasPriceService (#2256) > [!WARNING] > 🚧🚧 This is PR 6/n in refactoring the gas price service. Now that the `algorithm_updater` is a part of `fuel-core-gas-price-service` we have squashed it into the `GasPriceService` using the `UninitializedTask` struct. We don't implement `RunnableService` *or* `RunnableTask` for the `UninitializedTask` struct, merely use it as a wrapper to generate the `GasPriceServiceV0` 🚧🚧 ## Linked Issues/PRs  - #2246 - #2245 - #2230 - #2226 - #2224 - #2192 ## Description  - created common module containing storage adapter, l2 block source and some updater metadata stuff (linked to storage) - created v0 module containing impl of GasPriceAlgorithm for AlgorithmV0, and V0metadata stuff - created v1 module containing impl of GasPriceAlgorithm for AlgorithmV1 & da block costs source (V1Metadata didn’t exist before so i didn’t create it) - fuel-gas-price-updater will be nuked, an UninitializedGasPriceServiceV(x) for each version that takes in all the args needed ```mermaid graph TD A["lib.rs (entry point)"] B[common] B1[utils] B2[storage] B3[l2_block_source] C[ports] D[v0] E[v1] F[v0/algorithm] G[v1/algorithm] H[v0/service] I[v1/da_source] J[v0/metadata] K[v1/service] L[v0/uninitialized] A --> B B --> B1 B --> B2 B --> B3 B --> C C --> D C --> E D --> F D --> H D --> J D --> L E --> G E --> I E --> K F --> H G --> I H --> J J --> L L --> M[SharedV0Algorithm] L --> N[GasPriceServiceV0] subgraph Common B B1 B2 B3 end subgraph Ports C end subgraph V0 D F H J L end subgraph V1 E G I K end ``` ## Checklist - [x] Breaking changes are clearly marked as such in the PR description and changelog - [x] New behavior is reflected in tests - [x] [The specification](https://github.com/FuelLabs/fuel-specs/) matches the implemented behavior (link update PR if changes are needed) ### Before requesting review - [x] I have reviewed the code myself - [ ] I have created follow-up issues caused by this PR and linked them here ### After merging, notify other teams [Add or remove entries as needed] - [ ] [Rust SDK](https://github.com/FuelLabs/fuels-rs/) - [ ] [Sway compiler](https://github.com/FuelLabs/sway/) - [ ] [Platform documentation](https://github.com/FuelLabs/devrel-requests/issues/new?assignees=&labels=new+request&projects=&template=NEW-REQUEST.yml&title=%5BRequest%5D%3A+) (for out-of-organization contributors, the person merging the PR will do this) - [ ] Someone else? ---------
FuelLabs · Oct 2, 2024 · 538b2a4 · 538b2a4
1 parent c88632a
commit 538b2a4
Show file tree

Hide file tree

Showing 35 changed files with 1,276 additions and 1,354 deletions.
diff --git a/crates/fuel-core/src/database.rs b/crates/fuel-core/src/database.rs
@@ -65,6 +65,7 @@ pub use fuel_core_database::Error;
 pub type Result<T> = core::result::Result<T, Error>;
 
 // TODO: Extract `Database` and all belongs into `fuel-core-database`.
+use crate::database::database_description::gas_price::GasPriceDatabase;
 #[cfg(feature = "rocksdb")]
 use crate::state::{
     historical_rocksdb::{
@@ -74,10 +75,9 @@ use crate::state::{
     },
     rocks_db::RocksDb,
 };
+use fuel_core_gas_price_service::common::fuel_core_storage_adapter::storage::GasPriceMetadata;
 #[cfg(feature = "rocksdb")]
 use std::path::Path;
-use fuel_core_gas_price_service::fuel_gas_price_updater::fuel_core_storage_adapter::storage::GasPriceMetadata;
-use crate::database::database_description::gas_price::GasPriceDatabase;
 
 // Storages implementation
 pub mod balances;

diff --git a/crates/fuel-core/src/database/database_description/gas_price.rs b/crates/fuel-core/src/database/database_description/gas_price.rs
@@ -1,6 +1,6 @@
-use fuel_core_gas_price_service::fuel_gas_price_updater::fuel_core_storage_adapter::storage::GasPriceColumn;
-use fuel_core_types::fuel_types::BlockHeight;
 use crate::database::database_description::DatabaseDescription;
+use fuel_core_gas_price_service::common::fuel_core_storage_adapter::storage::GasPriceColumn;
+use fuel_core_types::fuel_types::BlockHeight;
 
 #[derive(Clone, Copy, Debug)]
 pub struct GasPriceDatabase;

diff --git a/crates/fuel-core/src/service/adapters/fuel_gas_price_provider.rs b/crates/fuel-core/src/service/adapters/fuel_gas_price_provider.rs
@@ -1,8 +1,9 @@
 use crate::fuel_core_graphql_api::ports::GasPriceEstimate as GraphqlGasPriceEstimate;
-use fuel_core_gas_price_service::{
+use fuel_core_gas_price_service::common::gas_price_algorithm::{
     GasPriceAlgorithm,
     SharedGasPriceAlgo,
 };
+
 use fuel_core_producer::block_producer::gas_price::GasPriceProvider as ProducerGasPriceProvider;
 use fuel_core_txpool::{
     ports::GasPriceProvider as TxPoolGasPriceProvider,

diff --git a/.../fuel-core/src/service/adapters/fuel_gas_price_provider/tests/producer_gas_price_tests.rs b/.../fuel-core/src/service/adapters/fuel_gas_price_provider/tests/producer_gas_price_tests.rs
@@ -1,7 +1,7 @@
 use crate::service::adapters::fuel_gas_price_provider::tests::build_provider;
 use fuel_core_gas_price_service::{
+    common::gas_price_algorithm::GasPriceAlgorithm,
     static_updater::StaticAlgorithm,
-    GasPriceAlgorithm,
 };
 
 #[tokio::test]

diff --git a/...s/fuel-core/src/service/adapters/fuel_gas_price_provider/tests/tx_pool_gas_price_tests.rs b/...s/fuel-core/src/service/adapters/fuel_gas_price_provider/tests/tx_pool_gas_price_tests.rs
@@ -1,7 +1,7 @@
 use crate::service::adapters::fuel_gas_price_provider::tests::build_provider;
 use fuel_core_gas_price_service::{
+    common::gas_price_algorithm::GasPriceAlgorithm,
     static_updater::StaticAlgorithm,
-    GasPriceAlgorithm,
 };
 
 #[tokio::test]

diff --git a/crates/fuel-core/src/service/adapters/gas_price_adapters.rs b/crates/fuel-core/src/service/adapters/gas_price_adapters.rs
@@ -3,13 +3,15 @@ use crate::{
     service::adapters::ConsensusParametersProvider,
 };
 use fuel_core_gas_price_service::{
-    fuel_gas_price_updater::{
+    common::{
         fuel_core_storage_adapter::{
             GasPriceSettings,
             GasPriceSettingsProvider,
         },
-        Error as GasPriceError,
-        Result as GasPriceResult,
+        utils::{
+            Error as GasPriceError,
+            Result as GasPriceResult,
+        },
     },
     ports::{
         GasPriceData,

diff --git a/crates/fuel-core/src/service/sub_services.rs b/crates/fuel-core/src/service/sub_services.rs
@@ -38,24 +38,14 @@ use crate::{
         SubServices,
     },
 };
-#[allow(unused_imports)]
-use fuel_core_gas_price_service::fuel_gas_price_updater::{
-    algorithm_updater,
-    fuel_core_storage_adapter::FuelL2BlockSource,
-    Algorithm,
+use fuel_core_gas_price_service::v0::uninitialized_task::{
+    new_gas_price_service_v0,
     AlgorithmV0,
-    FuelGasPriceUpdater,
-    UpdaterMetadata,
-    V0Metadata,
 };
 use fuel_core_poa::{
     signer::SignMode,
     Trigger,
 };
-use fuel_core_services::{
-    RunnableService,
-    ServiceRunner,
-};
 use fuel_core_storage::{
     self,
     transactional::AtomicView,
@@ -79,15 +69,15 @@ pub type TxPoolSharedState = fuel_core_txpool::service::SharedState<
     P2PAdapter,
     Database,
     ExecutorAdapter,
-    FuelGasPriceProvider<Algorithm>,
+    FuelGasPriceProvider<AlgorithmV0>,
     ConsensusParametersProvider,
     SharedMemoryPool,
 >;
 pub type BlockProducerService = fuel_core_producer::block_producer::Producer<
     Database,
     TxPoolAdapter,
     ExecutorAdapter,
-    FuelGasPriceProvider<Algorithm>,
+    FuelGasPriceProvider<AlgorithmV0>,
     ConsensusParametersProvider,
 >;
 
@@ -199,18 +189,17 @@ pub fn init_sub_services(
     let settings = consensus_parameters_provider.clone();
     let block_stream = importer_adapter.events_shared_result();
 
-    let gas_price_init = algorithm_updater::InitializeTask::new(
+    let gas_price_service_v0 = new_gas_price_service_v0(
         config.clone().into(),
         genesis_block_height,
         settings,
         block_stream,
         database.gas_price().clone(),
         database.on_chain().clone(),
     )?;
-    let next_algo = gas_price_init.shared_data();
-    let gas_price_service = ServiceRunner::new(gas_price_init);
 
-    let gas_price_provider = FuelGasPriceProvider::new(next_algo);
+    let gas_price_provider =
+        FuelGasPriceProvider::new(gas_price_service_v0.shared.clone());
     let txpool = fuel_core_txpool::new_service(
         config.txpool.clone(),
         database.on_chain().clone(),
@@ -345,7 +334,7 @@ pub fn init_sub_services(
     #[allow(unused_mut)]
     // `FuelService` starts and shutdowns all sub-services in the `services` order
     let mut services: SubServices = vec![
-        Box::new(gas_price_service),
+        Box::new(gas_price_service_v0),
         Box::new(txpool),
         Box::new(consensus_parameters_provider_service),
     ];

diff --git a/crates/services/gas_price_service/src/common.rs b/crates/services/gas_price_service/src/common.rs
@@ -0,0 +1,5 @@
+pub mod fuel_core_storage_adapter;
+pub mod gas_price_algorithm;
+pub mod l2_block_source;
+pub mod updater_metadata;
+pub mod utils;
diff --git a/...rice_updater/fuel_core_storage_adapter.rs → ...e/src/common/fuel_core_storage_adapter.rs b/...rice_updater/fuel_core_storage_adapter.rs → ...e/src/common/fuel_core_storage_adapter.rs
@@ -1,20 +1,18 @@
-use crate::fuel_gas_price_updater::{
+use crate::common::utils::{
     BlockInfo,
     Error as GasPriceError,
-    Error,
-    L2BlockSource,
-    Result,
     Result as GasPriceResult,
-    UpdaterMetadata,
 };
 use anyhow::anyhow;
-use fuel_core_services::stream::BoxStream;
 use fuel_core_types::fuel_types::BlockHeight;
 
 use crate::{
-    fuel_gas_price_updater::fuel_core_storage_adapter::storage::{
-        GasPriceColumn,
-        GasPriceMetadata,
+    common::{
+        fuel_core_storage_adapter::storage::{
+            GasPriceColumn,
+            GasPriceMetadata,
+        },
+        updater_metadata::UpdaterMetadata,
     },
     ports::MetadataStorage,
 };
@@ -40,17 +38,12 @@ use fuel_core_types::{
         },
         Transaction,
     },
-    services::block_importer::SharedImportResult,
 };
 use std::cmp::min;
-use tokio_stream::StreamExt;
 
 #[cfg(test)]
 mod metadata_tests;
 
-#[cfg(test)]
-mod l2_source_tests;
-
 pub mod storage;
 
 impl<Storage> MetadataStorage for StructuredStorage<Storage>
@@ -61,53 +54,30 @@ where
     fn get_metadata(
         &self,
         block_height: &BlockHeight,
-    ) -> Result<Option<UpdaterMetadata>> {
+    ) -> GasPriceResult<Option<UpdaterMetadata>> {
         let metadata = self
             .storage::<GasPriceMetadata>()
             .get(block_height)
-            .map_err(|err| Error::CouldNotFetchMetadata {
+            .map_err(|err| GasPriceError::CouldNotFetchMetadata {
                 source_error: err.into(),
             })?;
         Ok(metadata.map(|inner| inner.into_owned()))
     }
 
-    fn set_metadata(&mut self, metadata: &UpdaterMetadata) -> Result<()> {
+    fn set_metadata(&mut self, metadata: &UpdaterMetadata) -> GasPriceResult<()> {
         let block_height = metadata.l2_block_height();
         let mut tx = self.write_transaction();
         tx.storage_as_mut::<GasPriceMetadata>()
             .insert(&block_height, metadata)
-            .map_err(|err| Error::CouldNotSetMetadata {
+            .and_then(|_| tx.commit())
+            .map_err(|err| GasPriceError::CouldNotSetMetadata {
                 block_height,
                 source_error: err.into(),
             })?;
-        tx.commit().map_err(|err| Error::CouldNotSetMetadata {
-            block_height,
-            source_error: err.into(),
-        })?;
         Ok(())
     }
 }
 
-pub struct FuelL2BlockSource<Settings> {
-    genesis_block_height: BlockHeight,
-    gas_price_settings: Settings,
-    committed_block_stream: BoxStream<SharedImportResult>,
-}
-
-impl<Settings> FuelL2BlockSource<Settings> {
-    pub fn new(
-        genesis_block_height: BlockHeight,
-        gas_price_settings: Settings,
-        committed_block_stream: BoxStream<SharedImportResult>,
-    ) -> Self {
-        Self {
-            genesis_block_height,
-            gas_price_settings,
-            committed_block_stream,
-        }
-    }
-}
-
 #[derive(Debug, Clone, PartialEq)]
 pub struct GasPriceSettings {
     pub gas_price_factor: u64,
@@ -117,7 +87,7 @@ pub trait GasPriceSettingsProvider: Send + Sync + Clone {
     fn settings(
         &self,
         param_version: &ConsensusParametersVersion,
-    ) -> Result<GasPriceSettings>;
+    ) -> GasPriceResult<GasPriceSettings>;
 }
 
 pub fn get_block_info(
@@ -126,9 +96,7 @@ pub fn get_block_info(
     block_gas_limit: u64,
 ) -> GasPriceResult<BlockInfo> {
     let (fee, gas_price) = mint_values(block)?;
-    let height = *block.header().height();
-    let used_gas =
-        block_used_gas(height, fee, gas_price, gas_price_factor, block_gas_limit)?;
+    let used_gas = block_used_gas(fee, gas_price, gas_price_factor, block_gas_limit)?;
     let info = BlockInfo::Block {
         height: (*block.header().height()).into(),
         gas_used: used_gas,
@@ -143,13 +111,11 @@ fn mint_values(block: &Block<Transaction>) -> GasPriceResult<(u64, u64)> {
         .last()
         .and_then(|tx| tx.as_mint())
         .ok_or(GasPriceError::CouldNotFetchL2Block {
-            block_height: *block.header().height(),
             source_error: anyhow!("Block has no mint transaction"),
         })?;
     Ok((*mint.mint_amount(), *mint.gas_price()))
 }
 fn block_used_gas(
-    block_height: BlockHeight,
     fee: u64,
     gas_price: u64,
     gas_price_factor: u64,
@@ -158,7 +124,6 @@ fn block_used_gas(
     let scaled_fee =
         fee.checked_mul(gas_price_factor)
             .ok_or(GasPriceError::CouldNotFetchL2Block {
-                block_height,
                 source_error: anyhow!(
                     "Failed to scale fee by gas price factor, overflow"
                 ),
@@ -168,41 +133,3 @@ fn block_used_gas(
     let used_gas = min(approximate, max_used_gas);
     Ok(used_gas)
 }
-
-#[async_trait::async_trait]
-impl<Settings> L2BlockSource for FuelL2BlockSource<Settings>
-where
-    Settings: GasPriceSettingsProvider + Send + Sync,
-{
-    async fn get_l2_block(&mut self, height: BlockHeight) -> GasPriceResult<BlockInfo> {
-        let block = &self
-            .committed_block_stream
-            .next()
-            .await
-            .ok_or({
-                GasPriceError::CouldNotFetchL2Block {
-                    block_height: height,
-                    source_error: anyhow!("No committed block found"),
-                }
-            })?
-            .sealed_block
-            .entity;
-
-        match block.header().height().cmp(&self.genesis_block_height) {
-            std::cmp::Ordering::Less => Err(GasPriceError::CouldNotFetchL2Block {
-                block_height: height,
-                source_error: anyhow!("Block precedes expected genesis block height"),
-            }),
-            std::cmp::Ordering::Equal => Ok(BlockInfo::GenesisBlock),
-            std::cmp::Ordering::Greater => {
-                let param_version = block.header().consensus_parameters_version;
-
-                let GasPriceSettings {
-                    gas_price_factor,
-                    block_gas_limit,
-                } = self.gas_price_settings.settings(&param_version)?;
-                get_block_info(block, gas_price_factor, block_gas_limit)
-            }
-        }
-    }
-}
diff --git a/...el_core_storage_adapter/metadata_tests.rs → ...el_core_storage_adapter/metadata_tests.rs b/...el_core_storage_adapter/metadata_tests.rs → ...el_core_storage_adapter/metadata_tests.rs
@@ -1,11 +1,6 @@
 #![allow(non_snake_case)]
 
 use super::*;
-use crate::fuel_gas_price_updater::{
-    fuel_core_storage_adapter::storage::GasPriceColumn,
-    AlgorithmUpdater,
-    UpdaterMetadata,
-};
 use fuel_core_storage::{
     structured_storage::test::InMemoryStorage,
     transactional::{
@@ -28,7 +23,7 @@ fn arb_metadata_with_l2_height(l2_height: BlockHeight) -> UpdaterMetadata {
         l2_block_height: l2_height.into(),
         l2_block_fullness_threshold_percent: 0,
     };
-    AlgorithmUpdater::V0(inner).into()
+    inner.into()
 }
 
 fn database() -> StorageTransaction<InMemoryStorage<GasPriceColumn>> {

diff --git a/...ater/fuel_core_storage_adapter/storage.rs → ...mmon/fuel_core_storage_adapter/storage.rs b/...ater/fuel_core_storage_adapter/storage.rs → ...mmon/fuel_core_storage_adapter/storage.rs
@@ -1,4 +1,4 @@
-use crate::fuel_gas_price_updater::UpdaterMetadata;
+use crate::common::updater_metadata::UpdaterMetadata;
 use fuel_core_storage::{
     blueprint::plain::Plain,
     codec::{
@@ -10,6 +10,7 @@ use fuel_core_storage::{
     Mappable,
 };
 use fuel_core_types::fuel_types::BlockHeight;
+
 #[repr(u32)]
 #[derive(
     Copy,