spherenet-program-whitelist-interface 0.3.0

//! Onchain functionality for the `InitiateAuthorityTransfer` instruction

use {
    crate::{
        instructions::ProgramWhitelistInstruction,
        onchain::{write_bytes, UNINIT_BYTE},
        program::ID,
    },
    core::{mem::MaybeUninit, slice::from_raw_parts},
    pinocchio::{
        account_info::AccountInfo,
        instruction::{AccountMeta, Instruction, Signer},
        program::invoke_signed,
        pubkey::Pubkey,
        ProgramResult,
    },
};

/// Proposes a new authority for the program whitelist. The current
/// `whitelist_authority` must sign this instruction. The proposed
/// `new_authority` must then sign an `AcceptAuthorityTransfer`
/// instruction to finalize the transfer.
///
/// ### Accounts:
///   0. `[WRITE]` The whitelist account
///   1. `[SIGNER]` The current whitelist authority
pub struct InitiateAuthorityTransfer<'a> {
    /// The whitelist account
    pub whitelist_account: &'a AccountInfo,
    /// The current whitelist authority
    pub whitelist_authority: &'a AccountInfo,
    /// New authority pubkey
    pub new_authority: Pubkey,
}

impl<'a> InitiateAuthorityTransfer<'a> {
    #[inline(always)]
    pub fn invoke(&self) -> ProgramResult {
        self.invoke_signed(&[])
    }

    /// Creates the instruction data for the InitiateAuthorityTransfer
    /// instruction
    fn create_instruction_data(new_authority: &Pubkey) -> [MaybeUninit<u8>; 33] {
        let mut instruction_data = [UNINIT_BYTE; 33];

        // Set discriminator as u8 at offset [0]
        write_bytes(&mut instruction_data, &[ProgramWhitelistInstruction::INITIATE_AUTHORITY_TRANSFER_TAG]);
        // Set new_authority as Pubkey at offset [1..33]
        write_bytes(&mut instruction_data[1..33], new_authority.as_ref());

        instruction_data
    }

    pub fn invoke_signed(&self, signers: &[Signer]) -> ProgramResult {
        // account metadata
        let account_metas: [AccountMeta; 2] = [
            AccountMeta::writable(self.whitelist_account.key()),
            AccountMeta::readonly_signer(self.whitelist_authority.key()),
        ];

        // Create instruction data
        let instruction_data = Self::create_instruction_data(&self.new_authority);

        let instruction = Instruction {
            program_id: &ID,
            accounts: &account_metas,
            data: unsafe { from_raw_parts(instruction_data.as_ptr() as _, 33) },
        };

        invoke_signed(
            &instruction,
            &[self.whitelist_account, self.whitelist_authority],
            signers,
        )
    }
}

/// Convenience helper for the `InitiateAuthorityTransfer` instruction
pub fn initiate_authority_transfer(
    whitelist_account: &AccountInfo,
    whitelist_authority: &AccountInfo,
    new_authority: Pubkey,
) -> ProgramResult {
    let ix = InitiateAuthorityTransfer {
        whitelist_account,
        whitelist_authority,
        new_authority,
    };
    ix.invoke()
}

/// Convenience helper for the `InitiateAuthorityTransfer` instruction with the
/// given signers.
pub fn initiate_authority_transfer_with_seed(
    whitelist_account: &AccountInfo,
    whitelist_authority: &AccountInfo,
    new_authority: Pubkey,
    signer_seeds: &[Signer],
) -> ProgramResult {
    let ix = InitiateAuthorityTransfer {
        whitelist_account,
        whitelist_authority,
        new_authority,
    };
    ix.invoke_signed(signer_seeds)
}

#[cfg(test)]
mod tests {
    use {super::*, crate::instructions::ProgramWhitelistInstruction};

    #[test]
    fn test_instruction_data_creation() {
        // Create a dummy pubkey for new authority
        let new_authority_bytes = [42u8; 32]; // Use a fixed value for testing
        let new_authority = Pubkey::from(new_authority_bytes);

        // Create instruction data using our function
        let instruction_data = InitiateAuthorityTransfer::create_instruction_data(&new_authority);

        // Create an instruction with this data for parsing
        let instruction = Instruction {
            program_id: &ID,
            accounts: &[], // Accounts not relevant for this test
            data: unsafe { from_raw_parts(instruction_data.as_ptr() as _, 33) },
        };

        // Parse the instruction data
        let parsed_ix = ProgramWhitelistInstruction::unpack(instruction.data).unwrap();

        // Verify that the parsed instruction matches what we expect
        match parsed_ix {
            ProgramWhitelistInstruction::InitiateAuthorityTransfer {
                new_authority: parsed_new_authority,
            } => {
                assert_eq!(parsed_new_authority, new_authority);
            }
            _ => panic!("Parsed incorrect instruction type"),
        }
    }
}