solana-keygen 2.0.10

Solana key generation 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
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
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
#![allow(clippy::arithmetic_side_effects)]
use {
    bip39::{Mnemonic, MnemonicType, Seed},
    clap::{
        builder::ValueParser, crate_description, crate_name, value_parser, Arg, ArgAction,
        ArgMatches, Command,
    },
    solana_clap_v3_utils::{
        input_parsers::{
            signer::{SignerSource, SignerSourceParserBuilder},
            STDOUT_OUTFILE_TOKEN,
        },
        keygen::{
            check_for_overwrite,
            derivation_path::{acquire_derivation_path, derivation_path_arg},
            mnemonic::{
                acquire_passphrase_and_message, no_passphrase_and_message, try_get_language,
                try_get_word_count,
            },
            no_outfile_arg, KeyGenerationCommonArgs, NO_OUTFILE_ARG,
        },
        keypair::{
            keypair_from_seed_phrase, keypair_from_source, signer_from_source,
            SKIP_SEED_PHRASE_VALIDATION_ARG,
        },
        DisplayError,
    },
    solana_cli_config::{Config, CONFIG_FILE},
    solana_remote_wallet::remote_wallet::RemoteWalletManager,
    solana_sdk::{
        instruction::{AccountMeta, Instruction},
        message::Message,
        pubkey::{write_pubkey_file, Pubkey},
        signature::{
            keypair_from_seed, keypair_from_seed_and_derivation_path, write_keypair,
            write_keypair_file, Keypair, Signer,
        },
    },
    std::{
        collections::HashSet,
        error,
        rc::Rc,
        sync::{
            atomic::{AtomicBool, AtomicU64, Ordering},
            Arc,
        },
        thread,
        time::Instant,
    },
};

mod smallest_length_44_public_key {
    use solana_sdk::{pubkey, pubkey::Pubkey};

    pub(super) static PUBKEY: Pubkey = pubkey!("21111111111111111111111111111111111111111111");

    #[test]
    fn assert_length() {
        use crate::smallest_length_44_public_key;
        assert_eq!(smallest_length_44_public_key::PUBKEY.to_string().len(), 44);
    }
}

struct GrindMatch {
    starts: String,
    ends: String,
    count: AtomicU64,
}

#[derive(Debug, Clone)]
enum GrindType {
    Starts,
    Ends,
    StartsAndEnds,
}

fn grind_parser(grind_type: GrindType) -> ValueParser {
    ValueParser::from(move |v: &str| -> Result<String, String> {
        let (required_div_count, prefix_suffix) = match grind_type {
            GrindType::Starts => (1, "PREFIX"),
            GrindType::Ends => (1, "SUFFIX"),
            GrindType::StartsAndEnds => (2, "PREFIX and SUFFIX"),
        };
        if v.matches(':').count() != required_div_count || (v.starts_with(':') || v.ends_with(':'))
        {
            return Err(format!("Expected : between {} and COUNT", prefix_suffix));
        }
        // `args` is guaranteed to have length at least 1 by the previous if statement
        let mut args: Vec<&str> = v.split(':').collect();
        let count = args.pop().unwrap().parse::<u64>();
        for arg in args.iter() {
            bs58::decode(arg)
                .into_vec()
                .map_err(|err| format!("{}: {:?}", args[0], err))?;
        }
        if count.is_err() || count.unwrap() == 0 {
            return Err(String::from("Expected COUNT to be of type u64"));
        }
        Ok(v.to_string())
    })
}

fn get_keypair_from_matches(
    matches: &ArgMatches,
    config: Config,
    wallet_manager: &mut Option<Rc<RemoteWalletManager>>,
) -> Result<Box<dyn Signer>, Box<dyn error::Error>> {
    let config_source;
    let keypair_source = if matches.try_contains_id("keypair")? {
        matches.get_one::<SignerSource>("keypair").unwrap()
    } else if !config.keypair_path.is_empty() {
        config_source = SignerSource::parse(&config.keypair_path)?;
        &config_source
    } else {
        let mut path = dirs_next::home_dir().expect("home directory");
        path.extend([".config", "solana", "id.json"]);
        config_source = SignerSource::parse(path.to_str().unwrap())?;
        &config_source
    };
    signer_from_source(matches, keypair_source, "pubkey recovery", wallet_manager)
}

fn output_keypair(
    keypair: &Keypair,
    outfile: &str,
    source: &str,
) -> Result<(), Box<dyn error::Error>> {
    if outfile == STDOUT_OUTFILE_TOKEN {
        let mut stdout = std::io::stdout();
        write_keypair(keypair, &mut stdout)?;
    } else {
        write_keypair_file(keypair, outfile)?;
        println!("Wrote {source} keypair to {outfile}");
    }
    Ok(())
}

fn grind_print_info(grind_matches: &[GrindMatch], num_threads: usize) {
    println!("Searching with {num_threads} threads for:");
    for gm in grind_matches {
        let mut msg = Vec::<String>::new();
        if gm.count.load(Ordering::Relaxed) > 1 {
            msg.push("pubkeys".to_string());
            msg.push("start".to_string());
            msg.push("end".to_string());
        } else {
            msg.push("pubkey".to_string());
            msg.push("starts".to_string());
            msg.push("ends".to_string());
        }
        println!(
            "\t{} {} that {} with '{}' and {} with '{}'",
            gm.count.load(Ordering::Relaxed),
            msg[0],
            msg[1],
            gm.starts,
            msg[2],
            gm.ends
        );
    }
}

fn grind_parse_args(
    ignore_case: bool,
    starts_with_args: HashSet<String>,
    ends_with_args: HashSet<String>,
    starts_and_ends_with_args: HashSet<String>,
    num_threads: usize,
) -> Vec<GrindMatch> {
    let mut grind_matches = Vec::<GrindMatch>::new();
    for sw in starts_with_args {
        let args: Vec<&str> = sw.split(':').collect();
        grind_matches.push(GrindMatch {
            starts: if ignore_case {
                args[0].to_lowercase()
            } else {
                args[0].to_string()
            },
            ends: "".to_string(),
            count: AtomicU64::new(args[1].parse::<u64>().unwrap()),
        });
    }
    for ew in ends_with_args {
        let args: Vec<&str> = ew.split(':').collect();
        grind_matches.push(GrindMatch {
            starts: "".to_string(),
            ends: if ignore_case {
                args[0].to_lowercase()
            } else {
                args[0].to_string()
            },
            count: AtomicU64::new(args[1].parse::<u64>().unwrap()),
        });
    }
    for swew in starts_and_ends_with_args {
        let args: Vec<&str> = swew.split(':').collect();
        grind_matches.push(GrindMatch {
            starts: if ignore_case {
                args[0].to_lowercase()
            } else {
                args[0].to_string()
            },
            ends: if ignore_case {
                args[1].to_lowercase()
            } else {
                args[1].to_string()
            },
            count: AtomicU64::new(args[2].parse::<u64>().unwrap()),
        });
    }
    grind_print_info(&grind_matches, num_threads);
    grind_matches
}

fn app<'a>(num_threads: &'a str, crate_version: &'a str) -> Command<'a> {
    Command::new(crate_name!())
        .about(crate_description!())
        .version(crate_version)
        .subcommand_required(true)
        .arg_required_else_help(true)
        .arg({
            let arg = Arg::new("config_file")
                .short('C')
                .long("config")
                .value_name("FILEPATH")
                .takes_value(true)
                .global(true)
                .help("Configuration file to use");
            if let Some(ref config_file) = *CONFIG_FILE {
                arg.default_value(config_file)
            } else {
                arg
            }
        })
        .subcommand(
            Command::new("verify")
                .about("Verify a keypair can sign and verify a message.")
                .arg(
                    Arg::new("pubkey")
                        .index(1)
                        .value_name("PUBKEY")
                        .takes_value(true)
                        .required(true)
                        .help("Public key"),
                )
                .arg(
                    Arg::new("keypair")
                        .index(2)
                        .value_name("KEYPAIR")
                        .takes_value(true)
                        .value_parser(
                            SignerSourceParserBuilder::default().allow_all().build()
                        )
                        .help("Filepath or URL to a keypair"),
                )
        )
        .subcommand(
            Command::new("new")
                .about("Generate new keypair file from a random seed phrase and optional BIP39 passphrase")
                .disable_version_flag(true)
                .arg(
                    Arg::new("outfile")
                        .short('o')
                        .long("outfile")
                        .value_name("FILEPATH")
                        .takes_value(true)
                        .help("Path to generated file"),
                )
                .arg(
                    Arg::new("force")
                        .short('f')
                        .long("force")
                        .help("Overwrite the output file if it exists"),
                )
                .arg(
                    Arg::new("silent")
                        .short('s')
                        .long("silent")
                        .help("Do not display seed phrase. Useful when piping output to other programs that prompt for user input, like gpg"),
                )
                .arg(
                    derivation_path_arg()
                )
                .key_generation_common_args()
                .arg(no_outfile_arg()
                    .conflicts_with_all(&["outfile", "silent"])
                )
        )
        .subcommand(
            Command::new("grind")
                .about("Grind for vanity keypairs")
                .disable_version_flag(true)
                .arg(
                    Arg::new("ignore_case")
                        .long("ignore-case")
                        .help("Performs case insensitive matches"),
                )
                .arg(
                    Arg::new("starts_with")
                        .long("starts-with")
                        .value_name("PREFIX:COUNT")
                        .number_of_values(1)
                        .takes_value(true)
                        .action(ArgAction::Append)
                        .multiple_values(true)
                        .value_parser(grind_parser(GrindType::Starts))
                        .help("Saves specified number of keypairs whos public key starts with the indicated prefix\nExample: --starts-with sol:4\nPREFIX type is Base58\nCOUNT type is u64"),
                )
                .arg(
                    Arg::new("ends_with")
                        .long("ends-with")
                        .value_name("SUFFIX:COUNT")
                        .number_of_values(1)
                        .takes_value(true)
                        .action(ArgAction::Append)
                        .multiple_values(true)
                        .value_parser(grind_parser(GrindType::Ends))
                        .help("Saves specified number of keypairs whos public key ends with the indicated suffix\nExample: --ends-with ana:4\nSUFFIX type is Base58\nCOUNT type is u64"),
                )
                .arg(
                    Arg::new("starts_and_ends_with")
                        .long("starts-and-ends-with")
                        .value_name("PREFIX:SUFFIX:COUNT")
                        .number_of_values(1)
                        .takes_value(true)
                        .action(ArgAction::Append)
                        .multiple_values(true)
                        .value_parser(grind_parser(GrindType::StartsAndEnds))
                        .help("Saves specified number of keypairs whos public key starts and ends with the indicated prefix and suffix\nExample: --starts-and-ends-with sol:ana:4\nPREFIX and SUFFIX type is Base58\nCOUNT type is u64"),
                )
                .arg(
                    Arg::new("num_threads")
                        .long("num-threads")
                        .value_name("NUMBER")
                        .takes_value(true)
                        .value_parser(value_parser!(usize))
                        .default_value(num_threads)
                        .help("Specify the number of grind threads"),
                )
                .arg(
                    Arg::new("use_mnemonic")
                        .long("use-mnemonic")
                        .help("Generate using a mnemonic key phrase.  Expect a significant slowdown in this mode"),
                )
                .arg(
                    derivation_path_arg()
                        .requires("use_mnemonic")
                )
                .key_generation_common_args()
                .arg(
                    no_outfile_arg()
                    // Require a seed phrase to avoid generating a keypair
                    // but having no way to get the private key
                    .requires("use_mnemonic")
                )
        )
        .subcommand(
            Command::new("pubkey")
                .about("Display the pubkey from a keypair file")
                .disable_version_flag(true)
                .arg(
                    Arg::new("keypair")
                        .index(1)
                        .value_name("KEYPAIR")
                        .takes_value(true)
                        .value_parser(
                            SignerSourceParserBuilder::default().allow_all().build()
                        )
                        .help("Filepath or URL to a keypair"),
                )
                .arg(
                    Arg::new(SKIP_SEED_PHRASE_VALIDATION_ARG.name)
                        .long(SKIP_SEED_PHRASE_VALIDATION_ARG.long)
                        .help(SKIP_SEED_PHRASE_VALIDATION_ARG.help),
                )
                .arg(
                    Arg::new("outfile")
                        .short('o')
                        .long("outfile")
                        .value_name("FILEPATH")
                        .takes_value(true)
                        .help("Path to generated file"),
                )
                .arg(
                    Arg::new("force")
                        .short('f')
                        .long("force")
                        .help("Overwrite the output file if it exists"),
                )
        )
        .subcommand(
            Command::new("recover")
                .about("Recover keypair from seed phrase and optional BIP39 passphrase")
                .disable_version_flag(true)
                .arg(
                    Arg::new("prompt_signer")
                        .index(1)
                        .value_name("KEYPAIR")
                        .takes_value(true)
                        .value_parser(SignerSourceParserBuilder::default().allow_prompt().allow_legacy().build())
                        .help("`prompt:` URI scheme or `ASK` keyword"),
                )
                .arg(
                    Arg::new("outfile")
                        .short('o')
                        .long("outfile")
                        .value_name("FILEPATH")
                        .takes_value(true)
                        .help("Path to generated file"),
                )
                .arg(
                    Arg::new("force")
                        .short('f')
                        .long("force")
                        .help("Overwrite the output file if it exists"),
                )
                .arg(
                    Arg::new(SKIP_SEED_PHRASE_VALIDATION_ARG.name)
                        .long(SKIP_SEED_PHRASE_VALIDATION_ARG.long)
                        .help(SKIP_SEED_PHRASE_VALIDATION_ARG.help),
                ),

        )
}

fn main() -> Result<(), Box<dyn error::Error>> {
    let default_num_threads = num_cpus::get().to_string();
    let matches = app(&default_num_threads, solana_version::version!())
        .try_get_matches()
        .unwrap_or_else(|e| e.exit());
    do_main(&matches).map_err(|err| DisplayError::new_as_boxed(err).into())
}

fn do_main(matches: &ArgMatches) -> Result<(), Box<dyn error::Error>> {
    let config = if let Some(config_file) = matches.try_get_one::<String>("config_file")? {
        Config::load(config_file).unwrap_or_default()
    } else {
        Config::default()
    };

    let mut wallet_manager = None;

    let subcommand = matches.subcommand().unwrap();

    match subcommand {
        ("pubkey", matches) => {
            let pubkey =
                get_keypair_from_matches(matches, config, &mut wallet_manager)?.try_pubkey()?;

            if matches.try_contains_id("outfile")? {
                let outfile = matches.get_one::<String>("outfile").unwrap();
                check_for_overwrite(outfile, matches)?;
                write_pubkey_file(outfile, pubkey)?;
            } else {
                println!("{pubkey}");
            }
        }
        ("new", matches) => {
            let mut path = dirs_next::home_dir().expect("home directory");
            let outfile = if matches.try_contains_id("outfile")? {
                matches.get_one::<String>("outfile").map(|s| s.as_str())
            } else if matches.try_contains_id(NO_OUTFILE_ARG.name)? {
                None
            } else {
                path.extend([".config", "solana", "id.json"]);
                Some(path.to_str().unwrap())
            };

            match outfile {
                Some(STDOUT_OUTFILE_TOKEN) => (),
                Some(outfile) => check_for_overwrite(outfile, matches)?,
                None => (),
            }

            let word_count = try_get_word_count(matches)?.unwrap();
            let mnemonic_type = MnemonicType::for_word_count(word_count)?;
            let language = try_get_language(matches)?.unwrap();

            let silent = matches.try_contains_id("silent")?;
            if !silent {
                println!("Generating a new keypair");
            }

            let derivation_path = acquire_derivation_path(matches)?;

            let mnemonic = Mnemonic::new(mnemonic_type, language);
            let (passphrase, passphrase_message) = acquire_passphrase_and_message(matches)
                .map_err(|err| format!("Unable to acquire passphrase: {err}"))?;

            let seed = Seed::new(&mnemonic, &passphrase);
            let keypair = match derivation_path {
                Some(_) => keypair_from_seed_and_derivation_path(seed.as_bytes(), derivation_path),
                None => keypair_from_seed(seed.as_bytes()),
            }?;

            if let Some(outfile) = outfile {
                output_keypair(&keypair, outfile, "new")
                    .map_err(|err| format!("Unable to write {outfile}: {err}"))?;
            }

            if !silent {
                let phrase: &str = mnemonic.phrase();
                let divider = String::from_utf8(vec![b'='; phrase.len()]).unwrap();
                println!(
                    "{}\npubkey: {}\n{}\nSave this seed phrase{} to recover your new keypair:\n{}\n{}",
                    &divider, keypair.pubkey(), &divider, passphrase_message, phrase, &divider
                );
            }
        }
        ("recover", matches) => {
            let mut path = dirs_next::home_dir().expect("home directory");
            let outfile = if matches.try_contains_id("outfile")? {
                matches.get_one::<String>("outfile").unwrap()
            } else {
                path.extend([".config", "solana", "id.json"]);
                path.to_str().unwrap()
            };

            if outfile != STDOUT_OUTFILE_TOKEN {
                check_for_overwrite(outfile, matches)?;
            }

            let keypair_name = "recover";
            let keypair =
                if let Some(source) = matches.try_get_one::<SignerSource>("prompt_signer")? {
                    keypair_from_source(matches, source, keypair_name, true)?
                } else {
                    let skip_validation =
                        matches.try_contains_id(SKIP_SEED_PHRASE_VALIDATION_ARG.name)?;
                    keypair_from_seed_phrase(keypair_name, skip_validation, true, None, true)?
                };
            output_keypair(&keypair, outfile, "recovered")?;
        }
        ("grind", matches) => {
            let ignore_case = matches.try_contains_id("ignore_case")?;

            let starts_with_args = if matches.try_contains_id("starts_with")? {
                matches
                    .get_many::<String>("starts_with")
                    .unwrap()
                    .map(|s| {
                        if ignore_case {
                            s.to_lowercase()
                        } else {
                            s.to_owned()
                        }
                    })
                    .collect()
            } else {
                HashSet::new()
            };
            let ends_with_args = if matches.try_contains_id("ends_with")? {
                matches
                    .get_many::<String>("ends_with")
                    .unwrap()
                    .map(|s| {
                        if ignore_case {
                            s.to_lowercase()
                        } else {
                            s.to_owned()
                        }
                    })
                    .collect()
            } else {
                HashSet::new()
            };
            let starts_and_ends_with_args = if matches.try_contains_id("starts_and_ends_with")? {
                matches
                    .get_many::<String>("starts_and_ends_with")
                    .unwrap()
                    .map(|s| {
                        if ignore_case {
                            s.to_lowercase()
                        } else {
                            s.to_owned()
                        }
                    })
                    .collect()
            } else {
                HashSet::new()
            };

            if starts_with_args.is_empty()
                && ends_with_args.is_empty()
                && starts_and_ends_with_args.is_empty()
            {
                return Err(
                    "Error: No keypair search criteria provided (--starts-with or --ends-with or --starts-and-ends-with)".into()
                );
            }

            let num_threads = *matches.get_one::<usize>("num_threads").unwrap();

            let grind_matches = grind_parse_args(
                ignore_case,
                starts_with_args,
                ends_with_args,
                starts_and_ends_with_args,
                num_threads,
            );

            let use_mnemonic = matches.try_contains_id("use_mnemonic")?;

            let derivation_path = acquire_derivation_path(matches)?;

            let word_count = try_get_word_count(matches)?.unwrap();
            let mnemonic_type = MnemonicType::for_word_count(word_count)?;
            let language = try_get_language(matches)?.unwrap();

            let (passphrase, passphrase_message) = if use_mnemonic {
                acquire_passphrase_and_message(matches).unwrap()
            } else {
                no_passphrase_and_message()
            };
            let no_outfile = matches.try_contains_id(NO_OUTFILE_ARG.name)?;

            // The vast majority of base58 encoded public keys have length 44, but
            // these only encapsulate prefixes 1-9 and A-H.  If the user is searching
            // for a keypair that starts with a prefix of J-Z or a-z, then there is no
            // reason to waste time searching for a keypair that will never match
            let skip_len_44_pubkeys = grind_matches
                .iter()
                .map(|g| {
                    let target_key = if ignore_case {
                        g.starts.to_ascii_uppercase()
                    } else {
                        g.starts.clone()
                    };
                    let target_key =
                        target_key + &(0..44 - g.starts.len()).map(|_| "1").collect::<String>();
                    bs58::decode(target_key).into_vec()
                })
                .filter_map(|s| s.ok())
                .all(|s| s.len() > 32);

            let grind_matches_thread_safe = Arc::new(grind_matches);
            let attempts = Arc::new(AtomicU64::new(1));
            let found = Arc::new(AtomicU64::new(0));
            let start = Instant::now();
            let done = Arc::new(AtomicBool::new(false));

            let thread_handles: Vec<_> = (0..num_threads)
                .map(|_| {
                    let done = done.clone();
                    let attempts = attempts.clone();
                    let found = found.clone();
                    let grind_matches_thread_safe = grind_matches_thread_safe.clone();
                    let passphrase = passphrase.clone();
                    let passphrase_message = passphrase_message.clone();
                    let derivation_path = derivation_path.clone();

                    thread::spawn(move || loop {
                        if done.load(Ordering::Relaxed) {
                            break;
                        }
                        let attempts = attempts.fetch_add(1, Ordering::Relaxed);
                        if attempts % 1_000_000 == 0 {
                            println!(
                                "Searched {} keypairs in {}s. {} matches found.",
                                attempts,
                                start.elapsed().as_secs(),
                                found.load(Ordering::Relaxed),
                            );
                        }
                        let (keypair, phrase) = if use_mnemonic {
                            let mnemonic = Mnemonic::new(mnemonic_type, language);
                            let seed = Seed::new(&mnemonic, &passphrase);
                            let keypair = match derivation_path {
                                Some(_) => keypair_from_seed_and_derivation_path(seed.as_bytes(), derivation_path.clone()),
                                None => keypair_from_seed(seed.as_bytes()),
                            }.unwrap();
                            (keypair, mnemonic.phrase().to_string())
                        } else {
                            (Keypair::new(), "".to_string())
                        };
                        // Skip keypairs that will never match the user specified prefix
                        if skip_len_44_pubkeys && keypair.pubkey() >= smallest_length_44_public_key::PUBKEY {
                            continue;
                        }
                        let mut pubkey = bs58::encode(keypair.pubkey()).into_string();
                        if ignore_case {
                            pubkey = pubkey.to_lowercase();
                        }
                        let mut total_matches_found = 0;
                        for i in 0..grind_matches_thread_safe.len() {
                            if grind_matches_thread_safe[i].count.load(Ordering::Relaxed) == 0 {
                                total_matches_found += 1;
                                continue;
                            }
                            if (!grind_matches_thread_safe[i].starts.is_empty()
                                && grind_matches_thread_safe[i].ends.is_empty()
                                && pubkey.starts_with(&grind_matches_thread_safe[i].starts))
                                || (grind_matches_thread_safe[i].starts.is_empty()
                                    && !grind_matches_thread_safe[i].ends.is_empty()
                                    && pubkey.ends_with(&grind_matches_thread_safe[i].ends))
                                || (!grind_matches_thread_safe[i].starts.is_empty()
                                    && !grind_matches_thread_safe[i].ends.is_empty()
                                    && pubkey.starts_with(&grind_matches_thread_safe[i].starts)
                                    && pubkey.ends_with(&grind_matches_thread_safe[i].ends))
                            {
                                let _found = found.fetch_add(1, Ordering::Relaxed);
                                grind_matches_thread_safe[i]
                                    .count
                                    .fetch_sub(1, Ordering::Relaxed);
                                if !no_outfile {
                                    write_keypair_file(&keypair, &format!("{}.json", keypair.pubkey()))
                                    .unwrap();
                                    println!(
                                        "Wrote keypair to {}",
                                        &format!("{}.json", keypair.pubkey())
                                    );
                                }
                                if use_mnemonic {
                                    let divider = String::from_utf8(vec![b'='; phrase.len()]).unwrap();
                                    println!(
                                        "{}\nFound matching key {}",
                                        &divider, keypair.pubkey());
                                    println!(
                                        "\nSave this seed phrase{} to recover your new keypair:\n{}\n{}",
                                        passphrase_message, phrase, &divider
                                    );
                                }
                            }
                        }
                        if total_matches_found == grind_matches_thread_safe.len() {
                            done.store(true, Ordering::Relaxed);
                        }
                    })
                })
                .collect();

            for thread_handle in thread_handles {
                thread_handle.join().unwrap();
            }
        }
        ("verify", matches) => {
            let keypair = get_keypair_from_matches(matches, config, &mut wallet_manager)?;
            let simple_message = Message::new(
                &[Instruction::new_with_bincode(
                    Pubkey::default(),
                    &0,
                    vec![AccountMeta::new(keypair.pubkey(), true)],
                )],
                Some(&keypair.pubkey()),
            )
            .serialize();
            let signature = keypair.try_sign_message(&simple_message)?;
            let pubkey_bs58 = matches.try_get_one::<String>("pubkey")?.unwrap();
            let pubkey = bs58::decode(pubkey_bs58).into_vec().unwrap();
            if signature.verify(&pubkey, &simple_message) {
                println!("Verification for public key: {pubkey_bs58}: Success");
            } else {
                let err_msg = format!("Verification for public key: {pubkey_bs58}: Failed");
                return Err(err_msg.into());
            }
        }
        _ => unreachable!(),
    }

    Ok(())
}

#[cfg(test)]
mod tests {
    use {
        super::*,
        tempfile::{tempdir, TempDir},
    };

    fn process_test_command(args: &[&str]) -> Result<(), Box<dyn error::Error>> {
        let default_num_threads = num_cpus::get().to_string();
        let solana_version = solana_version::version!();
        let app_matches = app(&default_num_threads, solana_version).get_matches_from(args);
        do_main(&app_matches)
    }

    fn create_tmp_keypair_and_config_file(
        keypair_out_dir: &TempDir,
        config_out_dir: &TempDir,
    ) -> (Pubkey, String, String) {
        let keypair = Keypair::new();
        let keypair_path = keypair_out_dir
            .path()
            .join(format!("{}-keypair", keypair.pubkey()));
        let keypair_outfile = keypair_path.into_os_string().into_string().unwrap();
        write_keypair_file(&keypair, &keypair_outfile).unwrap();

        let config = Config {
            keypair_path: keypair_outfile.clone(),
            ..Config::default()
        };
        let config_path = config_out_dir
            .path()
            .join(format!("{}-config", keypair.pubkey()));
        let config_outfile = config_path.into_os_string().into_string().unwrap();
        config.save(&config_outfile).unwrap();

        (keypair.pubkey(), keypair_outfile, config_outfile)
    }

    fn tmp_outfile_path(out_dir: &TempDir, name: &str) -> String {
        let path = out_dir.path().join(name);
        path.into_os_string().into_string().unwrap()
    }

    #[test]
    fn test_arguments() {
        let default_num_threads = num_cpus::get().to_string();
        let solana_version = solana_version::version!();

        // run clap internal assert statements
        app(&default_num_threads, solana_version).debug_assert();
    }

    #[test]
    fn test_verify() {
        let keypair_out_dir = tempdir().unwrap();
        let config_out_dir = tempdir().unwrap();
        let (correct_pubkey, keypair_path, config_path) =
            create_tmp_keypair_and_config_file(&keypair_out_dir, &config_out_dir);

        // success case using a keypair file
        process_test_command(&[
            "solana-keygen",
            "verify",
            &correct_pubkey.to_string(),
            &keypair_path,
        ])
        .unwrap();

        // success case using a config file
        process_test_command(&[
            "solana-keygen",
            "verify",
            &correct_pubkey.to_string(),
            "--config",
            &config_path,
        ])
        .unwrap();

        // fail case using a keypair file
        let incorrect_pubkey = Pubkey::new_unique();
        let result = process_test_command(&[
            "solana-keygen",
            "verify",
            &incorrect_pubkey.to_string(),
            &keypair_path,
        ])
        .unwrap_err()
        .to_string();

        let expected = format!("Verification for public key: {incorrect_pubkey}: Failed");
        assert_eq!(result, expected);

        // fail case using a config file
        process_test_command(&[
            "solana-keygen",
            "verify",
            &incorrect_pubkey.to_string(),
            "--config",
            &config_path,
        ])
        .unwrap_err()
        .to_string();

        let expected = format!("Verification for public key: {incorrect_pubkey}: Failed");
        assert_eq!(result, expected);

        // keypair file takes precedence over config file
        let alt_keypair_out_dir = tempdir().unwrap();
        let alt_config_out_dir = tempdir().unwrap();
        let (_, alt_keypair_path, alt_config_path) =
            create_tmp_keypair_and_config_file(&alt_keypair_out_dir, &alt_config_out_dir);

        process_test_command(&[
            "solana-keygen",
            "verify",
            &correct_pubkey.to_string(),
            &keypair_path,
            "--config",
            &alt_config_path,
        ])
        .unwrap();

        process_test_command(&[
            "solana-keygen",
            "verify",
            &correct_pubkey.to_string(),
            &alt_keypair_path,
            "--config",
            &config_path,
        ])
        .unwrap_err()
        .to_string();

        let expected = format!("Verification for public key: {incorrect_pubkey}: Failed");
        assert_eq!(result, expected);
    }

    #[test]
    fn test_pubkey() {
        let keypair_out_dir = tempdir().unwrap();
        let config_out_dir = tempdir().unwrap();
        let (expected_pubkey, keypair_path, config_path) =
            create_tmp_keypair_and_config_file(&keypair_out_dir, &config_out_dir);

        // success case using a keypair file
        {
            let outfile_dir = tempdir().unwrap();
            let outfile_path = tmp_outfile_path(&outfile_dir, &expected_pubkey.to_string());

            process_test_command(&[
                "solana-keygen",
                "pubkey",
                &keypair_path,
                "--outfile",
                &outfile_path,
            ])
            .unwrap();

            let result_pubkey = solana_sdk::pubkey::read_pubkey_file(&outfile_path).unwrap();
            assert_eq!(result_pubkey, expected_pubkey);
        }

        // success case using a config file
        {
            let outfile_dir = tempdir().unwrap();
            let outfile_path = tmp_outfile_path(&outfile_dir, &expected_pubkey.to_string());

            process_test_command(&[
                "solana-keygen",
                "pubkey",
                "--config",
                &config_path,
                "--outfile",
                &outfile_path,
            ])
            .unwrap();

            let result_pubkey = solana_sdk::pubkey::read_pubkey_file(&outfile_path).unwrap();
            assert_eq!(result_pubkey, expected_pubkey);
        }

        // keypair file takes precedence over config file
        {
            let alt_keypair_out_dir = tempdir().unwrap();
            let alt_config_out_dir = tempdir().unwrap();
            let (_, _, alt_config_path) =
                create_tmp_keypair_and_config_file(&alt_keypair_out_dir, &alt_config_out_dir);
            let outfile_dir = tempdir().unwrap();
            let outfile_path = tmp_outfile_path(&outfile_dir, &expected_pubkey.to_string());

            process_test_command(&[
                "solana-keygen",
                "pubkey",
                &keypair_path,
                "--config",
                &alt_config_path,
                "--outfile",
                &outfile_path,
            ])
            .unwrap();

            let result_pubkey = solana_sdk::pubkey::read_pubkey_file(&outfile_path).unwrap();
            assert_eq!(result_pubkey, expected_pubkey);
        }

        // refuse to overwrite file
        {
            let outfile_dir = tempdir().unwrap();
            let outfile_path = tmp_outfile_path(&outfile_dir, &expected_pubkey.to_string());

            process_test_command(&[
                "solana-keygen",
                "pubkey",
                &keypair_path,
                "--outfile",
                &outfile_path,
            ])
            .unwrap();

            let result = process_test_command(&[
                "solana-keygen",
                "pubkey",
                "--config",
                &config_path,
                "--outfile",
                &outfile_path,
            ])
            .unwrap_err()
            .to_string();

            let expected = format!("Refusing to overwrite {outfile_path} without --force flag");
            assert_eq!(result, expected);
        }
    }

    #[test]
    fn test_new() {
        let keypair_out_dir = tempdir().unwrap();
        let config_out_dir = tempdir().unwrap();
        let (expected_pubkey, _, _) =
            create_tmp_keypair_and_config_file(&keypair_out_dir, &config_out_dir);

        let outfile_dir = tempdir().unwrap();
        let outfile_path = tmp_outfile_path(&outfile_dir, &expected_pubkey.to_string());

        // general success case
        process_test_command(&[
            "solana-keygen",
            "new",
            "--outfile",
            &outfile_path,
            "--no-bip39-passphrase",
        ])
        .unwrap();

        // refuse to overwrite file
        let result = process_test_command(&[
            "solana-keygen",
            "new",
            "--outfile",
            &outfile_path,
            "--no-bip39-passphrase",
        ])
        .unwrap_err()
        .to_string();

        let expected = format!("Refusing to overwrite {outfile_path} without --force flag");
        assert_eq!(result, expected);

        // no outfile
        process_test_command(&[
            "solana-keygen",
            "new",
            "--no-bip39-passphrase",
            "--no-outfile",
        ])
        .unwrap();

        // sanity check on languages and word count combinations
        let languages = [
            "english",
            "chinese-simplified",
            "chinese-traditional",
            "japanese",
            "spanish",
            "korean",
            "french",
            "italian",
        ];
        let word_counts = ["12", "15", "18", "21", "24"];

        for language in languages {
            for word_count in word_counts {
                process_test_command(&[
                    "solana-keygen",
                    "new",
                    "--no-outfile",
                    "--no-bip39-passphrase",
                    "--language",
                    language,
                    "--word-count",
                    word_count,
                ])
                .unwrap();
            }
        }

        // sanity check derivation path
        process_test_command(&[
            "solana-keygen",
            "new",
            "--no-bip39-passphrase",
            "--no-outfile",
            "--derivation-path",
            // empty derivation path
        ])
        .unwrap();

        process_test_command(&[
            "solana-keygen",
            "new",
            "--no-bip39-passphrase",
            "--no-outfile",
            "--derivation-path",
            "m/44'/501'/0'/0'", // default derivation path
        ])
        .unwrap();

        let result = process_test_command(&[
            "solana-keygen",
            "new",
            "--no-bip39-passphrase",
            "--no-outfile",
            "--derivation-path",
            "-", // invalid derivation path
        ])
        .unwrap_err()
        .to_string();

        let expected = "invalid derivation path: invalid prefix: -";
        assert_eq!(result, expected);
    }

    #[test]
    fn test_grind() {
        // simple sanity checks
        process_test_command(&[
            "solana-keygen",
            "grind",
            "--no-outfile",
            "--no-bip39-passphrase",
            "--use-mnemonic",
            "--starts-with",
            "a:1",
        ])
        .unwrap();

        process_test_command(&[
            "solana-keygen",
            "grind",
            "--no-outfile",
            "--no-bip39-passphrase",
            "--use-mnemonic",
            "--ends-with",
            "b:1",
        ])
        .unwrap();
    }
}