parent 5af8a54

author Fernando Otero <[email protected]> 1752707789 +0100
committer zubayr1 <[email protected]> 1752784793 +0200

Clarify the use of constant values (anza-xyz#200)

* Add comments on constants

* Improve offset comments

* Add bitmask to dictionary

* Renamed to field_at_offset

Ignore `zero_init` parameter (anza-xyz#203)

Ignore zero_init parameter

issue 136 idea solution

add checked accounts

fix instruction_data argument for lamports

use Sysvar rent account

update mod

fix typo

issue 136 idea solution

fix instruction_data argument for lamports

update mod

fix typo

implement invoke_signed_checked

Author: febo

programs/system/src/instructions/create_account_checked.rs

@@ -0,0 +1,85 @@
+use pinocchio::{
+    account_info::AccountInfo,
+    instruction::{AccountMeta, Instruction, Signer},
+    program::invoke_signed,
+    pubkey::Pubkey,
+    sysvars::{rent::Rent, Sysvar},
+    ProgramResult,
+    program_error::ProgramError,
+};
+
+/// Create a new account.
+///
+/// ### Accounts:
+///   0. `[WRITE, SIGNER]` Funding account
+///   1. `[WRITE, SIGNER]` New account
+pub struct CreateAccountChecked<'a> {
+    /// Funding account.
+    pub from: &'a AccountInfo,
+
+    /// New account.
+    pub to: &'a AccountInfo,
+
+    /// Number of bytes of memory to allocate.
+    pub space: u64,
+
+    /// Address of program that will own the new account.
+    pub owner: &'a Pubkey,
+
+    /// Sysvar rent account.
+    pub sysvar_rent_account: &'a AccountInfo,
+}
+
+impl CreateAccountChecked<'_> {
+    #[inline(always)]
+    pub fn invoke(&self) -> ProgramResult {
+        self.invoke_signed_checked(&[])
+    }
+
+    #[inline(always)]
+    pub fn invoke_signed_checked(&self, signers: &[Signer]) -> ProgramResult {
+        // Get lamports from rent
+        let rent = Rent::from_account_info(self.sysvar_rent_account)?;
+        let lamports = rent.minimum_balance(self.space as usize);
+
+        // Check if the funding account has enough lamports
+        if self.from.lamports() < lamports {
+            return Err(ProgramError::InsufficientFunds);
+        }
+
+        // Check if the new account is already initialized
+        if !self.to.data_is_empty() {
+            return Err(ProgramError::InvalidAccountData);
+        }
+
+        self.invoke_signed(signers, lamports)
+    }
+
+    #[inline(always)]
+    fn invoke_signed(&self, signers: &[Signer], lamports: u64) -> ProgramResult {
+        // account metadata
+        let account_metas: [AccountMeta; 2] = [
+            AccountMeta::writable_signer(self.from.key()),
+            AccountMeta::writable_signer(self.to.key()),
+        ];
+
+        // instruction data
+        // - [0..4  ]: instruction discriminator
+        // - [4..12 ]: lamports
+        // - [12..20]: account space
+        // - [20..52]: owner pubkey
+        let mut instruction_data = [0; 52];
+        // create account instruction has a '0' discriminator
+        instruction_data[4..12].copy_from_slice(&lamports.to_le_bytes());
+        instruction_data[12..20].copy_from_slice(&self.space.to_le_bytes());
+        instruction_data[20..52].copy_from_slice(self.owner.as_ref());
+
+        let instruction = Instruction {
+            program_id: &crate::ID,
+            accounts: &account_metas,
+            data: &instruction_data,
+        };
+
+        invoke_signed(&instruction, &[self.from, self.to], signers)
+    }
+}

programs/system/src/instructions/create_account_with_seed_checked.rs

@@ -0,0 +1,115 @@
+use pinocchio::{
+    account_info::AccountInfo,
+    instruction::{AccountMeta, Instruction, Signer},
+    program::invoke_signed,
+    pubkey::{self, Pubkey, MAX_SEED_LEN},
+    sysvars::{rent::Rent, Sysvar},
+    ProgramResult,
+    program_error::ProgramError,
+};
+
+/// Create a new account at an address derived from a base pubkey and a seed.
+///
+/// ### Accounts:
+///   0. `[WRITE, SIGNER]` Funding account
+///   1. `[WRITE]` Created account
+///   2. `[SIGNER]` (optional) Base account; the account matching the base Pubkey below must be
+///      provided as a signer, but may be the same as the funding account
+pub struct CreateAccountWithSeedChecked<'a, 'b, 'c> {
+    /// Funding account.
+    pub from: &'a AccountInfo,
+
+    /// New account.
+    pub to: &'a AccountInfo,
+
+    /// Base account.
+    ///
+    /// The account matching the base Pubkey below must be provided as
+    /// a signer, but may be the same as the funding account and provided
+    /// as account 0.
+    pub base: Option<&'a AccountInfo>,
+
+    /// String of ASCII chars, no longer than `Pubkey::MAX_SEED_LEN`.
+    pub seed: &'b str,
+
+    /// Number of bytes of memory to allocate.
+    pub space: u64,
+
+    /// Address of program that will own the new account.
+    pub owner: &'c Pubkey,
+
+    /// Sysvar rent account.
+    pub sysvar_rent_account: &'a AccountInfo,
+}
+
+impl CreateAccountWithSeed<'_, '_, '_> {
+    #[inline(always)]
+    pub fn invoke(&self) -> ProgramResult {
+        self.invoke_signed_checked(&[])
+    }
+
+    #[inline(always)]
+    pub fn invoke_signed_checked(&self, signers: &[Signer]) -> ProgramResult {
+        // Get lamports from rent
+        let rent = Rent::from_account_info(self.sysvar_rent_account)?;
+        let lamports = rent.minimum_balance(self.space as usize);
+
+        // Check if the seed is valid
+        if self.seed.len() > MAX_SEED_LEN {
+            return Err(ProgramError::InvalidInstructionData);
+        }
+
+        // Check if the funding account has enough lamports
+        if self.from.lamports() < lamports {
+            return Err(ProgramError::InsufficientFunds);
+        }
+
+        // Check if the new account is already initialized
+        if !self.to.data_is_empty() {
+            return Err(ProgramError::InvalidAccountData);
+        }
+
+        self.invoke_signed(signers, lamports)
+    }
+
+    #[inline(always)]
+    fn invoke_signed(&self, signers: &[Signer], lamports: u64) -> ProgramResult {
+        // account metadata
+        let account_metas: [AccountMeta; 3] = [
+            AccountMeta::writable_signer(self.from.key()),
+            AccountMeta::writable(self.to.key()),
+            AccountMeta::readonly_signer(self.base.unwrap_or(self.from).key()),
+        ];
+
+        // instruction data
+        // - [0..4  ]: instruction discriminator
+        // - [4..36 ]: base pubkey
+        // - [36..44]: seed length
+        // - [44..  ]: seed (max 32)
+        // - [..  +8]: lamports
+        // - [..  +8]: account space
+        // - [.. +32]: owner pubkey
+        let mut instruction_data = [0; 120];
+        instruction_data[0] = 3;
+        instruction_data[4..36].copy_from_slice(self.base.unwrap_or(self.from).key());
+        instruction_data[36..44].copy_from_slice(&u64::to_le_bytes(self.seed.len() as u64));
+
+        let offset = 44 + self.seed.len();
+        instruction_data[44..offset].copy_from_slice(self.seed.as_bytes());
+        instruction_data[offset..offset + 8].copy_from_slice(&lamports.to_le_bytes());
+        instruction_data[offset + 8..offset + 16].copy_from_slice(&self.space.to_le_bytes());
+        instruction_data[offset + 16..offset + 48].copy_from_slice(self.owner.as_ref());
+
+        let instruction = Instruction {
+            program_id: &crate::ID,
+            accounts: &account_metas,
+            data: &instruction_data[..offset + 48],
+        };
+
+        invoke_signed(
+            &instruction,
+            &[self.from, self.to, self.base.unwrap_or(self.from)],
+            signers,
+        )
+    }
+}

programs/system/src/instructions/mod.rs

@@ -5,7 +5,9 @@ mod assign;
 mod assign_with_seed;
 mod authorize_nonce_account;
 mod create_account;
+mod create_account_checked;
 mod create_account_with_seed;
+mod create_account_with_seed_checked;
 mod initialize_nonce_account;
 mod transfer;
 mod transfer_with_seed;
@@ -19,7 +21,9 @@ pub use assign::*;
 pub use assign_with_seed::*;
 pub use authorize_nonce_account::*;
 pub use create_account::*;
+pub use create_account_checked::*;
 pub use create_account_with_seed::*;
+pub use create_account_with_seed_checked::*;
 pub use initialize_nonce_account::*;
 pub use transfer::*;
 pub use transfer_with_seed::*;

scripts/setup/solana.dic

@@ -63,4 +63,5 @@ callee
 RPC
 ed25519
 performant
-syscall/S
+syscall/S
+bitmask