light-client 0.23.0

Client library for Light Protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

use std::process::{Command, Stdio};

use light_prover_client::helpers::get_project_root;

/// Configuration for an upgradeable program to deploy to the validator.
#[derive(Debug, Clone)]
pub struct UpgradeableProgramConfig {
    /// The program ID (public key) of the program
    pub program_id: String,
    /// Path to the compiled program (.so file)
    pub program_path: String,
    /// The upgrade authority for the program
    pub upgrade_authority: String,
}

impl UpgradeableProgramConfig {
    pub fn new(program_id: String, program_path: String, upgrade_authority: String) -> Self {
        Self {
            program_id,
            program_path,
            upgrade_authority,
        }
    }
}

#[derive(Debug)]
pub struct LightValidatorConfig {
    pub enable_indexer: bool,
    pub enable_prover: bool,
    pub wait_time: u64,
    /// Non-upgradeable programs: (program_id, program_path)
    pub sbf_programs: Vec<(String, String)>,
    /// Upgradeable programs to deploy with a valid upgrade authority.
    /// Use this when the program needs a valid upgrade authority (e.g., for compression config).
    pub upgradeable_programs: Vec<UpgradeableProgramConfig>,
    pub limit_ledger_size: Option<u64>,
    /// Use surfpool instead of solana-test-validator
    pub use_surfpool: bool,
    /// Additional arguments to pass to the validator (e.g., "--account <ADDRESS> <FILEPATH>")
    pub validator_args: Vec<String>,
}

impl Default for LightValidatorConfig {
    fn default() -> Self {
        Self {
            enable_indexer: false,
            enable_prover: false,
            wait_time: 35,
            sbf_programs: vec![],
            upgradeable_programs: vec![],
            limit_ledger_size: None,
            use_surfpool: true,
            validator_args: vec![],
        }
    }
}

pub async fn spawn_validator(config: LightValidatorConfig) {
    if let Some(project_root) = get_project_root() {
        let path = "cli/test_bin/run test-validator";
        let mut path = format!("{}/{}", project_root.trim(), path);
        if !config.enable_indexer {
            path.push_str(" --skip-indexer");
        }

        if let Some(limit_ledger_size) = config.limit_ledger_size {
            path.push_str(&format!(" --limit-ledger-size {}", limit_ledger_size));
        }

        for sbf_program in config.sbf_programs.iter() {
            path.push_str(&format!(
                " --sbf-program {} {}",
                sbf_program.0, sbf_program.1
            ));
        }

        for upgradeable_program in config.upgradeable_programs.iter() {
            path.push_str(&format!(
                " --upgradeable-program {} {} {}",
                upgradeable_program.program_id,
                upgradeable_program.program_path,
                upgradeable_program.upgrade_authority
            ));
        }

        if !config.enable_prover {
            path.push_str(" --skip-prover");
        }

        if config.use_surfpool {
            path.push_str(" --use-surfpool");
        }

        for arg in config.validator_args.iter() {
            path.push_str(&format!(" {}", arg));
        }

        println!("Starting validator with command: {}", path);

        if config.use_surfpool {
            // The CLI starts surfpool, prover, and photon, then exits once all
            // services are ready. Wait for it to finish so we know everything
            // is up before the test proceeds.
            let mut child = Command::new("sh")
                .arg("-c")
                .arg(path)
                .stdin(Stdio::null())
                .stdout(Stdio::inherit())
                .stderr(Stdio::inherit())
                .spawn()
                .expect("Failed to start server process");
            let status = child.wait().expect("Failed to wait for CLI process");
            assert!(status.success(), "CLI exited with error: {}", status);
        } else {
            let child = Command::new("sh")
                .arg("-c")
                .arg(path)
                .stdin(Stdio::null())
                .stdout(Stdio::null())
                .stderr(Stdio::null())
                .spawn()
                .expect("Failed to start server process");
            std::mem::drop(child);
            tokio::time::sleep(tokio::time::Duration::from_secs(config.wait_time)).await;
        }
    }
}