Enum spl_token_metadata_interface::instruction::TokenMetadataInstruction

pub enum TokenMetadataInstruction {
    Initialize(Initialize),
    UpdateField(UpdateField),
    RemoveKey(RemoveKey),
    UpdateAuthority(UpdateAuthority),
    Emit(Emit),
}

All instructions that must be implemented in the token-metadata interface

Variants

Initialize(Initialize)

Initializes a TLV entry with the basic token-metadata fields.

Assumes that the provided mint is an SPL token mint, that the metadata account is allocated and assigned to the program, and that the metadata account has enough lamports to cover the rent-exempt reserve.

Accounts expected by this instruction:

0. [w] Metadata
1. [] Update authority
2. [] Mint
3. [s] Mint authority

Data: Initialize data, name / symbol / uri strings

UpdateField(UpdateField)

Updates a field in a token-metadata account.

The field can be one of the required fields (name, symbol, URI), or a totally new field denoted by a “key” string.

By the end of the instruction, the metadata account must be properly resized based on the new size of the TLV entry.

• If the new size is larger, the program must first reallocate to avoid overwriting other TLV entries.
• If the new size is smaller, the program must reallocate at the end so that it’s possible to iterate over TLV entries

Accounts expected by this instruction:

0. [w] Metadata account
1. [s] Update authority

Data: UpdateField data, specifying the new field and value. If the field does not exist on the account, it will be created. If the field does exist, it will be overwritten.

RemoveKey(RemoveKey)

Removes a key-value pair in a token-metadata account.

This only applies to additional fields, and not the base name / symbol / URI fields.

By the end of the instruction, the metadata account must be properly resized at the end based on the new size of the TLV entry.

Accounts expected by this instruction:

0. [w] Metadata account
1. [s] Update authority

Data: the string key to remove. If the idempotent flag is set to false, returns an error if the key is not present

UpdateAuthority(UpdateAuthority)

Updates the token-metadata authority

Accounts expected by this instruction:

0. [w] Metadata account
1. [s] Current update authority

Data: the new authority. Can be unset using a None value

Emit(Emit)

Emits the token-metadata as return data

The format of the data emitted follows exactly the TokenMetadata struct, but it’s possible that the account data is stored in another format by the program.

With this instruction, a program that implements the token-metadata interface can return TokenMetadata without adhering to the specific byte layout of the TokenMetadata struct in any accounts.

Accounts expected by this instruction:

0. [] Metadata account

Implementations

impl TokenMetadataInstruction

pub fn unpack(input: &[u8]) -> Result<Self, ProgramError>

Unpacks a byte buffer into a TokenMetadataInstruction.

pub fn pack(&self) -> Vec<u8>

Packs a TokenInstruction into a byte buffer.

Trait Implementations

impl Clone for TokenMetadataInstruction

fn clone(&self) -> TokenMetadataInstruction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TokenMetadataInstruction

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

Formats the value using the given formatter.

impl PartialEq for TokenMetadataInstruction

fn eq(&self, other: &TokenMetadataInstruction) -> 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 StructuralPartialEq for TokenMetadataInstruction