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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
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_top_up_lamports_from_slice, BaseMint, Mint, MintConfig, MintMetadata, ACCOUNT_TYPE_MINT,
};
use light_zero_copy::traits::{ZeroCopyAt, ZeroCopyNew};
use rand::{thread_rng, Rng};

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

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

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

    let uri_len = rng.gen_range(0..=100);
    let uri: Vec<u8> = (0..uri_len).map(|_| rng.gen::<u8>()).collect();

    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 a random Mint for testing
fn generate_random_compressed_mint(rng: &mut impl Rng, with_extensions: bool) -> Mint {
    let mint = Pubkey::from(rng.gen::<[u8; 32]>());

    let extensions = if with_extensions {
        let token_metadata = generate_random_token_metadata(rng, mint);
        Some(vec![ExtensionStruct::TokenMetadata(token_metadata)])
    } else {
        None
    };

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

#[derive(BorshDeserialize, BorshSerialize, PartialEq, Debug)]
pub struct VecTestStruct {
    pub opt_vec: Option<Vec<u32>>,
}

/// Test that Mint borsh serialization and zero-copy representations are compatible
#[test]
fn test_compressed_mint_borsh_zerocopy_compatibility() {
    let test = VecTestStruct { opt_vec: None };
    let test_bytes = test.try_to_vec().unwrap();
    println!("test bytes {:?}", test_bytes);
    let deserialize = VecTestStruct::deserialize(&mut test_bytes.as_slice()).unwrap();
    assert_eq!(test, deserialize);

    let mut rng = thread_rng();

    for i in 0..100 {
        let original_mint = generate_random_compressed_mint(&mut rng, false);
        let borsh_bytes = original_mint.try_to_vec().unwrap();
        println!("Iteration {}: Borsh size = {} bytes", i, borsh_bytes.len());
        let borsh_deserialized = Mint::deserialize_reader(&mut borsh_bytes.as_slice())
            .unwrap_or_else(|_| panic!("Failed to deserialize Mint at iteration {}", i));
        assert_eq!(
            original_mint, borsh_deserialized,
            "Borsh roundtrip failed at iteration {}",
            i
        );

        // Test zero-copy serialization
        let config = MintConfig { extensions: None };
        let byte_len = Mint::byte_len(&config).unwrap();
        let mut zero_copy_bytes = vec![0u8; byte_len];
        let (mut zc_mint, _) = Mint::new_zero_copy(&mut zero_copy_bytes, config)
            .unwrap_or_else(|_| panic!("Failed to create zero-copy Mint at iteration {}", i));

        // Set the zero-copy fields to match original
        zc_mint
            .base
            .set_mint_authority(original_mint.base.mint_authority);
        zc_mint.base.supply = original_mint.base.supply.into();
        zc_mint.base.decimals = original_mint.base.decimals;
        zc_mint.base.is_initialized = if original_mint.base.is_initialized {
            1
        } else {
            0
        };
        zc_mint
            .base
            .set_freeze_authority(original_mint.base.freeze_authority);
        zc_mint.base.metadata.version = original_mint.metadata.version;
        zc_mint.base.metadata.mint = original_mint.metadata.mint;
        zc_mint.base.metadata.mint_decompressed = if original_mint.metadata.mint_decompressed {
            1
        } else {
            0
        };
        zc_mint.base.metadata.mint_signer = original_mint.metadata.mint_signer;
        zc_mint.base.metadata.bump = original_mint.metadata.bump;
        // account_type is already set in new_zero_copy
        // Set compression fields
        zc_mint.base.compression.config_account_version =
            original_mint.compression.config_account_version.into();
        zc_mint.base.compression.compress_to_pubkey = original_mint.compression.compress_to_pubkey;
        zc_mint.base.compression.account_version = original_mint.compression.account_version;
        zc_mint.base.compression.lamports_per_write =
            original_mint.compression.lamports_per_write.into();
        zc_mint.base.compression.compression_authority =
            original_mint.compression.compression_authority;
        zc_mint.base.compression.rent_sponsor = original_mint.compression.rent_sponsor;
        zc_mint.base.compression.last_claimed_slot =
            original_mint.compression.last_claimed_slot.into();
        zc_mint.base.compression.rent_config.base_rent =
            original_mint.compression.rent_config.base_rent.into();
        zc_mint.base.compression.rent_config.compression_cost = original_mint
            .compression
            .rent_config
            .compression_cost
            .into();
        zc_mint
            .base
            .compression
            .rent_config
            .lamports_per_byte_per_epoch = original_mint
            .compression
            .rent_config
            .lamports_per_byte_per_epoch;
        zc_mint.base.compression.rent_config.max_funded_epochs =
            original_mint.compression.rent_config.max_funded_epochs;
        zc_mint.base.compression.rent_config.max_top_up =
            original_mint.compression.rent_config.max_top_up.into();

        // Now deserialize the zero-copy bytes with borsh
        let zc_as_borsh = Mint::deserialize(&mut zero_copy_bytes.as_slice()).unwrap_or_else(|_| {
            panic!(
                "Failed to deserialize zero-copy bytes as borsh at iteration {}",
                i
            )
        });
        assert_eq!(
            original_mint, zc_as_borsh,
            "Zero-copy to borsh conversion failed at iteration {}",
            i
        );

        // Test zero-copy read
        let (zc_read, _) = Mint::zero_copy_at(&zero_copy_bytes)
            .unwrap_or_else(|_| panic!("Failed to read zero-copy Mint at iteration {}", i));

        // Verify fields match
        assert_eq!(
            original_mint.base.mint_authority,
            zc_read.base.mint_authority().copied(),
            "Mint authority mismatch at iteration {}",
            i
        );
        assert_eq!(
            original_mint.base.supply,
            u64::from(zc_read.base.supply),
            "Supply mismatch at iteration {}",
            i
        );
        assert_eq!(
            original_mint.base.decimals, zc_read.base.decimals,
            "Decimals mismatch at iteration {}",
            i
        );
        assert_eq!(
            original_mint.base.freeze_authority,
            zc_read.base.freeze_authority().copied(),
            "Freeze authority mismatch at iteration {}",
            i
        );
        assert_eq!(
            original_mint.metadata.version, zc_read.base.metadata.version,
            "Version mismatch at iteration {}",
            i
        );
        assert_eq!(
            original_mint.metadata.mint, zc_read.base.metadata.mint,
            "SPL mint mismatch at iteration {}",
            i
        );
        assert_eq!(
            original_mint.metadata.mint_decompressed,
            zc_read.base.metadata.mint_decompressed != 0,
            "Is decompressed mismatch at iteration {}",
            i
        );
    }
}

/// Test edge cases for Mint serialization
#[test]
fn test_compressed_mint_edge_cases() {
    // Test with no authorities
    let mint_no_auth = Mint {
        base: BaseMint {
            mint_authority: None,
            supply: u64::MAX,
            decimals: 0,
            is_initialized: true,
            freeze_authority: None,
        },
        metadata: MintMetadata {
            version: 3,
            mint: Pubkey::from([0xff; 32]),
            mint_decompressed: false,
            mint_signer: [0u8; 32],
            bump: 0,
        },
        reserved: [0u8; 16],
        account_type: ACCOUNT_TYPE_MINT,
        compression: CompressionInfo::default(),
        extensions: None,
    };

    // Borsh roundtrip
    let bytes = mint_no_auth.try_to_vec().unwrap();
    println!("Borsh serialized size: {} bytes", bytes.len());
    println!("All bytes: {:?}", &bytes);
    let deserialized = Mint::deserialize(&mut bytes.as_slice()).unwrap();
    assert_eq!(mint_no_auth, deserialized);

    // Zero-copy roundtrip
    let config = MintConfig { extensions: None };

    let byte_len = Mint::byte_len(&config).unwrap();
    let mut zc_bytes = vec![0u8; byte_len];
    let (mut zc_mint, _) = Mint::new_zero_copy(&mut zc_bytes, config).unwrap();

    zc_mint
        .base
        .set_mint_authority(mint_no_auth.base.mint_authority);
    zc_mint.base.supply = mint_no_auth.base.supply.into();
    zc_mint.base.decimals = mint_no_auth.base.decimals;
    zc_mint.base.is_initialized = 1;
    zc_mint
        .base
        .set_freeze_authority(mint_no_auth.base.freeze_authority);
    zc_mint.base.metadata.version = mint_no_auth.metadata.version;
    zc_mint.base.metadata.mint = mint_no_auth.metadata.mint;
    zc_mint.base.metadata.mint_decompressed = 0;
    zc_mint.base.metadata.mint_signer = mint_no_auth.metadata.mint_signer;
    zc_mint.base.metadata.bump = mint_no_auth.metadata.bump;
    // account_type is already set in new_zero_copy
    // Set compression fields
    zc_mint.base.compression.config_account_version =
        mint_no_auth.compression.config_account_version.into();
    zc_mint.base.compression.compress_to_pubkey = mint_no_auth.compression.compress_to_pubkey;
    zc_mint.base.compression.account_version = mint_no_auth.compression.account_version;
    zc_mint.base.compression.lamports_per_write =
        mint_no_auth.compression.lamports_per_write.into();
    zc_mint.base.compression.compression_authority = mint_no_auth.compression.compression_authority;
    zc_mint.base.compression.rent_sponsor = mint_no_auth.compression.rent_sponsor;
    zc_mint.base.compression.last_claimed_slot = mint_no_auth.compression.last_claimed_slot.into();
    zc_mint.base.compression.rent_config.base_rent =
        mint_no_auth.compression.rent_config.base_rent.into();
    zc_mint.base.compression.rent_config.compression_cost =
        mint_no_auth.compression.rent_config.compression_cost.into();
    zc_mint
        .base
        .compression
        .rent_config
        .lamports_per_byte_per_epoch = mint_no_auth
        .compression
        .rent_config
        .lamports_per_byte_per_epoch;
    zc_mint.base.compression.rent_config.max_funded_epochs =
        mint_no_auth.compression.rent_config.max_funded_epochs;
    zc_mint.base.compression.rent_config.max_top_up =
        mint_no_auth.compression.rent_config.max_top_up.into();

    let zc_as_borsh = Mint::deserialize(&mut zc_bytes.as_slice()).unwrap();
    assert_eq!(mint_no_auth, zc_as_borsh);

    // Test with maximum values
    let mint_max = Mint {
        base: BaseMint {
            mint_authority: Some(Pubkey::from([0xff; 32])),
            supply: u64::MAX,
            decimals: 255,
            is_initialized: true,
            freeze_authority: Some(Pubkey::from([0xaa; 32])),
        },
        metadata: MintMetadata {
            version: 255,
            mint: Pubkey::from([0xbb; 32]),
            mint_decompressed: true,
            mint_signer: [0xcc; 32],
            bump: 255,
        },
        reserved: [0u8; 16],
        account_type: ACCOUNT_TYPE_MINT,
        compression: CompressionInfo::default(),
        extensions: None,
    };

    let bytes = mint_max.try_to_vec().unwrap();
    let deserialized = Mint::deserialize(&mut bytes.as_slice()).unwrap();
    assert_eq!(mint_max, deserialized);
}

/// Test that BaseMint within Mint maintains SPL compatibility format
#[test]
fn test_base_mint_in_compressed_mint_spl_format() {
    let mint = Mint {
        base: BaseMint {
            mint_authority: Some(Pubkey::from([1; 32])),
            supply: 1000000,
            decimals: 9,
            is_initialized: true,
            freeze_authority: Some(Pubkey::from([2; 32])),
        },
        metadata: MintMetadata {
            version: 3,
            mint: Pubkey::from([3; 32]),
            mint_decompressed: false,
            mint_signer: [4u8; 32],
            bump: 255,
        },
        reserved: [0u8; 16],
        account_type: ACCOUNT_TYPE_MINT,
        compression: CompressionInfo::default(),
        extensions: None,
    };

    // Serialize the whole Mint
    let full_bytes = mint.try_to_vec().unwrap();

    // The BaseMint portion should be at the beginning
    // and should be 82 bytes (SPL Mint size)
    assert!(
        full_bytes.len() >= 82,
        "Serialized Mint should be at least 82 bytes"
    );

    // Extract just the BaseMint portion
    let base_mint_bytes = &full_bytes[..82];

    // Deserialize as BaseMint to verify format
    let base_mint = BaseMint::deserialize(&mut base_mint_bytes.to_vec().as_slice()).unwrap();
    assert_eq!(mint.base, base_mint);
}

#[test]
fn test_compressed_mint_new_zero_copy_fails_if_already_initialized() {
    let config = MintConfig { extensions: None };
    let byte_len = Mint::byte_len(&config).unwrap();
    let mut buffer = vec![0u8; byte_len];

    // First initialization should succeed
    let _ = Mint::new_zero_copy(&mut buffer, config.clone()).expect("First init should succeed");

    // Second initialization should fail because account is already initialized
    let result = Mint::new_zero_copy(&mut buffer, config);
    assert!(
        result.is_err(),
        "new_zero_copy should fail if account is already initialized"
    );
    assert_eq!(
        result.unwrap_err(),
        light_zero_copy::errors::ZeroCopyError::MemoryNotZeroed
    );
}

/// Test that mint_top_up_lamports_from_slice produces identical results to full deserialization.
#[test]
fn test_mint_top_up_lamports_matches_full_deserialization() {
    // Create a Mint using zero-copy
    let config = MintConfig { extensions: None };
    let byte_len = Mint::byte_len(&config).unwrap();
    let mut buffer = vec![0u8; byte_len];
    let (mut mint, _) = Mint::new_zero_copy(&mut buffer, config).unwrap();

    // Set known values in CompressionInfo
    mint.base.compression.lamports_per_write = 1000.into();
    mint.base.compression.last_claimed_slot = 13500.into(); // Epoch 1
    mint.base.compression.rent_exemption_paid = 50_000.into();
    mint.base.compression.rent_config.base_rent = 128.into();
    mint.base.compression.rent_config.compression_cost = 11000.into();
    mint.base
        .compression
        .rent_config
        .lamports_per_byte_per_epoch = 1;
    mint.base.compression.rent_config.max_funded_epochs = 2;

    // Test parameters
    let current_slot = 27000u64; // Epoch 2
    let current_lamports = 100_000u64;

    // Calculate using optimized function
    let optimized_result = mint_top_up_lamports_from_slice(&buffer, current_lamports, current_slot)
        .expect("Should return Some");

    // Calculate using full deserialization
    let (mint_read, _) = Mint::zero_copy_at(&buffer).unwrap();
    let full_deser_result = mint_read
        .base
        .compression
        .calculate_top_up_lamports(buffer.len() as u64, current_slot, current_lamports)
        .expect("Should succeed");

    assert_eq!(
        optimized_result, full_deser_result,
        "Optimized result should match full deserialization"
    );
}