Struct mpl_token_metadata::state::TokenRecord

#[repr(C)]
pub struct TokenRecord {
    pub key: Key,
    pub bump: u8,
    pub state: TokenState,
    pub rule_set_revision: Option<u64>,
    pub delegate: Option<Pubkey>,
    pub delegate_role: Option<TokenDelegateRole>,
    pub locked_transfer: Option<Pubkey>,
}

The TokenRecord struct represents the state of the token account holding a pNFT. Given that the token account is always frozen, it includes a state that provides an abstraction of frozen (locked) and thaw (unlocked).

It also stores state regarding token delegates that are set on the token account: the pubkey of the delegate set (this would match the spl-token account delegate) and the role.

Every token account holding a pNFT has a token record associated. The seeds for the token record PDA are:

1. "metadata"
2. program id
3. mint id
4. "token_record"
5. token account id

Fields

key: Key

Account key.

bump: u8

Derivation bump.

state: TokenState

Represented the token state.

rule_set_revision: Option<u64>

Stores the rule set revision (if any). The revision is updated every time a new token delegate is approved.

delegate: Option<Pubkey>

Pubkey of the current token delegate. This delegate key will match the spl-token delegate pubkey.

delegate_role: Option<TokenDelegateRole>

The role of the current token delegate.

locked_transfer: Option<Pubkey>

Stores the destination pubkey when a transfer is lock to an allowed address. This pubkey gets set when a ‘LockTransfer’ delegate is approved.

Implementations

impl TokenRecord

pub fn is_locked(&self) -> bool

pub fn reset(&mut self)

Resets the token state by clearing any state stored.

Trait Implementations

impl BorshDeserialize for TokenRecordwhere
Key: BorshDeserialize,
u8: BorshDeserialize,
TokenState: BorshDeserialize,
Option<u64>: BorshDeserialize,
Option<Pubkey>: BorshDeserialize,
Option<TokenDelegateRole>: BorshDeserialize,

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

impl BorshSerialize for TokenRecordwhere
Key: BorshSerialize,
u8: BorshSerialize,
TokenState: BorshSerialize,
Option<u64>: BorshSerialize,
Option<Pubkey>: BorshSerialize,
Option<TokenDelegateRole>: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

fn try_to_vec(&self) -> Result<Vec<u8, Global>, Error>

Serialize this instance into a vector of bytes.

impl Clone for TokenRecord

fn clone(&self) -> TokenRecord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TokenRecord

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

Formats the value using the given formatter.

impl Default for TokenRecord

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<TokenRecord> for TokenRecord

fn eq(&self, other: &TokenRecord) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Resizable for TokenRecord

fn from_bytes<'a>(account_data: &[u8]) -> Result<TokenRecord, ProgramError>

Deserializes the struct data from the specified byte array.

fn save<'a>(
&self,
account_info: &'a AccountInfo<'a>,
payer_info: &'a AccountInfo<'a>,
system_program_info: &'a AccountInfo<'a>
) -> Result<(), ProgramError>

Saves the information to the specified account, resizing the account if needed.

impl TokenMetadataAccount for TokenRecord

fn key() -> Key

fn size() -> usize

fn safe_deserialize(data: &[u8]) -> Result<Self, BorshError>

fn from_account_info(
account_info: &AccountInfo<'_>
) -> Result<Self, ProgramError>

fn is_correct_account_type(data: &[u8], data_type: Key, data_size: usize) -> bool

fn pad_length(buf: &mut Vec<u8>) -> Result<(), MetadataError>

impl Eq for TokenRecord

impl StructuralEq for TokenRecord

impl StructuralPartialEq for TokenRecord