Light Client

A client library for interacting with Light Protocol compressed accounts and RPC endpoints.

For detailed documentation, visit zkcompression.com. For full program examples, see the Program Examples. For pinocchio solana program development see light-sdk-pinocchio. For rust client developement see light-client. For rust program testing see light-program-test. For local test validator with light system programs see Light CLI.

Features

• Connect to various RPC endpoints (local test validator, devnet/mainnet)
• Query compressed accounts and validity proofs from RPC endpoints
• Support for both v1 and v2 merkle trees (with v2 feature)
• Start local test validator with Light Protocol programs

Prerequisites

For local test validator usage, install the Light CLI:

npm i -g @lightprotocol/zk-compression-cli

Example

use light_client::{
    rpc::{LightClient, LightClientConfig, Rpc},
    indexer::{Indexer, IndexerRpcConfig, RetryConfig},
    local_test_validator::{spawn_validator, LightValidatorConfig},
};
use solana_pubkey::Pubkey;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Start local test validator with Light Protocol programs
    let config = LightValidatorConfig {
        enable_indexer: true,
        enable_prover: true,
        wait_time: 75,
        sbf_programs: vec![],
        upgradeable_programs: vec![],
        limit_ledger_size: None,
        use_surfpool: true,
        validator_args: vec![],
    };
    spawn_validator(config).await;

    // Connect to the validator
    let mut rpc = LightClient::new(LightClientConfig::local()).await?;

    // Or connect to devnet/mainnet (API key embedded in photon URL):
    // let mut rpc = LightClient::new(LightClientConfig::new(
    //     "https://devnet.helius-rpc.com".to_string(),
    //     Some("https://photon.helius.com?api-key=YOUR_KEY".to_string()),
    // )).await?;

    let owner = Pubkey::new_unique();

    // Create indexer config for queries
    let slot = rpc.get_slot().await?;
    let config = IndexerRpcConfig {
        slot,
        retry_config: RetryConfig::default(),
    };

    // Query compressed accounts using Indexer trait
    let accounts = rpc
        .get_compressed_accounts_by_owner(&owner, None, Some(config))
        .await?;

    println!("Found {} compressed accounts", accounts.value.items.len());

    // Get validity proofs for creating transactions
    let rpc_result = rpc
        .get_validity_proof(
            vec![], // add account hashes here
            vec![], // add addresses with address tree here
            None
        )
        .await?;

    println!("Got validity proof and proof inputs {:?}", rpc_result.value);

    Ok(())
}