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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
// Tests compatibility between Borsh and Zero-copy serialization for Mint
// Verifies that both implementations correctly serialize/deserialize their data
// and maintain full struct equivalence including token metadata extension.

use borsh::{BorshDeserialize, BorshSerialize};
use light_compressed_account::Pubkey;
use light_compressible::compression_info::CompressionInfo;
use light_token_interface::state::{
    extensions::{AdditionalMetadata, ExtensionStruct, TokenMetadata},
    mint::{BaseMint, Mint, MintMetadata, ACCOUNT_TYPE_MINT},
};
use light_zero_copy::traits::{ZeroCopyAt, ZeroCopyAtMut};
use rand::{thread_rng, Rng};
use spl_token_2022::{solana_program::program_pack::Pack, state::Mint as SplMint};

/// Generate random token metadata extension
fn generate_random_token_metadata(rng: &mut impl Rng) -> TokenMetadata {
    // Random update authority
    let update_authority = if rng.gen_bool(0.7) {
        let mut bytes = [0u8; 32];
        rng.fill(&mut bytes);
        Pubkey::from(bytes)
    } else {
        Pubkey::from([0u8; 32]) // Zero pubkey for None
    };

    // Random mint
    let mut mint_bytes = [0u8; 32];
    rng.fill(&mut mint_bytes);
    let mint = Pubkey::from(mint_bytes);

    // Random name (1-32 chars)
    let name_len = rng.gen_range(1..=32);
    let name: Vec<u8> = (0..name_len).map(|_| rng.gen::<u8>()).collect();

    // Random symbol (1-10 chars)
    let symbol_len = rng.gen_range(1..=10);
    let symbol: Vec<u8> = (0..symbol_len).map(|_| rng.gen::<u8>()).collect();

    // Random URI (0-200 chars)
    let uri_len = rng.gen_range(0..=200);
    let uri: Vec<u8> = (0..uri_len).map(|_| rng.gen::<u8>()).collect();

    // Random additional metadata (0-3 entries)
    let num_metadata = rng.gen_range(0..=3);
    let additional_metadata: Vec<AdditionalMetadata> = (0..num_metadata)
        .map(|_| {
            let key_len = rng.gen_range(1..=20);
            let key: Vec<u8> = (0..key_len).map(|_| rng.gen::<u8>()).collect();
            let value_len = rng.gen_range(0..=50);
            let value: Vec<u8> = (0..value_len).map(|_| rng.gen::<u8>()).collect();
            AdditionalMetadata { key, value }
        })
        .collect();

    TokenMetadata {
        update_authority,
        mint,
        name,
        symbol,
        uri,
        additional_metadata,
    }
}

/// Generate random Mint for testing
fn generate_random_mint() -> Mint {
    let mut rng = thread_rng();

    // 40% chance to include token metadata extension
    let extensions = if rng.gen_bool(0.4) {
        let token_metadata = generate_random_token_metadata(&mut rng);
        Some(vec![ExtensionStruct::TokenMetadata(token_metadata)])
    } else {
        None
    };

    Mint {
        base: BaseMint {
            mint_authority: if rng.gen_bool(0.7) {
                let mut bytes = [0u8; 32];
                rng.fill(&mut bytes);
                Some(Pubkey::from(bytes))
            } else {
                None
            },
            freeze_authority: if rng.gen_bool(0.5) {
                let mut bytes = [0u8; 32];
                rng.fill(&mut bytes);
                Some(Pubkey::from(bytes))
            } else {
                None
            },
            supply: rng.gen::<u64>(),
            decimals: rng.gen_range(0..=18),
            is_initialized: true,
        },
        metadata: MintMetadata {
            version: 3,
            mint_decompressed: rng.gen_bool(0.5),
            mint: {
                let mut bytes = [0u8; 32];
                rng.fill(&mut bytes);
                Pubkey::from(bytes)
            },
            mint_signer: rng.gen::<[u8; 32]>(),
            bump: rng.gen(),
        },
        reserved: [0u8; 16],
        account_type: ACCOUNT_TYPE_MINT,
        compression: CompressionInfo::default(),
        extensions,
    }
}

/// Reconstruct extensions from zero-copy format
fn reconstruct_extensions(
    zc_extensions: &Option<Vec<light_token_interface::state::extensions::ZExtensionStruct>>,
) -> Option<Vec<ExtensionStruct>> {
    zc_extensions.as_ref().map(|exts| {
        exts.iter()
            .map(|ext| match ext {
                light_token_interface::state::extensions::ZExtensionStruct::TokenMetadata(
                    zc_metadata,
                ) => ExtensionStruct::TokenMetadata(TokenMetadata {
                    update_authority: zc_metadata.update_authority,
                    mint: zc_metadata.mint,
                    name: zc_metadata.name.to_vec(),
                    symbol: zc_metadata.symbol.to_vec(),
                    uri: zc_metadata.uri.to_vec(),
                    additional_metadata: zc_metadata
                        .additional_metadata
                        .iter()
                        .map(|am| AdditionalMetadata {
                            key: am.key.to_vec(),
                            value: am.value.to_vec(),
                        })
                        .collect(),
                }),
                _ => panic!("Unexpected extension type in test"),
            })
            .collect()
    })
}

/// Compare Borsh-serialized mint with zero-copy deserialized versions
fn compare_mint_borsh_vs_zero_copy(original: &Mint, borsh_bytes: &[u8]) {
    // Deserialize using Borsh
    let borsh_mint = Mint::try_from_slice(borsh_bytes).unwrap();

    // Deserialize using zero-copy (read-only)
    let (zc_mint, _) = Mint::zero_copy_at(borsh_bytes).unwrap();

    // Reconstruct extensions from zero-copy format
    let zc_extensions = reconstruct_extensions(&zc_mint.extensions);

    // Construct a Mint from zero-copy read-only data for comparison
    let zc_reconstructed = Mint {
        base: BaseMint {
            mint_authority: zc_mint.base.mint_authority().copied(),
            freeze_authority: zc_mint.base.freeze_authority().copied(),
            supply: u64::from(zc_mint.base.supply),
            decimals: zc_mint.base.decimals,
            is_initialized: zc_mint.base.is_initialized != 0,
        },
        metadata: MintMetadata {
            version: zc_mint.base.metadata.version,
            mint_decompressed: zc_mint.base.metadata.mint_decompressed != 0,
            mint: zc_mint.base.metadata.mint,
            mint_signer: zc_mint.base.metadata.mint_signer,
            bump: zc_mint.base.metadata.bump,
        },
        reserved: *zc_mint.base.reserved,
        account_type: zc_mint.base.account_type,
        compression: CompressionInfo::default(),
        extensions: zc_extensions.clone(),
    };

    // Test zero-copy mutable deserialization
    let mut mutable_bytes = borsh_bytes.to_vec();
    let (zc_mint_mut, _) = Mint::zero_copy_at_mut(&mut mutable_bytes).unwrap();

    // Reconstruct from mutable zero-copy data for comparison
    let zc_mut_reconstructed = Mint {
        base: BaseMint {
            mint_authority: zc_mint_mut.base.mint_authority().copied(),
            freeze_authority: zc_mint_mut.base.freeze_authority().copied(),
            supply: u64::from(zc_mint_mut.base.supply),
            decimals: zc_mint_mut.base.decimals,
            is_initialized: zc_mint_mut.base.is_initialized != 0,
        },
        metadata: MintMetadata {
            version: zc_mint_mut.base.metadata.version,
            mint_decompressed: zc_mint_mut.base.metadata.mint_decompressed != 0,
            mint: zc_mint_mut.base.metadata.mint,
            mint_signer: zc_mint_mut.base.metadata.mint_signer,
            bump: zc_mint_mut.base.metadata.bump,
        },
        reserved: *zc_mint_mut.base.reserved,
        account_type: *zc_mint_mut.base.account_type,
        compression: CompressionInfo::default(),
        extensions: zc_extensions, // Extensions handling for mut is same as read-only
    };

    // Single assertion comparing all four structs
    assert_eq!(
        (original, &borsh_mint, &zc_reconstructed, &zc_mut_reconstructed),
        (original, original, original, original),
        "Mismatch between original, Borsh, zero-copy read-only, and zero-copy mutable deserialized structs"
    );

    // Test SPL mint pod deserialization on base mint only
    // Only use the first Mint::LEN bytes for SPL deserialization
    let mint = SplMint::unpack(&borsh_bytes[..SplMint::LEN]).unwrap();

    // Reconstruct BaseMint from SPL mint for comparison
    let spl_reconstructed_base = BaseMint {
        mint_authority: Option::<solana_pubkey::Pubkey>::from(mint.mint_authority)
            .map(|p| Pubkey::from(p.to_bytes())),
        freeze_authority: Option::<solana_pubkey::Pubkey>::from(mint.freeze_authority)
            .map(|p| Pubkey::from(p.to_bytes())),
        supply: mint.supply,
        decimals: mint.decimals,
        is_initialized: mint.is_initialized,
    };

    // Additional assertion comparing base mints with SPL pod deserialization
    assert_eq!(
        &original.base, &spl_reconstructed_base,
        "Mismatch between original base mint and SPL pod deserialized base mint"
    );
}

/// Randomized test comparing Borsh and zero-copy serialization (1k iterations)
#[test]
fn test_mint_borsh_zero_copy_compatibility() {
    for _ in 0..1000 {
        let mint = generate_random_mint();
        let borsh_bytes = mint.try_to_vec().unwrap();
        compare_mint_borsh_vs_zero_copy(&mint, &borsh_bytes);
    }
}

/// Generate mint with guaranteed TokenMetadata extension
fn generate_mint_with_extensions() -> Mint {
    let mut rng = thread_rng();
    let token_metadata = generate_random_token_metadata(&mut rng);

    Mint {
        base: BaseMint {
            mint_authority: Some(Pubkey::from(rng.gen::<[u8; 32]>())),
            freeze_authority: Some(Pubkey::from(rng.gen::<[u8; 32]>())),
            supply: rng.gen::<u64>(),
            decimals: rng.gen_range(0..=18),
            is_initialized: true,
        },
        metadata: MintMetadata {
            version: 3,
            mint_decompressed: rng.gen_bool(0.5),
            mint: Pubkey::from(rng.gen::<[u8; 32]>()),
            mint_signer: rng.gen::<[u8; 32]>(),
            bump: rng.gen(),
        },
        reserved: [0u8; 16],
        account_type: ACCOUNT_TYPE_MINT,
        compression: CompressionInfo::default(),
        extensions: Some(vec![ExtensionStruct::TokenMetadata(token_metadata)]),
    }
}

/// Test with guaranteed extensions - ensures extension path is always tested
#[test]
fn test_mint_with_extensions_borsh_zero_copy_compatibility() {
    for _ in 0..500 {
        let mint = generate_mint_with_extensions();
        let borsh_bytes = mint.try_to_vec().unwrap();
        compare_mint_borsh_vs_zero_copy(&mint, &borsh_bytes);
    }
}

/// Test extension edge cases
#[test]
fn test_mint_extension_edge_cases() {
    // Test 1: Empty strings in TokenMetadata
    let mint_empty_strings = Mint {
        base: BaseMint {
            mint_authority: Some(Pubkey::from([1u8; 32])),
            freeze_authority: None,
            supply: 1_000_000,
            decimals: 9,
            is_initialized: true,
        },
        metadata: MintMetadata {
            version: 3,
            mint_decompressed: false,
            mint: Pubkey::from([2u8; 32]),
            mint_signer: [0u8; 32],
            bump: 0,
        },
        reserved: [0u8; 16],
        account_type: ACCOUNT_TYPE_MINT,
        compression: CompressionInfo::default(),
        extensions: Some(vec![ExtensionStruct::TokenMetadata(TokenMetadata {
            update_authority: Pubkey::from([3u8; 32]),
            mint: Pubkey::from([2u8; 32]),
            name: vec![],                // Empty name
            symbol: vec![],              // Empty symbol
            uri: vec![],                 // Empty URI
            additional_metadata: vec![], // No additional metadata
        })]),
    };
    let borsh_bytes = mint_empty_strings.try_to_vec().unwrap();
    compare_mint_borsh_vs_zero_copy(&mint_empty_strings, &borsh_bytes);

    // Test 2: Maximum reasonable lengths
    let mint_max_lengths = Mint {
        base: BaseMint {
            mint_authority: Some(Pubkey::from([0xffu8; 32])),
            freeze_authority: Some(Pubkey::from([0xaau8; 32])),
            supply: u64::MAX,
            decimals: 18,
            is_initialized: true,
        },
        metadata: MintMetadata {
            version: 3,
            mint_decompressed: true,
            mint: Pubkey::from([0xbbu8; 32]),
            mint_signer: [0xddu8; 32],
            bump: 255,
        },
        reserved: [0u8; 16],
        account_type: ACCOUNT_TYPE_MINT,
        compression: CompressionInfo::default(),
        extensions: Some(vec![ExtensionStruct::TokenMetadata(TokenMetadata {
            update_authority: Pubkey::from([0xccu8; 32]),
            mint: Pubkey::from([0xbbu8; 32]),
            name: vec![b'A'; 64],   // Long name
            symbol: vec![b'S'; 16], // Long symbol
            uri: vec![b'U'; 256],   // Long URI
            additional_metadata: vec![
                AdditionalMetadata {
                    key: vec![b'K'; 32],
                    value: vec![b'V'; 128],
                },
                AdditionalMetadata {
                    key: vec![b'X'; 32],
                    value: vec![b'Y'; 128],
                },
                AdditionalMetadata {
                    key: vec![b'Z'; 32],
                    value: vec![b'W'; 128],
                },
            ],
        })]),
    };
    let borsh_bytes = mint_max_lengths.try_to_vec().unwrap();
    compare_mint_borsh_vs_zero_copy(&mint_max_lengths, &borsh_bytes);

    // Test 3: Zero update authority (represents None)
    let mint_zero_authority = Mint {
        base: BaseMint {
            mint_authority: None,
            freeze_authority: None,
            supply: 0,
            decimals: 0,
            is_initialized: true,
        },
        metadata: MintMetadata {
            version: 3,
            mint_decompressed: false,
            mint: Pubkey::from([4u8; 32]),
            mint_signer: [5u8; 32],
            bump: 255,
        },
        reserved: [0u8; 16],
        account_type: ACCOUNT_TYPE_MINT,
        compression: CompressionInfo::default(),
        extensions: Some(vec![ExtensionStruct::TokenMetadata(TokenMetadata {
            update_authority: Pubkey::from([0u8; 32]), // Zero = None
            mint: Pubkey::from([4u8; 32]),
            name: b"Test Token".to_vec(),
            symbol: b"TEST".to_vec(),
            uri: b"https://example.com/token.json".to_vec(),
            additional_metadata: vec![],
        })]),
    };
    let borsh_bytes = mint_zero_authority.try_to_vec().unwrap();
    compare_mint_borsh_vs_zero_copy(&mint_zero_authority, &borsh_bytes);

    // Test 4: No extensions (explicit None)
    let mint_no_extensions = Mint {
        base: BaseMint {
            mint_authority: Some(Pubkey::from([5u8; 32])),
            freeze_authority: Some(Pubkey::from([6u8; 32])),
            supply: 500_000,
            decimals: 6,
            is_initialized: true,
        },
        metadata: MintMetadata {
            version: 3,
            mint_decompressed: true,
            mint: Pubkey::from([7u8; 32]),
            mint_signer: [8u8; 32],
            bump: 255,
        },
        reserved: [0u8; 16],
        account_type: ACCOUNT_TYPE_MINT,
        compression: CompressionInfo::default(),
        extensions: None,
    };
    let borsh_bytes = mint_no_extensions.try_to_vec().unwrap();
    compare_mint_borsh_vs_zero_copy(&mint_no_extensions, &borsh_bytes);
}