star_frame 0.29.0

//! Typed wrapper for program accounts in instruction contexts.
//!
//! The `Program<T>` type represents a reference to a specific Star Frame program within an instruction's
//! account set. It automatically validates that the provided account matches the expected program ID
//! and provides type-safe access to program-specific functionality.

use crate::{account_set::ClientAccountSet, prelude::*};
use ref_cast::{ref_cast_custom, RefCastCustom};
use std::marker::PhantomData;

/// A typed wrapper for a program account that validates the program ID matches the expected ID.
///
/// This type is used in instruction account sets to represent a specific Star Frame program account.
/// During validation, it ensures the provided account's public key matches `T::ID`, preventing
/// incorrect program references in cross-program invocations or instruction contexts.
#[derive(AccountSet, Debug, RefCastCustom, derive_where::DeriveWhere)]
#[derive_where(Clone, Copy)]
#[account_set(skip_client_account_set)]
#[validate(
    extra_validation = self.check_id(),
)]
#[repr(transparent)]
pub struct Program<T: StarFrameProgram>(
    #[single_account_set]
    #[idl(address = T::ID)]
    pub(crate) AccountInfo,
    #[account_set(skip = PhantomData)] pub(crate) PhantomData<T>,
);

impl<T: StarFrameProgram> ClientAccountSet for Program<T> {
    type ClientAccounts = Option<Pubkey>;

    const MIN_LEN: usize = 1;

    fn extend_account_metas(
        _program_id: &Pubkey,
        accounts: &Self::ClientAccounts,
        metas: &mut Vec<AccountMeta>,
    ) {
        metas.push(AccountMeta::new_readonly(accounts.unwrap_or(T::ID), false));
    }
}

impl<T: StarFrameProgram> Program<T> {
    pub fn check_id(&self) -> Result<()> {
        if self.0.pubkey().fast_eq(&T::ID) {
            Ok(())
        } else {
            Err(ProgramError::IncorrectProgramId.into())
        }
    }

    /// Allows casting references from an `AccountInfo` without validating the program id.
    #[allow(dead_code)]
    #[ref_cast_custom]
    pub(crate) fn cast_info_unchecked<'a>(info: &'a AccountInfo) -> &'a Self;
}