apl-token-metadata 0.6.5

On-chain program for Arch Token Metadata
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

//! Instruction types

use {
    arch_program::{program_error::ProgramError, pubkey::Pubkey},
    borsh::{BorshDeserialize, BorshSerialize},
};

/// Instructions supported by the token metadata program.
#[derive(BorshSerialize, BorshDeserialize, Debug, Clone, PartialEq)]
pub enum MetadataInstruction {
    /// Create core metadata for a token
    CreateMetadata {
        /// The name of the token
        name: String,
        /// The symbol of the token
        symbol: String,
        /// The image URI for the token
        image: String,
        /// The description of the token
        description: String,
        /// If true, metadata is immutable (no updates allowed)
        immutable: bool,
    },
    /// Update core metadata
    UpdateMetadata {
        /// Optional new name for the token
        name: Option<String>,
        /// Optional new symbol for the token
        symbol: Option<String>,
        /// Optional new image URI for the token
        image: Option<String>,
        /// Optional new description for the token
        description: Option<String>,
    },
    /// Create metadata attributes
    CreateAttributes {
        /// Key-value pairs for extensible attributes
        data: Vec<(String, String)>,
    },
    /// Replace metadata attributes
    ReplaceAttributes {
        /// Key-value pairs for extensible attributes
        data: Vec<(String, String)>,
    },
    /// Transfer update authority (must provide a new authority)
    TransferAuthority {
        /// New authority to transfer to
        new_authority: Pubkey,
    },
    /// Make metadata immutable (revoke update authority)
    MakeImmutable,
    /// Sign a Bitcoin transaction input for an account owned by this program.
    ///
    /// Works for metadata accounts. Reads the pending Bitcoin transaction via
    /// `get_transaction_to_sign`, computes its txid, validates the
    /// update_authority, and registers the specified input for signing.
    ///
    /// Accounts expected by this instruction:
    ///
    ///   0. `[writable]` The metadata account
    ///   1. `[signer]` The update authority
    Anchor {
        /// Index of the input in the Bitcoin transaction to sign
        input_index: u32,
        /// The public key of the signer for this input
        input_signer: Pubkey,
    },
}

impl MetadataInstruction {
    /// Unpack a byte array into a MetadataInstruction
    pub fn unpack(input: &[u8]) -> Result<Self, ProgramError> {
        borsh::from_slice(input).map_err(|_| ProgramError::InvalidInstructionData)
    }

    /// Pack the MetadataInstruction into a byte array
    pub fn pack(&self) -> Vec<u8> {
        borsh::to_vec(self).unwrap()
    }
}