Struct anchor_lang::accounts::sysvar::Sysvar

pub struct Sysvar<'info, T: Sysvar> { /* private fields */ }

Type validating that the account is a sysvar and deserializing it.

If possible, sysvars should not be used via accounts but by using the get function on the desired sysvar. This is because using get does not run the risk of Anchor having a bug in its Sysvar type and using get also decreases tx size, making space for other accounts that cannot be requested via syscall.

Example

// OK - via account in the account validation struct
#[derive(Accounts)]
pub struct Example<'info> {
    pub clock: Sysvar<'info, Clock>
}
// BETTER - via syscall in the instruction function
fn better(ctx: Context<Better>) -> Result<()> {
    let clock = Clock::get()?;
}

Implementations

impl<'info, T: Sysvar> Sysvar<'info, T>

pub fn from_account_info(
    acc_info: &AccountInfo<'info>
) -> Result<Sysvar<'info, T>>

Trait Implementations

impl<'info, T: Sysvar> Accounts<'info> for Sysvar<'info, T>

fn try_accounts(
    _program_id: &Pubkey,
    accounts: &mut &[AccountInfo<'info>],
    _ix_data: &[u8],
    _bumps: &mut BTreeMap<String, u8>,
    _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.

impl<'info, T: Sysvar> AccountsExit<'info> for Sysvar<'info, T>

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

program_id is the currently executing program.

impl<'info, T: Sysvar> AsRef<AccountInfo<'info>> for Sysvar<'info, T>

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

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

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

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'info, T: Sysvar + Debug> Debug for Sysvar<'info, T>

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

Formats the value using the given formatter.

impl<'a, T: Sysvar> Deref for Sysvar<'a, T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, T: Sysvar> DerefMut for Sysvar<'a, T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'info, T: Sysvar> Key for Sysvar<'info, T>

fn key(&self) -> Pubkey

impl<'info, T: Sysvar> ToAccountInfos<'info> for Sysvar<'info, T>

fn to_account_infos(&self) -> Vec<AccountInfo<'info>>

impl<'info, T: Sysvar> ToAccountMetas for Sysvar<'info, T>

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.