1#![deny(missing_docs)]
2
3use solana_program::account_info::AccountInfo;
6use solana_program::clock::Clock;
7use solana_program::entrypoint::ProgramResult;
8use solana_program::program_error::ProgramError;
9use solana_program::pubkey::Pubkey;
10use solana_program::sysvar::Sysvar;
11use solana_program::{msg, sysvar};
12use solana_sdk_ids::system_program;
13
14#[macro_export]
18macro_rules! log_everywhere {
19 ($($arg:tt)*) => {{
20 let message = format!($($arg)*);
21
22 #[cfg(not(target_os = "solana"))]
23 {
24 dbg!(message);
25 }
26
27 #[cfg(target_os = "solana")]
28 {
29 solana_program::msg!("SOL: {}", message);
30 }
31 }}
32}
33
34pub fn check_program_account(program_id: &Pubkey, check_f: fn(&Pubkey) -> bool) -> ProgramResult {
36 if !&check_f(program_id) {
37 return Err(ProgramError::IncorrectProgramId);
38 }
39 Ok(())
40}
41
42pub fn next_optional_account_info<'a, 'b, I: Iterator<Item = &'a AccountInfo<'b>>>(
47 iter: &mut I,
48 program_id: &Pubkey,
49) -> Result<Option<I::Item>, ProgramError> {
50 iter.next()
51 .ok_or(ProgramError::NotEnoughAccountKeys)
52 .map(|account| {
53 if account.key == program_id {
54 None
55 } else {
56 Some(account)
57 }
58 })
59}
60
61#[macro_export]
63macro_rules! ensure_single_feature {
64 ($($feature:literal),+) => {
65 #[cfg(not(any($(feature = $feature),+)))]
67 compile_error!(concat!("Exactly one of these features must be enabled: ", $(stringify!($feature), ", "),+));
68
69 ensure_single_feature!(@pairs [] $($feature),+);
71 };
72
73 (@pairs [$($processed:literal),*] $first:literal $(,$rest:literal)*) => {
75 $(
77 #[cfg(all(feature = $first, feature = $processed))]
78 compile_error!(concat!("Features '", $first, "' and '", $processed, "' are mutually exclusive"));
79 )*
80
81 ensure_single_feature!(@pairs [$($processed,)* $first] $($rest),*);
83 };
84
85 (@pairs [$($processed:literal),*]) => {};
87}
88
89#[allow(clippy::little_endian_bytes)]
117pub fn checked_from_u256_le_bytes_to_u64(le_u256: &[u8; 32]) -> Result<u64, ProgramError> {
118 if le_u256[8..32].iter().any(|&byte| byte != 0) {
120 return Err(ProgramError::InvalidArgument);
121 }
122
123 let mut u64data: [u8; 8] = [0_u8; 8];
125 u64data.copy_from_slice(&le_u256[0..8]);
126
127 Ok(u64::from_le_bytes(u64data))
129}
130
131#[must_use]
133#[allow(clippy::little_endian_bytes)]
134pub fn from_u64_to_u256_le_bytes(u64: u64) -> [u8; 32] {
135 let mut u256 = [0; 32];
136 u256[0..8].copy_from_slice(&u64.to_le_bytes());
137 u256
138}
139
140pub fn current_time() -> Result<u64, ProgramError> {
150 let solana_now = Clock::get()?.unix_timestamp;
151 let now = u64::try_from(solana_now).map_err(|err| {
152 msg!("Cannot convert solana type into u64: {}", err);
153 ProgramError::InvalidArgument
154 })?;
155 Ok(now)
156}
157
158pub fn transfer_lamports(
171 from_account: &AccountInfo<'_>,
172 to_account: &AccountInfo<'_>,
173 amount_of_lamports: u64,
174) -> ProgramResult {
175 if **from_account.try_borrow_lamports()? < amount_of_lamports {
177 return Err(ProgramError::InsufficientFunds);
178 }
179 let mut from_account = from_account.try_borrow_mut_lamports()?;
181 let mut to_account = to_account.try_borrow_mut_lamports()?;
182 **from_account = from_account
183 .checked_sub(amount_of_lamports)
184 .ok_or(ProgramError::InsufficientFunds)?;
185 **to_account = to_account
186 .checked_add(amount_of_lamports)
187 .ok_or(ProgramError::InsufficientFunds)?;
188 Ok(())
189}
190
191#[macro_export]
210macro_rules! transfer_lamports_anchor {
211 ($from:expr, $to:expr, $amount:expr) => {{
212 if $from.get_lamports() < $amount {
213 return Err(anchor_lang::error::Error::from(
214 anchor_lang::solana_program::program_error::ProgramError::InsufficientFunds,
215 ));
216 }
217 $from.sub_lamports($amount)?;
218 $to.add_lamports($amount)?;
219 }};
220}
221
222pub fn validate_system_account_key(key: &Pubkey) -> Result<(), ProgramError> {
224 if !system_program::check_id(key) {
225 msg!("Wrong system account key");
226 return Err(ProgramError::IncorrectProgramId);
227 }
228 Ok(())
229}
230
231pub fn validate_spl_associated_token_account_key(key: &Pubkey) -> Result<(), ProgramError> {
233 if !spl_associated_token_account::check_id(key) {
234 msg!("Wrong spl associated token account key");
235 return Err(ProgramError::IncorrectProgramId);
236 }
237 Ok(())
238}
239
240pub fn validate_rent_key(key: &Pubkey) -> Result<(), ProgramError> {
242 if !sysvar::rent::check_id(key) {
243 msg!("Wrong rent key");
244 return Err(ProgramError::IncorrectProgramId);
245 }
246 Ok(())
247}
248
249pub fn validate_sysvar_instructions_key(key: &Pubkey) -> Result<(), ProgramError> {
251 if !sysvar::instructions::check_id(key) {
252 msg!("Wrong sysvar instructions key");
253 return Err(ProgramError::IncorrectProgramId);
254 }
255 Ok(())
256}
257
258pub fn validate_mpl_token_metadata_key(key: &Pubkey) -> Result<(), ProgramError> {
260 if *key != mpl_token_metadata::ID {
261 msg!("Wrong mpl token metadata key");
262 return Err(ProgramError::IncorrectProgramId);
263 }
264 Ok(())
265}
266
267#[cfg(test)]
268mod tests {
269 #[allow(deprecated)]
270 use solana_program::{system_program, sysvar};
271
272 use crate::{
273 validate_mpl_token_metadata_key, validate_rent_key,
274 validate_spl_associated_token_account_key, validate_system_account_key,
275 validate_sysvar_instructions_key,
276 };
277
278 #[test]
279 fn validate_system_account_key_works() {
280 assert!(validate_system_account_key(&system_program::ID).is_ok());
281 assert!(validate_system_account_key(&sysvar::instructions::ID).is_err());
282 assert!(validate_system_account_key(&sysvar::rent::ID).is_err());
283 }
284
285 #[test]
286 fn validate_spl_associated_token_account_key_works() {
287 assert!(
288 validate_spl_associated_token_account_key(&spl_associated_token_account::ID).is_ok()
289 );
290 assert!(validate_spl_associated_token_account_key(&sysvar::instructions::ID).is_err());
291 assert!(validate_spl_associated_token_account_key(&sysvar::rent::ID).is_err());
292 }
293
294 #[test]
295 fn validate_rent_key_works() {
296 assert!(validate_rent_key(&sysvar::rent::ID).is_ok());
297 assert!(validate_rent_key(&system_program::ID).is_err());
298 assert!(validate_rent_key(&spl_associated_token_account::ID).is_err());
299 }
300
301 #[test]
302 fn sysvar_instructions_key() {
303 assert!(validate_sysvar_instructions_key(&sysvar::instructions::ID).is_ok());
304 assert!(validate_sysvar_instructions_key(&system_program::ID).is_err());
305 assert!(validate_sysvar_instructions_key(&spl_associated_token_account::ID).is_err());
306 }
307
308 #[test]
309 fn mpl_token_metadata_key() {
310 assert!(validate_mpl_token_metadata_key(&mpl_token_metadata::ID).is_ok());
311 assert!(validate_mpl_token_metadata_key(&system_program::ID).is_err());
312 assert!(validate_mpl_token_metadata_key(&spl_associated_token_account::ID).is_err());
313 }
314}