Struct InterfaceTokenAccount 

pub struct InterfaceTokenAccount<'a> {
    pub kind: TokenProgramKind,
    /* private fields */
}

Polymorphic SPL Token / Token-2022 token-account overlay.

Construct via InterfaceTokenAccount::from_data using a borrowed view of an account body that has already been ownership-checked via TokenProgramKind::for_account. The constructor validates the body is at least crate::token::TOKEN_ACCOUNT_LEN (165) bytes.

The reader methods delegate to crate::token, which is correct for both programs because the first 165 bytes of a Token-2022 account match the SPL Token layout exactly.

let kind = TokenProgramKind::for_account(&view)?;
let data = view.try_borrow()?;
let token = InterfaceTokenAccount::from_data(&data, kind)?;
let mint = token.mint()?;

Fields

kind: TokenProgramKind

Which program owns the account.

Implementations

impl<'a> InterfaceTokenAccount<'a>

pub fn from_data( data: &'a [u8], kind: TokenProgramKind, ) -> Result<InterfaceTokenAccount<'a>, ProgramError>

Wrap a previously-borrowed account body.

Caller is responsible for confirming kind matches the account’s actual owner - usually by calling TokenProgramKind::for_account beforehand.

pub fn data(&self) -> &'a [u8]

The raw account body. Always at least 165 bytes.

pub fn mint(&self) -> Result<&'a Address, ProgramError>

The mint pubkey.

pub fn owner(&self) -> Result<&'a Address, ProgramError>

The owner pubkey of the token account (the user wallet, not the program owning the account).

pub fn amount(&self) -> Result<u64, ProgramError>

The token amount.

pub fn state(&self) -> Result<u8, ProgramError>

The state byte (0 = uninitialised, 1 = initialised, 2 = frozen).

pub fn assert_initialized(&self) -> Result<(), ProgramError>

Convenience: assert the account is initialised.

pub fn assert_owner(&self, expected: &Address) -> Result<(), ProgramError>

Convenience: assert the wallet owner matches.

pub fn assert_mint(&self, expected: &Address) -> Result<(), ProgramError>

Convenience: assert the mint matches.

Trait Implementations

impl<'a> Clone for InterfaceTokenAccount<'a>

fn clone(&self) -> InterfaceTokenAccount<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for InterfaceTokenAccount<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for InterfaceTokenAccount<'a>