pub struct Program<'info, T> { /* private fields */ }
Expand description

Type validating that the account is the given Program

The type has a programdata_address function that will return Option::Some if the program is owned by the BPFUpgradeableLoader which will contain the programdata_address property of the Program variant of the UpgradeableLoaderState enum.

Table of Contents

Basic Functionality

Checks:

  • account_info.key == expected_program
  • account_info.executable == true

Example

#[program]
mod my_program {
    fn set_admin_settings(...){...}
}

#[account]
#[derive(Default)]
pub struct AdminSettings {
    ...
}

#[derive(Accounts)]
pub struct SetAdminSettings<'info> {
    #[account(mut, seeds = [b"admin"], bump)]
    pub admin_settings: Account<'info, AdminSettings>,
    #[account(constraint = program.programdata_address()? == Some(program_data.key()))]
    pub program: Program<'info, MyProgram>,
    #[account(constraint = program_data.upgrade_authority_address == Some(authority.key()))]
    pub program_data: Account<'info, ProgramData>,
    pub authority: Signer<'info>,
}

The given program has a function with which the upgrade authority can set admin settings.

The required constraints are as follows:

  • program is the account of the program itself. Its constraint checks that program_data is the account that contains the program’s upgrade authority. Implicitly, this checks that program is a BPFUpgradeable program (program.programdata_address()? will be None if it’s not).
  • program_data’s constraint checks that its upgrade authority is the authority account.
  • Finally, authority needs to sign the transaction.

Out of the Box Types

Between the anchor_lang and anchor_spl crates, the following Program types are provided out of the box:

Implementations§

source§

impl<'a, T> Program<'a, T>

Methods from Deref<Target = AccountInfo<'info>>§

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>

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.

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 deserialize_data<T>(&self) -> Result<T, Box<ErrorKind>>where T: DeserializeOwned,

source

pub fn serialize_data<T>(&self, state: &T) -> Result<(), Box<ErrorKind>>where T: Serialize,

Trait Implementations§

source§

impl<'info, B, T: Id> Accounts<'info, B> for Program<'info, T>

source§

fn try_accounts( _program_id: &Pubkey, accounts: &mut &'info [AccountInfo<'info>], _ix_data: &[u8], _bumps: &mut B, _reallocs: &mut BTreeSet<Pubkey> ) -> Result<Self>

Returns the validated accounts struct. What constitutes “valid” is program dependent. However, users of these types should never have to worry about account substitution attacks. For example, if a program expects a Mint account from the SPL token program in a particular field, then it should be impossible for this method to return Ok if any other account type is given–from the SPL token program or elsewhere. Read more
source§

impl<'info, T: AccountDeserialize> AccountsExit<'info> for Program<'info, T>

source§

fn exit(&self, _program_id: &Pubkey) -> Result<()>

program_id is the currently executing program.
source§

impl<'info, T> AsRef<AccountInfo<'info>> for Program<'info, T>

source§

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

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

impl<'info, T: Clone> Clone for Program<'info, T>

source§

fn clone(&self) -> Program<'info, T>

Returns a copy 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<'info, T: Debug> Debug for Program<'info, T>

source§

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

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

impl<'info, T> Deref for Program<'info, T>

§

type Target = AccountInfo<'info>

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl<'info, T: AccountDeserialize> Key for Program<'info, T>

source§

fn key(&self) -> Pubkey

source§

impl<'info, T> ToAccountInfos<'info> for Program<'info, T>

source§

impl<'info, T> ToAccountMetas for Program<'info, T>

source§

fn to_account_metas(&self, is_signer: Option<bool>) -> Vec<AccountMeta>

is_signer is given as an optional override for the signer meta field. This covers the edge case when a program-derived-address needs to relay a transaction from a client to another program but sign the transaction before the relay. The client cannot mark the field as a signer, and so we have to override the is_signer meta field given by the client.
source§

impl<'a, T: Id> TryFrom<&'a AccountInfo<'a>> for Program<'a, T>

source§

fn try_from(info: &'a AccountInfo<'a>) -> Result<Self>

Deserializes the given info into a Program.

§

type Error = Error

The type returned in the event of a conversion error.

Auto Trait Implementations§

§

impl<'info, T> !RefUnwindSafe for Program<'info, T>

§

impl<'info, T> !Send for Program<'info, T>

§

impl<'info, T> !Sync for Program<'info, T>

§

impl<'info, T> Unpin for Program<'info, T>where T: Unpin,

§

impl<'info, T> !UnwindSafe for Program<'info, T>

Blanket Implementations§

§

impl<T> AbiExample for T

§

default fn example() -> T

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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<'info, T> Lamports<'info> for Twhere T: AsRef<AccountInfo<'info>>,

source§

fn get_lamports(&self) -> u64

Get the lamports of the account.
source§

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

Add lamports to the account. Read more
source§

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

Subtract lamports from the account. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<'info, T> ToAccountInfo<'info> for Twhere T: AsRef<AccountInfo<'info>>,

source§

impl<T> ToOwned for Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V