apollo_l1_gas_price,deployment: rename eth_to_strk_oracle to price_oracle

Author: sirandreww-starkware

.github/workflows/hybrid_system_test.yaml

@@ -96,8 +96,8 @@ jobs:
             dockerfile: Dockerfile
           - svc: dummy_recorder
             dockerfile: dummy_recorder.Dockerfile
-          - svc: dummy_eth_to_strk_oracle
-            dockerfile: dummy_eth_to_strk_oracle.Dockerfile
+          - svc: dummy_exchange_rate_oracle
+            dockerfile: dummy_exchange_rate_oracle.Dockerfile
     steps:
       - uses: actions/checkout@v6
 
@@ -225,7 +225,7 @@ jobs:
           echo "Deploying Dummy Eth2Strk Oracle..."
           pipenv install
           cdk8s import
-          cdk8s synth --app "pipenv run python main.py --namespace ${{ env.dummy_eth_to_strk_namespace }} --image ${{ env.NSC_CONTAINER_REGISTRY }}/dummy_eth_to_strk_oracle:${{ github.sha }}"
+          cdk8s synth --app "pipenv run python main.py --namespace ${{ env.dummy_eth_to_strk_namespace }} --image ${{ env.NSC_CONTAINER_REGISTRY }}/dummy_exchange_rate_oracle:${{ github.sha }}"
           kubectl create namespace ${{ env.dummy_eth_to_strk_namespace }}
           kubectl apply -R -f ./dist
           echo "⏳ Waiting for Dummy Eth2Strk Oracle to become ready..."

crates/apollo_consensus_orchestrator/src/build_proposal.rs

@@ -15,7 +15,7 @@ use apollo_batcher_types::batcher_types::{
 use apollo_batcher_types::communication::{BatcherClient, BatcherClientError};
 use apollo_consensus::types::{ProposalCommitment, Round};
 use apollo_consensus_orchestrator_config::config::PricePerHeight;
-use apollo_l1_gas_price_types::errors::{EthToStrkOracleClientError, L1GasPriceClientError};
+use apollo_l1_gas_price_types::errors::{ExchangeRateOracleClientError, L1GasPriceClientError};
 use apollo_protobuf::consensus::{
     BuildParam,
     CommitmentParts,
@@ -93,8 +93,8 @@ pub(crate) enum BuildProposalError {
     RetrospectiveBlockHashError(#[from] RetrospectiveBlockHashError),
     #[error("Failed to send proposal part: {0}")]
     SendError(String),
-    #[error("EthToStrkOracle error: {0}")]
-    EthToStrkOracle(#[from] EthToStrkOracleClientError),
+    #[error("ExchangeRateOracle error: {0}")]
+    ExchangeRateOracle(#[from] ExchangeRateOracleClientError),
     #[error("L1GasPriceProvider error: {0}")]
     L1GasPriceProvider(#[from] L1GasPriceClientError),
     #[error("Proposal interrupted.")]

crates/apollo_consensus_orchestrator/src/sequencer_consensus_context_test.rs

@@ -22,7 +22,7 @@ use apollo_consensus_orchestrator_config::config::{
     PricePerHeight,
 };
 use apollo_l1_gas_price_types::errors::{
-    EthToStrkOracleClientError,
+    ExchangeRateOracleClientError,
     L1GasPriceClientError,
     L1GasPriceProviderError,
 };
@@ -642,7 +642,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_rate().returning(|_| Ok(ETH_TO_FRI_RATE));
     l1_gas_price_provider.expect_get_price_info().returning(move |_| {
         Ok(PriceInfo {
             base_fee_per_gas: GasPrice(measured_price),
@@ -835,7 +835,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_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
@@ -851,9 +851,9 @@ async fn oracle_fails_on_startup(#[case] l1_oracle_failure: bool) {
                 blob_fee: GasPrice(TEMP_ETH_BLOB_GAS_FEE_IN_WEI),
             })
         });
-        l1_prices_oracle_client.expect_get_eth_to_fri_rate().times(1).return_once(|_| {
-            Err(L1GasPriceClientError::EthToStrkOracleClientError(
-                EthToStrkOracleClientError::MissingFieldError("".to_string(), "".to_string()),
+        l1_prices_oracle_client.expect_get_rate().times(1).return_once(|_| {
+            Err(L1GasPriceClientError::ExchangeRateOracleClientError(
+                ExchangeRateOracleClientError::MissingFieldError("".to_string(), "".to_string()),
             ))
         });
         deps.l1_gas_price_provider = l1_prices_oracle_client;
@@ -923,7 +923,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_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),
@@ -945,14 +945,11 @@ async fn oracle_fails_on_second_block(#[case] l1_oracle_failure: bool) {
             })
         });
         // 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));
+        l1_prices_oracle_client.expect_get_rate().times(1).return_once(|_| Ok(ETH_TO_FRI_RATE));
         // 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()),
+        l1_prices_oracle_client.expect_get_rate().times(1).return_once(|_| {
+            Err(L1GasPriceClientError::ExchangeRateOracleClientError(
+                ExchangeRateOracleClientError::MissingFieldError("".to_string(), "".to_string()),
             ))
         });
         deps.l1_gas_price_provider = l1_prices_oracle_client;

crates/apollo_consensus_orchestrator/src/test_utils.rs

@@ -318,7 +318,7 @@ impl TestDeps {
             base_fee_per_gas: GasPrice(TEMP_ETH_GAS_FEE_IN_WEI),
             blob_fee: GasPrice(TEMP_ETH_BLOB_GAS_FEE_IN_WEI),
         }));
-        self.l1_gas_price_provider.expect_get_eth_to_fri_rate().return_const(Ok(ETH_TO_FRI_RATE));
+        self.l1_gas_price_provider.expect_get_rate().return_const(Ok(ETH_TO_FRI_RATE));
     }
 
     pub(crate) fn setup_default_batcher_get_block_hash(&mut self) {

crates/apollo_consensus_orchestrator/src/utils.rs

@@ -145,7 +145,7 @@ pub(crate) async fn get_l1_prices_in_fri_and_wei_and_conversion_rate(
 
     // Get the eth to fri rate from the oracle, and the L1 gas price (in wei) from the provider.
     let (eth_to_fri_rate, price_info) = tokio::join!(
-        l1_gas_price_provider_client.get_eth_to_fri_rate(timestamp),
+        l1_gas_price_provider_client.get_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

@@ -17,7 +17,7 @@ use apollo_batcher_types::batcher_types::{
 use apollo_batcher_types::communication::{BatcherClient, BatcherClientError};
 use apollo_batcher_types::errors::BatcherError;
 use apollo_consensus::types::ProposalCommitment;
-use apollo_l1_gas_price_types::errors::{EthToStrkOracleClientError, L1GasPriceClientError};
+use apollo_l1_gas_price_types::errors::{ExchangeRateOracleClientError, L1GasPriceClientError};
 use apollo_l1_gas_price_types::L1GasPriceProviderClient;
 use apollo_protobuf::consensus::{ProposalFin, ProposalInit, ProposalPart, TransactionBatch};
 use apollo_state_sync_types::communication::SharedStateSyncClient;
@@ -111,8 +111,8 @@ pub(crate) enum ValidateProposalError {
     // Consensus may exit early (e.g. sync).
     #[error("Failed to send commitment to consensus: {0}")]
     SendError(ProposalCommitment),
-    #[error("EthToStrkOracle error: {0}")]
-    EthToStrkOracle(#[from] EthToStrkOracleClientError),
+    #[error("ExchangeRateOracle error: {0}")]
+    ExchangeRateOracle(#[from] ExchangeRateOracleClientError),
     #[error("L1GasPriceProvider error: {0}")]
     L1GasPriceProvider(#[from] L1GasPriceClientError),
     #[error("ProposalInit conversion error: {0}")]

…ests/src/bin/dummy_eth_to_strk_oracle.rs …ts/src/bin/dummy_exchange_rate_oracle.rscrates/apollo_integration_tests/src/bin/dummy_eth_to_strk_oracle.rs renamed to crates/apollo_integration_tests/src/bin/dummy_exchange_rate_oracle.rs crates/apollo_integration_tests/src/bin/dummy_eth_to_strk_oracle.rs renamed to crates/apollo_integration_tests/src/bin/dummy_exchange_rate_oracle.rs

@@ -8,7 +8,7 @@ use apollo_consensus_manager_config::config::ConsensusManagerConfig;
 use apollo_http_server::test_utils::HttpTestClient;
 use apollo_infra::metrics::{metrics_recorder, MetricsConfig};
 use apollo_infra_utils::test_utils::AvailablePorts;
-use apollo_l1_gas_price_config::config::EthToStrkOracleConfig;
+use apollo_l1_gas_price_config::config::ExchangeRateOracleConfig;
 use apollo_mempool_p2p_config::config::MempoolP2pConfig;
 use apollo_monitoring_endpoint::test_utils::MonitoringClient;
 use apollo_monitoring_endpoint_config::config::MonitoringEndpointConfig;
@@ -256,7 +256,7 @@ impl FlowSequencerSetup {
 
         let (eth_to_strk_oracle_url_headers, _join_handle) =
             spawn_local_eth_to_strk_oracle(available_ports.get_next_port());
-        let eth_to_strk_oracle_config = EthToStrkOracleConfig {
+        let eth_to_strk_oracle_config = ExchangeRateOracleConfig {
             url_header_list: Some(vec![eth_to_strk_oracle_url_headers.into()]),
             ..Default::default()
         };

crates/apollo_integration_tests/src/flow_test_setup.rs

@@ -11,7 +11,7 @@ use apollo_http_server::test_utils::HttpTestClient;
 use apollo_infra_utils::dumping::serialize_to_file;
 use apollo_infra_utils::test_utils::{AvailablePortsGenerator, TestIdentifier};
 use apollo_infra_utils::tracing::{CustomLogger, TraceLevel};
-use apollo_l1_gas_price_config::config::{EthToStrkOracleConfig, L1GasPriceScraperConfig};
+use apollo_l1_gas_price_config::config::{ExchangeRateOracleConfig, L1GasPriceScraperConfig};
 use apollo_monitoring_endpoint::test_utils::MonitoringClient;
 use apollo_monitoring_endpoint_config::config::MonitoringEndpointConfig;
 use apollo_network::network_manager::test_utils::create_connected_network_configs;
@@ -1298,7 +1298,7 @@ async fn get_sequencer_setup_configs(
         let state_sync_config = state_sync_configs.remove(0);
 
         consensus_manager_config.cende_config.recorder_url = recorder_url.clone();
-        let eth_to_strk_oracle_config = EthToStrkOracleConfig {
+        let eth_to_strk_oracle_config = ExchangeRateOracleConfig {
             url_header_list: Some(vec![eth_to_strk_oracle_url.clone().into()]),
             ..Default::default()
         };

crates/apollo_integration_tests/src/integration_test_manager.rs

@@ -52,9 +52,9 @@ use apollo_http_server::test_utils::create_http_server_config;
 use apollo_infra::trace_util::configure_tracing;
 use apollo_infra_utils::test_utils::{AvailablePorts, TestIdentifier};
 use apollo_l1_events_config::config::{L1EventsProviderConfig, L1EventsScraperConfig};
-use apollo_l1_gas_price::eth_to_strk_oracle::ETH_TO_STRK_QUANTIZATION;
+use apollo_l1_gas_price::exchange_rate_oracle::EXCHANGE_RATE_DECIMALS;
 use apollo_l1_gas_price_config::config::{
-    EthToStrkOracleConfig,
+    ExchangeRateOracleConfig,
     L1GasPriceProviderConfig,
     L1GasPriceScraperConfig,
 };
@@ -254,7 +254,7 @@ pub fn create_node_config(
     storage_config: StorageTestConfig,
     mut state_sync_config: StateSyncConfig,
     mut consensus_manager_config: ConsensusManagerConfig,
-    eth_to_strk_oracle_config: EthToStrkOracleConfig,
+    eth_to_strk_oracle_config: ExchangeRateOracleConfig,
     mempool_p2p_config: MempoolP2pConfig,
     monitoring_endpoint_config: MonitoringEndpointConfig,
     components: ComponentConfig,
@@ -552,22 +552,23 @@ struct EthToStrkOracleQuery {
 }
 
 /// Returns a fake eth to fri rate response.
-async fn get_price(Query(query): Query<EthToStrkOracleQuery>) -> Json<serde_json::Value> {
+async fn get_rate(Query(query): Query<EthToStrkOracleQuery>) -> Json<serde_json::Value> {
     // This value must be large enough so that conversion for ETH to STRK is not zero (e.g. for gas
     // prices). We set a value a bit higher than the min needed to avoid test failures due to
     // small changes.
     //
     // TODO(Asmaa): Retrun timestamp as price once we start mocking out time in the
     // tests.
     let price = format!("0x{DEFAULT_ETH_TO_FRI_RATE:x}");
-    let response = json!({ "timestamp": query.timestamp ,"price": price, "decimals": ETH_TO_STRK_QUANTIZATION });
+    let response =
+        json!({ "timestamp": query.timestamp ,"price": price, "decimals": EXCHANGE_RATE_DECIMALS });
     Json(response)
 }
 
 /// Spawns a local fake eth to fri oracle server.
 pub fn spawn_eth_to_strk_oracle_server(socket_address: SocketAddr) -> JoinHandle<()> {
     tokio::spawn(async move {
-        let router = Router::new().route(ETH_TO_STRK_ORACLE_PATH, get(get_price));
+        let router = Router::new().route(ETH_TO_STRK_ORACLE_PATH, get(get_rate));
         let listener = TcpListener::bind(socket_address).await.unwrap();
         serve(listener, router).await.unwrap();
     })