Derive Macro anchor_derive_accounts::Accounts [−][src]
#[derive(Accounts)]
{
// Attributes available to this derive:
#[account]
#[instruction]
}
Expand description
Implements an Accounts
deserializer on the given
struct, applying any constraints specified via inert #[account(..)]
attributes upon deserialization.
Example
ⓘ
#[derive(Accounts)]
pub struct Auth<'info> {
#[account(mut, has_one = authority)]
pub data: ProgramAccount<'info, MyData>,
#[account(signer)]
pub authority: AccountInfo<'info>,
}
#[account]
pub struct MyData {
authority: Pubkey,
protected_data: u64,
}
Here, any instance of the Auth
struct created via
try_accounts
is guaranteed
to have been both
- Signed by
authority
. - Checked that
&data.authority == authority.key
.
The full list of available attributes is as follows.
Attribute | Location | Description |
---|---|---|
#[account(signer)] | On raw AccountInfo structs. | Checks the given account signed the transaction. |
#[account(mut)] | On AccountInfo , ProgramAccount or CpiAccount structs. | Marks the account as mutable and persists the state transition. |
#[account(init)] | On ProgramAccount structs. | Marks the account as being initialized, creating the account via the system program. |
#[account(zero)] | On ProgramAccount structs. | Asserts the account discriminator is zero. |
#[account(close = <target>)] | On ProgramAccount and Loader structs. | Marks the account as being closed at the end of the instruction’s execution, sending the rent exemption lamports to the specified |
#[account(has_one = <target>)] | On ProgramAccount or CpiAccount structs | Checks the target field on the account matches the target field in the struct deriving Accounts . |
#[account(seeds = [<seeds>], bump? = <target>, payer? = <target>, space? = <target>, owner? = <target>)] | On AccountInfo structs | Seeds for the program derived address an AccountInfo struct represents. If bump is provided, then appends it to the seeds. On initialization, validates the given bump is the bump provided by Pubkey::find_program_address . |
#[account(constraint = <expression>)] | On any type deriving Accounts | Executes the given code as a constraint. The expression should evaluate to a boolean. |
#[account("<literal>")] | Deprecated | Executes the given code literal as a constraint. The literal should evaluate to a boolean. |
#[account(rent_exempt = <skip>)] | On AccountInfo or ProgramAccount structs | Optional attribute to skip the rent exemption check. By default, all accounts marked with #[account(init)] will be rent exempt, and so this should rarely (if ever) be used. Similarly, omitting = skip will mark the account rent exempt. |
#[account(executable)] | On AccountInfo structs | Checks the given account is an executable program. |
#[account(state = <target>)] | On CpiState structs | Checks the given state is the canonical state account for the target program. |
#[account(owner = <target>)] | On CpiState , CpiAccount , and AccountInfo | Checks the account owner matches the target. |
#[account(address = <pubkey>)] | On AccountInfo and Account | Checks the account key matches the pubkey. |