light-program-test 0.23.0

#[cfg(feature = "devenv")]
use account_compression::{
    AddressMerkleTreeConfig, AddressQueueConfig, NullifierQueueConfig, StateMerkleTreeConfig,
};
#[cfg(feature = "devenv")]
use light_batched_merkle_tree::{
    initialize_address_tree::InitAddressTreeAccountsInstructionData,
    initialize_state_tree::InitStateTreeAccountsInstructionData,
};
#[cfg(feature = "devenv")]
use light_registry::protocol_config::state::ProtocolConfig;
use solana_sdk::pubkey::Pubkey;

use crate::logging::EnhancedLoggingConfig;

/// Configuration for Light Program Test
#[derive(Debug, Clone)]
pub struct ProgramTestConfig {
    pub additional_programs: Option<Vec<(&'static str, Pubkey)>>,
    #[cfg(feature = "devenv")]
    pub protocol_config: ProtocolConfig,
    pub with_prover: bool,
    #[cfg(feature = "devenv")]
    pub auto_register_custom_programs_for_pda_compression: bool,
    #[cfg(feature = "devenv")]
    pub skip_register_programs: bool,
    #[cfg(feature = "devenv")]
    pub skip_v1_trees: bool,
    #[cfg(feature = "devenv")]
    pub skip_second_v1_tree: bool,
    #[cfg(feature = "devenv")]
    pub v1_state_tree_config: StateMerkleTreeConfig,
    #[cfg(feature = "devenv")]
    pub v1_nullifier_queue_config: NullifierQueueConfig,
    #[cfg(feature = "devenv")]
    pub v1_address_tree_config: AddressMerkleTreeConfig,
    #[cfg(feature = "devenv")]
    pub v1_address_queue_config: AddressQueueConfig,
    #[cfg(feature = "devenv")]
    pub v2_state_tree_config: Option<InitStateTreeAccountsInstructionData>,
    #[cfg(feature = "devenv")]
    pub v2_address_tree_config: Option<InitAddressTreeAccountsInstructionData>,
    #[cfg(feature = "devenv")]
    pub skip_protocol_init: bool,
    /// Log failed transactions
    pub log_failed_tx: bool,
    /// Disable all logging
    pub no_logs: bool,
    /// Skip startup logs
    pub skip_startup_logs: bool,
    /// Register a forester for epoch 0 during setup
    pub with_forester: bool,
    /// Log Light Protocol events (BatchPublicTransactionEvent, etc.)
    pub log_light_protocol_events: bool,
    /// Enhanced transaction logging configuration
    pub enhanced_logging: EnhancedLoggingConfig,
}

impl ProgramTestConfig {
    pub fn new(
        with_prover: bool,
        additional_programs: Option<Vec<(&'static str, Pubkey)>>,
    ) -> Self {
        Self {
            additional_programs,
            with_prover,
            ..Default::default()
        }
    }

    #[cfg(feature = "v2")]
    pub fn new_v2(
        with_prover: bool,
        additional_programs: Option<Vec<(&'static str, Pubkey)>>,
    ) -> Self {
        Self {
            additional_programs,
            with_prover,
            #[cfg(feature = "devenv")]
            v2_state_tree_config: Some(InitStateTreeAccountsInstructionData::test_default()),
            #[cfg(feature = "devenv")]
            v2_address_tree_config: Some(InitAddressTreeAccountsInstructionData::test_default()),
            ..Default::default()
        }
    }

    #[cfg(feature = "devenv")]
    pub fn default_with_batched_trees(with_prover: bool) -> Self {
        Self {
            additional_programs: None,
            with_prover,
            v2_state_tree_config: Some(InitStateTreeAccountsInstructionData::test_default()),
            v2_address_tree_config: Some(InitAddressTreeAccountsInstructionData::test_default()),
            ..Default::default()
        }
    }

    #[cfg(feature = "devenv")]
    pub fn default_test_forester(with_prover: bool) -> Self {
        Self {
            additional_programs: None,
            with_prover,
            v2_state_tree_config: Some(InitStateTreeAccountsInstructionData::test_default()),
            v2_address_tree_config: Some(InitAddressTreeAccountsInstructionData::test_default()),
            ..Default::default()
        }
    }

    /// Enable Light Protocol event logging
    pub fn with_light_protocol_events(mut self) -> Self {
        self.log_light_protocol_events = true;
        self
    }

    /// Disable Light Protocol event logging
    pub fn without_light_protocol_events(mut self) -> Self {
        self.log_light_protocol_events = false;
        self
    }

    /// Register custom instruction decoders for enhanced logging
    ///
    /// This allows registering decoders generated by `#[derive(InstructionDecoder)]`
    /// or `#[instruction_decoder]` macros from `light-instruction-decoder-derive`.
    ///
    /// ## Example
    ///
    /// ```rust,ignore
    /// use light_instruction_decoder_derive::instruction_decoder;
    ///
    /// #[instruction_decoder(program_id = crate::ID)]
    /// #[program]
    /// pub mod my_program {
    ///     // ...
    /// }
    ///
    /// let config = ProgramTestConfig::new_v2(true, Some(vec![("my_program", program_id)]))
    ///     .with_decoders(vec![Box::new(MyProgramInstructionDecoder)]);
    /// ```
    pub fn with_decoders(
        mut self,
        decoders: Vec<Box<dyn crate::logging::InstructionDecoder>>,
    ) -> Self {
        self.enhanced_logging = self.enhanced_logging.with_decoders(decoders);
        self
    }
}

impl Default for ProgramTestConfig {
    fn default() -> Self {
        Self {
            additional_programs: None,
            #[cfg(feature = "devenv")]
            protocol_config: ProtocolConfig {
                // Init with an active epoch which doesn't end
                active_phase_length: 1_000_000_000,
                slot_length: 1_000_000_000 - 1,
                genesis_slot: 0,
                registration_phase_length: 2,
                ..Default::default()
            },
            with_prover: true,
            #[cfg(feature = "devenv")]
            auto_register_custom_programs_for_pda_compression: true,
            #[cfg(feature = "devenv")]
            skip_second_v1_tree: false,
            #[cfg(feature = "devenv")]
            skip_register_programs: false,
            #[cfg(feature = "devenv")]
            v1_state_tree_config: StateMerkleTreeConfig::default(),
            #[cfg(feature = "devenv")]
            v1_address_tree_config: AddressMerkleTreeConfig::default(),
            #[cfg(feature = "devenv")]
            v1_address_queue_config: AddressQueueConfig::default(),
            #[cfg(feature = "devenv")]
            v1_nullifier_queue_config: NullifierQueueConfig::default(),
            #[cfg(feature = "devenv")]
            v2_state_tree_config: None,
            #[cfg(feature = "devenv")]
            v2_address_tree_config: None,
            #[cfg(feature = "devenv")]
            skip_protocol_init: false,
            #[cfg(feature = "devenv")]
            skip_v1_trees: false,
            log_failed_tx: true,
            no_logs: false,
            skip_startup_logs: true,
            with_forester: true,
            log_light_protocol_events: false, // Disabled by default
            enhanced_logging: EnhancedLoggingConfig::from_env(),
        }
    }
}