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 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344
// Copyright (c) Mysten Labs, Inc.
// SPDX-License-Identifier: Apache-2.0
use crate::key_identity::{get_identity_address_from_keystore, KeyIdentity};
use crate::zklogin_commands_util::{perform_zk_login_test_tx, read_cli_line};
use anyhow::anyhow;
use bip32::DerivationPath;
use clap::*;
use fastcrypto::ed25519::Ed25519KeyPair;
use fastcrypto::encoding::{Base64, Encoding, Hex};
use fastcrypto::hash::HashFunction;
use fastcrypto::jwt_utils::parse_and_validate_jwt;
use fastcrypto::secp256k1::recoverable::Secp256k1Sig;
use fastcrypto::traits::{KeyPair, ToFromBytes};
use fastcrypto_zkp::bn254::utils::{
gen_address_seed, get_nonce, get_oidc_url, get_proof, get_test_issuer_jwt_token,
get_token_exchange_url,
};
use fastcrypto_zkp::bn254::zk_login::{fetch_jwks, OIDCProvider, ZkLoginInputs};
use fastcrypto_zkp::bn254::zk_login::{JwkId, JWK};
use fastcrypto_zkp::bn254::zk_login_api::ZkLoginEnv;
use im::hashmap::HashMap as ImHashMap;
use json_to_table::{json_to_table, Orientation};
use num_bigint::BigUint;
use rand::rngs::StdRng;
use rand::Rng;
use rand::SeedableRng;
use rusoto_core::Region;
use rusoto_kms::{Kms, KmsClient, SignRequest};
use serde::Serialize;
use serde_json::json;
use shared_crypto::intent::{Intent, IntentMessage, IntentScope, PersonalMessage};
use std::fmt::{Debug, Display, Formatter};
use std::fs;
use std::path::{Path, PathBuf};
use sui_keys::key_derive::generate_new_key;
use sui_keys::keypair_file::{
read_authority_keypair_from_file, read_keypair_from_file, write_authority_keypair_to_file,
write_keypair_to_file,
};
use sui_keys::keystore::{AccountKeystore, Keystore};
use sui_types::base_types::SuiAddress;
use sui_types::committee::EpochId;
use sui_types::crypto::{
get_authority_key_pair, EncodeDecodeBase64, Signature, SignatureScheme, SuiKeyPair,
ZkLoginPublicIdentifier,
};
use sui_types::crypto::{DefaultHash, PublicKey};
use sui_types::error::SuiResult;
use sui_types::multisig::{MultiSig, MultiSigPublicKey, ThresholdUnit, WeightUnit};
use sui_types::multisig_legacy::{MultiSigLegacy, MultiSigPublicKeyLegacy};
use sui_types::signature::{GenericSignature, VerifyParams};
use sui_types::transaction::{TransactionData, TransactionDataAPI};
use sui_types::zk_login_authenticator::ZkLoginAuthenticator;
use tabled::builder::Builder;
use tabled::settings::Rotate;
use tabled::settings::{object::Rows, Modify, Width};
use tracing::info;
#[cfg(test)]
#[path = "unit_tests/keytool_tests.rs"]
mod keytool_tests;
#[allow(clippy::large_enum_variant)]
#[derive(Subcommand)]
#[clap(rename_all = "kebab-case")]
pub enum KeyToolCommand {
/// Update an old alias to a new one.
/// If a new alias is not provided, a random one will be generated.
#[clap(name = "update-alias")]
Alias {
old_alias: String,
/// The alias must start with a letter and can contain only letters, digits, dots, hyphens (-), or underscores (_).
new_alias: Option<String>,
},
/// Convert private key in Hex or Base64 to new format (Bech32
/// encoded 33 byte flag || private key starting with "suiprivkey").
/// Hex private key format import and export are both deprecated in
/// Sui Wallet and Sui CLI Keystore. Use `sui keytool import` if you
/// wish to import a key to Sui Keystore.
Convert { value: String },
/// Given a Base64 encoded transaction bytes, decode its components. If a signature is provided,
/// verify the signature against the transaction and output the result.
DecodeOrVerifyTx {
#[clap(long)]
tx_bytes: String,
#[clap(long)]
sig: Option<GenericSignature>,
#[clap(long, default_value = "0")]
cur_epoch: u64,
},
/// Given a Base64 encoded MultiSig signature, decode its components.
/// If tx_bytes is passed in, verify the multisig.
DecodeMultiSig {
#[clap(long)]
multisig: MultiSig,
#[clap(long)]
tx_bytes: Option<String>,
#[clap(long, default_value = "0")]
cur_epoch: u64,
},
/// Generate a new keypair with key scheme flag {ed25519 | secp256k1 | secp256r1}
/// with optional derivation path, default to m/44'/784'/0'/0'/0' for ed25519 or
/// m/54'/784'/0'/0/0 for secp256k1 or m/74'/784'/0'/0/0 for secp256r1. Word
/// length can be { word12 | word15 | word18 | word21 | word24} default to word12
/// if not specified.
///
/// The keypair file is output to the current directory. The content of the file is
/// a Base64 encoded string of 33-byte `flag || privkey`.
///
/// Use `sui client new-address` if you want to generate and save the key into sui.keystore.
Generate {
key_scheme: SignatureScheme,
derivation_path: Option<DerivationPath>,
word_length: Option<String>,
},
/// Add a new key to Sui CLI Keystore using either the input mnemonic phrase or a Bech32 encoded 33-byte
/// `flag || privkey` starting with "suiprivkey", the key scheme flag {ed25519 | secp256k1 | secp256r1}
/// and an optional derivation path, default to m/44'/784'/0'/0'/0' for ed25519 or m/54'/784'/0'/0/0
/// for secp256k1 or m/74'/784'/0'/0/0 for secp256r1. Supports mnemonic phrase of word length 12, 15,
/// 18, 21, 24. Set an alias for the key with the --alias flag. If no alias is provided, the tool will
/// automatically generate one.
Import {
/// Sets an alias for this address. The alias must start with a letter and can contain only letters, digits, hyphens (-), or underscores (_).
#[clap(long)]
alias: Option<String>,
input_string: String,
key_scheme: SignatureScheme,
derivation_path: Option<DerivationPath>,
},
/// Output the private key of the given key identity in Sui CLI Keystore as Bech32
/// encoded string starting with `suiprivkey`.
Export {
#[clap(long)]
key_identity: KeyIdentity,
},
/// List all keys by its Sui address, Base64 encoded public key, key scheme name in
/// sui.keystore.
List {
/// Sort by alias
#[clap(long, short = 's')]
sort_by_alias: bool,
},
/// This reads the content at the provided file path. The accepted format can be
/// [enum SuiKeyPair] (Base64 encoded of 33-byte `flag || privkey`) or `type AuthorityKeyPair`
/// (Base64 encoded `privkey`). This prints out the account keypair as Base64 encoded `flag || privkey`,
/// the network keypair, worker keypair, protocol keypair as Base64 encoded `privkey`.
LoadKeypair { file: PathBuf },
/// To MultiSig Sui Address. Pass in a list of all public keys `flag || pk` in Base64.
/// See `keytool list` for example public keys.
MultiSigAddress {
#[clap(long)]
threshold: ThresholdUnit,
#[clap(long, num_args(1..))]
pks: Vec<PublicKey>,
#[clap(long, num_args(1..))]
weights: Vec<WeightUnit>,
},
/// Provides a list of participating signatures (`flag || sig || pk` encoded in Base64),
/// threshold, a list of all public keys and a list of their weights that define the
/// MultiSig address. Returns a valid MultiSig signature and its sender address. The
/// result can be used as signature field for `sui client execute-signed-tx`. The sum
/// of weights of all signatures must be >= the threshold.
///
/// The order of `sigs` must be the same as the order of `pks`.
/// e.g. for [pk1, pk2, pk3, pk4, pk5], [sig1, sig2, sig5] is valid, but
/// [sig2, sig1, sig5] is invalid.
MultiSigCombinePartialSig {
#[clap(long, num_args(1..))]
sigs: Vec<GenericSignature>,
#[clap(long, num_args(1..))]
pks: Vec<PublicKey>,
#[clap(long, num_args(1..))]
weights: Vec<WeightUnit>,
#[clap(long)]
threshold: ThresholdUnit,
},
MultiSigCombinePartialSigLegacy {
#[clap(long, num_args(1..))]
sigs: Vec<GenericSignature>,
#[clap(long, num_args(1..))]
pks: Vec<PublicKey>,
#[clap(long, num_args(1..))]
weights: Vec<WeightUnit>,
#[clap(long)]
threshold: ThresholdUnit,
},
/// Read the content at the provided file path. The accepted format can be
/// [enum SuiKeyPair] (Base64 encoded of 33-byte `flag || privkey`) or `type AuthorityKeyPair`
/// (Base64 encoded `privkey`). It prints its Base64 encoded public key and the key scheme flag.
Show { file: PathBuf },
/// Create signature using the private key for for the given address (or its alias) in sui keystore.
/// Any signature commits to a [struct IntentMessage] consisting of the Base64 encoded
/// of the BCS serialized transaction bytes itself and its intent. If intent is absent,
/// default will be used.
Sign {
#[clap(long)]
address: KeyIdentity,
#[clap(long)]
data: String,
#[clap(long)]
intent: Option<Intent>,
},
/// Creates a signature by leveraging AWS KMS. Pass in a key-id to leverage Amazon
/// KMS to sign a message and the base64 pubkey.
/// Generate PubKey from pem using MystenLabs/base64pemkey
/// Any signature commits to a [struct IntentMessage] consisting of the Base64 encoded
/// of the BCS serialized transaction bytes itself and its intent. If intent is absent,
/// default will be used.
SignKMS {
#[clap(long)]
data: String,
#[clap(long)]
keyid: String,
#[clap(long)]
intent: Option<Intent>,
#[clap(long)]
base64pk: String,
},
/// This takes [enum SuiKeyPair] of Base64 encoded of 33-byte `flag || privkey`). It
/// outputs the keypair into a file at the current directory where the address is the filename,
/// and prints out its Sui address, Base64 encoded public key, the key scheme, and the key scheme flag.
Unpack { keypair: String },
/// Given the max_epoch, generate an OAuth url, ask user to paste the redirect with id_token, call salt server, then call the prover server,
/// create a test transaction, use the ephemeral key to sign and execute it by assembling to a serialized zkLogin signature.
ZkLoginSignAndExecuteTx {
#[clap(long)]
max_epoch: EpochId,
#[clap(long, default_value = "devnet")]
network: String,
#[clap(long, default_value = "true")]
fixed: bool, // if true, use a fixed kp generated from [0; 32] seed.
#[clap(long, default_value = "true")]
test_multisig: bool, // if true, use a multisig address with zklogin and a traditional kp.
#[clap(long, default_value = "false")]
sign_with_sk: bool, // if true, execute tx with the traditional sig (in the multisig), otherwise with the zklogin sig.
},
/// A workaround to the above command because sometimes token pasting does not work (for Facebook). All the inputs required here are printed from the command above.
ZkLoginEnterToken {
#[clap(long)]
parsed_token: String,
#[clap(long)]
max_epoch: EpochId,
#[clap(long)]
jwt_randomness: String,
#[clap(long)]
kp_bigint: String,
#[clap(long)]
ephemeral_key_identifier: SuiAddress,
#[clap(long, default_value = "devnet")]
network: String,
#[clap(long, default_value = "true")]
test_multisig: bool,
#[clap(long, default_value = "false")]
sign_with_sk: bool,
},
/// Given a zkLogin signature, parse it if valid. If `bytes` provided,
/// parse it as either as TransactionData or PersonalMessage based on `intent_scope`.
/// It verifies the zkLogin signature based its latest JWK fetched.
/// Example request: sui keytool zk-login-sig-verify --sig $SERIALIZED_ZKLOGIN_SIG --bytes $BYTES --intent-scope 0 --network devnet --curr-epoch 10
ZkLoginSigVerify {
/// The Base64 of the serialized zkLogin signature.
#[clap(long)]
sig: String,
/// The Base64 of the BCS encoded TransactionData or PersonalMessage.
#[clap(long)]
bytes: Option<String>,
/// Either 0 for TransactionData or 3 for PersonalMessage.
#[clap(long)]
intent_scope: u8,
/// The current epoch for the network to verify the signature's max_epoch against.
#[clap(long)]
cur_epoch: Option<EpochId>,
/// The network to verify the signature for, determines ZkLoginEnv.
#[clap(long, default_value = "devnet")]
network: String,
},
/// TESTING ONLY: Generate a fixed ephemeral key and its JWT token with test issuer. Produce a zklogin signature for the given data and max epoch.
/// e.g. sui keytool zk-login-insecure-sign-personal-message --data "hello" --max-epoch 5
ZkLoginInsecureSignPersonalMessage {
/// The base64 encoded string of the message to sign, without the intent message wrapping.
#[clap(long)]
data: String,
/// The max epoch used for the zklogin signature validity.
#[clap(long)]
max_epoch: EpochId,
},
}
// Command Output types
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct AliasUpdate {
old_alias: String,
new_alias: String,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct DecodedMultiSig {
public_base64_key: String,
sig_base64: String,
weight: String,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct DecodedMultiSigOutput {
multisig_address: SuiAddress,
participating_keys_signatures: Vec<DecodedMultiSig>,
pub_keys: Vec<MultiSigOutput>,
threshold: usize,
transaction_result: String,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct DecodeOrVerifyTxOutput {
tx: TransactionData,
result: Option<SuiResult>,
}
#[derive(PartialEq, Eq, PartialOrd, Ord, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct Key {
alias: Option<String>,
sui_address: SuiAddress,
public_base64_key: String,
key_scheme: String,
flag: u8,
#[serde(skip_serializing_if = "Option::is_none")]
mnemonic: Option<String>,
peer_id: Option<String>,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ExportedKey {
exported_private_key: String,
key: Key,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct KeypairData {
account_keypair: String,
network_keypair: Option<String>,
worker_keypair: Option<String>,
key_scheme: String,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct MultiSigAddress {
multisig_address: String,
multisig: Vec<MultiSigOutput>,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct MultiSigCombinePartialSig {
multisig_address: SuiAddress,
multisig_parsed: GenericSignature,
multisig_serialized: String,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct MultiSigCombinePartialSigLegacyOutput {
multisig_address: SuiAddress,
multisig_legacy_parsed: GenericSignature,
multisig_legacy_serialized: String,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct MultiSigOutput {
address: SuiAddress,
public_base64_key: String,
weight: u8,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ConvertOutput {
bech32_with_flag: String, // latest Sui Keystore and Sui Wallet import/export format
base64_with_flag: String, // Sui Keystore storage format
hex_without_flag: String, // Legacy Sui Wallet format
scheme: String,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct PrivateKeyBase64 {
base64: String,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct SerializedSig {
serialized_sig_base64: String,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct SignData {
sui_address: SuiAddress,
// Base64 encoded string of serialized transaction data.
raw_tx_data: String,
// Intent struct used, see [struct Intent] for field definitions.
intent: Intent,
// Base64 encoded [struct IntentMessage] consisting of (intent || message)
// where message can be `TransactionData` etc.
raw_intent_msg: String,
// Base64 encoded blake2b hash of the intent message, this is what the signature commits to.
digest: String,
// Base64 encoded `flag || signature || pubkey` for a complete
// serialized Sui signature to be send for executing the transaction.
sui_signature: String,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ZkLoginSignAndExecuteTx {
tx_digest: String,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ZkLoginSigVerifyResponse {
data: Option<String>,
parsed: Option<String>,
jwks: Option<String>,
res: Option<SuiResult>,
}
#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct ZkLoginInsecureSignPersonalMessage {
sig: String,
bytes: String,
address: String,
}
#[derive(Serialize)]
#[serde(untagged)]
pub enum CommandOutput {
Alias(AliasUpdate),
Convert(ConvertOutput),
DecodeMultiSig(DecodedMultiSigOutput),
DecodeOrVerifyTx(DecodeOrVerifyTxOutput),
Error(String),
Generate(Key),
Import(Key),
Export(ExportedKey),
List(Vec<Key>),
LoadKeypair(KeypairData),
MultiSigAddress(MultiSigAddress),
MultiSigCombinePartialSig(MultiSigCombinePartialSig),
MultiSigCombinePartialSigLegacy(MultiSigCombinePartialSigLegacyOutput),
PrivateKeyBase64(PrivateKeyBase64),
Show(Key),
Sign(SignData),
SignKMS(SerializedSig),
ZkLoginSignAndExecuteTx(ZkLoginSignAndExecuteTx),
ZkLoginInsecureSignPersonalMessage(ZkLoginInsecureSignPersonalMessage),
ZkLoginSigVerify(ZkLoginSigVerifyResponse),
}
impl KeyToolCommand {
pub async fn execute(self, keystore: &mut Keystore) -> Result<CommandOutput, anyhow::Error> {
let cmd_result = Ok(match self {
KeyToolCommand::Alias {
old_alias,
new_alias,
} => {
let new_alias = keystore.update_alias(&old_alias, new_alias.as_deref())?;
CommandOutput::Alias(AliasUpdate {
old_alias,
new_alias,
})
}
KeyToolCommand::Convert { value } => {
let result = convert_private_key_to_bech32(value)?;
CommandOutput::Convert(result)
}
KeyToolCommand::DecodeMultiSig {
multisig,
tx_bytes,
cur_epoch,
} => {
let pks = multisig.get_pk().pubkeys();
let sigs = multisig.get_sigs();
let bitmap = multisig.get_indices()?;
let address = SuiAddress::from(multisig.get_pk());
let pub_keys = pks
.iter()
.map(|(pk, w)| MultiSigOutput {
address: (pk).into(),
public_base64_key: pk.encode_base64(),
weight: *w,
})
.collect::<Vec<MultiSigOutput>>();
let threshold = *multisig.get_pk().threshold() as usize;
let mut output = DecodedMultiSigOutput {
multisig_address: address,
participating_keys_signatures: vec![],
pub_keys,
threshold,
transaction_result: "".to_string(),
};
for (sig, i) in sigs.iter().zip(bitmap) {
let (pk, w) = pks
.get(i as usize)
.ok_or(anyhow!("Invalid public keys index".to_string()))?;
output.participating_keys_signatures.push(DecodedMultiSig {
public_base64_key: pk.encode_base64().clone(),
sig_base64: Base64::encode(sig.as_ref()),
weight: w.to_string(),
})
}
if tx_bytes.is_some() {
let tx_bytes = Base64::decode(&tx_bytes.unwrap())
.map_err(|e| anyhow!("Invalid base64 tx bytes: {:?}", e))?;
let tx_data: TransactionData = bcs::from_bytes(&tx_bytes)?;
let s = GenericSignature::MultiSig(multisig);
let res = s.verify_authenticator(
&IntentMessage::new(Intent::sui_transaction(), tx_data),
address,
cur_epoch,
&VerifyParams::default(),
);
output.transaction_result = format!("{:?}", res);
};
CommandOutput::DecodeMultiSig(output)
}
KeyToolCommand::DecodeOrVerifyTx {
tx_bytes,
sig,
cur_epoch,
} => {
let tx_bytes = Base64::decode(&tx_bytes)
.map_err(|e| anyhow!("Invalid base64 key: {:?}", e))?;
let tx_data: TransactionData = bcs::from_bytes(&tx_bytes)?;
match sig {
None => CommandOutput::DecodeOrVerifyTx(DecodeOrVerifyTxOutput {
tx: tx_data,
result: None,
}),
Some(s) => {
let res = s.verify_authenticator(
&IntentMessage::new(Intent::sui_transaction(), tx_data.clone()),
tx_data.sender(),
cur_epoch,
&VerifyParams::default(),
);
CommandOutput::DecodeOrVerifyTx(DecodeOrVerifyTxOutput {
tx: tx_data,
result: Some(res),
})
}
}
}
KeyToolCommand::Generate {
key_scheme,
derivation_path,
word_length,
} => match key_scheme {
SignatureScheme::BLS12381 => {
let (sui_address, kp) = get_authority_key_pair();
let file_name = format!("bls-{sui_address}.key");
write_authority_keypair_to_file(&kp, file_name)?;
CommandOutput::Generate(Key {
alias: None,
sui_address,
public_base64_key: kp.public().encode_base64(),
key_scheme: key_scheme.to_string(),
flag: SignatureScheme::BLS12381.flag(),
mnemonic: None,
peer_id: None,
})
}
_ => {
let (sui_address, skp, _scheme, phrase) =
generate_new_key(key_scheme, derivation_path, word_length)?;
let file = format!("{sui_address}.key");
write_keypair_to_file(&skp, file)?;
let mut key = Key::from(&skp);
key.mnemonic = Some(phrase);
CommandOutput::Generate(key)
}
},
KeyToolCommand::Import {
alias,
input_string,
key_scheme,
derivation_path,
} => {
if Hex::decode(&input_string).is_ok() {
return Err(anyhow!(
"Sui Keystore and Sui Wallet no longer support importing
private key as Hex, if you are sure your private key is encoded in Hex, use
`sui keytool convert $HEX` to convert first then import the Bech32 encoded
private key starting with `suiprivkey`."
));
}
match SuiKeyPair::decode(&input_string) {
Ok(skp) => {
info!("Importing Bech32 encoded private key to keystore");
let key = Key::from(&skp);
keystore.add_key(alias, skp)?;
CommandOutput::Import(key)
}
Err(_) => {
info!("Importing mneomonics to keystore");
let sui_address = keystore.import_from_mnemonic(
&input_string,
key_scheme,
derivation_path,
)?;
let skp = keystore.get_key(&sui_address)?;
let key = Key::from(skp);
CommandOutput::Import(key)
}
}
}
KeyToolCommand::Export { key_identity } => {
let address = get_identity_address_from_keystore(key_identity, keystore)?;
let skp = keystore.get_key(&address)?;
let key = ExportedKey {
exported_private_key: skp
.encode()
.map_err(|_| anyhow!("Cannot decode keypair"))?,
key: Key::from(skp),
};
CommandOutput::Export(key)
}
KeyToolCommand::List { sort_by_alias } => {
let mut keys = keystore
.keys()
.into_iter()
.map(|pk| {
let mut key = Key::from(pk);
key.alias = keystore.get_alias_by_address(&key.sui_address).ok();
key
})
.collect::<Vec<Key>>();
if sort_by_alias {
keys.sort_unstable();
}
CommandOutput::List(keys)
}
KeyToolCommand::LoadKeypair { file } => {
let output = match read_keypair_from_file(&file) {
Ok(keypair) => {
// Account keypair is encoded with the key scheme flag {},
// and network and worker keypair are not.
let network_worker_keypair = match &keypair {
SuiKeyPair::Ed25519(kp) => kp.encode_base64(),
SuiKeyPair::Secp256k1(kp) => kp.encode_base64(),
SuiKeyPair::Secp256r1(kp) => kp.encode_base64(),
};
KeypairData {
account_keypair: keypair.encode_base64(),
network_keypair: Some(network_worker_keypair.clone()),
worker_keypair: Some(network_worker_keypair),
key_scheme: keypair.public().scheme().to_string(),
}
}
Err(_) => {
// Authority keypair file is not stored with the flag, it will try read as BLS keypair..
match read_authority_keypair_from_file(&file) {
Ok(keypair) => KeypairData {
account_keypair: keypair.encode_base64(),
network_keypair: None,
worker_keypair: None,
key_scheme: SignatureScheme::BLS12381.to_string(),
},
Err(e) => {
return Err(anyhow!(format!(
"Failed to read keypair at path {:?} err: {:?}",
file, e
)));
}
}
}
};
CommandOutput::LoadKeypair(output)
}
KeyToolCommand::MultiSigAddress {
threshold,
pks,
weights,
} => {
let multisig_pk = MultiSigPublicKey::new(pks.clone(), weights.clone(), threshold)?;
let address: SuiAddress = (&multisig_pk).into();
let mut output = MultiSigAddress {
multisig_address: address.to_string(),
multisig: vec![],
};
for (pk, w) in pks.into_iter().zip(weights.into_iter()) {
output.multisig.push(MultiSigOutput {
address: Into::<SuiAddress>::into(&pk),
public_base64_key: pk.encode_base64(),
weight: w,
});
}
CommandOutput::MultiSigAddress(output)
}
KeyToolCommand::MultiSigCombinePartialSig {
sigs,
pks,
weights,
threshold,
} => {
let multisig_pk = MultiSigPublicKey::new(pks, weights, threshold)?;
let address: SuiAddress = (&multisig_pk).into();
let multisig = MultiSig::combine(sigs, multisig_pk)?;
let generic_sig: GenericSignature = multisig.into();
let multisig_serialized = generic_sig.encode_base64();
CommandOutput::MultiSigCombinePartialSig(MultiSigCombinePartialSig {
multisig_address: address,
multisig_parsed: generic_sig,
multisig_serialized,
})
}
KeyToolCommand::MultiSigCombinePartialSigLegacy {
sigs,
pks,
weights,
threshold,
} => {
let multisig_pk_legacy =
MultiSigPublicKeyLegacy::new(pks.clone(), weights.clone(), threshold)?;
let multisig_pk = MultiSigPublicKey::new(pks, weights, threshold)?;
let address: SuiAddress = (&multisig_pk).into();
let multisig = MultiSigLegacy::combine(sigs, multisig_pk_legacy)?;
let generic_sig: GenericSignature = multisig.into();
let multisig_legacy_serialized = generic_sig.encode_base64();
CommandOutput::MultiSigCombinePartialSigLegacy(
MultiSigCombinePartialSigLegacyOutput {
multisig_address: address,
multisig_legacy_parsed: generic_sig,
multisig_legacy_serialized,
},
)
}
KeyToolCommand::Show { file } => {
let res = read_keypair_from_file(&file);
match res {
Ok(skp) => {
let key = Key::from(&skp);
CommandOutput::Show(key)
}
Err(_) => match read_authority_keypair_from_file(&file) {
Ok(keypair) => {
let public_base64_key = keypair.public().encode_base64();
CommandOutput::Show(Key {
alias: None, // alias does not get stored in key files
sui_address: (keypair.public()).into(),
public_base64_key,
key_scheme: SignatureScheme::BLS12381.to_string(),
flag: SignatureScheme::BLS12381.flag(),
peer_id: None,
mnemonic: None,
})
}
Err(e) => CommandOutput::Error(format!(
"Failed to read keypair at path {:?}, err: {e}",
file
)),
},
}
}
KeyToolCommand::Sign {
address,
data,
intent,
} => {
let address = get_identity_address_from_keystore(address, keystore)?;
let intent = intent.unwrap_or_else(Intent::sui_transaction);
let intent_clone = intent.clone();
let msg: TransactionData =
bcs::from_bytes(&Base64::decode(&data).map_err(|e| {
anyhow!("Cannot deserialize data as TransactionData {:?}", e)
})?)?;
let intent_msg = IntentMessage::new(intent, msg);
let raw_intent_msg: String = Base64::encode(bcs::to_bytes(&intent_msg)?);
let mut hasher = DefaultHash::default();
hasher.update(bcs::to_bytes(&intent_msg)?);
let digest = hasher.finalize().digest;
let sui_signature =
keystore.sign_secure(&address, &intent_msg.value, intent_msg.intent)?;
CommandOutput::Sign(SignData {
sui_address: address,
raw_tx_data: data,
intent: intent_clone,
raw_intent_msg,
digest: Base64::encode(digest),
sui_signature: sui_signature.encode_base64(),
})
}
KeyToolCommand::SignKMS {
data,
keyid,
intent,
base64pk,
} => {
// Currently only supports secp256k1 keys
let pk_owner = PublicKey::decode_base64(&base64pk)
.map_err(|e| anyhow!("Invalid base64 key: {:?}", e))?;
let address_owner = SuiAddress::from(&pk_owner);
info!("Address For Corresponding KMS Key: {}", address_owner);
info!("Raw tx_bytes to execute: {}", data);
let intent = intent.unwrap_or_else(Intent::sui_transaction);
info!("Intent: {:?}", intent);
let msg: TransactionData =
bcs::from_bytes(&Base64::decode(&data).map_err(|e| {
anyhow!("Cannot deserialize data as TransactionData {:?}", e)
})?)?;
let intent_msg = IntentMessage::new(intent, msg);
info!(
"Raw intent message: {:?}",
Base64::encode(bcs::to_bytes(&intent_msg)?)
);
let mut hasher = DefaultHash::default();
hasher.update(bcs::to_bytes(&intent_msg)?);
let digest = hasher.finalize().digest;
info!("Digest to sign: {:?}", Base64::encode(digest));
// Set up the KMS client in default region.
let region: Region = Region::default();
let kms: KmsClient = KmsClient::new(region);
// Construct the signing request.
let request: SignRequest = SignRequest {
key_id: keyid.to_string(),
message: digest.to_vec().into(),
message_type: Some("RAW".to_string()),
signing_algorithm: "ECDSA_SHA_256".to_string(),
..Default::default()
};
// Sign the message, normalize the signature and then compacts it
// serialize_compact is loaded as bytes for Secp256k1Sinaturere
let response = kms.sign(request).await?;
let sig_bytes_der = response
.signature
.map(|b| b.to_vec())
.expect("Requires Asymmetric Key Generated in KMS");
let mut external_sig = Secp256k1Sig::from_der(&sig_bytes_der)?;
external_sig.normalize_s();
let sig_compact = external_sig.serialize_compact();
let mut serialized_sig = vec![SignatureScheme::Secp256k1.flag()];
serialized_sig.extend_from_slice(&sig_compact);
serialized_sig.extend_from_slice(pk_owner.as_ref());
let serialized_sig = Base64::encode(&serialized_sig);
CommandOutput::SignKMS(SerializedSig {
serialized_sig_base64: serialized_sig,
})
}
KeyToolCommand::Unpack { keypair } => {
let keypair = SuiKeyPair::decode_base64(&keypair)
.map_err(|_| anyhow!("Invalid Base64 encode keypair"))?;
let key = Key::from(&keypair);
let path_str = format!("{}.key", key.sui_address).to_lowercase();
let path = Path::new(&path_str);
let out_str = format!(
"address: {}\nkeypair: {}\nflag: {}",
key.sui_address,
keypair.encode_base64(),
key.flag
);
fs::write(path, out_str).unwrap();
CommandOutput::Show(key)
}
KeyToolCommand::ZkLoginInsecureSignPersonalMessage { data, max_epoch } => {
let msg = PersonalMessage {
message: data.as_bytes().to_vec(),
};
let sub = "1";
let user_salt = "1";
let intent_msg = IntentMessage::new(Intent::personal_message(), msg.clone());
// set up keypair, nonce with max_epoch
let skp =
SuiKeyPair::Ed25519(Ed25519KeyPair::generate(&mut StdRng::from_seed([0; 32])));
let jwt_randomness = BigUint::from_bytes_be(&[0; 32]).to_string();
let mut eph_pk_bytes = vec![0x00];
eph_pk_bytes.extend(skp.public().as_ref());
let kp_bigint = BigUint::from_bytes_be(&eph_pk_bytes).to_string();
let nonce = get_nonce(&eph_pk_bytes, max_epoch, &jwt_randomness).unwrap();
// call test issuer to get jwt token.
let client = reqwest::Client::new();
let parsed_token = get_test_issuer_jwt_token(
&client,
&nonce,
&OIDCProvider::TestIssuer.get_config().iss,
sub,
)
.await
.unwrap()
.jwt;
// call prover-dev for zklogin inputs
let reader = get_proof(
&parsed_token,
max_epoch,
&jwt_randomness,
&kp_bigint,
user_salt,
"https://prover-dev.mystenlabs.com/v1",
)
.await
.unwrap();
let (_, aud) = parse_and_validate_jwt(&parsed_token).unwrap();
let address_seed = gen_address_seed(user_salt, "sub", sub, &aud).unwrap();
let zk_login_inputs =
ZkLoginInputs::from_reader(reader, &address_seed.to_string()).unwrap();
let pk = PublicKey::ZkLogin(
ZkLoginPublicIdentifier::new(
zk_login_inputs.get_iss(),
zk_login_inputs.get_address_seed(),
)
.unwrap(),
);
let address = SuiAddress::from(&pk);
// sign with ephemeral key and combine with zklogin inputs to generic signature
let s = Signature::new_secure(&intent_msg, &skp);
let sig = GenericSignature::ZkLoginAuthenticator(ZkLoginAuthenticator::new(
zk_login_inputs,
max_epoch,
s,
));
CommandOutput::ZkLoginInsecureSignPersonalMessage(
ZkLoginInsecureSignPersonalMessage {
sig: Base64::encode(sig.as_bytes()),
bytes: Base64::encode(data.as_bytes()),
address: address.to_string(),
},
)
}
KeyToolCommand::ZkLoginSignAndExecuteTx {
max_epoch,
network,
fixed,
test_multisig,
sign_with_sk,
} => {
let skp = if fixed {
SuiKeyPair::Ed25519(Ed25519KeyPair::generate(&mut StdRng::from_seed([0; 32])))
} else {
SuiKeyPair::Ed25519(Ed25519KeyPair::generate(&mut rand::thread_rng()))
};
println!("Ephemeral keypair: {:?}", skp.encode());
let pk = skp.public();
let ephemeral_key_identifier: SuiAddress = (&skp.public()).into();
println!("Ephemeral key identifier: {ephemeral_key_identifier}");
keystore.add_key(None, skp)?;
let mut eph_pk_bytes = vec![pk.flag()];
eph_pk_bytes.extend(pk.as_ref());
let kp_bigint = BigUint::from_bytes_be(&eph_pk_bytes);
println!("Ephemeral pubkey (BigInt): {:?}", kp_bigint);
let jwt_randomness = if fixed {
"100681567828351849884072155819400689117".to_string()
} else {
let random_bytes = rand::thread_rng().gen::<[u8; 16]>();
let jwt_random_bytes = BigUint::from_bytes_be(&random_bytes);
jwt_random_bytes.to_string()
};
println!("Jwt randomness: {jwt_randomness}");
let url = get_oidc_url(
OIDCProvider::Google,
&eph_pk_bytes,
max_epoch,
"25769832374-famecqrhe2gkebt5fvqms2263046lj96.apps.googleusercontent.com",
"https://sui.io/",
&jwt_randomness,
)?;
let url_2 = get_oidc_url(
OIDCProvider::Twitch,
&eph_pk_bytes,
max_epoch,
"rs1bh065i9ya4ydvifixl4kss0uhpt",
"https://sui.io/",
&jwt_randomness,
)?;
let url_3 = get_oidc_url(
OIDCProvider::Facebook,
&eph_pk_bytes,
max_epoch,
"233307156352917",
"https://sui.io/",
&jwt_randomness,
)?;
let url_4 = get_oidc_url(
OIDCProvider::Kakao,
&eph_pk_bytes,
max_epoch,
"aa6bddf393b54d4e0d42ae0014edfd2f",
"https://sui.io/",
&jwt_randomness,
)?;
let url_5 = get_token_exchange_url(
OIDCProvider::Kakao,
"aa6bddf393b54d4e0d42ae0014edfd2f",
"https://sui.io/",
"$YOUR_AUTH_CODE",
"", // not needed
)?;
let url_6 = get_oidc_url(
OIDCProvider::Apple,
&eph_pk_bytes,
max_epoch,
"nl.digkas.wallet.client",
"https://sui.io/",
&jwt_randomness,
)?;
let url_7 = get_oidc_url(
OIDCProvider::Slack,
&eph_pk_bytes,
max_epoch,
"2426087588661.5742457039348",
"https://sui.io/",
&jwt_randomness,
)?;
let url_8 = get_token_exchange_url(
OIDCProvider::Slack,
"2426087588661.5742457039348",
"https://sui.io/",
"$YOUR_AUTH_CODE",
"39b955a118f2f21110939bf3dff1de90",
)?;
println!("Visit URL (Google): {url}");
println!("Visit URL (Twitch): {url_2}");
println!("Visit URL (Facebook): {url_3}");
println!("Visit URL (Kakao): {url_4}");
println!("Token exchange URL (Kakao): {url_5}");
println!("Visit URL (Apple): {url_6}");
println!("Visit URL (Slack): {url_7}");
println!("Token exchange URL (Slack): {url_8}");
println!("Finish login and paste the entire URL here (e.g. https://sui.io/#id_token=...):");
let parsed_token = read_cli_line()?;
let tx_digest = perform_zk_login_test_tx(
&parsed_token,
max_epoch,
&jwt_randomness,
&kp_bigint.to_string(),
ephemeral_key_identifier,
keystore,
&network,
test_multisig,
sign_with_sk,
)
.await?;
CommandOutput::ZkLoginSignAndExecuteTx(ZkLoginSignAndExecuteTx { tx_digest })
}
KeyToolCommand::ZkLoginEnterToken {
parsed_token,
max_epoch,
jwt_randomness,
kp_bigint,
ephemeral_key_identifier,
network,
test_multisig,
sign_with_sk,
} => {
let tx_digest = perform_zk_login_test_tx(
&parsed_token,
max_epoch,
&jwt_randomness,
&kp_bigint,
ephemeral_key_identifier,
keystore,
&network,
test_multisig,
sign_with_sk,
)
.await?;
CommandOutput::ZkLoginSignAndExecuteTx(ZkLoginSignAndExecuteTx { tx_digest })
}
KeyToolCommand::ZkLoginSigVerify {
sig,
bytes,
intent_scope,
cur_epoch,
network,
} => {
match GenericSignature::from_bytes(
&Base64::decode(&sig).map_err(|e| anyhow!("Invalid base64 sig: {:?}", e))?,
)? {
GenericSignature::ZkLoginAuthenticator(zk) => {
if bytes.is_none() || cur_epoch.is_none() {
return Ok(CommandOutput::ZkLoginSigVerify(ZkLoginSigVerifyResponse {
data: None,
parsed: Some(serde_json::to_string(&zk)?),
res: None,
jwks: None,
}));
}
let client = reqwest::Client::new();
let provider = OIDCProvider::from_iss(zk.get_iss())
.map_err(|_| anyhow!("Invalid iss"))?;
let jwks = fetch_jwks(&provider, &client).await?;
let parsed: ImHashMap<JwkId, JWK> = jwks.clone().into_iter().collect();
let env = match network.as_str() {
"devnet" | "localnet" => ZkLoginEnv::Test,
"mainnet" | "testnet" => ZkLoginEnv::Prod,
_ => return Err(anyhow!("Invalid network")),
};
let verify_params =
VerifyParams::new(parsed, vec![], env, true, true, Some(2));
let (serialized, res) = match IntentScope::try_from(intent_scope)
.map_err(|_| anyhow!("Invalid scope"))?
{
IntentScope::TransactionData => {
let tx_data: TransactionData = bcs::from_bytes(
&Base64::decode(&bytes.unwrap())
.map_err(|e| anyhow!("Invalid base64 tx data: {:?}", e))?,
)?;
let sig = GenericSignature::ZkLoginAuthenticator(zk.clone());
let res = sig.verify_authenticator(
&IntentMessage::new(Intent::sui_transaction(), tx_data.clone()),
tx_data.execution_parts().1,
cur_epoch.unwrap(),
&verify_params,
);
(serde_json::to_string(&tx_data)?, res)
}
IntentScope::PersonalMessage => {
let data = PersonalMessage {
message: Base64::decode(&bytes.unwrap()).map_err(|e| {
anyhow!("Invalid base64 personal message data: {:?}", e)
})?,
};
let sig = GenericSignature::ZkLoginAuthenticator(zk.clone());
let res = sig.verify_authenticator(
&IntentMessage::new(Intent::personal_message(), data.clone()),
(&zk).try_into()?,
cur_epoch.unwrap(),
&verify_params,
);
(serde_json::to_string(&data)?, res)
}
_ => return Err(anyhow!("Invalid intent scope")),
};
CommandOutput::ZkLoginSigVerify(ZkLoginSigVerifyResponse {
data: Some(serialized),
parsed: Some(serde_json::to_string(&zk)?),
jwks: Some(serde_json::to_string(&jwks)?),
res: Some(res),
})
}
_ => CommandOutput::Error("Not a zkLogin signature".to_string()),
}
}
});
cmd_result
}
}
impl From<&SuiKeyPair> for Key {
fn from(skp: &SuiKeyPair) -> Self {
Key::from(skp.public())
}
}
impl From<PublicKey> for Key {
fn from(pk: PublicKey) -> Self {
Key {
alias: None, // this is retrieved later
sui_address: SuiAddress::from(&pk),
public_base64_key: pk.encode_base64(),
key_scheme: pk.scheme().to_string(),
mnemonic: None,
flag: pk.flag(),
peer_id: anemo_styling(&pk),
}
}
}
impl Display for CommandOutput {
fn fmt(&self, formatter: &mut Formatter<'_>) -> std::fmt::Result {
match self {
CommandOutput::Alias(update) => {
write!(
formatter,
"Old alias {} was updated to {}",
update.old_alias, update.new_alias
)
}
// Sign needs to be manually built because we need to wrap the very long
// rawTxData string and rawIntentMsg strings into multiple rows due to
// their lengths, which we cannot do with a JsonTable
CommandOutput::Sign(data) => {
let intent_table = json_to_table(&json!(&data.intent))
.with(tabled::settings::Style::rounded().horizontals([]))
.to_string();
let mut builder = Builder::default();
builder
.set_header([
"suiSignature",
"digest",
"rawIntentMsg",
"intent",
"rawTxData",
"suiAddress",
])
.push_record([
&data.sui_signature,
&data.digest,
&data.raw_intent_msg,
&intent_table,
&data.raw_tx_data,
&data.sui_address.to_string(),
]);
let mut table = builder.build();
table.with(Rotate::Left);
table.with(tabled::settings::Style::rounded().horizontals([]));
table.with(Modify::new(Rows::new(0..)).with(Width::wrap(160).keep_words()));
write!(formatter, "{}", table)
}
_ => {
let json_obj = json![self];
let mut table = json_to_table(&json_obj);
let style = tabled::settings::Style::rounded().horizontals([]);
table.with(style);
table.array_orientation(Orientation::Column);
write!(formatter, "{}", table)
}
}
}
}
impl CommandOutput {
pub fn print(&self, pretty: bool) {
let line = if pretty {
format!("{self}")
} else {
format!("{:?}", self)
};
// Log line by line
for line in line.lines() {
// Logs write to a file on the side. Print to stdout and also log to file, for tests to pass.
println!("{line}");
info!("{line}")
}
}
}
// when --json flag is used, any output result is transformed into a JSON pretty string and sent to std output
impl Debug for CommandOutput {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
match serde_json::to_string_pretty(self) {
Ok(json) => write!(f, "{json}"),
Err(err) => write!(f, "Error serializing JSON: {err}"),
}
}
}
/// Converts legacy formatted private key to 33 bytes bech32 encoded private key or vice versa.
/// It can handle:
/// 1) Hex encoded 32 byte private key (assumes scheme is Ed25519), this is the legacy wallet format
/// 2) Base64 encoded 32 bytes private key (assumes scheme is Ed25519)
/// 3) Base64 encoded 33 bytes private key with flag.
/// 4) Bech32 encoded 33 bytes private key with flag.
fn convert_private_key_to_bech32(value: String) -> Result<ConvertOutput, anyhow::Error> {
let skp = match SuiKeyPair::decode(&value) {
Ok(s) => s,
Err(_) => match Hex::decode(&value) {
Ok(decoded) => {
if decoded.len() != 32 {
return Err(anyhow!(format!(
"Invalid private key length, expected 32 but got {}",
decoded.len()
)));
}
SuiKeyPair::Ed25519(Ed25519KeyPair::from_bytes(&decoded)?)
}
Err(_) => match SuiKeyPair::decode_base64(&value) {
Ok(skp) => skp,
Err(_) => match Ed25519KeyPair::decode_base64(&value) {
Ok(kp) => SuiKeyPair::Ed25519(kp),
Err(_) => return Err(anyhow!("Invalid private key encoding")),
},
},
},
};
Ok(ConvertOutput {
bech32_with_flag: skp.encode().map_err(|_| anyhow!("Cannot encode keypair"))?,
base64_with_flag: skp.encode_base64(),
hex_without_flag: Hex::encode(&skp.to_bytes()[1..]),
scheme: skp.public().scheme().to_string(),
})
}
fn anemo_styling(pk: &PublicKey) -> Option<String> {
if let PublicKey::Ed25519(public_key) = pk {
Some(anemo::PeerId(public_key.0).to_string())
} else {
None
}
}