light-token-interface 0.5.0

Light Protocol token instruction data types.
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

use light_compressed_account::Pubkey;
use light_zero_copy::ZeroCopy;

use crate::{AnchorDeserialize, AnchorSerialize};

#[repr(C)]
#[derive(Debug, Clone, AnchorSerialize, AnchorDeserialize, ZeroCopy)]
pub struct UpdateMetadataFieldAction {
    pub extension_index: u8, // Index of the TokenMetadata extension in the extensions array
    pub field_type: u8,      // 0=Name, 1=Symbol, 2=Uri, 3=Custom key
    pub key: Vec<u8>,        // Empty for Name/Symbol/Uri, key string for custom fields
    pub value: Vec<u8>,      // UTF-8 encoded value
}

#[repr(C)]
#[derive(Debug, Clone, AnchorSerialize, AnchorDeserialize, ZeroCopy)]
pub struct UpdateMetadataAuthorityAction {
    pub extension_index: u8, // Index of the TokenMetadata extension in the extensions array
    pub new_authority: Pubkey, // Use zero bytes to set to None
}

#[repr(C)]
#[derive(Debug, Clone, AnchorSerialize, AnchorDeserialize, ZeroCopy)]
pub struct RemoveMetadataKeyAction {
    pub extension_index: u8, // Index of the TokenMetadata extension in the extensions array
    pub key: Vec<u8>,        // UTF-8 encoded key to remove
    pub idempotent: u8,      // 0=false, 1=true - don't error if key doesn't exist
}

/// Authority types for compressed mint updates, following SPL Token-2022 pattern
#[derive(Debug, Clone, PartialEq, Eq, AnchorSerialize, AnchorDeserialize, ZeroCopy)]
#[repr(C, u8)]
pub enum MetadataUpdate {
    UpdateAuthority(UpdateMetadataAuthority),
    UpdateKey(UpdateKey),
    RemoveKey(RemoveKey),
}

#[repr(C)]
#[derive(Debug, Clone, PartialEq, Eq, AnchorSerialize, AnchorDeserialize, ZeroCopy)]
pub struct UpdateKey {
    pub extension_index: u8,
    pub key_index: u8,
    pub key: Vec<u8>,
    pub value: Vec<u8>,
}

#[repr(C)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, AnchorSerialize, AnchorDeserialize, ZeroCopy)]
pub struct RemoveKey {
    pub extension_index: u8,
    pub key_index: u8,
}

#[repr(C)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, AnchorSerialize, AnchorDeserialize, ZeroCopy)]
pub struct UpdateMetadataAuthority {
    pub extension_index: u8,
    pub new_authority: Pubkey,
}