cleanup utils imports

2026-05-16 23:16:47 +00:00 · 2024-08-25 14:16:05 +00:00
parent 96f07f7d37
commit 80f6efeeb2
17 changed files with 178 additions and 176 deletions
--- a/utils/src/cpi.rs
+++ b/utils/src/cpi.rs
@@ -1,5 +1,77 @@
-use solana_program::{account_info::AccountInfo, entrypoint::ProgramResult};
+use solana_program::{
+    account_info::AccountInfo, entrypoint::ProgramResult, pubkey::Pubkey, rent::Rent,
+    sysvar::Sysvar,
+};

+/// Creates a new pda.
+#[inline(always)]
+pub fn create_pda<'a, 'info>(
+    target_account: &'a AccountInfo<'info>,
+    owner: &Pubkey,
+    space: usize,
+    pda_seeds: &[&[u8]],
+    system_program: &'a AccountInfo<'info>,
+    payer: &'a AccountInfo<'info>,
+) -> ProgramResult {
+    let rent = Rent::get()?;
+    if target_account.lamports().eq(&0) {
+        // If balance is zero, create account
+        solana_program::program::invoke_signed(
+            &solana_program::system_instruction::create_account(
+                payer.key,
+                target_account.key,
+                rent.minimum_balance(space),
+                space as u64,
+                owner,
+            ),
+            &[
+                payer.clone(),
+                target_account.clone(),
+                system_program.clone(),
+            ],
+            &[pda_seeds],
+        )?;
+    } else {
+        // Otherwise, if balance is nonzero:
+
+        // 1) transfer sufficient lamports for rent exemption
+        let rent_exempt_balance = rent
+            .minimum_balance(space)
+            .saturating_sub(target_account.lamports());
+        if rent_exempt_balance.gt(&0) {
+            solana_program::program::invoke(
+                &solana_program::system_instruction::transfer(
+                    payer.key,
+                    target_account.key,
+                    rent_exempt_balance,
+                ),
+                &[
+                    payer.clone(),
+                    target_account.clone(),
+                    system_program.clone(),
+                ],
+            )?;
+        }
+
+        // 2) allocate space for the account
+        solana_program::program::invoke_signed(
+            &solana_program::system_instruction::allocate(target_account.key, space as u64),
+            &[target_account.clone(), system_program.clone()],
+            &[pda_seeds],
+        )?;
+
+        // 3) assign our program as the owner
+        solana_program::program::invoke_signed(
+            &solana_program::system_instruction::assign(target_account.key, owner),
+            &[target_account.clone(), system_program.clone()],
+            &[pda_seeds],
+        )?;
+    }
+
+    Ok(())
+}
+
+#[cfg(feature = "spl")]
 #[inline(always)]
 pub fn create_ata<'info>(
    funder_info: &AccountInfo<'info>,
@@ -29,6 +101,7 @@ pub fn create_ata<'info>(
    )
 }

+#[cfg(feature = "spl")]
 #[inline(always)]
 pub fn transfer<'info>(
    authority_info: &AccountInfo<'info>,
@@ -55,6 +128,7 @@ pub fn transfer<'info>(
    )
 }

+#[cfg(feature = "spl")]
 #[inline(always)]
 pub fn transfer_signed<'info>(
    authority_info: &AccountInfo<'info>,
@@ -83,6 +157,7 @@ pub fn transfer_signed<'info>(
    )
 }

+#[cfg(feature = "spl")]
 #[inline(always)]
 pub fn mint_to_signed<'info>(
    mint_info: &AccountInfo<'info>,
@@ -111,6 +186,7 @@ pub fn mint_to_signed<'info>(
    )
 }

+#[cfg(feature = "spl")]
 #[inline(always)]
 pub fn burn<'info>(
    token_account_info: &AccountInfo<'info>,
--- a/utils/src/lib.rs
+++ b/utils/src/lib.rs
@@ -1,155 +1,8 @@
-pub mod loaders;
-#[cfg(feature = "spl")]
-pub mod spl;
+mod cpi;
+mod loaders;
+pub mod macros;
+mod traits;

-use solana_program::{
-    account_info::AccountInfo, entrypoint::ProgramResult, program_error::ProgramError,
-    pubkey::Pubkey, rent::Rent, sysvar::Sysvar,
-};
-
-/// Creates a new pda.
-#[inline(always)]
-pub fn create_pda<'a, 'info>(
-    target_account: &'a AccountInfo<'info>,
-    owner: &Pubkey,
-    space: usize,
-    pda_seeds: &[&[u8]],
-    system_program: &'a AccountInfo<'info>,
-    payer: &'a AccountInfo<'info>,
-) -> ProgramResult {
-    let rent = Rent::get()?;
-    if target_account.lamports().eq(&0) {
-        // If balance is zero, create account
-        solana_program::program::invoke_signed(
-            &solana_program::system_instruction::create_account(
-                payer.key,
-                target_account.key,
-                rent.minimum_balance(space),
-                space as u64,
-                owner,
-            ),
-            &[
-                payer.clone(),
-                target_account.clone(),
-                system_program.clone(),
-            ],
-            &[pda_seeds],
-        )?;
-    } else {
-        // Otherwise, if balance is nonzero:
-
-        // 1) transfer sufficient lamports for rent exemption
-        let rent_exempt_balance = rent
-            .minimum_balance(space)
-            .saturating_sub(target_account.lamports());
-        if rent_exempt_balance.gt(&0) {
-            solana_program::program::invoke(
-                &solana_program::system_instruction::transfer(
-                    payer.key,
-                    target_account.key,
-                    rent_exempt_balance,
-                ),
-                &[
-                    payer.clone(),
-                    target_account.clone(),
-                    system_program.clone(),
-                ],
-            )?;
-        }
-
-        // 2) allocate space for the account
-        solana_program::program::invoke_signed(
-            &solana_program::system_instruction::allocate(target_account.key, space as u64),
-            &[target_account.clone(), system_program.clone()],
-            &[pda_seeds],
-        )?;
-
-        // 3) assign our program as the owner
-        solana_program::program::invoke_signed(
-            &solana_program::system_instruction::assign(target_account.key, owner),
-            &[target_account.clone(), system_program.clone()],
-            &[pda_seeds],
-        )?;
-    }
-
-    Ok(())
-}
-
-pub trait Discriminator {
-    fn discriminator() -> u8;
-}
-
-pub trait AccountDeserialize {
-    fn try_from_bytes(data: &[u8]) -> Result<&Self, ProgramError>;
-    fn try_from_bytes_mut(data: &mut [u8]) -> Result<&mut Self, ProgramError>;
-}
-
-#[macro_export]
-macro_rules! impl_to_bytes {
-    ($struct_name:ident) => {
-        impl $struct_name {
-            pub fn to_bytes(&self) -> &[u8] {
-                bytemuck::bytes_of(self)
-            }
-        }
-    };
-}
-
-#[macro_export]
-macro_rules! impl_account_from_bytes {
-    ($struct_name:ident) => {
-        impl $crate::AccountDeserialize for $struct_name {
-            fn try_from_bytes(
-                data: &[u8],
-            ) -> Result<&Self, solana_program::program_error::ProgramError> {
-                if Self::discriminator().ne(&data[0]) {
-                    return Err(solana_program::program_error::ProgramError::InvalidAccountData);
-                }
-                bytemuck::try_from_bytes::<Self>(&data[8..]).or(Err(
-                    solana_program::program_error::ProgramError::InvalidAccountData,
-                ))
-            }
-            fn try_from_bytes_mut(
-                data: &mut [u8],
-            ) -> Result<&mut Self, solana_program::program_error::ProgramError> {
-                if Self::discriminator().ne(&data[0]) {
-                    return Err(solana_program::program_error::ProgramError::InvalidAccountData);
-                }
-                bytemuck::try_from_bytes_mut::<Self>(&mut data[8..]).or(Err(
-                    solana_program::program_error::ProgramError::InvalidAccountData,
-                ))
-            }
-        }
-    };
-}
-
-#[macro_export]
-macro_rules! impl_instruction_from_bytes {
-    ($struct_name:ident) => {
-        impl $struct_name {
-            pub fn try_from_bytes(
-                data: &[u8],
-            ) -> Result<&Self, solana_program::program_error::ProgramError> {
-                bytemuck::try_from_bytes::<Self>(data).or(Err(
-                    solana_program::program_error::ProgramError::InvalidInstructionData,
-                ))
-            }
-        }
-    };
-}
-
-#[macro_export]
-macro_rules! account {
-    ($struct_name:ident) => {
-        $crate::impl_to_bytes!($struct_name);
-        $crate::impl_account_from_bytes!($struct_name);
-    };
-}
-
-#[macro_export]
-macro_rules! instruction {
-    ($struct_name:ident) => {
-        $crate::impl_to_bytes!($struct_name);
-        $crate::impl_instruction_from_bytes!($struct_name);
-    };
-}
+pub use cpi::*;
+pub use loaders::*;
+pub use traits::*;
--- a/utils/src/macros.rs
+++ b/utils/src/macros.rs
@@ -0,0 +1,69 @@
+#[macro_export]
+macro_rules! impl_to_bytes {
+    ($struct_name:ident) => {
+        impl $struct_name {
+            pub fn to_bytes(&self) -> &[u8] {
+                bytemuck::bytes_of(self)
+            }
+        }
+    };
+}
+
+#[macro_export]
+macro_rules! impl_account_from_bytes {
+    ($struct_name:ident) => {
+        impl $crate::AccountDeserialize for $struct_name {
+            fn try_from_bytes(
+                data: &[u8],
+            ) -> Result<&Self, solana_program::program_error::ProgramError> {
+                if Self::discriminator().ne(&data[0]) {
+                    return Err(solana_program::program_error::ProgramError::InvalidAccountData);
+                }
+                bytemuck::try_from_bytes::<Self>(&data[8..]).or(Err(
+                    solana_program::program_error::ProgramError::InvalidAccountData,
+                ))
+            }
+            fn try_from_bytes_mut(
+                data: &mut [u8],
+            ) -> Result<&mut Self, solana_program::program_error::ProgramError> {
+                if Self::discriminator().ne(&data[0]) {
+                    return Err(solana_program::program_error::ProgramError::InvalidAccountData);
+                }
+                bytemuck::try_from_bytes_mut::<Self>(&mut data[8..]).or(Err(
+                    solana_program::program_error::ProgramError::InvalidAccountData,
+                ))
+            }
+        }
+    };
+}
+
+#[macro_export]
+macro_rules! impl_instruction_from_bytes {
+    ($struct_name:ident) => {
+        impl $struct_name {
+            pub fn try_from_bytes(
+                data: &[u8],
+            ) -> Result<&Self, solana_program::program_error::ProgramError> {
+                bytemuck::try_from_bytes::<Self>(data).or(Err(
+                    solana_program::program_error::ProgramError::InvalidInstructionData,
+                ))
+            }
+        }
+    };
+}
+
+#[macro_export]
+macro_rules! account {
+    ($struct_name:ident) => {
+        $crate::impl_to_bytes!($struct_name);
+        $crate::impl_account_from_bytes!($struct_name);
+    };
+}
+
+#[macro_export]
+macro_rules! instruction {
+    ($struct_name:ident) => {
+        $crate::impl_to_bytes!($struct_name);
+        $crate::impl_instruction_from_bytes!($struct_name);
+    };
+}
--- a/utils/src/traits.rs
+++ b/utils/src/traits.rs
@@ -0,0 +1,10 @@
+use solana_program::program_error::ProgramError;
+
+pub trait Discriminator {
+    fn discriminator() -> u8;
+}
+
+pub trait AccountDeserialize {
+    fn try_from_bytes(data: &[u8]) -> Result<&Self, ProgramError>;
+    fn try_from_bytes_mut(data: &mut [u8]) -> Result<&mut Self, ProgramError>;
+}