Enum MetadataInstruction 

pub enum MetadataInstruction {
    CreateMetadata {
        name: String,
        symbol: String,
        image: String,
        description: String,
        immutable: bool,
    },
    UpdateMetadata {
        name: Option<String>,
        symbol: Option<String>,
        image: Option<String>,
        description: Option<String>,
    },
    CreateAttributes {
        data: Vec<(String, String)>,
    },
    ReplaceAttributes {
        data: Vec<(String, String)>,
    },
    TransferAuthority {
        new_authority: Pubkey,
    },
    MakeImmutable,
}

Instructions supported by the token metadata program.

Variants

CreateMetadata

Create core metadata for a token

Fields

name: String

The name of the token

symbol: String

The symbol of the token

image: String

The image URI for the token

description: String

The description of the token

immutable: bool

If true, metadata is immutable (no updates allowed)

UpdateMetadata

Update core metadata

Fields

name: Option<String>

Optional new name for the token

symbol: Option<String>

Optional new symbol for the token

image: Option<String>

Optional new image URI for the token

description: Option<String>

Optional new description for the token

CreateAttributes

Create metadata attributes

Fields

data: Vec<(String, String)>

Key-value pairs for extensible attributes

ReplaceAttributes

Replace metadata attributes

Fields

data: Vec<(String, String)>

Key-value pairs for extensible attributes

TransferAuthority

Transfer update authority (must provide a new authority)

Fields

new_authority: Pubkey

New authority to transfer to

MakeImmutable

Make metadata immutable (revoke update authority)

Implementations

impl MetadataInstruction

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

Unpack a byte array into a MetadataInstruction

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

Pack the MetadataInstruction into a byte array

Trait Implementations

impl BorshDeserialize for MetadataInstruction

fn deserialize_reader<__R: Read>(reader: &mut __R) -> Result<Self, Error>

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.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for MetadataInstruction

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

impl Clone for MetadataInstruction

fn clone(&self) -> MetadataInstruction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataInstruction

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

Formats the value using the given formatter.

impl EnumExt for MetadataInstruction

fn deserialize_variant<__R: Read>( reader: &mut __R, variant_tag: u8, ) -> Result<Self, Error>

Deserialises given variant of an enum from the reader.

impl PartialEq for MetadataInstruction

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for MetadataInstruction