SystemAccountMetaConfig

Struct SystemAccountMetaConfig 

Source
#[non_exhaustive]
pub struct SystemAccountMetaConfig { pub self_program: Option<Pubkey>, pub sol_compression_recipient: Option<Pubkey>, pub sol_pool_pda: Option<Pubkey>, }
Expand description

Configuration for Light system program accounts when building instructions.

This struct specifies which system accounts to include when using PackedAccounts::add_system_accounts() or PackedAccounts::add_system_accounts_v2().

§Required Fields

  • self_program: Your program’s ID (the one calling the Light system program). Used to derive the CPI signer PDA.

§Optional Fields

  • cpi_context: CPI context account for batched operations (v2 only). Required when using CPI context for multi-step compressed account operations.

  • sol_compression_recipient: Account to receive decompressed SOL. Required when decompressing SOL from compressed accounts.

  • sol_pool_pda: SOL pool PDA for SOL compression/decompression. Required when compressing or decompressing SOL.

§Examples

Basic usage (no SOL operations):

let program_id = Pubkey::new_unique();
let config = SystemAccountMetaConfig::new(program_id);

With CPI context (v2 batched operations):

let program_id = Pubkey::new_unique();
let cpi_context_account = Pubkey::new_unique();
let config = SystemAccountMetaConfig::new_with_cpi_context(program_id, cpi_context_account);

With SOL compression:

let program_id = Pubkey::new_unique();
let sol_pool_pda = Pubkey::new_unique();
let recipient = Pubkey::new_unique();

let mut config = SystemAccountMetaConfig::new(program_id);
config.sol_pool_pda = Some(sol_pool_pda);
config.sol_compression_recipient = Some(recipient);

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§self_program: Option<Pubkey>

Your program’s ID (optional). Used to derive the CPI signer PDA. When None, the CPI signer is not included (for registry CPI flow).

§sol_compression_recipient: Option<Pubkey>

Optional account to receive decompressed SOL.

§sol_pool_pda: Option<Pubkey>

Optional SOL pool PDA for SOL compression/decompression.

Implementations§

Source§

impl SystemAccountMetaConfig

Source

pub fn new(self_program: Pubkey) -> Self

Creates a basic configuration with only the program ID.

Use this for simple compressed account operations without SOL compression or CPI context.

§Example
let program_id = Pubkey::new_unique();
let config = SystemAccountMetaConfig::new(program_id);

Trait Implementations§

Source§

impl Clone for SystemAccountMetaConfig

Source§

fn clone(&self) -> SystemAccountMetaConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SystemAccountMetaConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for SystemAccountMetaConfig

Source§

fn default() -> SystemAccountMetaConfig

Returns the “default value” for a type. Read more
Source§

impl Copy for SystemAccountMetaConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.