Skip to main content

AccountInfo

Struct AccountInfo 

Source
#[repr(C)]
pub struct AccountInfo<'a> { pub key: &'a Pubkey, pub lamports: Rc<RefCell<&'a mut u64>>, pub data: Rc<RefCell<&'a mut [u8]>>, pub owner: &'a Pubkey, pub rent_epoch: u64, pub is_signer: bool, pub is_writable: bool, pub executable: bool, }
Expand description

Account information

Fields§

§key: &'a Pubkey

Public key of the account

§lamports: Rc<RefCell<&'a mut u64>>

The lamports in the account. Modifiable by programs.

§data: Rc<RefCell<&'a mut [u8]>>

The data held in this account. Modifiable by programs.

§owner: &'a Pubkey

Program that owns this account

§rent_epoch: u64

The epoch at which this account will next owe rent

§is_signer: bool

Was the transaction signed by this account’s public key?

§is_writable: bool

Is the account writable?

§executable: bool

This account’s data contains a loaded program (and is now read-only)

Implementations§

Source§

impl<'a> AccountInfo<'a>

Source

pub fn signer_key(&self) -> Option<&Pubkey>

Source

pub fn unsigned_key(&self) -> &Pubkey

Source

pub fn lamports(&self) -> u64

Source

pub fn try_lamports(&self) -> Result<u64, ProgramError>

Source

pub unsafe fn original_data_len(&self) -> usize

Return the account’s original data length when it was serialized for the current program invocation.

§Safety

This method assumes that the original data length was serialized as a u32 integer in the 4 bytes immediately preceding the serialized account key.

Source

pub fn data_len(&self) -> usize

Source

pub fn try_data_len(&self) -> Result<usize, ProgramError>

Source

pub fn data_is_empty(&self) -> bool

Source

pub fn try_data_is_empty(&self) -> Result<bool, ProgramError>

Source

pub fn try_borrow_lamports(&self) -> Result<Ref<'_, &mut u64>, ProgramError>

Source

pub fn try_borrow_mut_lamports( &self, ) -> Result<RefMut<'_, &'a mut u64>, ProgramError>

Source

pub fn try_borrow_data(&self) -> Result<Ref<'_, &mut [u8]>, ProgramError>

Source

pub fn try_borrow_mut_data( &self, ) -> Result<RefMut<'_, &'a mut [u8]>, ProgramError>

Source

pub fn realloc( &self, new_len: usize, zero_init: bool, ) -> Result<(), ProgramError>

👎Deprecated since 2.3.0: Use AccountInfo::resize() instead

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: zero_init being false will no longer be supported by the program runtime.

§Safety

This method makes assumptions about the layout and location of memory referenced by AccountInfo fields. It should only be called for instances of AccountInfo that were created by the runtime and received in the process_instruction entrypoint of a program.

Source

pub fn resize(&self, new_len: usize) -> Result<(), ProgramError>

Resize the account’s data: Either truncating or zero extending.

Note: Account data can be increased within a single call by up to solana_program::entrypoint::MAX_PERMITTED_DATA_INCREASE bytes.

§Safety

This method makes assumptions about the layout and location of memory referenced by AccountInfo fields. It should only be called for instances of AccountInfo that were created by the runtime and received in the process_instruction entrypoint of a program.

Source

pub fn assign(&self, new_owner: &Pubkey)

Source

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: u64, ) -> AccountInfo<'a>

Trait Implementations§

Source§

impl AccountInfoTrait for AccountInfo<'_>

Implement trait for solana AccountInfo

Source§

type Pubkey = Pubkey

Source§

type DataRef<'b> = Ref<'b, [u8]> where AccountInfo<'_>: 'b

Source§

type DataRefMut<'b> = RefMut<'b, [u8]> where AccountInfo<'_>: 'b

Source§

fn key(&self) -> [u8; 32]

Return raw byte array for maximum compatibility
Source§

fn key_ref(&self) -> &[u8]

Return a reference to the key bytes with the lifetime of the account. Used when building seed ref arrays that borrow from the accounts slice.
Source§

fn pubkey(&self) -> <AccountInfo<'_> as AccountInfoTrait>::Pubkey

Return the pubkey in the native format
Source§

fn pubkey_from_bytes( bytes: [u8; 32], ) -> <AccountInfo<'_> as AccountInfoTrait>::Pubkey

Convert byte array to native Pubkey type
Source§

fn is_writable(&self) -> bool

Source§

fn is_signer(&self) -> bool

Source§

fn executable(&self) -> bool

Source§

fn lamports(&self) -> u64

Source§

fn data_len(&self) -> usize

Source§

fn try_borrow_data( &self, ) -> Result<<AccountInfo<'_> as AccountInfoTrait>::DataRef<'_>, AccountError>

Unified data access interface
Source§

fn try_borrow_mut_data( &self, ) -> Result<<AccountInfo<'_> as AccountInfoTrait>::DataRefMut<'_>, AccountError>

Source§

fn is_owned_by(&self, program: &[u8; 32]) -> bool

Check ownership safely - each implementation handles this without exposing owner
Source§

fn find_program_address( seeds: &[&[u8]], program_id: &[u8; 32], ) -> ([u8; 32], u8)

PDA functions - each implementation uses its own backend
Source§

fn create_program_address( seeds: &[&[u8]], program_id: &[u8; 32], ) -> Result<[u8; 32], AccountError>

Source§

fn get_min_rent_balance(size: usize) -> Result<u64, AccountError>

Get minimum rent balance for a given size
Source§

fn get_current_slot() -> Result<u64, AccountError>

Get the current clock slot from sysvar. Only meaningful on-chain; implementations may error off-chain.
Source§

fn assign(&self, new_owner: &[u8; 32]) -> Result<(), AccountError>

Assign the account to a new owner program.
Source§

fn realloc(&self, new_len: usize, zero_init: bool) -> Result<(), AccountError>

Resize the account data (truncating or zero-extending).
Source§

fn sub_lamports(&self, amount: u64) -> Result<(), AccountError>

Subtract lamports from the account (checked).
Source§

fn add_lamports(&self, amount: u64) -> Result<(), AccountError>

Add lamports to the account (checked).
Source§

fn close(&self, destination: &AccountInfo<'_>) -> Result<(), AccountError>

Close this account: zero data, transfer all lamports to destination, assign to system program.
Source§

fn create_pda_account( &self, lamports: u64, space: u64, owner: &[u8; 32], pda_seeds: &[&[u8]], rent_payer: &AccountInfo<'_>, rent_payer_seeds: &[&[u8]], system_program: &AccountInfo<'_>, ) -> Result<(), AccountError>

Create a PDA account via system program CPI (invoke_signed). Read more
Source§

fn transfer_lamports_cpi( &self, destination: &AccountInfo<'_>, lamports: u64, signer_seeds: &[&[u8]], ) -> Result<(), AccountError>

Transfer lamports via system program CPI with invoke_signed. Pass &[] for signer_seeds if the sender is already a signer.
Source§

fn invoke_cpi( program_id: &[u8; 32], instruction_data: &[u8], account_metas: &[CpiMeta], account_infos: &[AccountInfo<'_>], signer_seeds: &[&[&[u8]]], ) -> Result<(), AccountError>

Invoke an arbitrary program via CPI with optional PDA signing. Read more
Source§

fn data_is_empty(&self) -> bool

Source§

fn transfer_lamports( &self, destination: &Self, lamports: u64, ) -> Result<(), AccountError>

Transfer lamports by direct lamport manipulation (no CPI).
Source§

impl<'a> AsRef<AccountInfo<'a>> for AccountInfo<'a>

Source§

fn as_ref(&self) -> &AccountInfo<'a>

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl<'a> Clone for AccountInfo<'a>

Source§

fn clone(&self) -> AccountInfo<'a>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for AccountInfo<'_>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more
Source§

impl<'a, T> From<T> for AccountInfo<'a>
where T: IntoAccountInfo<'a>,

Source§

fn from(src: T) -> AccountInfo<'a>

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<'a> Freeze for AccountInfo<'a>

§

impl<'a> !RefUnwindSafe for AccountInfo<'a>

§

impl<'a> !Send for AccountInfo<'a>

§

impl<'a> !Sync for AccountInfo<'a>

§

impl<'a> Unpin for AccountInfo<'a>

§

impl<'a> !UnwindSafe for AccountInfo<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.