Add unrecorded blocks abstraction to gas price algo

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ## [Unreleased]
 
 ### Added
+- [2442](https://github.com/FuelLabs/fuel-core/pull/2442): Add uninitialized task for V1 gas price service
 - [2154](https://github.com/FuelLabs/fuel-core/pull/2154): Added `Unknown` variant to `ConsensusParameters` graphql queries
 - [2154](https://github.com/FuelLabs/fuel-core/pull/2154): Added `Unknown` variant to `Block` graphql queries
 - [2154](https://github.com/FuelLabs/fuel-core/pull/2154): Added `TransactionType` type in `fuel-client`
@@ -35,6 +36,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - [2389](https://github.com/FuelLabs/fuel-core/pull/2389): Fix construction of reverse iterator in RocksDB.
 
 ### Changed
+- [2468](https://github.com/FuelLabs/fuel-core/pull/2468): Abstract unrecorded blocks concept for V1 algorithm, create new storage impl
 - [2295](https://github.com/FuelLabs/fuel-core/pull/2295): `CombinedDb::from_config` now respects `state_rewind_policy` with tmp RocksDB.
 - [2378](https://github.com/FuelLabs/fuel-core/pull/2378): Use cached hash of the topic instead of calculating it on each publishing gossip message.
 - [2429](https://github.com/FuelLabs/fuel-core/pull/2429): Introduce custom enum for representing result of running service tasks

crates/fuel-gas-price-algorithm/src/v1.rs

@@ -19,6 +19,10 @@ pub enum Error {
     FailedTooIncludeL2BlockData(String),
     #[error("L2 block expected but not found in unrecorded blocks: {height}")]
     L2BlockExpectedNotFound { height: u32 },
+    #[error("Could not insert unrecorded block: {0}")]
+    CouldNotInsertUnrecordedBlock(String),
+    #[error("Could not remove unrecorded block: {0}")]
+    CouldNotRemoveUnrecordedBlock(String),
 }
 
 // TODO: separate exec gas price and DA gas price into newtypes for clarity
@@ -59,6 +63,25 @@ impl AlgorithmV1 {
     }
 }
 
+pub type Height = u32;
+pub type Bytes = u64;
+pub trait UnrecordedBlocks {
+    fn insert(&mut self, height: Height, bytes: Bytes) -> Result<(), Error>;
+    fn remove(&mut self, height: &Height) -> Result<Option<Bytes>, Error>;
+}
+
+impl UnrecordedBlocks for BTreeMap<Height, Bytes> {
+    fn insert(&mut self, height: Height, bytes: Bytes) -> Result<(), Error> {
+        self.insert(height, bytes);
+        Ok(())
+    }
+
+    fn remove(&mut self, height: &Height) -> Result<Option<Bytes>, Error> {
+        let value = self.remove(height);
+        Ok(value)
+    }
+}
+
 /// The state of the algorithm used to update the gas price algorithm for each block
 ///
 /// Because there will always be a delay between blocks submitted to the L2 chain and the blocks
@@ -96,10 +119,8 @@ impl AlgorithmV1 {
 /// The DA portion also uses a moving average of the profits over the last `avg_window` blocks
 /// instead of the actual profit. Setting the `avg_window` to 1 will effectively disable the
 /// moving average.
-type Height = u32;
-type Bytes = u64;
 #[derive(serde::Serialize, serde::Deserialize, Debug, Clone, PartialEq)]
-pub struct AlgorithmUpdaterV1 {
+pub struct AlgorithmUpdaterV1<U> {
     // Execution
     /// The gas price (scaled by the `gas_price_factor`) to cover the execution of the next block
     pub new_scaled_exec_price: u64,
@@ -144,7 +165,7 @@ pub struct AlgorithmUpdaterV1 {
     /// Activity of L2
     pub l2_activity: L2ActivityTracker,
     /// The unrecorded blocks that are used to calculate the projected cost of recording blocks
-    pub unrecorded_blocks: BTreeMap<Height, Bytes>,
+    pub unrecorded_blocks: U,
     /// Total unrecorded block bytes
     pub unrecorded_blocks_bytes: u128,
 }
@@ -299,7 +320,7 @@ impl core::ops::Deref for ClampedPercentage {
     }
 }
 
-impl AlgorithmUpdaterV1 {
+impl<U: UnrecordedBlocks> AlgorithmUpdaterV1<U> {
     pub fn update_da_record_data(
         &mut self,
         heights: &[u32],
@@ -351,7 +372,7 @@ impl AlgorithmUpdaterV1 {
             self.update_da_gas_price();
 
             // metadata
-            self.unrecorded_blocks.insert(height, block_bytes);
+            self.unrecorded_blocks.insert(height, block_bytes)?;
             self.unrecorded_blocks_bytes = self
                 .unrecorded_blocks_bytes
                 .saturating_add(block_bytes as u128);
@@ -543,14 +564,20 @@ impl AlgorithmUpdaterV1 {
     fn update_unrecorded_block_bytes(&mut self, heights: &[u32]) {
         let mut total: u128 = 0;
         for expected_height in heights {
-            let maybe_bytes = self.unrecorded_blocks.remove(expected_height);
-            if let Some(bytes) = maybe_bytes {
-                total = total.saturating_add(bytes as u128);
-            } else {
-                tracing::warn!(
-                    "L2 block expected but not found in unrecorded blocks: {}",
-                    expected_height,
-                );
+            let res = self.unrecorded_blocks.remove(expected_height);
+            match res {
+                Ok(Some(bytes)) => {
+                    total = total.saturating_add(bytes as u128);
+                }
+                Ok(None) => {
+                    tracing::warn!(
+                        "L2 block expected but not found in unrecorded blocks: {}",
+                        expected_height,
+                    );
+                }
+                Err(err) => {
+                    tracing::error!("Could not remove unrecorded block: {}", err);
+                }
             }
         }
         self.unrecorded_blocks_bytes = self.unrecorded_blocks_bytes.saturating_sub(total);

crates/fuel-gas-price-algorithm/src/v1/tests.rs

@@ -4,8 +4,11 @@
 
 use crate::v1::{
     AlgorithmUpdaterV1,
+    Bytes,
+    Height,
     L2ActivityTracker,
 };
+use std::collections::BTreeMap;
 
 #[cfg(test)]
 mod algorithm_v1_tests;
@@ -162,7 +165,7 @@ impl UpdaterBuilder {
         self
     }
 
-    fn build(self) -> AlgorithmUpdaterV1 {
+    fn build(self) -> AlgorithmUpdaterV1<BTreeMap<Height, Bytes>> {
         AlgorithmUpdaterV1 {
             min_exec_gas_price: self.min_exec_gas_price,
             new_scaled_exec_price: self.starting_exec_gas_price,

crates/services/gas_price_service/src/common/fuel_core_storage_adapter.rs

@@ -111,7 +111,7 @@ pub fn get_block_info(
     Ok(info)
 }
 
-fn mint_values(block: &Block<Transaction>) -> GasPriceResult<(u64, u64)> {
+pub(crate) fn mint_values(block: &Block<Transaction>) -> GasPriceResult<(u64, u64)> {
     let mint = block
         .transactions()
         .last()
@@ -121,6 +121,13 @@ fn mint_values(block: &Block<Transaction>) -> GasPriceResult<(u64, u64)> {
         })?;
     Ok((*mint.mint_amount(), *mint.gas_price()))
 }
+
+// TODO: Don't take a direct dependency on `Postcard` as it's not guaranteed to be the encoding format
+// https://github.com/FuelLabs/fuel-core/issues/2443
+pub(crate) fn block_bytes(block: &Block<Transaction>) -> u64 {
+    Postcard::encode(block).len() as u64
+}
+
 fn block_used_gas(
     fee: u64,
     gas_price: u64,

crates/services/gas_price_service/src/common/updater_metadata.rs

@@ -30,8 +30,8 @@ impl From<AlgorithmUpdaterV0> for UpdaterMetadata {
     }
 }
 
-impl From<AlgorithmUpdaterV1> for UpdaterMetadata {
-    fn from(updater: AlgorithmUpdaterV1) -> Self {
+impl<U> From<AlgorithmUpdaterV1<U>> for UpdaterMetadata {
+    fn from(updater: AlgorithmUpdaterV1<U>) -> Self {
         Self::V1(updater.into())
     }
 }

crates/services/gas_price_service/src/v0/service.rs

@@ -141,13 +141,15 @@ where
     Metadata: MetadataStorage,
 {
     async fn run(&mut self, watcher: &mut StateWatcher) -> TaskNextAction {
+        tracing::trace!("Starting gas price service");
         tokio::select! {
             biased;
             _ = watcher.while_started() => {
                 tracing::debug!("Stopping gas price service");
                 TaskNextAction::Stop
             }
             l2_block_res = self.l2_block_source.get_l2_block() => {
+                tracing::debug!("Received L2 block");
                 let res = self.process_l2_block_res(l2_block_res).await;
                 TaskNextAction::always_continue(res)
             }

crates/services/gas_price_service/src/v0/tests.rs

@@ -167,14 +167,16 @@ async fn next_gas_price__affected_by_new_l2_block() {
         algo_updater,
     );
 
+    tracing::debug!("service created");
+
     let read_algo = service.next_block_algorithm();
     let initial = read_algo.next_gas_price();
-    let mut watcher = StateWatcher::default();
+    let mut watcher = StateWatcher::started();
+    tokio::spawn(async move { service.run(&mut watcher).await });
 
     // when
-    service.run(&mut watcher).await;
     l2_block_sender.send(l2_block).await.unwrap();
-    service.shutdown().await.unwrap();
+    tokio::time::sleep(std::time::Duration::from_millis(10)).await;
 
     // then
     let new = read_algo.next_gas_price();
@@ -212,18 +214,16 @@ async fn next__new_l2_block_saves_old_metadata() {
         algo_updater,
     );
 
-    // when
-    let read_algo = service.next_block_algorithm();
-    let mut watcher = StateWatcher::default();
-    let start = read_algo.next_gas_price();
+    let mut watcher = StateWatcher::started();
+    tokio::spawn(async move { service.run(&mut watcher).await });
 
-    service.run(&mut watcher).await;
+    // when
     l2_block_sender.send(l2_block).await.unwrap();
-    service.shutdown().await.unwrap();
+    tokio::time::sleep(std::time::Duration::from_millis(10)).await;
 
     // then
-    let new = read_algo.next_gas_price();
-    assert_ne!(start, new);
+    let metadata_has_been_updated = metadata_inner.lock().unwrap().is_some();
+    assert!(metadata_has_been_updated);
 }
 
 #[derive(Clone)]

crates/services/gas_price_service/src/v1.rs

@@ -2,3 +2,7 @@ pub mod algorithm;
 pub mod da_source_service;
 pub mod metadata;
 pub mod service;
+
+#[cfg(test)]
+mod tests;
+pub mod uninitialized_task;