feat: forester: add PHOTON_API_KEY .env var support (#1031)

sergeytimoshin · web-flow · commit 5760575f2fbd · 2024-07-25T18:32:49.000+01:00
* Add Photon API key support

* Change 'photon_api_key' to Optional

* Refactor API key appending for cleanliness
diff --git a/forester/src/external_services_config.rs b/forester/src/external_services_config.rs
@@ -4,5 +4,6 @@ pub struct ExternalServicesConfig {
     pub ws_rpc_url: String,
     pub indexer_url: String,
     pub prover_url: String,
+    pub photon_api_key: Option<String>,
     pub derivation: String,
 }
diff --git a/forester/src/indexer/photon_indexer.rs b/forester/src/indexer/photon_indexer.rs
@@ -3,7 +3,7 @@ use account_compression::initialize_address_merkle_tree::Pubkey;
 use light_test_utils::indexer::{Indexer, IndexerError, MerkleProof, NewAddressProofWithContext};
 use light_test_utils::rpc::rpc_connection::RpcConnection;
 use log::{debug, info};
-use photon_api::apis::configuration::Configuration;
+use photon_api::apis::configuration::{ApiKey, Configuration};
 use photon_api::models::GetCompressedAccountsByOwnerPostRequestParams;
 use solana_sdk::bs58;
 use std::fmt::Debug;
@@ -14,9 +14,13 @@ pub struct PhotonIndexer<R: RpcConnection> {
 }
 
 impl<R: RpcConnection> PhotonIndexer<R> {
-    pub fn new(path: String, rpc: R) -> Self {
+    pub fn new(path: String, api_key: Option<String>, rpc: R) -> Self {
         let configuration = Configuration {
             base_path: path,
+            api_key: api_key.map(|key| ApiKey {
+                prefix: Some("api-key".to_string()),
+                key,
+            }),
             ..Default::default()
         };
 
diff --git a/forester/src/main.rs b/forester/src/main.rs
@@ -236,6 +236,7 @@ async fn run_subscribe_state<R: RpcConnection>(
     let indexer_rpc = R::new(config.external_services.rpc_url.to_string(), None);
     let indexer = Arc::new(tokio::sync::Mutex::new(PhotonIndexer::new(
         config.external_services.indexer_url.to_string(),
+        config.external_services.photon_api_key.clone(),
         indexer_rpc,
     )));
 
@@ -251,6 +252,7 @@ async fn run_subscribe_addresses<R: RpcConnection>(
     let indexer_rpc = R::new(config.external_services.rpc_url.to_string(), None);
     let indexer = Arc::new(tokio::sync::Mutex::new(PhotonIndexer::new(
         config.external_services.indexer_url.to_string(),
+        config.external_services.photon_api_key.clone(),
         indexer_rpc,
     )));
 
@@ -266,6 +268,7 @@ async fn run_nullify_addresses<R: RpcConnection>(
     let indexer_rpc = R::new(config.external_services.rpc_url.to_string(), None);
     let indexer = Arc::new(tokio::sync::Mutex::new(PhotonIndexer::new(
         config.external_services.indexer_url.to_string(),
+        config.external_services.photon_api_key.clone(),
         indexer_rpc,
     )));
 
@@ -281,6 +284,7 @@ async fn run_nullify_state<R: RpcConnection>(
     let indexer_rpc = R::new(config.external_services.rpc_url.to_string(), None);
     let indexer = Arc::new(tokio::sync::Mutex::new(PhotonIndexer::new(
         config.external_services.indexer_url.to_string(),
+        config.external_services.photon_api_key.clone(),
         indexer_rpc,
     )));
     nullify_state(config.clone(), rpc_pool, indexer, tree_data, rollover_state).await;
diff --git a/forester/src/settings.rs b/forester/src/settings.rs
@@ -20,6 +20,7 @@ pub enum SettingsKey {
     ConcurrencyLimit,
     CULimit,
     RpcPoolSize,
+    PhotonApiKey,
 }
 
 impl Display for SettingsKey {
@@ -33,6 +34,7 @@ impl Display for SettingsKey {
                 SettingsKey::WsRpcUrl => "WS_RPC_URL",
                 SettingsKey::IndexerUrl => "INDEXER_URL",
                 SettingsKey::ProverUrl => "PROVER_URL",
+                SettingsKey::PhotonApiKey => "PHOTON_API_KEY",
                 SettingsKey::ConcurrencyLimit => "CONCURRENCY_LIMIT",
                 SettingsKey::BatchSize => "PHOTON_BATCH_SIZE",
                 SettingsKey::MaxRetries => "MAX_RETRIES",
@@ -90,6 +92,9 @@ pub fn init_config() -> ForesterConfig {
     let prover_url = settings
         .get_string(&SettingsKey::ProverUrl.to_string())
         .expect("PROVER_URL not found in config file or environment variables");
+    let photon_api_key = settings
+        .get_string(&SettingsKey::PhotonApiKey.to_string())
+        .ok();
     let concurrency_limit = settings
         .get_int(&SettingsKey::ConcurrencyLimit.to_string())
         .expect("CONCURRENCY_LIMIT not found in config file or environment variables");
@@ -107,6 +112,7 @@ pub fn init_config() -> ForesterConfig {
             ws_rpc_url,
             indexer_url,
             prover_url,
+            photon_api_key,
             derivation: payer.pubkey().to_string(),
         },
         registry_pubkey: Pubkey::from_str(&registry_pubkey).unwrap(),
diff --git a/forester/tests/interop_address_test.rs b/forester/tests/interop_address_test.rs
@@ -59,6 +59,7 @@ async fn test_photon_interop_address() {
     let indexer_rpc = SolanaRpcConnection::new(forester_config.external_services.rpc_url, None);
     let photon_indexer = PhotonIndexer::new(
         forester_config.external_services.indexer_url.to_string(),
+        forester_config.external_services.photon_api_key.clone(),
         indexer_rpc,
     );
 
diff --git a/forester/tests/interop_nullify_test.rs b/forester/tests/interop_nullify_test.rs
@@ -60,7 +60,11 @@ async fn test_photon_interop_nullify_account() {
     .await;
 
     let rpc = SolanaRpcConnection::new(SolanaRpcUrl::Localnet, None);
-    let photon_indexer = PhotonIndexer::new(forester_config.external_services.indexer_url, rpc);
+    let photon_indexer = PhotonIndexer::new(
+        forester_config.external_services.indexer_url,
+        forester_config.external_services.photon_api_key,
+        rpc,
+    );
     let user_index = 0;
     let balance = env
         .rpc
diff --git a/forester/tests/test_utils.rs b/forester/tests/test_utils.rs
@@ -81,6 +81,7 @@ pub fn forester_config() -> ForesterConfig {
             ws_rpc_url: "ws://localhost:8900".to_string(),
             indexer_url: "http://localhost:8784".to_string(),
             prover_url: "http://localhost:3001".to_string(),
+            photon_api_key: None,
             derivation: "En9a97stB3Ek2n6Ey3NJwCUJnmTzLMMEA5C69upGDuQP".to_string(),
         },
         registry_pubkey: registry_keypair.pubkey(),
diff --git a/photon-api/src/apis/default_api.rs b/photon-api/src/apis/default_api.rs
@@ -9,6 +9,7 @@
  */
 
 use super::{configuration, Error};
+use crate::apis::configuration::Configuration;
 use crate::{apis::ResponseContent, models};
 use log::info;
 use reqwest;
@@ -220,6 +221,8 @@ pub async fn get_compressed_account_post(
     let local_var_client = &local_var_configuration.client;
 
     let local_var_uri_str = format!("{}/getCompressedAccount", local_var_configuration.base_path);
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -264,6 +267,8 @@ pub async fn get_compressed_account_proof_post(
         "{}/getCompressedAccountProof",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -308,6 +313,8 @@ pub async fn get_compressed_accounts_by_owner_post(
         "{}/getCompressedAccountsByOwner",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -351,6 +358,8 @@ pub async fn get_compressed_balance_by_owner_post(
         "{}/getCompressedBalanceByOwner",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -390,6 +399,8 @@ pub async fn get_compressed_balance_post(
     let local_var_client = &local_var_configuration.client;
 
     let local_var_uri_str = format!("{}/getCompressedBalance", local_var_configuration.base_path);
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -434,6 +445,8 @@ pub async fn get_compressed_token_account_balance_post(
         "{}/getCompressedTokenAccountBalance",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -479,6 +492,8 @@ pub async fn get_compressed_token_accounts_by_delegate_post(
         "{}/getCompressedTokenAccountsByDelegate",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -524,6 +539,8 @@ pub async fn get_compressed_token_accounts_by_owner_post(
         "{}/getCompressedTokenAccountsByOwner",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -569,6 +586,8 @@ pub async fn get_compressed_token_balances_by_owner_post(
         "{}/getCompressedTokenBalancesByOwner",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -614,6 +633,8 @@ pub async fn get_compression_signatures_for_account_post(
         "{}/getCompressionSignaturesForAccount",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -659,6 +680,8 @@ pub async fn get_compression_signatures_for_address_post(
         "{}/getCompressionSignaturesForAddress",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -704,6 +727,8 @@ pub async fn get_compression_signatures_for_owner_post(
         "{}/getCompressionSignaturesForOwner",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -749,6 +774,8 @@ pub async fn get_compression_signatures_for_token_owner_post(
         "{}/getCompressionSignaturesForTokenOwner",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -788,6 +815,8 @@ pub async fn get_indexer_health_post(
     let local_var_client = &local_var_configuration.client;
 
     let local_var_uri_str = format!("{}/getIndexerHealth", local_var_configuration.base_path);
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -826,6 +855,8 @@ pub async fn get_indexer_slot_post(
     let local_var_client = &local_var_configuration.client;
 
     let local_var_uri_str = format!("{}/getIndexerSlot", local_var_configuration.base_path);
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -870,6 +901,8 @@ pub async fn get_latest_compression_signatures_post(
         "{}/getLatestCompressionSignatures",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -915,6 +948,8 @@ pub async fn get_latest_non_voting_signatures_post(
         "{}/getLatestNonVotingSignatures",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -960,13 +995,16 @@ pub async fn get_multiple_compressed_account_proofs_post(
         "{}/getMultipleCompressedAccountProofs",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
     if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
         local_var_req_builder =
             local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
     }
+
     local_var_req_builder =
         local_var_req_builder.json(&get_multiple_compressed_account_proofs_post_request);
 
@@ -1005,6 +1043,8 @@ pub async fn get_multiple_compressed_accounts_post(
         "{}/getMultipleCompressedAccounts",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -1050,6 +1090,13 @@ pub async fn get_multiple_new_address_proofs_post(
         "{}/getMultipleNewAddressProofs",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
+    info!(
+        "get_multiple_new_address_proofs_post uri: {}",
+        local_var_uri_str
+    );
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -1061,6 +1108,12 @@ pub async fn get_multiple_new_address_proofs_post(
         local_var_req_builder.json(&get_multiple_new_address_proofs_post_request);
 
     let local_var_req = local_var_req_builder.build()?;
+
+    info!(
+        "get_multiple_new_address_proofs_post request: {:?}",
+        local_var_req
+    );
+
     let local_var_resp = local_var_client.execute(local_var_req).await?;
 
     let local_var_status = local_var_resp.status();
@@ -1095,6 +1148,8 @@ pub async fn get_transaction_with_compression_info_post(
         "{}/getTransactionWithCompressionInfo",
         local_var_configuration.base_path
     );
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -1134,6 +1189,8 @@ pub async fn get_validity_proof_post(
     let local_var_client = &local_var_configuration.client;
 
     let local_var_uri_str = format!("{}/getValidityProof", local_var_configuration.base_path);
+    let local_var_uri_str = append_api_key(local_var_configuration, &local_var_uri_str);
+
     let mut local_var_req_builder =
         local_var_client.request(reqwest::Method::POST, local_var_uri_str.as_str());
 
@@ -1162,3 +1219,12 @@ pub async fn get_validity_proof_post(
         Err(Error::ResponseError(local_var_error))
     }
 }
+
+fn append_api_key(configuration: &Configuration, uri_str: &str) -> String {
+    let mut uri_str = uri_str.to_string();
+    if let Some(ref api_key) = configuration.api_key {
+        let prefix = api_key.prefix.clone().unwrap_or("api-key".to_string());
+        uri_str = format!("{}?{}={}", uri_str, prefix, api_key.key);
+    }
+    uri_str
+}

Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,6 @@ pub struct ExternalServicesConfig {`
`4`	`4`	`pub ws_rpc_url: String,`
`5`	`5`	`pub indexer_url: String,`
`6`	`6`	`pub prover_url: String,`
	`7`	`+ pub photon_api_key: Option<String>,`
`7`	`8`	`pub derivation: String,`
`8`	`9`	`}`