Struct LightSystemProgramCpi 

pub struct LightSystemProgramCpi { /* private fields */ }

Light system program CPI instruction data builder.

Use this builder to construct instructions for compressed account operations: creating, updating, closing accounts, and compressing/decompressing SOL.

Builder Methods

Common Methods

• with_light_account() - Add a compressed account (handles output hashing, and type conversion to instruction data)
• with_new_addresses() - Create new compressed account addresses
• compress_lamports() - Compress SOL into compressed accounts
• decompress_lamports() - Decompress SOL from compressed accounts

Note: An instruction can either compress or decompress lamports, not both.

Advanced Methods

For fine-grained control, use these low-level methods instead of with_light_account():

• with_input_compressed_accounts_with_merkle_context() - Manually specify input accounts
• with_output_compressed_accounts() - Manually specify output accounts

Examples

Create a compressed account with an address

LightSystemProgramCpi::new_cpi(LIGHT_CPI_SIGNER, proof)
    .with_new_addresses(&[new_address_params])
    .with_light_account(account)?
    .invoke(cpi_accounts)?;

Update a compressed account

LightSystemProgramCpi::new_cpi(LIGHT_CPI_SIGNER, proof)
    .with_light_account(account)?
    .invoke(cpi_accounts)?;

Implementations

impl LightSystemProgramCpi

pub fn with_new_addresses( self, new_address_params: &[NewAddressParamsPacked], ) -> Self

pub fn with_input_compressed_accounts_with_merkle_context( self, input_compressed_accounts_with_merkle_context: &[PackedCompressedAccountWithMerkleContext], ) -> Self

pub fn with_output_compressed_accounts( self, output_compressed_accounts: &[OutputCompressedAccountWithPackedContext], ) -> Self

pub fn compress_lamports(self, lamports: u64) -> Self

pub fn decompress_lamports(self, lamports: u64) -> Self

Trait Implementations

impl BorshSerialize for LightSystemProgramCpi

fn serialize<W: Write>(&self, writer: &mut W) -> Result<()>

fn try_to_vec(&self) -> Result<Vec<u8>, Error>

Serialize this instance into a vector of bytes.

impl Clone for LightSystemProgramCpi

fn clone(&self) -> LightSystemProgramCpi

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl InstructionDiscriminator for LightSystemProgramCpi

fn discriminator(&self) -> &'static [u8]

impl LightCpiInstruction for LightSystemProgramCpi

fn new_cpi(cpi_signer: CpiSigner, proof: ValidityProof) -> Self

Creates a new CPI instruction builder with a validity proof.

fn with_light_account<A>( self, account: LightAccount<A>, ) -> Result<Self, ProgramError>

where A: AnchorSerialize + AnchorDeserialize + LightDiscriminator + Default,

Adds a compressed account to the instruction (using SHA256 hashing).

fn get_mode(&self) -> u8

Returns the instruction mode (0 for v1, 1 for v2).

fn get_bump(&self) -> u8

Returns the CPI signer bump seed.

impl LightInstructionData for LightSystemProgramCpi

fn data(&self) -> Result<Vec<u8>, CompressedAccountError>

fn data_array<const N: usize>( &self, ) -> Result<ArrayVec<[u8; N]>, CompressedAccountError>