117 lines
3.7 KiB
Rust
117 lines
3.7 KiB
Rust
//! Type validating that the account is a sysvar and deserializing it
|
|
|
|
use crate::error::ErrorCode;
|
|
use crate::{Accounts, AccountsExit, Result, ToAccountInfos, ToAccountMetas};
|
|
use solana_program::account_info::AccountInfo;
|
|
use solana_program::instruction::AccountMeta;
|
|
use solana_program::pubkey::Pubkey;
|
|
use std::collections::BTreeMap;
|
|
use std::fmt;
|
|
use std::ops::{Deref, DerefMut};
|
|
|
|
/// 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`](https://docs.rs/solana-program/latest/solana_program/sysvar/trait.Sysvar.html#method.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
|
|
/// ```ignore
|
|
/// // 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()?;
|
|
/// }
|
|
/// ```
|
|
pub struct Sysvar<'info, T: solana_program::sysvar::Sysvar> {
|
|
info: AccountInfo<'info>,
|
|
account: T,
|
|
}
|
|
|
|
impl<'info, T: solana_program::sysvar::Sysvar + fmt::Debug> fmt::Debug for Sysvar<'info, T> {
|
|
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
|
|
f.debug_struct("Sysvar")
|
|
.field("info", &self.info)
|
|
.field("account", &self.account)
|
|
.finish()
|
|
}
|
|
}
|
|
|
|
impl<'info, T: solana_program::sysvar::Sysvar> Sysvar<'info, T> {
|
|
pub fn from_account_info(acc_info: &AccountInfo<'info>) -> Result<Sysvar<'info, T>> {
|
|
match T::from_account_info(acc_info) {
|
|
Ok(val) => Ok(Sysvar {
|
|
info: acc_info.clone(),
|
|
account: val,
|
|
}),
|
|
Err(_) => Err(ErrorCode::AccountSysvarMismatch.into()),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<'info, T: solana_program::sysvar::Sysvar> Clone for Sysvar<'info, T> {
|
|
fn clone(&self) -> Self {
|
|
Self {
|
|
info: self.info.clone(),
|
|
account: T::from_account_info(&self.info).unwrap(),
|
|
}
|
|
}
|
|
}
|
|
|
|
impl<'info, T: solana_program::sysvar::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>,
|
|
) -> Result<Self> {
|
|
if accounts.is_empty() {
|
|
return Err(ErrorCode::AccountNotEnoughKeys.into());
|
|
}
|
|
let account = &accounts[0];
|
|
*accounts = &accounts[1..];
|
|
Sysvar::from_account_info(account)
|
|
}
|
|
}
|
|
|
|
impl<'info, T: solana_program::sysvar::Sysvar> ToAccountMetas for Sysvar<'info, T> {
|
|
fn to_account_metas(&self, _is_signer: Option<bool>) -> Vec<AccountMeta> {
|
|
vec![AccountMeta::new_readonly(*self.info.key, false)]
|
|
}
|
|
}
|
|
|
|
impl<'info, T: solana_program::sysvar::Sysvar> ToAccountInfos<'info> for Sysvar<'info, T> {
|
|
fn to_account_infos(&self) -> Vec<AccountInfo<'info>> {
|
|
vec![self.info.clone()]
|
|
}
|
|
}
|
|
|
|
impl<'info, T: solana_program::sysvar::Sysvar> AsRef<AccountInfo<'info>> for Sysvar<'info, T> {
|
|
fn as_ref(&self) -> &AccountInfo<'info> {
|
|
&self.info
|
|
}
|
|
}
|
|
|
|
impl<'a, T: solana_program::sysvar::Sysvar> Deref for Sysvar<'a, T> {
|
|
type Target = T;
|
|
|
|
fn deref(&self) -> &Self::Target {
|
|
&self.account
|
|
}
|
|
}
|
|
|
|
impl<'a, T: solana_program::sysvar::Sysvar> DerefMut for Sysvar<'a, T> {
|
|
fn deref_mut(&mut self) -> &mut Self::Target {
|
|
&mut self.account
|
|
}
|
|
}
|
|
|
|
impl<'info, T: solana_program::sysvar::Sysvar> AccountsExit<'info> for Sysvar<'info, T> {}
|