Module anchor_lang::prelude

The prelude contains all commonly used components of the crate. All programs should include it via anchor_lang::prelude::*;.

Re-exports

pub use super::accounts::account::Account;

pub use super::accounts::loader_account::AccountLoader;

pub use super::accounts::program::Program;

pub use super::accounts::signer::Signer;

pub use super::accounts::system_account::SystemAccount;

pub use super::accounts::sysvar::Sysvar;

pub use super::accounts::unchecked_account::UncheckedAccount;

pub use super::context::Context;

pub use super::context::CpiContext;

pub use super::require;

pub use super::AccountDeserialize;

pub use super::AccountSerialize;

pub use super::Accounts;

pub use super::AccountsExit;

pub use super::Id;

pub use super::Key;

pub use super::Owner;

pub use super::ToAccountInfo;

pub use super::ToAccountInfos;

pub use super::ToAccountMetas;

pub use borsh;

pub use thiserror;

Macros

declare_id

Defines the program’s ID. This should be used at the root of all Anchor based programs.

emit

Creates an event that can be subscribed to by clients. Calling this method will internally borsh serialize the event, base64 encode the bytes, and then add a msg! log to the transaction.

msg

Print a message to the log.

Structs

AccountInfo

Account information

AccountMeta

Describes a single account read or written by a program during instruction execution.

Clock

Clock represents network time. Members of Clock start from 0 upon network boot. The best way to map Clock to wallclock time is to use current Slot, as Epochs vary in duration (they start short and grow as the network progresses).

EpochSchedule

FeesDeprecated

Instructions

ProgramData

Pubkey

RecentBlockhashesDeprecated

Contains recent block hashes and fee calculators.

Rent

Rewards

SlotHashes

SlotHistory

StakeHistory

System

Enums

ProgramError

Reasons the program may fail

UpgradeableLoaderState

Upgradeable loader account states

Traits

AnchorDeserialize

A data-structure that can be de-serialized from binary format by NBOR.

AnchorSerialize

A data-structure that can be serialized into binary format by NBOR.

SolanaSysvar

Functions

next_account_info

Convenience function for accessing the next item in an AccountInfo iterator.

Type Definitions

ProgramResult

Attribute Macros

access_control

Executes the given access control method before running the decorated instruction handler. Any method in scope of the attribute can be invoked with any arguments from the associated instruction handler.

account

An attribute for a data structure representing a Solana account.

constant

A marker attribute used to mark const values that should be included in the generated IDL but functionally does nothing.

error

Generates Error and type Result<T> = Result<T, Error> types to be used as return types from Anchor instruction handlers. Importantly, the attribute implements From on the ErrorCode to support converting from the user defined error enum into the generated Error.

event

The event attribute allows a struct to be used with emit! so that programs can log significant events in their programs that clients can subscribe to. Currently, this macro is for structs only.

interface

The #[interface] attribute allows one to define an external program dependency, without having any knowledge about the program, other than the fact that it implements the given trait.

program

The #[program] attribute defines the module containing all instruction handlers defining all entries into a Solana program.

state

The #[state] attribute defines the program’s state struct, i.e., the program’s global account singleton giving the program the illusion of state.

zero_copy

A data structure that can be used as an internal field for a zero copy deserialized account, i.e., a struct marked with #[account(zero_copy)].

Derive Macros

Accounts

Implements an Accounts deserializer on the given struct. Can provide further functionality through the use of attributes.

AnchorDeserialize

AnchorSerialize