metaboss 0.49.0

The Metaplex NFT-standard Swiss Army Knife tool.
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
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
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
use anyhow::{anyhow, Context, Result};
use mpl_token_metadata::types::Creator;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use solana_sdk::pubkey::Pubkey;
use solana_sdk::signer::keypair::Keypair;
use std::fs::read_to_string;
use std::path::PathBuf;
use std::{env, fs, path::Path, str::FromStr};

use crate::constants::ERROR_FILE_BEGIN;
use crate::utils::{convert_to_wtf_error, find_errors};

#[derive(Debug, Deserialize, Serialize)]
pub struct SolanaConfig {
    pub json_rpc_url: String,
    pub keypair_path: String,
    pub commitment: String,
}

pub fn creator_is_verified(creators_opt: &Option<Vec<Creator>>, position: usize) -> bool {
    // Only add mints with a verified creator.
    if let Some(creators) = creators_opt {
        if creators[position].verified {
            return true;
        }
    }
    false
}

pub fn parse_solana_config() -> Option<SolanaConfig> {
    let home = if cfg!(unix) {
        env::var_os("HOME").expect("Coulnd't find UNIX home key.")
    } else if cfg!(windows) {
        let drive = env::var_os("HOMEDRIVE").expect("Could not find Windows home drive key.");
        let path = env::var_os("HOMEPATH").expect("Could not find Windows home path key.");
        Path::new(&drive).join(path).as_os_str().to_owned()
    } else if cfg!(target_os = "macos") {
        env::var_os("HOME").expect("Coulnd't find MacOS home key.")
    } else {
        panic!("Unsupported OS!");
    };

    let config_path = Path::new(&home)
        .join(".config")
        .join("solana")
        .join("cli")
        .join("config.yml");

    let conf_file = match fs::File::open(config_path) {
        Ok(f) => f,
        Err(_) => return None,
    };
    serde_yaml::from_reader(&conf_file).ok()
}

pub fn parse_keypair(
    keypair_opt: Option<String>,
    sol_config_option: Option<SolanaConfig>,
) -> Keypair {
    let keypair = match keypair_opt {
        Some(keypair_path) => read_keypair(&keypair_path).expect("Failed to read keypair file."),
        None => match sol_config_option {
            Some(ref sol_config) => {
                read_keypair(&sol_config.keypair_path).expect("Failed to read keypair file.")
            }
            None => read_keypair(&(*shellexpand::tilde("~/.config/solana/id.json")).to_string())
                .expect("Failed to read keypair file."),
        },
    };
    keypair
}

pub fn read_keypair(path: &String) -> Result<Keypair> {
    let secret_string: String = fs::read_to_string(path).context("Can't find key file")?;

    // Try to decode the secret string as a JSON array of ints first and then as a base58 encoded string to support Phantom private keys.
    let secret_bytes: Vec<u8> = match serde_json::from_str(&secret_string) {
        Ok(bytes) => bytes,
        Err(_) => match bs58::decode(&secret_string.trim()).into_vec() {
            Ok(bytes) => bytes,
            Err(_) => return Err(anyhow!("Unsupported key type!")),
        },
    };

    let keypair = Keypair::try_from(secret_bytes.as_slice())?;
    Ok(keypair)
}

pub fn parse_creators(creators_json: &Value) -> Result<Vec<Creator>> {
    let mut creators = Vec::new();

    for creator in creators_json
        .as_array()
        .ok_or_else(|| anyhow!("Invalid creators array!"))?
    {
        let address = creator
            .get("address")
            .ok_or_else(|| anyhow!("Invalid address!"))?
            .as_str()
            .ok_or_else(|| anyhow!("Invalid address!"))?
            .to_string();
        let share = creator
            .get("share")
            .ok_or_else(|| anyhow!("Invalid share!"))?
            .as_u64()
            .ok_or_else(|| anyhow!("Invalid share!"))? as u8;
        creators.push(Creator {
            address: Pubkey::from_str(&address)?,
            verified: false,
            share,
        });
    }
    Ok(creators)
}

pub fn parse_name(body: &Value) -> Result<String> {
    let name = body
        .get("name")
        .ok_or_else(|| anyhow!("Invalid name!"))?
        .as_str()
        .ok_or_else(|| anyhow!("Invalid name!"))?
        .to_string();
    Ok(name)
}

pub fn parse_symbol(body: &Value) -> Result<String> {
    let symbol = body
        .get("symbol")
        .ok_or_else(|| anyhow!("Invalid symbol!"))?
        .as_str()
        .ok_or_else(|| anyhow!("Invalid symbol!"))?
        .to_string();
    Ok(symbol)
}

pub fn parse_seller_fee_basis_points(body: &Value) -> Result<u16> {
    let seller_fee_basis_points =
        body.get("seller_fee_basis_points")
            .ok_or_else(|| anyhow!("Invalid seller_fee_basis_points!"))?
            .as_u64()
            .ok_or_else(|| anyhow!("Invalid seller_fee_basis_points!"))? as u16;
    Ok(seller_fee_basis_points)
}

pub fn is_only_one_option<T, U>(option1: &Option<T>, option2: &Option<U>) -> bool {
    match (option1, option2) {
        (Some(_), None) | (None, Some(_)) => true,
        (Some(_), Some(_)) => false,
        (None, None) => false,
    }
}

pub fn parse_cli_creators(new_creators: String, should_append: bool) -> Result<Vec<Creator>> {
    let mut creators = Vec::new();

    for nc in new_creators.split(',') {
        let mut c = nc.split(':');
        let address = c.next().ok_or_else(|| anyhow!("Missing address!"))?;
        let address = Pubkey::from_str(address)
            .map_err(|_| anyhow!(format!("Invalid creator address: {address:?}!")))?;
        let share = if should_append {
            c.next();
            0u8
        } else {
            c.next()
                .ok_or_else(|| anyhow!("Invalid creator share, must be 0-100!"))?
                .parse::<u8>()?
        };
        let verified = c
            .next()
            .ok_or_else(|| anyhow!("Missing creator verified: must be 'true' or 'false'!"))?
            .parse::<bool>()?;
        creators.push(Creator {
            address,
            share,
            verified,
        });
    }

    if creators.len() > 5 {
        return Err(anyhow!("Too many creators: maximum of five!"));
    }

    Ok(creators)
}

pub fn parse_errors_file() -> Result<()> {
    let wtf_error_path = Path::new("src/wtf_errors.rs");
    let error_files_dir = PathBuf::from("src/error_files");

    match error_files_dir.read_dir() {
        Ok(files) => {
            let mut error_file_content = String::from(ERROR_FILE_BEGIN);
            for file in files.flatten() {
                let file_name = file.file_name();
                let file_contents = read_to_string(file.path())?;
                let error_content =
                    convert_to_wtf_error(file_name.to_str().unwrap(), &file_contents)?;
                error_file_content.push_str(&error_content);
            }
            fs::write(wtf_error_path, error_file_content)?;
            Ok(())
        }
        Err(_) => Err(anyhow!("Error folder doesn't exist")),
    }
}

pub fn parse_errors_code(error_code: &str) -> Result<()> {
    let parsed_error_code = if error_code.contains("0x") {
        error_code.replace("0x", "")
    } else {
        format!("{:X}", error_code.parse::<i64>()?)
    };

    let errors = find_errors(&parsed_error_code);

    if errors.is_empty() {
        return Err(anyhow!("Invalid Error Code"));
    }

    for error in errors {
        println!("\t{:<10} |\t{}", error.domain, error.message);
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json::json;

    #[test]
    fn parses_white_space_keys() {
        // Arrange
        let whitespace_key_path = String::from("./tests/test_key_whitespace.txt");
        let newline_key_path = String::from("./tests/test_key_newline.txt");
        let phantom_key_path = String::from("./tests/test_key_phantom.txt");

        // Act
        let whitespace_res = read_keypair(&whitespace_key_path);
        let newline_res = read_keypair(&newline_key_path);
        let phantom_res = read_keypair(&phantom_key_path);

        // Assert
        assert!(whitespace_res.is_ok());
        assert!(newline_res.is_ok());
        assert!(phantom_res.is_ok());
    }

    // -- creator_is_verified tests --

    #[test]
    fn test_creator_is_verified_true() {
        // Arrange
        let creators = Some(vec![Creator {
            address: Pubkey::new_unique(),
            verified: true,
            share: 100,
        }]);

        // Act & Assert
        assert!(creator_is_verified(&creators, 0));
    }

    #[test]
    fn test_creator_is_verified_false() {
        // Arrange
        let creators = Some(vec![Creator {
            address: Pubkey::new_unique(),
            verified: false,
            share: 100,
        }]);

        // Act & Assert
        assert!(!creator_is_verified(&creators, 0));
    }

    #[test]
    fn test_creator_is_verified_none() {
        // Act & Assert
        assert!(!creator_is_verified(&None, 0));
    }

    #[test]
    #[should_panic]
    fn test_creator_is_verified_out_of_bounds() {
        // Arrange
        let creators = Some(vec![Creator {
            address: Pubkey::new_unique(),
            verified: true,
            share: 100,
        }]);

        // Act - should panic on out-of-bounds index
        creator_is_verified(&creators, 5);
    }

    // -- parse_creators tests --

    #[test]
    fn test_parse_creators_valid_single_creator() {
        // Arrange
        let pubkey = Pubkey::new_unique();
        let creators_json = json!([
            {"address": pubkey.to_string(), "share": 100}
        ]);

        // Act
        let result = parse_creators(&creators_json).unwrap();

        // Assert
        assert_eq!(result.len(), 1);
        assert_eq!(result[0].address, pubkey);
        assert_eq!(result[0].share, 100);
    }

    #[test]
    fn test_parse_creators_valid_multiple_creators() {
        // Arrange
        let pubkey1 = Pubkey::new_unique();
        let pubkey2 = Pubkey::new_unique();
        let creators_json = json!([
            {"address": pubkey1.to_string(), "share": 60},
            {"address": pubkey2.to_string(), "share": 40}
        ]);

        // Act
        let result = parse_creators(&creators_json).unwrap();

        // Assert
        assert_eq!(result.len(), 2);
        assert_eq!(result[0].share, 60);
        assert_eq!(result[1].share, 40);
    }

    #[test]
    fn test_parse_creators_all_verified_false() {
        // Arrange
        let pubkey = Pubkey::new_unique();
        let creators_json = json!([
            {"address": pubkey.to_string(), "share": 100}
        ]);

        // Act
        let result = parse_creators(&creators_json).unwrap();

        // Assert
        assert!(!result[0].verified);
    }

    #[test]
    fn test_parse_creators_error_not_array() {
        // Arrange
        let creators_json = json!({"address": "test", "share": 100});

        // Act
        let result = parse_creators(&creators_json);

        // Assert
        assert!(result.is_err());
    }

    #[test]
    fn test_parse_creators_error_missing_address() {
        // Arrange
        let creators_json = json!([{"share": 100}]);

        // Act
        let result = parse_creators(&creators_json);

        // Assert
        assert!(result.is_err());
    }

    #[test]
    fn test_parse_creators_error_missing_share() {
        // Arrange
        let pubkey = Pubkey::new_unique();
        let creators_json = json!([{"address": pubkey.to_string()}]);

        // Act
        let result = parse_creators(&creators_json);

        // Assert
        assert!(result.is_err());
    }

    #[test]
    fn test_parse_creators_error_invalid_pubkey() {
        // Arrange
        let creators_json = json!([{"address": "not_a_valid_pubkey", "share": 100}]);

        // Act
        let result = parse_creators(&creators_json);

        // Assert
        assert!(result.is_err());
    }

    // -- parse_name tests --

    #[test]
    fn test_parse_name_valid() {
        // Arrange
        let body = json!({"name": "My NFT"});

        // Act
        let result = parse_name(&body).unwrap();

        // Assert
        assert_eq!(result, "My NFT");
    }

    #[test]
    fn test_parse_name_missing() {
        // Arrange
        let body = json!({"symbol": "NFT"});

        // Act & Assert
        assert!(parse_name(&body).is_err());
    }

    #[test]
    fn test_parse_name_not_string() {
        // Arrange
        let body = json!({"name": 123});

        // Act & Assert
        assert!(parse_name(&body).is_err());
    }

    // -- parse_symbol tests --

    #[test]
    fn test_parse_symbol_valid() {
        // Arrange
        let body = json!({"symbol": "NFT"});

        // Act
        let result = parse_symbol(&body).unwrap();

        // Assert
        assert_eq!(result, "NFT");
    }

    #[test]
    fn test_parse_symbol_missing() {
        // Arrange
        let body = json!({"name": "test"});

        // Act & Assert
        assert!(parse_symbol(&body).is_err());
    }

    // -- parse_seller_fee_basis_points tests --

    #[test]
    fn test_parse_seller_fee_basis_points_valid() {
        // Arrange
        let body = json!({"seller_fee_basis_points": 500});

        // Act
        let result = parse_seller_fee_basis_points(&body).unwrap();

        // Assert
        assert_eq!(result, 500);
    }

    #[test]
    fn test_parse_seller_fee_basis_points_missing() {
        // Arrange
        let body = json!({"name": "test"});

        // Act & Assert
        assert!(parse_seller_fee_basis_points(&body).is_err());
    }

    #[test]
    fn test_parse_seller_fee_basis_points_not_number() {
        // Arrange
        let body = json!({"seller_fee_basis_points": "five hundred"});

        // Act & Assert
        assert!(parse_seller_fee_basis_points(&body).is_err());
    }

    // -- is_only_one_option tests --

    #[test]
    fn test_is_only_one_option_some_none() {
        assert!(is_only_one_option(&Some(1), &None::<i32>));
    }

    #[test]
    fn test_is_only_one_option_none_some() {
        assert!(is_only_one_option(&None::<i32>, &Some(1)));
    }

    #[test]
    fn test_is_only_one_option_some_some() {
        assert!(!is_only_one_option(&Some(1), &Some(2)));
    }

    #[test]
    fn test_is_only_one_option_none_none() {
        assert!(!is_only_one_option(&None::<i32>, &None::<i32>));
    }

    // -- parse_cli_creators tests --

    #[test]
    fn test_parse_cli_creators_single() {
        // Arrange
        let pubkey = Pubkey::new_unique();
        let input = format!("{}:100:true", pubkey);

        // Act
        let result = parse_cli_creators(input, false).unwrap();

        // Assert
        assert_eq!(result.len(), 1);
        assert_eq!(result[0].address, pubkey);
        assert_eq!(result[0].share, 100);
        assert!(result[0].verified);
    }

    #[test]
    fn test_parse_cli_creators_multiple() {
        // Arrange
        let pk1 = Pubkey::new_unique();
        let pk2 = Pubkey::new_unique();
        let input = format!("{}:60:true,{}:40:false", pk1, pk2);

        // Act
        let result = parse_cli_creators(input, false).unwrap();

        // Assert
        assert_eq!(result.len(), 2);
        assert_eq!(result[0].share, 60);
        assert_eq!(result[1].share, 40);
        assert!(result[0].verified);
        assert!(!result[1].verified);
    }

    #[test]
    fn test_parse_cli_creators_too_many() {
        // Arrange - 6 creators (over the limit of 5)
        let creators: Vec<String> = (0..6)
            .map(|_| format!("{}:10:true", Pubkey::new_unique()))
            .collect();
        let input = creators.join(",");

        // Act & Assert
        assert!(parse_cli_creators(input, false).is_err());
    }

    #[test]
    fn test_parse_cli_creators_append_sets_share_zero() {
        // Arrange
        let pubkey = Pubkey::new_unique();
        let input = format!("{}:100:true", pubkey);

        // Act
        let result = parse_cli_creators(input, true).unwrap();

        // Assert
        assert_eq!(result[0].share, 0);
    }

    #[test]
    fn test_parse_cli_creators_invalid_address() {
        // Arrange
        let input = "not_a_valid_address:100:true".to_string();

        // Act & Assert
        assert!(parse_cli_creators(input, false).is_err());
    }

    #[test]
    fn test_parse_cli_creators_missing_fields() {
        // Arrange - missing verified field
        let pubkey = Pubkey::new_unique();
        let input = format!("{}:100", pubkey);

        // Act & Assert
        assert!(parse_cli_creators(input, false).is_err());
    }
}