use crate::{ clock::Epoch, program_error::ProgramError, program_memory::sol_memset, pubkey::Pubkey, }; use std::{ cell::{Ref, RefCell, RefMut}, cmp, fmt, rc::Rc, }; /// Account information #[derive(Clone)] pub struct AccountInfo<'a> { /// Public key of the account pub key: &'a Pubkey, /// Was the transaction signed by this account's public key? pub is_signer: bool, /// Is the account writable? pub is_writable: bool, /// The lamports in the account. Modifiable by programs. pub lamports: Rc>, /// The data held in this account. Modifiable by programs. pub data: Rc>, /// Program that owns this account pub owner: &'a Pubkey, /// This account's data contains a loaded program (and is now read-only) pub executable: bool, /// The epoch at which this account will next owe rent pub rent_epoch: Epoch, } impl<'a> fmt::Debug for AccountInfo<'a> { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { let data_len = cmp::min(64, self.data_len()); let data_str = if data_len > 0 { format!( " data: {} ...", hex::encode(self.data.borrow()[..data_len].to_vec()) ) } else { "".to_string() }; write!( f, "AccountInfo {{ key: {} owner: {} is_signer: {} is_writable: {} executable: {} rent_epoch: {} lamports: {} data.len: {} {} }}", self.key, self.owner, self.is_signer, self.is_writable, self.executable, self.rent_epoch, self.lamports(), self.data_len(), data_str, ) } } impl<'a> AccountInfo<'a> { pub fn signer_key(&self) -> Option<&Pubkey> { if self.is_signer { Some(self.key) } else { None } } pub fn unsigned_key(&self) -> &Pubkey { self.key } pub fn lamports(&self) -> u64 { **self.lamports.borrow() } pub fn try_lamports(&self) -> Result { Ok(**self.try_borrow_lamports()?) } pub fn data_len(&self) -> usize { self.data.borrow().len() } pub fn try_data_len(&self) -> Result { Ok(self.try_borrow_data()?.len()) } pub fn data_is_empty(&self) -> bool { self.data.borrow().is_empty() } pub fn try_data_is_empty(&self) -> Result { Ok(self.try_borrow_data()?.is_empty()) } pub fn try_borrow_lamports(&self) -> Result, ProgramError> { self.lamports .try_borrow() .map_err(|_| ProgramError::AccountBorrowFailed) } pub fn try_borrow_mut_lamports(&self) -> Result, ProgramError> { self.lamports .try_borrow_mut() .map_err(|_| ProgramError::AccountBorrowFailed) } pub fn try_borrow_data(&self) -> Result, ProgramError> { self.data .try_borrow() .map_err(|_| ProgramError::AccountBorrowFailed) } pub fn try_borrow_mut_data(&self) -> Result, ProgramError> { self.data .try_borrow_mut() .map_err(|_| ProgramError::AccountBorrowFailed) } /// Realloc the account's data and optionally zero-initialize the new /// memory. /// /// Note: Account data can be increased within a single call by up to /// `solana_program::entrypoint::MAX_PERMITTED_DATA_INCREASE` bytes. /// /// Note: Memory used to grow is already zero-initialized upon program /// entrypoint and re-zeroing it wastes compute units. If within the same /// call a program reallocs from larger to smaller and back to larger again /// the new space could contain stale data. Pass `true` for `zero_init` in /// this case, otherwise compute units will be wasted re-zero-initializing. pub fn realloc(&self, new_len: usize, zero_init: bool) -> Result<(), ProgramError> { let orig_len = self.data_len(); // realloc unsafe { // First set new length in the serialized data let ptr = self.try_borrow_mut_data()?.as_mut_ptr().offset(-8) as *mut u64; *ptr = new_len as u64; // Then set the new length in the local slice let ptr = &mut *(((self.data.as_ptr() as *const u64).offset(1) as u64) as *mut u64); *ptr = new_len as u64; } // zero-init if requested if zero_init && new_len > orig_len { sol_memset( &mut self.try_borrow_mut_data()?[orig_len..], 0, new_len.saturating_sub(orig_len), ); } Ok(()) } pub fn assign(&self, new_owner: &Pubkey) { // Set the non-mut owner field unsafe { std::ptr::write_volatile( self.owner as *const Pubkey as *mut [u8; 32], new_owner.to_bytes(), ); } } pub fn new( key: &'a Pubkey, is_signer: bool, is_writable: bool, lamports: &'a mut u64, data: &'a mut [u8], owner: &'a Pubkey, executable: bool, rent_epoch: Epoch, ) -> Self { Self { key, is_signer, is_writable, lamports: Rc::new(RefCell::new(lamports)), data: Rc::new(RefCell::new(data)), owner, executable, rent_epoch, } } pub fn deserialize_data(&self) -> Result { bincode::deserialize(&self.data.borrow()) } pub fn serialize_data(&self, state: &T) -> Result<(), bincode::Error> { if bincode::serialized_size(state)? > self.data_len() as u64 { return Err(Box::new(bincode::ErrorKind::SizeLimit)); } bincode::serialize_into(&mut self.data.borrow_mut()[..], state) } } /// Constructs an `AccountInfo` from self, used in conversion implementations. pub trait IntoAccountInfo<'a> { fn into_account_info(self) -> AccountInfo<'a>; } impl<'a, T: IntoAccountInfo<'a>> From for AccountInfo<'a> { fn from(src: T) -> Self { src.into_account_info() } } /// Provides information required to construct an `AccountInfo`, used in /// conversion implementations. pub trait Account { fn get(&mut self) -> (&mut u64, &mut [u8], &Pubkey, bool, Epoch); } /// Convert (&'a Pubkey, &'a mut T) where T: Account into an `AccountInfo` impl<'a, T: Account> IntoAccountInfo<'a> for (&'a Pubkey, &'a mut T) { fn into_account_info(self) -> AccountInfo<'a> { let (key, account) = self; let (lamports, data, owner, executable, rent_epoch) = account.get(); AccountInfo::new( key, false, false, lamports, data, owner, executable, rent_epoch, ) } } /// Convert (&'a Pubkey, bool, &'a mut T) where T: Account into an /// `AccountInfo`. impl<'a, T: Account> IntoAccountInfo<'a> for (&'a Pubkey, bool, &'a mut T) { fn into_account_info(self) -> AccountInfo<'a> { let (key, is_signer, account) = self; let (lamports, data, owner, executable, rent_epoch) = account.get(); AccountInfo::new( key, is_signer, false, lamports, data, owner, executable, rent_epoch, ) } } /// Convert &'a mut (Pubkey, T) where T: Account into an `AccountInfo`. impl<'a, T: Account> IntoAccountInfo<'a> for &'a mut (Pubkey, T) { fn into_account_info(self) -> AccountInfo<'a> { let (ref key, account) = self; let (lamports, data, owner, executable, rent_epoch) = account.get(); AccountInfo::new( key, false, false, lamports, data, owner, executable, rent_epoch, ) } } /// Convenience function for accessing the next item in an [`AccountInfo`] /// iterator. /// /// This is simply a wrapper around [`Iterator::next`] that returns a /// [`ProgramError`] instead of an option. /// /// # Errors /// /// Returns [`ProgramError::NotEnoughAccountKeys`] if there are no more items in /// the iterator. /// /// # Examples /// /// ``` /// use solana_program::{ /// account_info::{AccountInfo, next_account_info}, /// entrypoint::ProgramResult, /// pubkey::Pubkey, /// }; /// # use solana_program::program_error::ProgramError; /// /// pub fn process_instruction( /// program_id: &Pubkey, /// accounts: &[AccountInfo], /// instruction_data: &[u8], /// ) -> ProgramResult { /// let accounts_iter = &mut accounts.iter(); /// let signer = next_account_info(accounts_iter)?; /// let payer = next_account_info(accounts_iter)?; /// /// // do stuff ... /// /// Ok(()) /// } /// # let p = Pubkey::new_unique(); /// # let l = &mut 0; /// # let d = &mut [0u8]; /// # let a = AccountInfo::new(&p, false, false, l, d, &p, false, 0); /// # let accounts = &[a.clone(), a]; /// # process_instruction( /// # &Pubkey::new_unique(), /// # accounts, /// # &[], /// # )?; /// # Ok::<(), ProgramError>(()) /// ``` pub fn next_account_info<'a, 'b, I: Iterator>>( iter: &mut I, ) -> Result { iter.next().ok_or(ProgramError::NotEnoughAccountKeys) } /// Convenience function for accessing multiple next items in an [`AccountInfo`] /// iterator. /// /// Returns a slice containing the next `count` [`AccountInfo`]s. /// /// # Errors /// /// Returns [`ProgramError::NotEnoughAccountKeys`] if there are not enough items /// in the iterator to satisfy the request. /// /// # Examples /// /// ``` /// use solana_program::{ /// account_info::{AccountInfo, next_account_info, next_account_infos}, /// entrypoint::ProgramResult, /// pubkey::Pubkey, /// }; /// # use solana_program::program_error::ProgramError; /// /// pub fn process_instruction( /// program_id: &Pubkey, /// accounts: &[AccountInfo], /// instruction_data: &[u8], /// ) -> ProgramResult { /// let accounts_iter = &mut accounts.iter(); /// let signer = next_account_info(accounts_iter)?; /// let payer = next_account_info(accounts_iter)?; /// let outputs = next_account_infos(accounts_iter, 3)?; /// /// // do stuff ... /// /// Ok(()) /// } /// # let p = Pubkey::new_unique(); /// # let l = &mut 0; /// # let d = &mut [0u8]; /// # let a = AccountInfo::new(&p, false, false, l, d, &p, false, 0); /// # let accounts = &[a.clone(), a.clone(), a.clone(), a.clone(), a]; /// # process_instruction( /// # &Pubkey::new_unique(), /// # accounts, /// # &[], /// # )?; /// # Ok::<(), ProgramError>(()) /// ``` pub fn next_account_infos<'a, 'b: 'a>( iter: &mut std::slice::Iter<'a, AccountInfo<'b>>, count: usize, ) -> Result<&'a [AccountInfo<'b>], ProgramError> { let accounts = iter.as_slice(); if accounts.len() < count { return Err(ProgramError::NotEnoughAccountKeys); } let (accounts, remaining) = accounts.split_at(count); *iter = remaining.iter(); Ok(accounts) } impl<'a> AsRef> for AccountInfo<'a> { fn as_ref(&self) -> &AccountInfo<'a> { self } } #[cfg(test)] mod tests { use super::*; #[test] fn test_next_account_infos() { let k1 = Pubkey::new_unique(); let k2 = Pubkey::new_unique(); let k3 = Pubkey::new_unique(); let k4 = Pubkey::new_unique(); let k5 = Pubkey::new_unique(); let l1 = &mut 0; let l2 = &mut 0; let l3 = &mut 0; let l4 = &mut 0; let l5 = &mut 0; let d1 = &mut [0u8]; let d2 = &mut [0u8]; let d3 = &mut [0u8]; let d4 = &mut [0u8]; let d5 = &mut [0u8]; let infos = &[ AccountInfo::new(&k1, false, false, l1, d1, &k1, false, 0), AccountInfo::new(&k2, false, false, l2, d2, &k2, false, 0), AccountInfo::new(&k3, false, false, l3, d3, &k3, false, 0), AccountInfo::new(&k4, false, false, l4, d4, &k4, false, 0), AccountInfo::new(&k5, false, false, l5, d5, &k5, false, 0), ]; let infos_iter = &mut infos.iter(); let info1 = next_account_info(infos_iter).unwrap(); let info2_3_4 = next_account_infos(infos_iter, 3).unwrap(); let info5 = next_account_info(infos_iter).unwrap(); assert_eq!(k1, *info1.key); assert_eq!(k2, *info2_3_4[0].key); assert_eq!(k3, *info2_3_4[1].key); assert_eq!(k4, *info2_3_4[2].key); assert_eq!(k5, *info5.key); } #[test] fn test_account_info_as_ref() { let k = Pubkey::new_unique(); let l = &mut 0; let d = &mut [0u8]; let info = AccountInfo::new(&k, false, false, l, d, &k, false, 0); assert_eq!(info.key, info.as_ref().key); } }