Cross Program Invocation

Cross Program Invocation (CPI) ma miejsce, gdy jeden program Solana bezpośrednio wywołuje instrukcje innego programu. Umożliwia to kompozycję programów. Jeśli pomyślisz o instrukcji Solana jako o punkcie końcowym API, który program udostępnia sieci, CPI jest jak wewnętrzne wywołanie jednego punktu końcowego przez inny.

Podczas wykonywania CPI program może podpisać w imieniu PDA wyprowadzonego z jego ID programu. Te uprawnienia podpisującego są przekazywane z programu wywołującego do programu wywoływanego.

Przykład wywołania międzyprogramowego

Podczas wykonywania CPI uprawnienia do kont są przekazywane z jednego programu do drugiego. Załóżmy, że Program A otrzymuje instrukcję z kontem podpisującym i kontem z możliwością zapisu. Następnie Program A wykonuje CPI do Programu B. Teraz Program B może używać tych samych kont co Program A, z ich oryginalnymi uprawnieniami. (Oznacza to, że Program B może podpisać się kontem podpisującym i zapisywać na konto z możliwością zapisu.) Jeśli Program B wykonuje własne CPI, może przekazać te same uprawnienia dalej, do głębokości 4.

Maksymalna wysokość stosu wywołań instrukcji programu nazywana jest max_instruction_stack_depth i jest ustawiona na stałą MAX_INSTRUCTION_STACK_DEPTH o wartości 5.

Wysokość stosu zaczyna się od 1 dla początkowej transakcji i zwiększa się o 1 za każdym razem, gdy program wywołuje inną instrukcję, ograniczając głębokość wywołań CPI do 4.

CPI z podpisującymi PDA

Gdy CPI wymaga podpisu PDA, używana jest funkcja invoke_signed. Przyjmuje ona seedy podpisujące używane do wyprowadzania podpisujących PDA. Środowisko wykonawcze Solana wewnętrznie wywołuje funkcję create_program_address używając signers_seeds i program_id programu wywołującego. Gdy PDA zostanie zweryfikowany, jest dodawany jako prawidłowy podpisujący.

Invoke signed

pub fn invoke_signed(
    instruction: &Instruction,
    account_infos: &[AccountInfo],
    signers_seeds: &[&[&[u8]]],
) -> ProgramResult {
    // --snip--
    invoke_signed_unchecked(instruction, account_infos, signers_seeds)
}

Poniższe przykłady pokazują, jak wykonać CPI z podpisami PDA przy użyciu Anchor i Native Rust. Każdy przykład zawiera pojedynczą instrukcję przesyłającą SOL z PDA na konto odbiorcy, używając CPI podpisanego przez PDA.

Anchor

Poniższe przykłady pokazują trzy podejścia do implementacji CPI w programie Anchor. Przykłady są funkcjonalnie równoważne, ale każdy z nich demonstruje inny poziom abstrakcji.

Przykład 1: Wykorzystuje CpiContext i funkcję pomocniczą Anchor.
Przykład 2: Wykorzystuje funkcję system_instruction::transfer z crate solana_program. (Przykład 1 jest abstrakcją tej implementacji.)
Przykład 3: Ręcznie konstruuje instrukcję CPI. To podejście jest przydatne, gdy nie ma dostępnego crate, który pomaga w budowie instrukcji, którą chcesz wywołać.

use anchor_lang::prelude::*;
use anchor_lang::system_program::{transfer, Transfer};

declare_id!("BrcdB9sV7z9DvF9rDHG263HUxXgJM3iCQdF36TcxbFEn");

#[program]
pub mod cpi {
    use super::*;

    pub fn sol_transfer(ctx: Context<SolTransfer>, amount: u64) -> Result<()> {
        let from_pubkey = ctx.accounts.pda_account.to_account_info();
        let to_pubkey = ctx.accounts.recipient.to_account_info();
        let program_id = ctx.accounts.system_program.to_account_info();

        let seed = to_pubkey.key();
        let bump_seed = ctx.bumps.pda_account;
        let signer_seeds: &[&[&[u8]]] = &[&[b"pda", seed.as_ref(), &[bump_seed]]];

        let cpi_context = CpiContext::new(
            program_id,
            Transfer {
                from: from_pubkey,
                to: to_pubkey,
            },
        )
        .with_signer(signer_seeds);

        transfer(cpi_context, amount)?;
        Ok(())
    }
}

#[derive(Accounts)]
pub struct SolTransfer<'info> {
    #[account(
        mut,
        seeds = [b"pda", recipient.key().as_ref()],
        bump,
    )]
    pda_account: SystemAccount<'info>,
    #[account(mut)]
    recipient: SystemAccount<'info>,
    system_program: Program<'info, System>,
}

Rust

Poniższy przykład pokazuje, jak wykonać CPI z podpisami PDA z programu napisanego w Native Rust. Zawiera pojedynczą instrukcję przesyłającą SOL z konta PDA na inne konto. CPI jest podpisane przez konto PDA. (Plik testowy wykorzystuje LiteSVM do testowania programu.)

use borsh::BorshDeserialize;
use solana_program::{
    account_info::AccountInfo,
    entrypoint,
    entrypoint::ProgramResult,
    program::invoke_signed,
    program_error::ProgramError,
    pubkey::Pubkey,
    system_instruction,
};

// Declare program entrypoint
entrypoint!(process_instruction);

// Define program instructions
#[derive(BorshDeserialize)]
enum ProgramInstruction {
    SolTransfer { amount: u64 },
}

impl ProgramInstruction {
    fn unpack(input: &[u8]) -> Result<Self, ProgramError> {
        Self::try_from_slice(input).map_err(|_| ProgramError::InvalidInstructionData)
    }
}

pub fn process_instruction(
    program_id: &Pubkey,
    accounts: &[AccountInfo],
    instruction_data: &[u8],
) -> ProgramResult {
    // Deserialize instruction data
    let instruction = ProgramInstruction::unpack(instruction_data)?;

    // Process instruction
    match instruction {
        ProgramInstruction::SolTransfer { amount } => {
            // Parse accounts
            let [pda_account_info, recipient_info, system_program_info] = accounts else {
                return Err(ProgramError::NotEnoughAccountKeys);
            };

            // Derive PDA and verify it matches the account provided by client
            let recipient_pubkey = recipient_info.key;
            let seeds = &[b"pda", recipient_pubkey.as_ref()];
            let (expected_pda, bump_seed) = Pubkey::find_program_address(seeds, program_id);

            if expected_pda != *pda_account_info.key {
                return Err(ProgramError::InvalidArgument);
            }

            // Create the transfer instruction
            let transfer_ix = system_instruction::transfer(
                pda_account_info.key,
                recipient_info.key,
                amount,
            );

            // Create signer seeds for PDA
            let signer_seeds: &[&[&[u8]]] = &[&[b"pda", recipient_pubkey.as_ref(), &[bump_seed]]];

            // Invoke the transfer instruction with PDA as signer
            invoke_signed(
                &transfer_ix,
                &[
                    pda_account_info.clone(),
                    recipient_info.clone(),
                    system_program_info.clone(),
                ],
                signer_seeds,
            )?;

            Ok(())
        }
    }
}

CPI bez podpisów PDA

Gdy CPI nie wymaga podpisów PDA, używana jest funkcja invoke. Funkcja invoke wywołuje funkcję invoke_signed z pustą tablicą signers_seeds. Pusta tablica podpisujących wskazuje, że nie są wymagane żadne PDA do podpisywania.

Invoke function

pub fn invoke(instruction: &Instruction, account_infos: &[AccountInfo]) -> ProgramResult {
    invoke_signed(instruction, account_infos, &[])
}

Poniższe przykłady pokazują, jak wykonać CPI za pomocą Anchor i Native Rust. Zawierają one pojedynczą instrukcję, która przesyła SOL z jednego konta na drugie.

Anchor

Poniższe przykłady przedstawiają trzy podejścia do implementacji CPI w programie Anchor. Przykłady są funkcjonalnie równoważne, ale każdy z nich pokazuje inny poziom abstrakcji.

Przykład 1: Wykorzystuje CpiContext i funkcję pomocniczą Anchor.
Przykład 2: Wykorzystuje funkcję system_instruction::transfer z biblioteki solana_program.
Przykład 3: Ręcznie konstruuje instrukcję CPI. To podejście jest przydatne, gdy nie istnieje biblioteka do budowy instrukcji, którą chcesz wywołać.

use anchor_lang::prelude::*;
use anchor_lang::system_program::{transfer, Transfer};

declare_id!("9AvUNHjxscdkiKQ8tUn12QCMXtcnbR9BVGq3ULNzFMRi");

#[program]
pub mod cpi {
    use super::*;

    pub fn sol_transfer(ctx: Context<SolTransfer>, amount: u64) -> Result<()> {
        let from_pubkey = ctx.accounts.sender.to_account_info();
        let to_pubkey = ctx.accounts.recipient.to_account_info();
        let program_id = ctx.accounts.system_program.to_account_info();

        let cpi_context = CpiContext::new(
            program_id,
            Transfer {
                from: from_pubkey,
                to: to_pubkey,
            },
        );

        transfer(cpi_context, amount)?;
        Ok(())
    }
}

#[derive(Accounts)]
pub struct SolTransfer<'info> {
    #[account(mut)]
    sender: Signer<'info>,
    #[account(mut)]
    recipient: SystemAccount<'info>,
    system_program: Program<'info, System>,
}

Rust

Poniższy przykład pokazuje, jak wykonać CPI z programu napisanego w Native Rust. Zawiera on pojedynczą instrukcję, która przesyła SOL z jednego konta na drugie. (Plik testowy wykorzystuje LiteSVM do testowania programu.)

use borsh::BorshDeserialize;
use solana_program::{
    account_info::AccountInfo,
    entrypoint,
    entrypoint::ProgramResult,
    program::invoke,
    program_error::ProgramError,
    pubkey::Pubkey,
    system_instruction,
};

// Declare program entrypoint
entrypoint!(process_instruction);

// Define program instructions
#[derive(BorshDeserialize)]
enum ProgramInstruction {
    SolTransfer { amount: u64 },
}

impl ProgramInstruction {
    fn unpack(input: &[u8]) -> Result<Self, ProgramError> {
        Self::try_from_slice(input).map_err(|_| ProgramError::InvalidInstructionData)
    }
}

pub fn process_instruction(
    _program_id: &Pubkey,
    accounts: &[AccountInfo],
    instruction_data: &[u8],
) -> ProgramResult {
    // Deserialize instruction data
    let instruction = ProgramInstruction::unpack(instruction_data)?;

    // Process instruction
    match instruction {
        ProgramInstruction::SolTransfer { amount } => {
            // Parse accounts
            let [sender_info, recipient_info, system_program_info] = accounts else {
                return Err(ProgramError::NotEnoughAccountKeys);
            };

            // Verify the sender is a signer
            if !sender_info.is_signer {
                return Err(ProgramError::MissingRequiredSignature);
            }

            // Create and invoke the transfer instruction
            let transfer_ix = system_instruction::transfer(
                sender_info.key,
                recipient_info.key,
                amount,
            );

            invoke(
                &transfer_ix,
                &[
                    sender_info.clone(),
                    recipient_info.clone(),
                    system_program_info.clone(),
                ],
            )?;

            Ok(())
        }
    }
}

Cross Program Invocation

CPI z podpisującymi PDA

Anchor

Rust

CPI bez podpisów PDA

Anchor

Rust

Spis treści