Struct spl_token_metadata_interface::state::TokenMetadata

pub struct TokenMetadata {
    pub update_authority: OptionalNonZeroPubkey,
    pub mint: Pubkey,
    pub name: String,
    pub symbol: String,
    pub uri: String,
    pub additional_metadata: Vec<(String, String)>,
}

Data struct for all token-metadata, stored in a TLV entry

The type and length parts must be handled by the TLV library, and not stored as part of this struct.

Fields

update_authority: OptionalNonZeroPubkey

The authority that can sign to update the metadata

mint: Pubkey

The associated mint, used to counter spoofing to be sure that metadata belongs to a particular mint

name: String

The longer name of the token

symbol: String

The shortened symbol for the token

uri: String

The URI pointing to richer metadata

additional_metadata: Vec<(String, String)>

Any additional metadata about the token as key-value pairs. The program must avoid storing the same key twice.

Implementations

impl TokenMetadata

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

Gives the total size of this struct as a TLV entry in an account

pub fn update(&mut self, field: Field, value: String)

Updates a field in the metadata struct

pub fn set_key_value(&mut self, new_key: String, new_value: String)

Sets a key-value pair in the additional metadata

If the key is already present, overwrites the existing entry. Otherwise, adds it to the end.

pub fn remove_key(&mut self, key: &str) -> bool

Removes the key-value pair given by the provided key. Returns true if the key was found.

pub fn get_slice( data: &[u8], start: Option<u64>, end: Option<u64>, ) -> Option<&[u8]>

Get the slice corresponding to the given start and end range

Trait Implementations

impl BorshDeserialize for TokenMetadata

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 BorshSchema for TokenMetadata

fn declaration() -> Declaration

Get the name of the type without brackets.

fn add_definitions_recursively( definitions: &mut BTreeMap<Declaration, Definition>, )

Recursively, using DFS, add type definitions required for this type. Type definition partially explains how to serialize/deserialize a type.

impl BorshSerialize for TokenMetadata

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

impl Clone for TokenMetadata

fn clone(&self) -> TokenMetadata

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TokenMetadata

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

Formats the value using the given formatter.

impl Default for TokenMetadata

fn default() -> TokenMetadata

Returns the “default value” for a type.

impl PartialEq for TokenMetadata

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

const SPL_DISCRIMINATOR: ArrayDiscriminator = _

Please use this discriminator in your program when matching

const SPL_DISCRIMINATOR_SLICE: &'static [u8] = _

The 8-byte discriminator as a slice (&[u8])

impl VariableLenPack for TokenMetadata

fn pack_into_slice(&self, dst: &mut [u8]) -> Result<(), ProgramError>

Writes the serialized form of the instance into the given slice

fn unpack_from_slice(src: &[u8]) -> Result<Self, ProgramError>

Deserializes the type from the given slice

fn get_packed_len(&self) -> Result<usize, ProgramError>

Gets the packed length for a given instance of the type

fn pack(&self, dst: &mut [u8]) -> Result<(), ProgramError>

Safely write the contents to the type into the given slice

impl StructuralPartialEq for TokenMetadata