spl-token-wrap-cli 2.0.0

Solana Program Library Token Wrap command-line utility
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
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
use {
    crate::helpers::{
        create_metaplex_metadata, create_unwrapped_mint, execute_create_mint, setup_test_env,
        TestEnv, TOKEN_WRAP_CLI_BIN,
    },
    mpl_token_metadata::utils::clean,
    serde_json::Value,
    serial_test::serial,
    solana_keypair::Keypair,
    solana_pubkey::Pubkey,
    solana_sdk_ids::system_program,
    solana_signer::Signer,
    solana_system_interface::instruction::{create_account, transfer},
    solana_transaction::Transaction,
    spl_token_2022::{
        extension::{
            metadata_pointer, BaseStateWithExtensions, ExtensionType, PodStateWithExtensions,
        },
        pod::PodMint,
        state::Mint,
    },
    spl_token_metadata_interface::state::TokenMetadata,
    spl_token_wrap::get_wrapped_mint_address,
    std::process::Command,
};

mod helpers;

const NAME: &str = "xyz-dex";
const SYMBOL: &str = "XYZ";
const URI: &str = "http://test.com";

async fn create_token2022_mint(
    env: &TestEnv,
    pointer_address: Option<Pubkey>,
    has_pointer_extension: bool,
    has_token_metadata: bool,
) -> Keypair {
    let unwrapped_mint_kp = Keypair::new();

    let mut extensions = vec![];
    if has_pointer_extension {
        extensions.push(ExtensionType::MetadataPointer);
    }

    let mint_size = ExtensionType::try_calculate_account_len::<Mint>(&extensions).unwrap();
    let rent = env
        .rpc_client
        .get_minimum_balance_for_rent_exemption(mint_size)
        .await
        .unwrap();

    let mut ixs = vec![create_account(
        &env.payer.pubkey(),
        &unwrapped_mint_kp.pubkey(),
        rent,
        mint_size as u64,
        &spl_token_2022::id(),
    )];

    if has_pointer_extension {
        ixs.push(
            metadata_pointer::instruction::initialize(
                &spl_token_2022::id(),
                &unwrapped_mint_kp.pubkey(),
                Some(env.payer.pubkey()),
                pointer_address,
            )
            .unwrap(),
        );
    }

    ixs.push(
        spl_token_2022::instruction::initialize_mint(
            &spl_token_2022::id(),
            &unwrapped_mint_kp.pubkey(),
            &env.payer.pubkey(),
            None,
            9,
        )
        .unwrap(),
    );

    let blockhash = env.rpc_client.get_latest_blockhash().await.unwrap();
    let init_tx = Transaction::new_signed_with_payer(
        &ixs,
        Some(&env.payer.pubkey()),
        &[&env.payer, &unwrapped_mint_kp],
        blockhash,
    );
    env.rpc_client
        .send_and_confirm_transaction(&init_tx)
        .await
        .unwrap();

    if has_token_metadata {
        // Fund for realloc
        let topup_tx = Transaction::new_signed_with_payer(
            &[transfer(
                &env.payer.pubkey(),
                &unwrapped_mint_kp.pubkey(),
                1_000_000_000,
            )],
            Some(&env.payer.pubkey()),
            &[&env.payer],
            env.rpc_client.get_latest_blockhash().await.unwrap(),
        );
        env.rpc_client
            .send_and_confirm_transaction(&topup_tx)
            .await
            .unwrap();

        let update_authority = env.payer.pubkey();
        let meta_tx = Transaction::new_signed_with_payer(
            &[
                spl_token_metadata_interface::instruction::initialize(
                    &spl_token_2022::id(),
                    &unwrapped_mint_kp.pubkey(),
                    &update_authority,
                    &unwrapped_mint_kp.pubkey(),
                    &update_authority,
                    NAME.to_string(),
                    SYMBOL.to_string(),
                    URI.to_string(),
                ),
                spl_token_metadata_interface::instruction::update_field(
                    &spl_token_2022::id(),
                    &unwrapped_mint_kp.pubkey(),
                    &update_authority,
                    spl_token_metadata_interface::state::Field::Name,
                    NAME.to_string(),
                ),
                spl_token_metadata_interface::instruction::update_field(
                    &spl_token_2022::id(),
                    &unwrapped_mint_kp.pubkey(),
                    &update_authority,
                    spl_token_metadata_interface::state::Field::Symbol,
                    SYMBOL.to_string(),
                ),
                spl_token_metadata_interface::instruction::update_field(
                    &spl_token_2022::id(),
                    &unwrapped_mint_kp.pubkey(),
                    &update_authority,
                    spl_token_metadata_interface::state::Field::Uri,
                    URI.to_string(),
                ),
            ],
            Some(&env.payer.pubkey()),
            &[&env.payer],
            env.rpc_client.get_latest_blockhash().await.unwrap(),
        );
        env.rpc_client
            .send_and_confirm_transaction(&meta_tx)
            .await
            .unwrap();
    }

    unwrapped_mint_kp
}

#[tokio::test(flavor = "multi_thread")]
#[serial]
async fn test_sync_metadata_from_spl_token_to_token2022() {
    let env = setup_test_env().await;

    // 1. Create a standard SPL Token mint
    let unwrapped_mint = create_unwrapped_mint(&env, &spl_token::id()).await;

    // 2. Create Metaplex metadata for the SPL Token mint
    let name = "Test Token".to_string();
    let symbol = "TEST".to_string();
    let uri = "http://test.com".to_string();
    create_metaplex_metadata(
        &env,
        &unwrapped_mint,
        spl_token::id(),
        name.clone(),
        symbol.clone(),
        uri.clone(),
    )
    .await;

    // 3. Create the corresponding wrapped Token-2022 mint for the SPL Token mint
    execute_create_mint(&env, &unwrapped_mint, &spl_token_2022::id()).await;

    // 4. Fund the wrapped mint account for the extra space needed for the metadata
    //    extension
    let wrapped_mint_address = get_wrapped_mint_address(&unwrapped_mint, &spl_token_2022::id());
    let fund_tx = Transaction::new_signed_with_payer(
        &[transfer(
            &env.payer.pubkey(),
            &wrapped_mint_address,
            1_000_000_000,
        )],
        Some(&env.payer.pubkey()),
        &[&env.payer],
        env.rpc_client.get_latest_blockhash().await.unwrap(),
    );
    env.rpc_client
        .send_and_confirm_transaction(&fund_tx)
        .await
        .unwrap();

    // 5. Execute the sync-metadata-to-token2022 command
    let output = Command::new(TOKEN_WRAP_CLI_BIN)
        .args([
            "sync-metadata-to-token2022",
            "-C",
            &env.config_file_path,
            &unwrapped_mint.to_string(),
            "--output",
            "json",
        ])
        .output()
        .unwrap();

    if !output.status.success() {
        let stderr = String::from_utf8_lossy(&output.stderr);
        let stdout = String::from_utf8_lossy(&output.stdout);
        panic!(
            "sync-metadata-to-token2022 command failed:\nSTDOUT:\n{}\nSTDERR:\n{}",
            stdout, stderr
        );
    }
    assert!(output.status.success());

    let json: Value = serde_json::from_slice(&output.stdout).unwrap();
    assert_eq!(
        json["wrappedMint"].as_str().unwrap(),
        &wrapped_mint_address.to_string()
    );

    // 6. Verify the metadata was written correctly to the wrapped mint
    let wrapped_mint_account_after = env
        .rpc_client
        .get_account(&wrapped_mint_address)
        .await
        .unwrap();
    let wrapped_mint_state =
        PodStateWithExtensions::<PodMint>::unpack(&wrapped_mint_account_after.data).unwrap();
    let token_metadata = wrapped_mint_state
        .get_variable_len_extension::<TokenMetadata>()
        .unwrap();

    assert_eq!(clean(token_metadata.name), name);
    assert_eq!(clean(token_metadata.symbol), symbol);
    assert_eq!(clean(token_metadata.uri), uri);
    assert_eq!(token_metadata.mint, wrapped_mint_address);
}

#[tokio::test(flavor = "multi_thread")]
#[serial]
async fn test_sync_from_token2022_with_self_referential_pointer() {
    let env = setup_test_env().await;

    // 1. Create unwrapped T22 mint with self-referential pointer and metadata
    let unwrapped_mint_kp = create_token2022_mint(
        &env,
        Some(Pubkey::new_unique()), // placeholder, will be updated
        true,
        true,
    )
    .await;
    let unwrapped_mint = unwrapped_mint_kp.pubkey();

    // Update pointer to be self-referential
    let update_pointer_ix = metadata_pointer::instruction::update(
        &spl_token_2022::id(),
        &unwrapped_mint,
        &env.payer.pubkey(),
        &[],
        Some(unwrapped_mint),
    )
    .unwrap();
    let tx = Transaction::new_signed_with_payer(
        &[update_pointer_ix],
        Some(&env.payer.pubkey()),
        &[&env.payer],
        env.rpc_client.get_latest_blockhash().await.unwrap(),
    );
    env.rpc_client
        .send_and_confirm_transaction(&tx)
        .await
        .unwrap();

    // 2. Create and fund wrapped mint
    execute_create_mint(&env, &unwrapped_mint, &spl_token_2022::id()).await;
    let wrapped_mint_address = get_wrapped_mint_address(&unwrapped_mint, &spl_token_2022::id());
    let fund_tx = Transaction::new_signed_with_payer(
        &[transfer(
            &env.payer.pubkey(),
            &wrapped_mint_address,
            1_000_000_000,
        )],
        Some(&env.payer.pubkey()),
        &[&env.payer],
        env.rpc_client.get_latest_blockhash().await.unwrap(),
    );
    env.rpc_client
        .send_and_confirm_transaction(&fund_tx)
        .await
        .unwrap();

    // 3. Execute sync command
    let output = Command::new(TOKEN_WRAP_CLI_BIN)
        .args([
            "sync-metadata-to-token2022",
            "-C",
            &env.config_file_path,
            &unwrapped_mint.to_string(),
        ])
        .output()
        .unwrap();
    assert!(output.status.success());

    // 4. Verify synced metadata
    let wrapped_mint_account = env
        .rpc_client
        .get_account(&wrapped_mint_address)
        .await
        .unwrap();
    let wrapped_mint_state =
        PodStateWithExtensions::<PodMint>::unpack(&wrapped_mint_account.data).unwrap();
    let token_metadata = wrapped_mint_state
        .get_variable_len_extension::<TokenMetadata>()
        .unwrap();

    assert_eq!(clean(token_metadata.name), NAME);
    assert_eq!(clean(token_metadata.symbol), SYMBOL);
    assert_eq!(clean(token_metadata.uri), URI);
}

#[tokio::test(flavor = "multi_thread")]
#[serial]
async fn test_sync_from_token2022_with_external_metaplex_pointer() {
    let env = setup_test_env().await;

    // 1. Create an external Metaplex metadata account
    let dummy_mint = create_unwrapped_mint(&env, &spl_token::id()).await;
    let name = "External Metaplex".to_string();
    let symbol = "EXTM".to_string();
    let uri = "http://external.com".to_string();
    let metaplex_pda = create_metaplex_metadata(
        &env,
        &dummy_mint,
        spl_token::id(),
        name.clone(),
        symbol.clone(),
        uri.clone(),
    )
    .await;

    // 2. Create unwrapped T22 mint pointing to the external metadata
    let unwrapped_mint_kp = create_token2022_mint(
        &env,
        Some(metaplex_pda),
        true,  // has_pointer_extension
        false, // has_token_metadata
    )
    .await;
    let unwrapped_mint = unwrapped_mint_kp.pubkey();

    // 3. Create and fund wrapped mint
    execute_create_mint(&env, &unwrapped_mint, &spl_token_2022::id()).await;
    let wrapped_mint_address = get_wrapped_mint_address(&unwrapped_mint, &spl_token_2022::id());

    let funding_amount = 1_000_000_000;
    let fund_tx = Transaction::new_signed_with_payer(
        &[transfer(
            &env.payer.pubkey(),
            &wrapped_mint_address,
            funding_amount,
        )],
        Some(&env.payer.pubkey()),
        &[&env.payer],
        env.rpc_client.get_latest_blockhash().await.unwrap(),
    );
    env.rpc_client
        .send_and_confirm_transaction(&fund_tx)
        .await
        .unwrap();

    // 4. Execute sync command
    let output = Command::new(TOKEN_WRAP_CLI_BIN)
        .args([
            "sync-metadata-to-token2022",
            "-C",
            &env.config_file_path,
            &unwrapped_mint.to_string(),
            "--metadata-account",
            &metaplex_pda.to_string(),
        ])
        .output()
        .unwrap();

    if !output.status.success() {
        let stderr = String::from_utf8_lossy(&output.stderr);
        let stdout = String::from_utf8_lossy(&output.stdout);
        panic!(
            "sync-metadata-to-token2022 command failed with status: {}\nStdout: {}\nStderr: {}",
            output.status, stdout, stderr
        );
    }

    // 5. Verify synced metadata
    let wrapped_mint_account = env
        .rpc_client
        .get_account(&wrapped_mint_address)
        .await
        .unwrap();
    let wrapped_mint_state =
        PodStateWithExtensions::<PodMint>::unpack(&wrapped_mint_account.data).unwrap();
    let token_metadata = wrapped_mint_state
        .get_variable_len_extension::<TokenMetadata>()
        .unwrap();

    assert_eq!(clean(token_metadata.name), name);
    assert_eq!(clean(token_metadata.symbol), symbol);
    assert_eq!(clean(token_metadata.uri), uri);
}

#[tokio::test(flavor = "multi_thread")]
#[serial]
async fn test_sync_from_token2022_without_pointer_fallback() {
    let env = setup_test_env().await;

    // 1. Create unwrapped T22 mint with no pointer extension
    let unwrapped_mint_kp = create_token2022_mint(&env, None, false, false).await;
    let unwrapped_mint = unwrapped_mint_kp.pubkey();

    // 2. Create Metaplex metadata for the unwrapped mint (the fallback)
    let name = "No Pointer Fallback".to_string();
    let symbol = "NPF".to_string();
    let uri = "http://npf.com".to_string();
    create_metaplex_metadata(
        &env,
        &unwrapped_mint,
        spl_token_2022::id(),
        name.clone(),
        symbol.clone(),
        uri.clone(),
    )
    .await;

    // 3. Create and fund wrapped mint
    execute_create_mint(&env, &unwrapped_mint, &spl_token_2022::id()).await;
    let wrapped_mint_address = get_wrapped_mint_address(&unwrapped_mint, &spl_token_2022::id());
    let fund_tx = Transaction::new_signed_with_payer(
        &[transfer(
            &env.payer.pubkey(),
            &wrapped_mint_address,
            1_000_000_000,
        )],
        Some(&env.payer.pubkey()),
        &[&env.payer],
        env.rpc_client.get_latest_blockhash().await.unwrap(),
    );
    env.rpc_client
        .send_and_confirm_transaction(&fund_tx)
        .await
        .unwrap();

    // 4. Execute sync command
    let output = Command::new(TOKEN_WRAP_CLI_BIN)
        .args([
            "sync-metadata-to-token2022",
            "-C",
            &env.config_file_path,
            &unwrapped_mint.to_string(),
        ])
        .output()
        .unwrap();
    assert!(output.status.success());

    // 5. Verify synced metadata
    let wrapped_mint_account = env
        .rpc_client
        .get_account(&wrapped_mint_address)
        .await
        .unwrap();
    let wrapped_mint_state =
        PodStateWithExtensions::<PodMint>::unpack(&wrapped_mint_account.data).unwrap();
    let token_metadata = wrapped_mint_state
        .get_variable_len_extension::<TokenMetadata>()
        .unwrap();

    assert_eq!(clean(token_metadata.name), name);
    assert_eq!(clean(token_metadata.symbol), symbol);
    assert_eq!(clean(token_metadata.uri), uri);
}

#[tokio::test(flavor = "multi_thread")]
#[serial]
async fn test_fail_sync_from_invalid_mint_owner() {
    let env = setup_test_env().await;
    let invalid_account = Keypair::new();

    let tx = Transaction::new_signed_with_payer(
        &[create_account(
            &env.payer.pubkey(),
            &invalid_account.pubkey(),
            env.rpc_client
                .get_minimum_balance_for_rent_exemption(0)
                .await
                .unwrap(),
            0,
            &system_program::id(),
        )],
        Some(&env.payer.pubkey()),
        &[&env.payer, &invalid_account],
        env.rpc_client.get_latest_blockhash().await.unwrap(),
    );
    env.rpc_client
        .send_and_confirm_transaction(&tx)
        .await
        .unwrap();

    let output = Command::new(TOKEN_WRAP_CLI_BIN)
        .args([
            "sync-metadata-to-token2022",
            "-C",
            &env.config_file_path,
            &invalid_account.pubkey().to_string(),
        ])
        .output()
        .unwrap();

    assert!(!output.status.success());
    let stderr = String::from_utf8_lossy(&output.stderr);
    assert!(stderr.contains("is not an SPL Token or SPL Token-2022 mint"));
}