chore: light client sdk cleanup (#1799)

ananas-block · web-flow · commit f98c74a482b5 · 2025-06-13T15:30:18.000-07:00
* test: add missing error to error codes test

* chore: rename RpcConfig -&gt; LightClientConfig

* chore: format, fix: light-program-test remove env variable modification during program setup

* feat: light program test skip startup logs

* fix: logging consistency
diff --git a/forester-utils/src/rpc_pool.rs b/forester-utils/src/rpc_pool.rs
@@ -2,7 +2,7 @@ use std::{cmp::min, time::Duration};
 
 use async_trait::async_trait;
 use bb8::{Pool, PooledConnection};
-use light_client::rpc::{Rpc, RpcConfig, RpcError};
+use light_client::rpc::{LightClientConfig, Rpc, RpcError};
 use solana_sdk::commitment_config::CommitmentConfig;
 use thiserror::Error;
 use tokio::time::sleep;
@@ -56,7 +56,7 @@ impl<R: Rpc + 'static> bb8::ManageConnection for SolanaConnectionManager<R> {
     type Error = PoolError;
 
     async fn connect(&self) -> Result<Self::Connection, Self::Error> {
-        let config = RpcConfig {
+        let config = LightClientConfig {
             url: self.url.to_string(),
             commitment_config: Some(self.commitment),
             with_indexer: false,
diff --git a/forester/src/epoch_manager.rs b/forester/src/epoch_manager.rs
@@ -16,7 +16,7 @@ use forester_utils::{
 use futures::future::join_all;
 use light_client::{
     indexer::{Indexer, MerkleProof, NewAddressProofWithContext},
-    rpc::{LightClient, RetryConfig, Rpc, RpcConfig, RpcError},
+    rpc::{LightClient, LightClientConfig, RetryConfig, Rpc, RpcError},
 };
 use light_compressed_account::TreeType;
 use light_registry::{
@@ -473,7 +473,7 @@ impl<R: Rpc, I: Indexer + IndexerType<R> + 'static> EpochManager<R, I> {
         max_retries: u32,
         retry_delay: Duration,
     ) -> Result<ForesterEpochInfo> {
-        let rpc = LightClient::new(RpcConfig {
+        let rpc = LightClient::new(LightClientConfig {
             url: self.config.external_services.rpc_url.to_string(),
             commitment_config: None,
             fetch_active_tree: false,
@@ -543,7 +543,7 @@ impl<R: Rpc, I: Indexer + IndexerType<R> + 'static> EpochManager<R, I> {
     ))]
     async fn register_for_epoch(&self, epoch: u64) -> Result<ForesterEpochInfo> {
         info!("Registering for epoch: {}", epoch);
-        let mut rpc = LightClient::new(RpcConfig {
+        let mut rpc = LightClient::new(LightClientConfig {
             url: self.config.external_services.rpc_url.to_string(),
             commitment_config: None,
             fetch_active_tree: false,
@@ -1196,7 +1196,7 @@ impl<R: Rpc, I: Indexer + IndexerType<R> + 'static> EpochManager<R, I> {
     ))]
     async fn report_work(&self, epoch_info: &ForesterEpochInfo) -> Result<()> {
         info!("Reporting work");
-        let mut rpc = LightClient::new(RpcConfig {
+        let mut rpc = LightClient::new(LightClientConfig {
             url: self.config.external_services.rpc_url.to_string(),
             commitment_config: None,
             fetch_active_tree: false,
diff --git a/forester/src/forester_status.rs b/forester/src/forester_status.rs
@@ -3,7 +3,7 @@ use std::sync::Arc;
 use anchor_lang::{AccountDeserialize, Discriminator};
 use forester_utils::forester_epoch::{get_epoch_phases, TreeAccounts};
 use itertools::Itertools;
-use light_client::rpc::{LightClient, Rpc, RpcConfig};
+use light_client::rpc::{LightClient, LightClientConfig, Rpc};
 use light_compressed_account::TreeType;
 use light_registry::{protocol_config::state::ProtocolConfigPda, EpochPda, ForesterEpochPda};
 use solana_program::{clock::Slot, pubkey::Pubkey};
@@ -173,7 +173,7 @@ pub async fn fetch_forester_status(args: &StatusArgs) {
 
     debug!("Fetching trees...");
     debug!("RPC URL: {}", config.external_services.rpc_url);
-    let mut rpc = LightClient::new(RpcConfig {
+    let mut rpc = LightClient::new(LightClientConfig {
         url: config.external_services.rpc_url.to_string(),
         commitment_config: None,
         fetch_active_tree: false,
diff --git a/forester/src/lib.rs b/forester/src/lib.rs
@@ -29,7 +29,7 @@ use forester_utils::{
 };
 use light_client::{
     indexer::Indexer,
-    rpc::{LightClient, Rpc, RpcConfig},
+    rpc::{LightClient, LightClientConfig, Rpc},
 };
 use light_compressed_account::TreeType;
 use solana_sdk::commitment_config::CommitmentConfig;
@@ -51,7 +51,7 @@ pub async fn run_queue_info(
     trees: Vec<TreeAccounts>,
     queue_type: TreeType,
 ) {
-    let mut rpc = LightClient::new(RpcConfig {
+    let mut rpc = LightClient::new(LightClientConfig {
         url: config.external_services.rpc_url.to_string(),
         commitment_config: None,
         fetch_active_tree: false,
diff --git a/forester/tests/address_v2_test.rs b/forester/tests/address_v2_test.rs
@@ -10,7 +10,7 @@ use light_batched_merkle_tree::{
 use light_client::{
     indexer::{photon_indexer::PhotonIndexer, AddressWithTree},
     local_test_validator::{LightValidatorConfig, ProverConfig},
-    rpc::{client::RpcUrl, merkle_tree::MerkleTreeExt, LightClient, Rpc, RpcConfig},
+    rpc::{client::RpcUrl, merkle_tree::MerkleTreeExt, LightClient, LightClientConfig, Rpc},
 };
 use light_compressed_account::{
     address::derive_address,
@@ -70,7 +70,7 @@ async fn test_create_v2_address() {
     config.derivation_pubkey = env.protocol.forester.pubkey();
     config.general_config = GeneralConfig::test_address_v2();
 
-    let mut rpc = LightClient::new(RpcConfig {
+    let mut rpc = LightClient::new(LightClientConfig {
         url: RpcUrl::Localnet.to_string(),
         commitment_config: Some(CommitmentConfig::processed()),
         fetch_active_tree: false,
diff --git a/forester/tests/batched_address_test.rs b/forester/tests/batched_address_test.rs
@@ -12,7 +12,7 @@ use light_batched_merkle_tree::{
 use light_client::{
     indexer::{photon_indexer::PhotonIndexer, AddressMerkleTreeAccounts, Indexer},
     local_test_validator::{LightValidatorConfig, ProverConfig},
-    rpc::{client::RpcUrl, LightClient, Rpc, RpcConfig},
+    rpc::{client::RpcUrl, LightClient, LightClientConfig, Rpc},
 };
 use light_program_test::{accounts::test_accounts::TestAccounts, indexer::TestIndexer};
 use light_test_utils::{
@@ -63,7 +63,7 @@ async fn test_address_batched() {
         .unwrap();
 
     let commitment_config = CommitmentConfig::confirmed();
-    let mut rpc = LightClient::new(RpcConfig {
+    let mut rpc = LightClient::new(LightClientConfig {
         url: RpcUrl::Localnet.to_string(),
         commitment_config: Some(commitment_config),
         fetch_active_tree: false,
diff --git a/forester/tests/batched_state_async_indexer_test.rs b/forester/tests/batched_state_async_indexer_test.rs
@@ -12,7 +12,7 @@ use light_client::{
         GetCompressedTokenAccountsByOwnerOrDelegateOptions, Indexer,
     },
     local_test_validator::{LightValidatorConfig, ProverConfig},
-    rpc::{client::RpcUrl, LightClient, Rpc, RpcConfig},
+    rpc::{client::RpcUrl, LightClient, LightClientConfig, Rpc},
 };
 use light_compressed_account::{
     address::derive_address_legacy,
@@ -222,7 +222,7 @@ async fn test_state_indexer_async_batched() {
 // ─────────────────────────────────────────────────────────────────────────────
 
 async fn setup_rpc_connection(forester: &Keypair) -> LightClient {
-    let mut rpc = LightClient::new(RpcConfig {
+    let mut rpc = LightClient::new(LightClientConfig {
         url: RpcUrl::Localnet.to_string(),
         commitment_config: Some(CommitmentConfig::processed()),
         fetch_active_tree: false,
diff --git a/forester/tests/batched_state_indexer_test.rs b/forester/tests/batched_state_indexer_test.rs
@@ -12,7 +12,7 @@ use light_batched_merkle_tree::{
 use light_client::{
     indexer::{photon_indexer::PhotonIndexer, Indexer, IndexerRpcConfig, RetryConfig},
     local_test_validator::{LightValidatorConfig, ProverConfig},
-    rpc::{client::RpcUrl, LightClient, Rpc, RpcConfig},
+    rpc::{client::RpcUrl, LightClient, LightClientConfig, Rpc},
 };
 use light_compressed_account::TreeType;
 use light_program_test::{accounts::test_accounts::TestAccounts, indexer::TestIndexer};
@@ -62,7 +62,7 @@ async fn test_state_indexer_batched() {
         .unwrap();
 
     let commitment_config = CommitmentConfig::confirmed();
-    let mut rpc = LightClient::new(RpcConfig {
+    let mut rpc = LightClient::new(LightClientConfig {
         url: RpcUrl::Localnet.to_string(),
         fetch_active_tree: false,
         commitment_config: Some(commitment_config),
diff --git a/forester/tests/batched_state_test.rs b/forester/tests/batched_state_test.rs
@@ -11,7 +11,7 @@ use light_batched_merkle_tree::{
 };
 use light_client::{
     local_test_validator::{LightValidatorConfig, ProverConfig},
-    rpc::{client::RpcUrl, LightClient, Rpc, RpcConfig},
+    rpc::{client::RpcUrl, LightClient, LightClientConfig, Rpc},
 };
 use light_compressed_account::TreeType;
 use light_program_test::{accounts::test_accounts::TestAccounts, indexer::TestIndexer};
@@ -67,7 +67,7 @@ async fn test_state_batched() {
         .unwrap();
 
     let commitment_config = CommitmentConfig::confirmed();
-    let mut rpc = LightClient::new(RpcConfig {
+    let mut rpc = LightClient::new(LightClientConfig {
         url: RpcUrl::Localnet.to_string(),
         commitment_config: Some(commitment_config),
         fetch_active_tree: false,
diff --git a/forester/tests/e2e_test.rs b/forester/tests/e2e_test.rs
@@ -12,7 +12,7 @@ use forester_utils::{
 use light_client::{
     indexer::{AddressMerkleTreeAccounts, StateMerkleTreeAccounts},
     local_test_validator::{LightValidatorConfig, ProverConfig},
-    rpc::{client::RpcUrl, LightClient, Rpc, RpcConfig, RpcError},
+    rpc::{client::RpcUrl, LightClient, LightClientConfig, Rpc, RpcError},
 };
 use light_program_test::{accounts::test_accounts::TestAccounts, indexer::TestIndexer};
 use light_registry::{utils::get_forester_epoch_pda_from_authority, ForesterEpochPda};
@@ -60,7 +60,7 @@ async fn test_epoch_monitor_with_2_foresters() {
         .await
         .unwrap();
 
-    let mut rpc = LightClient::new(RpcConfig {
+    let mut rpc = LightClient::new(LightClientConfig {
         url: RpcUrl::Localnet.to_string(),
         commitment_config: Some(CommitmentConfig::confirmed()),
         fetch_active_tree: false,
@@ -408,7 +408,7 @@ async fn test_epoch_double_registration() {
         .await
         .unwrap();
 
-    let mut rpc = LightClient::new(RpcConfig {
+    let mut rpc = LightClient::new(LightClientConfig {
         url: RpcUrl::Localnet.to_string(),
         commitment_config: Some(CommitmentConfig::confirmed()),
         fetch_active_tree: false,
diff --git a/forester/tests/priority_fee_test.rs b/forester/tests/priority_fee_test.rs
@@ -6,7 +6,7 @@ use forester::{
     },
     ForesterConfig,
 };
-use light_client::rpc::{LightClient, Rpc, RpcConfig};
+use light_client::rpc::{LightClient, LightClientConfig, Rpc};
 use light_test_utils::RpcUrl;
 use reqwest::Url;
 use solana_sdk::{commitment_config::CommitmentConfig, signature::Signer};
@@ -79,7 +79,7 @@ async fn test_priority_fee_request() {
     let config = ForesterConfig::new_for_start(&args).expect("Failed to create config");
 
     // Setup RPC connection using config
-    let mut rpc = LightClient::new(RpcConfig {
+    let mut rpc = LightClient::new(LightClientConfig {
         url: RpcUrl::Localnet.to_string(),
         commitment_config: Some(CommitmentConfig::confirmed()),
         fetch_active_tree: false,
diff --git a/program-tests/client-test/tests/light_client.rs b/program-tests/client-test/tests/light_client.rs
@@ -4,7 +4,7 @@ use light_client::{
         IndexerRpcConfig, PaginatedOptions, RetryConfig,
     },
     local_test_validator::{spawn_validator, LightValidatorConfig},
-    rpc::{LightClient, RpcConfig},
+    rpc::{LightClient, LightClientConfig},
 };
 use light_compressed_account::hash_to_bn254_field_size_be;
 use light_compressed_token::mint_sdk::{
@@ -59,7 +59,7 @@ async fn test_all_endpoints() {
     spawn_validator(config).await;
 
     let test_accounts = TestAccounts::get_local_test_validator_accounts();
-    let mut rpc: LightClient = LightClient::new(RpcConfig::local()).await.unwrap();
+    let mut rpc: LightClient = LightClient::new(LightClientConfig::local()).await.unwrap();
 
     let payer_pubkey = rpc.get_payer().pubkey();
     rpc.airdrop_lamports(&payer_pubkey, 10 * LAMPORTS_PER_SOL)
diff --git a/program-tests/client-test/tests/sdk_compat.rs b/program-tests/client-test/tests/sdk_compat.rs
@@ -34,6 +34,7 @@ fn generate_all_solana_errors() -> Vec<SolanaLightSdkError> {
         SolanaLightSdkError::MetaMutOutputIsNone,
         SolanaLightSdkError::MetaCloseAddressIsNone,
         SolanaLightSdkError::MetaCloseInputIsNone,
+        SolanaLightSdkError::CpiAccountsIndexOutOfBounds(1),
         SolanaLightSdkError::Hasher(HasherError::IntegerOverflow),
         SolanaLightSdkError::ZeroCopy(ZeroCopyError::Full),
     ]
@@ -70,6 +71,7 @@ fn generate_all_pinocchio_errors() -> Vec<PinocchioLightSdkError> {
         PinocchioLightSdkError::MetaMutOutputIsNone,
         PinocchioLightSdkError::MetaCloseAddressIsNone,
         PinocchioLightSdkError::MetaCloseInputIsNone,
+        PinocchioLightSdkError::CpiAccountsIndexOutOfBounds(1),
         PinocchioLightSdkError::Hasher(HasherError::IntegerOverflow),
         PinocchioLightSdkError::ZeroCopy(ZeroCopyError::Full),
     ]
diff --git a/program-tests/compressed-token-test/tests/test.rs b/program-tests/compressed-token-test/tests/test.rs
@@ -15,7 +15,7 @@ use forester_utils::{instructions::create_account_instruction, utils::airdrop_la
 use light_client::{
     indexer::Indexer,
     local_test_validator::{spawn_validator, LightValidatorConfig},
-    rpc::RpcConfig,
+    rpc::LightClientConfig,
 };
 use light_compressed_account::{
     compressed_account::{CompressedAccountWithMerkleContext, MerkleContext},
@@ -5493,7 +5493,7 @@ async fn test_transfer_with_photon_and_batched_tree() {
     })
     .await;
 
-    let mut rpc = LightClient::new(RpcConfig::local_no_indexer())
+    let mut rpc = LightClient::new(LightClientConfig::local_no_indexer())
         .await
         .unwrap();
     let env = TestAccounts::get_local_test_validator_accounts();
diff --git a/program-tests/registry-test/tests/tests.rs b/program-tests/registry-test/tests/tests.rs
@@ -21,7 +21,7 @@ use light_batched_merkle_tree::{
     merkle_tree_metadata::{BatchedMerkleTreeMetadata, CreateTreeParams},
     queue::BatchedQueueAccount,
 };
-use light_client::{indexer::Indexer, rpc::RpcConfig};
+use light_client::{indexer::Indexer, rpc::LightClientConfig};
 use light_compressed_account::TreeType;
 use light_hasher::Poseidon;
 use light_program_test::{
@@ -1283,7 +1283,7 @@ async fn failing_test_forester() {
 #[tokio::test(flavor = "multi_thread", worker_threads = 1)]
 async fn update_forester_on_testnet() {
     let test_accounts = TestAccounts::get_program_test_test_accounts();
-    let mut rpc = LightClient::new(RpcConfig::local_no_indexer())
+    let mut rpc = LightClient::new(LightClientConfig::local_no_indexer())
         .await
         .unwrap();
     rpc.airdrop_lamports(
@@ -1327,7 +1327,7 @@ async fn update_forester_on_testnet() {
 #[tokio::test(flavor = "multi_thread", worker_threads = 1)]
 async fn update_registry_governance_on_testnet() {
     let test_accounts = TestAccounts::get_program_test_test_accounts();
-    let mut rpc = LightClient::new(RpcConfig::local_no_indexer())
+    let mut rpc = LightClient::new(LightClientConfig::local_no_indexer())
         .await
         .unwrap();
     rpc.airdrop_lamports(
diff --git a/program-tests/system-cpi-v2-test/tests/event.rs b/program-tests/system-cpi-v2-test/tests/event.rs
@@ -7,7 +7,7 @@ use create_address_test_program::create_invoke_cpi_instruction;
 use light_client::{
     indexer::{AddressWithTree, Indexer},
     local_test_validator::{spawn_validator, LightValidatorConfig},
-    rpc::RpcConfig,
+    rpc::LightClientConfig,
 };
 use light_compressed_account::{
     address::{derive_address, derive_address_legacy},
@@ -541,7 +541,7 @@ async fn generate_photon_test_data_multiple_events() {
         })
         .await;
 
-        let mut rpc = LightClient::new(RpcConfig::local_no_indexer())
+        let mut rpc = LightClient::new(LightClientConfig::local_no_indexer())
             .await
             .unwrap();
         let env = TestAccounts::get_local_test_validator_accounts();
diff --git a/program-tests/utils/src/setup_accounts.rs b/program-tests/utils/src/setup_accounts.rs
@@ -7,10 +7,10 @@ use light_program_test::{
 };
 
 pub async fn setup_accounts(keypairs: TestKeypairs, url: RpcUrl) -> Result<TestAccounts, RpcError> {
-    use light_client::rpc::RpcConfig;
+    use light_client::rpc::LightClientConfig;
     use solana_sdk::commitment_config::CommitmentConfig;
 
-    let mut rpc = light_client::rpc::LightClient::new(RpcConfig {
+    let mut rpc = light_client::rpc::LightClient::new(LightClientConfig {
         commitment_config: Some(CommitmentConfig::confirmed()),
         url: url.to_string(),
         with_indexer: false,
diff --git a/sdk-libs/client/src/lib.rs b/sdk-libs/client/src/lib.rs
@@ -19,7 +19,7 @@
 //!
 //! ```no_run
 //! use light_client::{
-//!     rpc::{LightClient, RpcConfig, Rpc},
+//!     rpc::{LightClient, LightClientConfig, Rpc},
 //!     indexer::{Indexer, IndexerRpcConfig, RetryConfig},
 //!     local_test_validator::{spawn_validator, LightValidatorConfig},
 //! };
@@ -39,11 +39,11 @@
 //!     spawn_validator(config).await;
 //!
 //!     // Connect to the validator
-//!     let mut rpc = LightClient::new(RpcConfig::local()).await?;
+//!     let mut rpc = LightClient::new(LightClientConfig::local()).await?;
 //!
 //!     // Or connect to devnet/mainnet:
-//!     // let mut rpc = LightClient::new(RpcConfig::new("https://devnet.helius-rpc.com/?api-key=YOUR_KEY")).await?;
-//!     // let mut rpc = LightClient::new(RpcConfig::new("https://mainnet.helius-rpc.com/?api-key=YOUR_KEY")).await?;
+//!     // let mut rpc = LightClient::new(LightClientConfig::new("https://devnet.helius-rpc.com/?api-key=YOUR_KEY")).await?;
+//!     // let mut rpc = LightClient::new(LightClientConfig::new("https://mainnet.helius-rpc.com/?api-key=YOUR_KEY")).await?;
 //!
 //!     let owner = Pubkey::new_unique();
 //!
diff --git a/sdk-libs/client/src/rpc/client.rs b/sdk-libs/client/src/rpc/client.rs
@@ -30,7 +30,7 @@ use solana_transaction_status_client_types::{
 use tokio::time::{sleep, Instant};
 use tracing::warn;
 
-use super::RpcConfig;
+use super::LightClientConfig;
 use crate::{
     indexer::{photon_indexer::PhotonIndexer, Indexer, TreeInfo},
     rpc::{
@@ -100,7 +100,7 @@ impl Debug for LightClient {
 
 impl LightClient {
     pub async fn new_with_retry(
-        config: RpcConfig,
+        config: LightClientConfig,
         retry_config: Option<RetryConfig>,
     ) -> Result<Self, RpcError> {
         let payer = Keypair::new();
@@ -429,7 +429,7 @@ impl LightClient {
 
 #[async_trait]
 impl Rpc for LightClient {
-    async fn new(config: RpcConfig) -> Result<Self, RpcError>
+    async fn new(config: LightClientConfig) -> Result<Self, RpcError>
     where
         Self: Sized,
     {
diff --git a/sdk-libs/client/src/rpc/mod.rs b/sdk-libs/client/src/rpc/mod.rs
@@ -7,5 +7,5 @@ pub mod state;
 
 pub use client::{LightClient, RetryConfig};
 pub use errors::RpcError;
-pub use rpc_trait::{Rpc, RpcConfig};
+pub use rpc_trait::{LightClientConfig, Rpc};
 pub mod get_light_state_tree_infos;
diff --git a/sdk-libs/client/src/rpc/rpc_trait.rs b/sdk-libs/client/src/rpc/rpc_trait.rs
diff --git a/sdk-libs/program-test/src/program_test/config.rs b/sdk-libs/program-test/src/program_test/config.rs
diff --git a/sdk-libs/program-test/src/program_test/light_program_test.rs b/sdk-libs/program-test/src/program_test/light_program_test.rs
diff --git a/sdk-libs/program-test/src/program_test/rpc.rs b/sdk-libs/program-test/src/program_test/rpc.rs
diff --git a/sdk-libs/program-test/src/utils/setup_light_programs.rs b/sdk-libs/program-test/src/utils/setup_light_programs.rs
diff --git a/xtask/src/create_batch_state_tree.rs b/xtask/src/create_batch_state_tree.rs
diff --git a/xtask/src/create_state_tree.rs b/xtask/src/create_state_tree.rs
diff --git a/xtask/src/create_update_protocol_config_ix.rs b/xtask/src/create_update_protocol_config_ix.rs
diff --git a/xtask/src/new_deployment.rs b/xtask/src/new_deployment.rs
