apollo_l1_provider: re-write FinalityTooHigh error as LatestBlockNumberTooLow

Author: guy-starkware

crates/apollo_central_sync/src/sources/base_layer.rs

@@ -14,10 +14,10 @@ pub enum BaseLayerSourceError {
     #[error("Base layer source creation error: {0}.")]
     BaseLayerSourceCreationError(String),
     #[error(
-        "Finality is too high: finality: {finality}, latest L1 block number: \
-         {latest_l1_block_number}"
+        "Latest L1 block number is too low: latest L1 block number: {latest_l1_block_number}, \
+         finality: {finality}"
     )]
-    FinalityTooHigh { finality: u64, latest_l1_block_number: u64 },
+    LatestBlockNumberTooLow { latest_l1_block_number: u64, finality: u64 },
 }
 
 pub trait BaseLayerSourceErrorTrait: std::error::Error + Sync + Send {}
@@ -46,9 +46,9 @@ impl<
             .latest_l1_block_number()
             .await
             .map_err(|e| BaseLayerSourceError::BaseLayerContractError(Box::new(e)))?;
-        let latest_l1_block_number = latest_l1_block_number
-            .checked_sub(finality)
-            .ok_or(BaseLayerSourceError::FinalityTooHigh { finality, latest_l1_block_number })?;
+        let latest_l1_block_number = latest_l1_block_number.checked_sub(finality).ok_or(
+            BaseLayerSourceError::LatestBlockNumberTooLow { latest_l1_block_number, finality },
+        )?;
         // TODO(guyn): There's no way to actually get an Ok(None) from this function. Consider
         // adding a check against the type of error we get back from get_proved_block_at() and
         // converting that into Ok(None) if we are truly convinced that there are no proved blocks

crates/apollo_l1_gas_price/src/l1_gas_price_scraper.rs

@@ -41,10 +41,10 @@ pub enum L1GasPriceScraperError<T: BaseLayerContract + Send + Sync> {
     #[error(transparent)]
     NetworkError(ClientError),
     #[error(
-        "Finality is too high: finality: {finality}, latest L1 block number: \
-         {latest_l1_block_number}"
+        "Latest L1 block number is too low: latest L1 block number: {latest_l1_block_number}, \
+         finality: {finality}"
     )]
-    FinalityTooHigh { finality: u64, latest_l1_block_number: u64 },
+    LatestBlockNumberTooLow { latest_l1_block_number: u64, finality: u64 },
 }
 
 pub struct L1GasPriceScraper<B: BaseLayerContract> {
@@ -158,9 +158,9 @@ impl<B: BaseLayerContract + Send + Sync + Debug> L1GasPriceScraper<B> {
             .map_err(L1GasPriceScraperError::BaseLayerError)?;
         let latest_l1_block_number = latest_l1_block_number
             .checked_sub(self.config.finality)
-            .ok_or(L1GasPriceScraperError::FinalityTooHigh {
-                finality: self.config.finality,
+            .ok_or(L1GasPriceScraperError::LatestBlockNumberTooLow {
                 latest_l1_block_number,
+                finality: self.config.finality,
             })?;
         Ok(latest_l1_block_number)
     }

crates/apollo_l1_gas_price/src/l1_gas_price_scraper_test.rs

@@ -319,7 +319,7 @@ async fn base_layer_returns_block_number_below_finality_causes_error() {
     // The scraper should return a finality too high error.
     assert_matches!(
         scraper.update_prices(&mut block_number).await,
-        Err(L1GasPriceScraperError::FinalityTooHigh { .. })
+        Err(L1GasPriceScraperError::LatestBlockNumberTooLow { .. })
     );
 }
 

crates/apollo_l1_provider/src/l1_scraper.rs

@@ -128,9 +128,9 @@ impl<BaseLayerType: BaseLayerContract + Send + Sync + Debug> L1Scraper<BaseLayer
             .await
             .map_err(L1ScraperError::BaseLayerError)?;
         let latest_l1_block_number = latest_l1_block_number.checked_sub(finality).ok_or(
-            L1ScraperError::FinalityTooHigh {
-                finality,
+            L1ScraperError::LatestBlockNumberTooLow {
                 latest_l1_block_no_finality: latest_l1_block_number,
+                finality,
             },
         )?;
         debug!("Latest L1 block number: {latest_l1_block_number:?}");
@@ -259,7 +259,7 @@ impl<BaseLayerType: BaseLayerContract + Send + Sync + Debug> L1Scraper<BaseLayer
             .map_err(L1ScraperError::BaseLayerError)?;
         let latest_l1_block_number = latest_l1_block_number
             .checked_sub(self.config.finality)
-            .ok_or(L1ScraperError::FinalityTooHigh {
+            .ok_or(L1ScraperError::LatestBlockNumberTooLow {
                 finality: self.config.finality,
                 latest_l1_block_no_finality: latest_l1_block_number,
             })?;
@@ -437,10 +437,10 @@ pub enum L1ScraperError<BaseLayerType: BaseLayerContract + Send + Sync + Debug>
     #[error("Base layer error: {0}")]
     BaseLayerError(BaseLayerType::Error),
     #[error(
-        "Could not find block number. Finality {finality:?}, latest block: \
-         {latest_l1_block_no_finality:?}"
+        "Latest L1 block number is too low: latest L1 block number: \
+         {latest_l1_block_no_finality:?}, finality: {finality:?}"
     )]
-    FinalityTooHigh { finality: u64, latest_l1_block_no_finality: L1BlockNumber },
+    LatestBlockNumberTooLow { latest_l1_block_no_finality: L1BlockNumber, finality: u64 },
     #[error("Block number {block_number} not found")]
     LatestL1BlockNumberNoBlockFound { block_number: L1BlockNumber },
     #[error("Failed to calculate hash: {0}")]
@@ -462,9 +462,10 @@ impl<BaseLayerType: BaseLayerContract + Send + Sync + Debug> PartialEq
     fn eq(&self, other: &Self) -> bool {
         match (self, other) {
             (Self::BaseLayerError(e1), Self::BaseLayerError(e2)) => e1 == e2,
-            (this @ Self::FinalityTooHigh { .. }, other @ Self::FinalityTooHigh { .. }) => {
-                this == other
-            }
+            (
+                this @ Self::LatestBlockNumberTooLow { .. },
+                other @ Self::LatestBlockNumberTooLow { .. },
+            ) => this == other,
             (Self::HashCalculationError(e1), Self::HashCalculationError(e2)) => e1 == e2,
             (Self::NetworkError(e1), Self::NetworkError(e2)) => e1 == e2,
             (this @ Self::L1ReorgDetected { .. }, other @ Self::L1ReorgDetected { .. }) => {

crates/apollo_l1_provider/src/l1_scraper_tests.rs

@@ -193,7 +193,7 @@ async fn base_layer_returns_block_number_below_finality_causes_error() {
     // The scraper should return a finality too high error.
     assert_matches!(
         scraper.send_events_to_l1_provider().await,
-        Err(L1ScraperError::FinalityTooHigh { .. })
+        Err(L1ScraperError::LatestBlockNumberTooLow { .. })
     );
 }