apollo_l1_gas_price: put eth/strk oracle into gas price provider

Author: guy-starkware

crates/apollo_consensus_manager/src/consensus_manager.rs

@@ -19,7 +19,6 @@ use apollo_consensus_orchestrator::sequencer_consensus_context::{
 };
 use apollo_infra::component_definitions::ComponentStarter;
 use apollo_infra_utils::type_name::short_type_name;
-use apollo_l1_gas_price::eth_to_strk_oracle::EthToStrkOracleClient;
 use apollo_l1_gas_price_types::L1GasPriceProviderClient;
 use apollo_network::gossipsub_impl::Topic;
 use apollo_network::network_manager::metrics::{BroadcastNetworkMetrics, NetworkMetrics};
@@ -158,9 +157,6 @@ impl ConsensusManager {
                     self.config.cende_config.clone(),
                     Arc::clone(&self.class_manager_client),
                 )),
-                eth_to_strk_oracle_client: Arc::new(EthToStrkOracleClient::new(
-                    self.config.eth_to_strk_oracle_config.clone(),
-                )),
                 l1_gas_price_provider: self.l1_gas_price_provider.clone(),
                 clock: Arc::new(DefaultClock),
                 outbound_proposal_sender: outbound_internal_sender,

crates/apollo_consensus_orchestrator/src/build_proposal.rs

@@ -136,7 +136,6 @@ async fn initiate_build(args: &ProposalBuildArguments) -> BuildProposalResult<Co
         .expect("Can't convert timeout to chrono::Duration");
     let timestamp = args.deps.clock.unix_now();
     let (eth_to_fri_rate, l1_prices) = get_oracle_rate_and_prices(
-        args.deps.eth_to_strk_oracle_client.clone(),
         args.deps.l1_gas_price_provider.clone(),
         timestamp,
         args.previous_block_info.as_ref(),

crates/apollo_consensus_orchestrator/src/sequencer_consensus_context.rs

@@ -25,7 +25,7 @@ use apollo_consensus::types::{
     Round,
     ValidatorId,
 };
-use apollo_l1_gas_price_types::{EthToStrkOracleClientTrait, L1GasPriceProviderClient};
+use apollo_l1_gas_price_types::L1GasPriceProviderClient;
 use apollo_network::network_manager::{BroadcastTopicClient, BroadcastTopicClientTrait};
 use apollo_protobuf::consensus::{
     ConsensusBlockInfo,
@@ -164,7 +164,6 @@ pub struct SequencerConsensusContextDeps {
     pub state_sync_client: Arc<dyn StateSyncClient>,
     pub batcher: Arc<dyn BatcherClient>,
     pub cende_ambassador: Arc<dyn CendeContext>,
-    pub eth_to_strk_oracle_client: Arc<dyn EthToStrkOracleClientTrait>,
     pub l1_gas_price_provider: Arc<dyn L1GasPriceProviderClient>,
     /// Use DefaultClock if you don't want to inject timestamps.
     pub clock: Arc<dyn Clock>,

crates/apollo_consensus_orchestrator/src/sequencer_consensus_context_test.rs

@@ -11,12 +11,7 @@ use apollo_l1_gas_price_types::errors::{
     L1GasPriceClientError,
     L1GasPriceProviderError,
 };
-use apollo_l1_gas_price_types::{
-    MockEthToStrkOracleClientTrait,
-    MockL1GasPriceProviderClient,
-    PriceInfo,
-    DEFAULT_ETH_TO_FRI_RATE,
-};
+use apollo_l1_gas_price_types::{MockL1GasPriceProviderClient, PriceInfo, DEFAULT_ETH_TO_FRI_RATE};
 use apollo_protobuf::consensus::{ProposalFin, ProposalInit, ProposalPart, TransactionBatch, Vote};
 use apollo_time::time::MockClock;
 use chrono::{TimeZone, Utc};
@@ -474,6 +469,7 @@ async fn gas_price_limits(#[case] maximum: bool) {
         0
     };
     let mut l1_gas_price_provider = MockL1GasPriceProviderClient::new();
+    l1_gas_price_provider.expect_get_eth_to_fri_rate().returning(|_| Ok(ETH_TO_FRI_RATE));
     l1_gas_price_provider.expect_get_price_info().returning(move |_| {
         Ok(PriceInfo { base_fee_per_gas: GasPrice(price), blob_fee: GasPrice(price) })
     });
@@ -586,6 +582,7 @@ async fn oracle_fails_on_startup(#[case] l1_oracle_failure: bool) {
 
     if l1_oracle_failure {
         let mut l1_prices_oracle_client = MockL1GasPriceProviderClient::new();
+        l1_prices_oracle_client.expect_get_eth_to_fri_rate().returning(|_| Ok(ETH_TO_FRI_RATE));
         l1_prices_oracle_client.expect_get_price_info().times(1).return_const(Err(
             L1GasPriceClientError::L1GasPriceProviderError(
                 // random error, these parameters don't mean anything
@@ -594,11 +591,19 @@ async fn oracle_fails_on_startup(#[case] l1_oracle_failure: bool) {
         ));
         deps.l1_gas_price_provider = l1_prices_oracle_client;
     } else {
-        let mut eth_to_strk_oracle_client = MockEthToStrkOracleClientTrait::new();
-        eth_to_strk_oracle_client.expect_eth_to_fri_rate().times(1).return_once(|_| {
-            Err(EthToStrkOracleClientError::MissingFieldError("".to_string(), "".to_string()))
+        let mut l1_prices_oracle_client = MockL1GasPriceProviderClient::new();
+        l1_prices_oracle_client.expect_get_price_info().returning(|_| {
+            Ok(PriceInfo {
+                base_fee_per_gas: GasPrice(TEMP_ETH_GAS_FEE_IN_WEI),
+                blob_fee: GasPrice(TEMP_ETH_BLOB_GAS_FEE_IN_WEI),
+            })
         });
-        deps.eth_to_strk_oracle_client = eth_to_strk_oracle_client;
+        l1_prices_oracle_client.expect_get_eth_to_fri_rate().times(1).return_once(|_| {
+            Err(L1GasPriceClientError::EthToStrkOracleClientError(
+                EthToStrkOracleClientError::MissingFieldError("".to_string(), "".to_string()),
+            ))
+        });
+        deps.l1_gas_price_provider = l1_prices_oracle_client;
     }
 
     let mut context = deps.build_context();
@@ -667,6 +672,7 @@ async fn oracle_fails_on_second_block(#[case] l1_oracle_failure: bool) {
     // set the oracle to succeed on first block and fail on second
     if l1_oracle_failure {
         let mut l1_prices_oracle_client = MockL1GasPriceProviderClient::new();
+        l1_prices_oracle_client.expect_get_eth_to_fri_rate().returning(|_| Ok(ETH_TO_FRI_RATE));
         l1_prices_oracle_client.expect_get_price_info().times(1).return_const(Ok(PriceInfo {
             base_fee_per_gas: GasPrice(TEMP_ETH_GAS_FEE_IN_WEI),
             blob_fee: GasPrice(TEMP_ETH_BLOB_GAS_FEE_IN_WEI),
@@ -679,15 +685,36 @@ async fn oracle_fails_on_second_block(#[case] l1_oracle_failure: bool) {
         ));
         deps.l1_gas_price_provider = l1_prices_oracle_client;
     } else {
-        let mut eth_to_strk_oracle_client = MockEthToStrkOracleClientTrait::new();
-        eth_to_strk_oracle_client
-            .expect_eth_to_fri_rate()
+        let mut l1_prices_oracle_client = MockL1GasPriceProviderClient::new();
+        // Make sure the L1 gas price always returns with good values.
+        l1_prices_oracle_client.expect_get_price_info().returning(|_| {
+            Ok(PriceInfo {
+                base_fee_per_gas: GasPrice(TEMP_ETH_GAS_FEE_IN_WEI),
+                blob_fee: GasPrice(TEMP_ETH_BLOB_GAS_FEE_IN_WEI),
+            })
+        });
+        // Set the eth_to_fri_rate to succeed on first block and fail on second.
+        l1_prices_oracle_client
+            .expect_get_eth_to_fri_rate()
             .times(1)
             .return_once(|_| Ok(ETH_TO_FRI_RATE));
-        eth_to_strk_oracle_client.expect_eth_to_fri_rate().times(1).return_once(|_| {
-            Err(EthToStrkOracleClientError::MissingFieldError("".to_string(), "".to_string()))
+        // Set the eth_to_fri_rate to fail on second block.
+        l1_prices_oracle_client.expect_get_eth_to_fri_rate().times(1).return_once(|_| {
+            Err(L1GasPriceClientError::EthToStrkOracleClientError(
+                EthToStrkOracleClientError::MissingFieldError("".to_string(), "".to_string()),
+            ))
         });
-        deps.eth_to_strk_oracle_client = eth_to_strk_oracle_client;
+        deps.l1_gas_price_provider = l1_prices_oracle_client;
+
+        // let mut eth_to_strk_oracle_client = MockEthToStrkOracleClientTrait::new();
+        // eth_to_strk_oracle_client
+        //     .expect_eth_to_fri_rate()
+        //     .times(1)
+        //     .return_once(|_| Ok(ETH_TO_FRI_RATE));
+        // eth_to_strk_oracle_client.expect_eth_to_fri_rate().times(1).return_once(|_| {
+        //     Err(EthToStrkOracleClientError::MissingFieldError("".to_string(), "".to_string()))
+        // });
+        // deps.eth_to_strk_oracle_client = eth_to_strk_oracle_client;
     }
 
     let mut context = deps.build_context();

crates/apollo_consensus_orchestrator/src/test_utils.rs

@@ -20,11 +20,7 @@ use apollo_class_manager_types::transaction_converter::{
     TransactionConverterTrait,
 };
 use apollo_class_manager_types::EmptyClassManagerClient;
-use apollo_l1_gas_price_types::{
-    MockEthToStrkOracleClientTrait,
-    MockL1GasPriceProviderClient,
-    PriceInfo,
-};
+use apollo_l1_gas_price_types::{MockL1GasPriceProviderClient, PriceInfo};
 use apollo_network::network_manager::test_utils::{
     mock_register_broadcast_topic,
     BroadcastNetworkMock,
@@ -93,7 +89,6 @@ pub(crate) struct TestDeps {
     pub state_sync_client: MockStateSyncClient,
     pub batcher: MockBatcherClient,
     pub cende_ambassador: MockCendeContext,
-    pub eth_to_strk_oracle_client: MockEthToStrkOracleClientTrait,
     pub l1_gas_price_provider: MockL1GasPriceProviderClient,
     pub clock: Arc<dyn Clock>,
     pub outbound_proposal_sender: mpsc::Sender<(HeightAndRound, mpsc::Receiver<ProposalPart>)>,
@@ -107,7 +102,6 @@ impl From<TestDeps> for SequencerConsensusContextDeps {
             state_sync_client: Arc::new(deps.state_sync_client),
             batcher: Arc::new(deps.batcher),
             cende_ambassador: Arc::new(deps.cende_ambassador),
-            eth_to_strk_oracle_client: Arc::new(deps.eth_to_strk_oracle_client),
             l1_gas_price_provider: Arc::new(deps.l1_gas_price_provider),
             clock: deps.clock,
             outbound_proposal_sender: deps.outbound_proposal_sender,
@@ -121,7 +115,6 @@ impl TestDeps {
         self.setup_default_transaction_converter();
         self.setup_default_cende_ambassador();
         self.setup_default_gas_price_provider();
-        self.setup_default_eth_to_strk_oracle_client();
     }
 
     pub(crate) fn setup_deps_for_build(
@@ -229,10 +222,7 @@ impl TestDeps {
             base_fee_per_gas: GasPrice(TEMP_ETH_GAS_FEE_IN_WEI),
             blob_fee: GasPrice(TEMP_ETH_BLOB_GAS_FEE_IN_WEI),
         }));
-    }
-
-    pub(crate) fn setup_default_eth_to_strk_oracle_client(&mut self) {
-        self.eth_to_strk_oracle_client.expect_eth_to_fri_rate().returning(|_| Ok(ETH_TO_FRI_RATE));
+        self.l1_gas_price_provider.expect_get_eth_to_fri_rate().return_const(Ok(ETH_TO_FRI_RATE));
     }
 
     pub(crate) fn build_context(self) -> SequencerConsensusContext {
@@ -261,7 +251,6 @@ pub(crate) fn create_test_and_network_deps() -> (TestDeps, NetworkDependencies)
     let state_sync_client = MockStateSyncClient::new();
     let batcher = MockBatcherClient::new();
     let cende_ambassador = MockCendeContext::new();
-    let eth_to_strk_oracle_client = MockEthToStrkOracleClientTrait::new();
     let l1_gas_price_provider = MockL1GasPriceProviderClient::new();
     let clock = Arc::new(DefaultClock);
 
@@ -270,7 +259,6 @@ pub(crate) fn create_test_and_network_deps() -> (TestDeps, NetworkDependencies)
         state_sync_client,
         batcher,
         cende_ambassador,
-        eth_to_strk_oracle_client,
         l1_gas_price_provider,
         clock,
         outbound_proposal_sender,

crates/apollo_consensus_orchestrator/src/utils.rs

@@ -1,11 +1,6 @@
 use std::sync::Arc;
 
-use apollo_l1_gas_price_types::{
-    EthToStrkOracleClientTrait,
-    L1GasPriceProviderClient,
-    PriceInfo,
-    DEFAULT_ETH_TO_FRI_RATE,
-};
+use apollo_l1_gas_price_types::{L1GasPriceProviderClient, PriceInfo, DEFAULT_ETH_TO_FRI_RATE};
 use apollo_protobuf::consensus::{ConsensusBlockInfo, ProposalPart};
 use apollo_state_sync_types::communication::{StateSyncClient, StateSyncClientError};
 // TODO(Gilad): Define in consensus, either pass to blockifier as config or keep the dup.
@@ -77,14 +72,13 @@ impl From<StateSyncError> for ValidateProposalError {
 }
 
 pub(crate) async fn get_oracle_rate_and_prices(
-    eth_to_strk_oracle_client: Arc<dyn EthToStrkOracleClientTrait>,
     l1_gas_price_provider_client: Arc<dyn L1GasPriceProviderClient>,
     timestamp: u64,
     previous_block_info: Option<&ConsensusBlockInfo>,
     gas_price_params: &GasPriceParams,
 ) -> (u128, PriceInfo) {
     let (eth_to_strk_rate, price_info) = tokio::join!(
-        eth_to_strk_oracle_client.eth_to_fri_rate(timestamp),
+        l1_gas_price_provider_client.get_eth_to_fri_rate(timestamp),
         l1_gas_price_provider_client.get_price_info(BlockTimestamp(timestamp))
     );
     if price_info.is_err() {

crates/apollo_consensus_orchestrator/src/validate_proposal.rs

@@ -16,7 +16,7 @@ use apollo_batcher_types::communication::{BatcherClient, BatcherClientError};
 use apollo_class_manager_types::transaction_converter::TransactionConverterTrait;
 use apollo_consensus::types::ProposalCommitment;
 use apollo_l1_gas_price_types::errors::{EthToStrkOracleClientError, L1GasPriceClientError};
-use apollo_l1_gas_price_types::{EthToStrkOracleClientTrait, L1GasPriceProviderClient};
+use apollo_l1_gas_price_types::L1GasPriceProviderClient;
 use apollo_protobuf::consensus::{ConsensusBlockInfo, ProposalFin, ProposalPart, TransactionBatch};
 use apollo_state_sync_types::communication::{StateSyncClient, StateSyncClientError};
 use apollo_time::time::{sleep_until, Clock, DateTime};
@@ -147,7 +147,6 @@ pub(crate) async fn validate_proposal(
     is_block_info_valid(
         args.block_info_validation.clone(),
         block_info.clone(),
-        args.deps.eth_to_strk_oracle_client,
         args.deps.clock.as_ref(),
         args.deps.l1_gas_price_provider,
         &args.gas_price_params,
@@ -232,7 +231,6 @@ pub(crate) async fn validate_proposal(
 async fn is_block_info_valid(
     block_info_validation: BlockInfoValidation,
     block_info_proposed: ConsensusBlockInfo,
-    eth_to_strk_oracle_client: Arc<dyn EthToStrkOracleClientTrait>,
     clock: &dyn Clock,
     l1_gas_price_provider: Arc<dyn L1GasPriceProviderClient>,
     gas_price_params: &GasPriceParams,
@@ -274,7 +272,6 @@ async fn is_block_info_valid(
         ));
     }
     let (eth_to_fri_rate, l1_gas_prices) = get_oracle_rate_and_prices(
-        eth_to_strk_oracle_client,
         l1_gas_price_provider,
         block_info_proposed.timestamp,
         block_info_validation.previous_block_info.as_ref(),

crates/apollo_l1_gas_price/src/communication.rs

@@ -34,6 +34,9 @@ impl ComponentRequestHandler<L1GasPriceRequest, L1GasPriceResponse> for L1GasPri
             L1GasPriceRequest::AddGasPrice(data) => {
                 L1GasPriceResponse::AddGasPrice(self.add_price_info(data))
             }
+            L1GasPriceRequest::GetEthToFriRate(timestamp) => {
+                L1GasPriceResponse::GetEthToFriRate(self.eth_to_fri_rate(timestamp).await)
+            }
         }
     }
 }

crates/apollo_l1_gas_price/src/l1_gas_price_provider.rs

@@ -1,12 +1,18 @@
 use std::any::type_name;
 use std::collections::{BTreeMap, VecDeque};
+use std::sync::Arc;
 
 use apollo_config::dumping::{ser_param, SerializeConfig};
 use apollo_config::{ParamPath, ParamPrivacyInput, SerializedParam};
 use apollo_infra::component_definitions::ComponentStarter;
 use apollo_infra_utils::info_every_n_sec;
 use apollo_l1_gas_price_types::errors::L1GasPriceProviderError;
-use apollo_l1_gas_price_types::{GasPriceData, L1GasPriceProviderResult, PriceInfo};
+use apollo_l1_gas_price_types::{
+    EthToStrkOracleClientTrait,
+    GasPriceData,
+    L1GasPriceProviderResult,
+    PriceInfo,
+};
 use async_trait::async_trait;
 use serde::{Deserialize, Serialize};
 use starknet_api::block::BlockTimestamp;
@@ -111,11 +117,15 @@ pub struct L1GasPriceProvider {
     config: L1GasPriceProviderConfig,
     // If received data before initialization (is None), it means the scraper has restarted.
     price_samples_by_block: Option<RingBuffer<GasPriceData>>,
+    eth_to_strk_oracle_client: Arc<dyn EthToStrkOracleClientTrait>,
 }
 
 impl L1GasPriceProvider {
-    pub fn new(config: L1GasPriceProviderConfig) -> Self {
-        Self { config, price_samples_by_block: None }
+    pub fn new(
+        config: L1GasPriceProviderConfig,
+        eth_to_strk_oracle_client: Arc<dyn EthToStrkOracleClientTrait>,
+    ) -> Self {
+        Self { config, price_samples_by_block: None, eth_to_strk_oracle_client }
     }
 
     pub fn initialize(&mut self) -> L1GasPriceProviderResult<()> {
@@ -226,6 +236,13 @@ impl L1GasPriceProvider {
         L1_DATA_GAS_PRICE_LATEST_MEAN_VALUE.set_lossy(price_info_out.blob_fee.0);
         Ok(price_info_out)
     }
+
+    pub async fn eth_to_fri_rate(&self, timestamp: u64) -> L1GasPriceProviderResult<u128> {
+        self.eth_to_strk_oracle_client
+            .eth_to_fri_rate(timestamp)
+            .await
+            .map_err(|e| L1GasPriceProviderError::EthToStrkOracleClientError(e))
+    }
 }
 
 #[async_trait]

crates/apollo_l1_gas_price/src/l1_gas_price_provider_test.rs

@@ -1,4 +1,6 @@
-use apollo_l1_gas_price_types::{GasPriceData, PriceInfo};
+use std::sync::Arc;
+
+use apollo_l1_gas_price_types::{GasPriceData, MockEthToStrkOracleClientTrait, PriceInfo};
 use starknet_api::block::{BlockTimestamp, GasPrice};
 
 use crate::l1_gas_price_provider::{
@@ -11,10 +13,11 @@ use crate::l1_gas_price_provider::{
 // To get the prices for the middle three blocks use the timestamp for block[3].
 // Returns the provider, a vector of block prices to compare with, and the timestamp of block[3].
 fn make_provider() -> (L1GasPriceProvider, Vec<PriceInfo>, u64) {
-    let mut provider = L1GasPriceProvider::new(L1GasPriceProviderConfig {
-        number_of_blocks_for_mean: 3,
-        ..Default::default()
-    });
+    let eth_to_strk_oracle_client = Arc::new(MockEthToStrkOracleClientTrait::new());
+    let mut provider = L1GasPriceProvider::new(
+        L1GasPriceProviderConfig { number_of_blocks_for_mean: 3, ..Default::default() },
+        eth_to_strk_oracle_client,
+    );
     provider.initialize().unwrap();
     let mut prices = Vec::new();
     let mut timestamp3 = 0;
@@ -116,10 +119,11 @@ fn gas_price_provider_timestamp_changes_mean() {
 
 #[test]
 fn gas_price_provider_can_start_at_nonzero_height() {
-    let mut provider = L1GasPriceProvider::new(L1GasPriceProviderConfig {
-        number_of_blocks_for_mean: 3,
-        ..Default::default()
-    });
+    let eth_to_strk_oracle_client = Arc::new(MockEthToStrkOracleClientTrait::new());
+    let mut provider = L1GasPriceProvider::new(
+        L1GasPriceProviderConfig { number_of_blocks_for_mean: 3, ..Default::default() },
+        eth_to_strk_oracle_client,
+    );
     provider.initialize().unwrap();
     let price_info = PriceInfo { base_fee_per_gas: GasPrice(0), blob_fee: GasPrice(0) };
     let timestamp = BlockTimestamp(0);
@@ -128,10 +132,11 @@ fn gas_price_provider_can_start_at_nonzero_height() {
 
 #[test]
 fn gas_price_provider_uninitialized_error() {
-    let mut provider = L1GasPriceProvider::new(L1GasPriceProviderConfig {
-        number_of_blocks_for_mean: 3,
-        ..Default::default()
-    });
+    let eth_to_strk_oracle_client = Arc::new(MockEthToStrkOracleClientTrait::new());
+    let mut provider = L1GasPriceProvider::new(
+        L1GasPriceProviderConfig { number_of_blocks_for_mean: 3, ..Default::default() },
+        eth_to_strk_oracle_client,
+    );
     let price_info = PriceInfo { base_fee_per_gas: GasPrice(0), blob_fee: GasPrice(0) };
     let timestamp = BlockTimestamp(0);
     let result = provider.add_price_info(GasPriceData { block_number: 42, timestamp, price_info });