light-token 0.23.0

SDK for Light Tokens
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

use solana_account_info::AccountInfo;
use solana_cpi::{invoke, invoke_signed};
use solana_instruction::{AccountMeta, Instruction};
use solana_program_error::ProgramError;
use solana_pubkey::Pubkey;

use crate::constants::RENT_SPONSOR_V1 as RENT_SPONSOR;

/// # Create a close ctoken account instruction:
/// ```rust
/// # use solana_pubkey::Pubkey;
/// # use light_token::instruction::{CloseAccount, LIGHT_TOKEN_PROGRAM_ID};
/// # let account = Pubkey::new_unique();
/// # let destination = Pubkey::new_unique();
/// # let owner = Pubkey::new_unique();
/// let instruction =
///     CloseAccount::new(LIGHT_TOKEN_PROGRAM_ID, account, destination, owner)
///     .instruction()?;
/// # Ok::<(), solana_program_error::ProgramError>(())
/// ```
pub struct CloseAccount {
    pub token_program: Pubkey,
    pub account: Pubkey,
    pub destination: Pubkey,
    pub owner: Pubkey,
    pub rent_sponsor: Pubkey,
}

impl CloseAccount {
    pub fn new(token_program: Pubkey, account: Pubkey, destination: Pubkey, owner: Pubkey) -> Self {
        Self {
            token_program,
            account,
            destination,
            owner,
            rent_sponsor: RENT_SPONSOR,
        }
    }

    pub fn custom_rent_sponsor(mut self, rent_sponsor: Pubkey) -> Self {
        self.rent_sponsor = rent_sponsor;
        self
    }

    pub fn instruction(self) -> Result<Instruction, ProgramError> {
        // CloseAccount discriminator is 9 (no additional instruction data)
        let data = vec![9u8];

        let accounts = vec![
            AccountMeta::new(self.account, false),
            AccountMeta::new(self.destination, false),
            AccountMeta::new_readonly(self.owner, true),
            AccountMeta::new(self.rent_sponsor, false),
        ];

        Ok(Instruction {
            program_id: self.token_program,
            accounts,
            data,
        })
    }
}

/// # Close a ctoken account via CPI:
/// ```rust,no_run
/// # use light_token::instruction::CloseAccountCpi;
/// # use solana_account_info::AccountInfo;
/// # let token_program: AccountInfo = todo!();
/// # let account: AccountInfo = todo!();
/// # let destination: AccountInfo = todo!();
/// # let owner: AccountInfo = todo!();
/// // Use ctoken::RENT_SPONSOR or ctoken::rent_sponsor_pda() to get the protocol rent sponsor.
/// # let rent_sponsor: AccountInfo = todo!();
/// CloseAccountCpi {
///     token_program,
///     account,
///     destination,
///     owner,
///     rent_sponsor,
/// }
/// .invoke()?;
/// # Ok::<(), solana_program_error::ProgramError>(())
/// ```
pub struct CloseAccountCpi<'info> {
    pub token_program: AccountInfo<'info>,
    pub account: AccountInfo<'info>,
    pub destination: AccountInfo<'info>,
    pub owner: AccountInfo<'info>,
    pub rent_sponsor: AccountInfo<'info>,
}

impl<'info> CloseAccountCpi<'info> {
    pub fn instruction(&self) -> Result<Instruction, ProgramError> {
        CloseAccount::from(self).instruction()
    }

    pub fn invoke(self) -> Result<(), ProgramError> {
        let instruction = self.instruction()?;
        let account_infos = [
            self.account,
            self.destination,
            self.owner,
            self.rent_sponsor,
        ];
        invoke(&instruction, &account_infos)
    }

    pub fn invoke_signed(self, signer_seeds: &[&[&[u8]]]) -> Result<(), ProgramError> {
        let instruction = self.instruction()?;
        let account_infos = [
            self.account,
            self.destination,
            self.owner,
            self.rent_sponsor,
        ];
        invoke_signed(&instruction, &account_infos, signer_seeds)
    }
}

impl<'info> From<&CloseAccountCpi<'info>> for CloseAccount {
    fn from(account_infos: &CloseAccountCpi<'info>) -> Self {
        Self {
            token_program: *account_infos.token_program.key,
            account: *account_infos.account.key,
            destination: *account_infos.destination.key,
            owner: *account_infos.owner.key,
            rent_sponsor: *account_infos.rent_sponsor.key,
        }
    }
}