sui_tool/commands.rs
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
// Copyright (c) Mysten Labs, Inc.
// SPDX-License-Identifier: Apache-2.0
use crate::{
check_completed_snapshot,
db_tool::{execute_db_tool_command, print_db_all_tables, DbToolCommand},
download_db_snapshot, download_formal_snapshot, get_latest_available_epoch, get_object,
get_transaction_block, make_clients, restore_from_db_checkpoint, ConciseObjectOutput,
GroupedObjectOutput, SnapshotVerifyMode, VerboseObjectOutput,
};
use anyhow::Result;
use futures::{future::join_all, StreamExt};
use std::path::PathBuf;
use std::{collections::BTreeMap, env, sync::Arc};
use sui_config::genesis::Genesis;
use sui_core::authority_client::AuthorityAPI;
use sui_protocol_config::Chain;
use sui_replay::{execute_replay_command, ReplayToolCommand};
use sui_sdk::{rpc_types::SuiTransactionBlockResponseOptions, SuiClient, SuiClientBuilder};
use telemetry_subscribers::TracingHandle;
use sui_types::{
base_types::*, crypto::AuthorityPublicKeyBytes, messages_grpc::TransactionInfoRequest,
};
use clap::*;
use fastcrypto::encoding::Encoding;
use sui_config::object_storage_config::{ObjectStoreConfig, ObjectStoreType};
use sui_config::Config;
use sui_core::authority_aggregator::AuthorityAggregatorBuilder;
use sui_types::messages_checkpoint::{
CheckpointRequest, CheckpointResponse, CheckpointSequenceNumber,
};
use sui_types::transaction::{SenderSignedData, Transaction};
#[derive(Parser, Clone, ValueEnum)]
pub enum Verbosity {
Grouped,
Concise,
Verbose,
}
#[derive(Parser)]
pub enum ToolCommand {
/// Inspect if a specific object is or all gas objects owned by an address are locked by validators
#[command(name = "locked-object")]
LockedObject {
/// Either id or address must be provided
/// The object to check
#[arg(long, help = "The object ID to fetch")]
id: Option<ObjectID>,
/// Either id or address must be provided
/// If provided, check all gas objects owned by this account
#[arg(long = "address")]
address: Option<SuiAddress>,
/// RPC address to provide the up-to-date committee info
#[arg(long = "fullnode-rpc-url")]
fullnode_rpc_url: String,
/// Should attempt to rescue the object if it's locked but not fully locked
#[arg(long = "rescue")]
rescue: bool,
},
/// Fetch the same object from all validators
#[command(name = "fetch-object")]
FetchObject {
#[arg(long, help = "The object ID to fetch")]
id: ObjectID,
#[arg(long, help = "Fetch object at a specific sequence")]
version: Option<u64>,
#[arg(
long,
help = "Validator to fetch from - if not specified, all validators are queried"
)]
validator: Option<AuthorityName>,
// RPC address to provide the up-to-date committee info
#[arg(long = "fullnode-rpc-url")]
fullnode_rpc_url: String,
/// Concise mode groups responses by results.
/// prints tabular output suitable for processing with unix tools. For
/// instance, to quickly check that all validators agree on the history of an object:
/// ```text
/// $ sui-tool fetch-object --id 0x260efde76ebccf57f4c5e951157f5c361cde822c \
/// --genesis $HOME/.sui/sui_config/genesis.blob \
/// --verbosity concise --concise-no-header
/// ```
#[arg(
value_enum,
long = "verbosity",
default_value = "grouped",
ignore_case = true
)]
verbosity: Verbosity,
#[arg(
long = "concise-no-header",
help = "don't show header in concise output"
)]
concise_no_header: bool,
},
/// Fetch the effects association with transaction `digest`
#[command(name = "fetch-transaction")]
FetchTransaction {
// RPC address to provide the up-to-date committee info
#[arg(long = "fullnode-rpc-url")]
fullnode_rpc_url: String,
#[arg(long, help = "The transaction ID to fetch")]
digest: TransactionDigest,
/// If true, show the input transaction as well as the effects
#[arg(long = "show-tx")]
show_input_tx: bool,
},
/// Tool to read validator & node db.
#[command(name = "db-tool")]
DbTool {
/// Path of the DB to read
#[arg(long = "db-path")]
db_path: String,
#[command(subcommand)]
cmd: Option<DbToolCommand>,
},
/// Download all packages to the local filesystem from a GraphQL service. Each package gets its
/// own sub-directory, named for its ID on chain and version containing two metadata files
/// (linkage.json and origins.json), a file containing the overall object and a file for every
/// module it contains. Each module file is named for its module name, with a .mv suffix, and
/// contains Move bytecode (suitable for passing into a disassembler).
#[command(name = "dump-packages")]
DumpPackages {
/// Connection information for a GraphQL service.
#[clap(long, short)]
rpc_url: String,
/// Path to a non-existent directory that can be created and filled with package information.
#[clap(long, short)]
output_dir: PathBuf,
/// Only fetch packages that were created before this checkpoint (given by its sequence
/// number).
#[clap(long)]
before_checkpoint: Option<u64>,
/// If false (default), log level will be overridden to "off", and output will be reduced to
/// necessary status information.
#[clap(short, long = "verbose")]
verbose: bool,
},
#[command(name = "dump-validators")]
DumpValidators {
#[arg(long = "genesis")]
genesis: PathBuf,
#[arg(
long = "concise",
help = "show concise output - name, protocol key and network address"
)]
concise: bool,
},
#[command(name = "dump-genesis")]
DumpGenesis {
#[arg(long = "genesis")]
genesis: PathBuf,
},
/// Fetch authenticated checkpoint information at a specific sequence number.
/// If sequence number is not specified, get the latest authenticated checkpoint.
#[command(name = "fetch-checkpoint")]
FetchCheckpoint {
// RPC address to provide the up-to-date committee info
#[arg(long = "fullnode-rpc-url")]
fullnode_rpc_url: String,
#[arg(long, help = "Fetch checkpoint at a specific sequence number")]
sequence_number: Option<CheckpointSequenceNumber>,
},
#[command(name = "anemo")]
Anemo {
#[command(next_help_heading = "foo", flatten)]
args: anemo_cli::Args,
},
#[command(name = "restore-db")]
RestoreFromDBCheckpoint {
#[arg(long = "config-path")]
config_path: PathBuf,
#[arg(long = "db-checkpoint-path")]
db_checkpoint_path: PathBuf,
},
#[clap(
name = "download-db-snapshot",
about = "Downloads the legacy database snapshot via cloud object store, outputs to local disk"
)]
DownloadDBSnapshot {
#[clap(long = "epoch", conflicts_with = "latest")]
epoch: Option<u64>,
#[clap(
long = "path",
help = "the path to write the downloaded snapshot files"
)]
path: PathBuf,
/// skip downloading indexes dir
#[clap(long = "skip-indexes")]
skip_indexes: bool,
/// Number of parallel downloads to perform. Defaults to a reasonable
/// value based on number of available logical cores.
#[clap(long = "num-parallel-downloads")]
num_parallel_downloads: Option<usize>,
/// Network to download snapshot for. Defaults to "mainnet".
/// If `--snapshot-bucket` or `--archive-bucket` is not specified,
/// the value of this flag is used to construct default bucket names.
#[clap(long = "network", default_value = "mainnet")]
network: Chain,
/// Snapshot bucket name. If not specified, defaults are
/// based on value of `--network` flag.
#[clap(long = "snapshot-bucket", conflicts_with = "no_sign_request")]
snapshot_bucket: Option<String>,
/// Snapshot bucket type
#[clap(
long = "snapshot-bucket-type",
conflicts_with = "no_sign_request",
help = "Required if --no-sign-request is not set"
)]
snapshot_bucket_type: Option<ObjectStoreType>,
/// Path to snapshot directory on local filesystem.
/// Only applicable if `--snapshot-bucket-type` is "file".
#[clap(
long = "snapshot-path",
help = "only used for testing, when --snapshot-bucket-type=FILE"
)]
snapshot_path: Option<PathBuf>,
/// If true, no authentication is needed for snapshot restores
#[clap(
long = "no-sign-request",
conflicts_with_all = &["snapshot_bucket", "snapshot_bucket_type"],
help = "if set, no authentication is needed for snapshot restore"
)]
no_sign_request: bool,
/// Download snapshot of the latest available epoch.
/// If `--epoch` is specified, then this flag gets ignored.
#[clap(
long = "latest",
conflicts_with = "epoch",
help = "defaults to latest available snapshot in chosen bucket"
)]
latest: bool,
/// If false (default), log level will be overridden to "off",
/// and output will be reduced to necessary status information.
#[clap(long = "verbose")]
verbose: bool,
},
// Restore from formal (slim, DB agnostic) snapshot. Note that this is only supported
/// for protocol versions supporting `commit_root_state_digest`. For mainnet, this is
/// epoch 20+, and for testnet this is epoch 12+
#[clap(
name = "download-formal-snapshot",
about = "Downloads formal database snapshot via cloud object store, outputs to local disk"
)]
DownloadFormalSnapshot {
#[clap(long = "epoch", conflicts_with = "latest")]
epoch: Option<u64>,
#[clap(long = "genesis")]
genesis: PathBuf,
#[clap(long = "path")]
path: PathBuf,
/// Number of parallel downloads to perform. Defaults to a reasonable
/// value based on number of available logical cores.
#[clap(long = "num-parallel-downloads")]
num_parallel_downloads: Option<usize>,
/// Verification mode to employ.
#[clap(long = "verify", default_value = "normal")]
verify: Option<SnapshotVerifyMode>,
/// Network to download snapshot for. Defaults to "mainnet".
/// If `--snapshot-bucket` or `--archive-bucket` is not specified,
/// the value of this flag is used to construct default bucket names.
#[clap(long = "network", default_value = "mainnet")]
network: Chain,
/// Snapshot bucket name. If not specified, defaults are
/// based on value of `--network` flag.
#[clap(long = "snapshot-bucket", conflicts_with = "no_sign_request")]
snapshot_bucket: Option<String>,
/// Snapshot bucket type
#[clap(
long = "snapshot-bucket-type",
conflicts_with = "no_sign_request",
help = "Required if --no-sign-request is not set"
)]
snapshot_bucket_type: Option<ObjectStoreType>,
/// Path to snapshot directory on local filesystem.
/// Only applicable if `--snapshot-bucket-type` is "file".
#[clap(long = "snapshot-path")]
snapshot_path: Option<PathBuf>,
/// If true, no authentication is needed for snapshot restores
#[clap(
long = "no-sign-request",
conflicts_with_all = &["snapshot_bucket", "snapshot_bucket_type"],
help = "if set, no authentication is needed for snapshot restore"
)]
no_sign_request: bool,
/// Download snapshot of the latest available epoch.
/// If `--epoch` is specified, then this flag gets ignored.
#[clap(
long = "latest",
conflicts_with = "epoch",
help = "defaults to latest available snapshot in chosen bucket"
)]
latest: bool,
/// If false (default), log level will be overridden to "off",
/// and output will be reduced to necessary status information.
#[clap(long = "verbose")]
verbose: bool,
/// If provided, all checkpoint summaries from genesis to the end of the target epoch
/// will be downloaded and (if --verify is provided) full checkpoint chain verification
/// will be performed. If omitted, only end of epoch checkpoint summaries will be
/// downloaded, and (if --verify is provided) will be verified via committee signature.
#[clap(long = "all-checkpoints")]
all_checkpoints: bool,
},
#[clap(name = "replay")]
Replay {
#[arg(long = "rpc")]
rpc_url: Option<String>,
#[arg(long = "safety-checks")]
safety_checks: bool,
#[arg(long = "authority")]
use_authority: bool,
#[arg(
long = "cfg-path",
short,
help = "Path to the network config file. This should be specified when rpc_url is not present. \
If not specified we will use the default network config file at ~/.sui-replay/network-config.yaml"
)]
cfg_path: Option<PathBuf>,
#[arg(
long,
help = "The name of the chain to replay from, could be one of: mainnet, testnet, devnet.\
When rpc_url is not specified, this is used to load the corresponding config from the network config file.\
If not specified, mainnet will be used by default"
)]
chain: Option<String>,
#[command(subcommand)]
cmd: ReplayToolCommand,
},
/// Ask all validators to sign a transaction through AuthorityAggregator.
#[command(name = "sign-transaction")]
SignTransaction {
#[arg(long = "genesis")]
genesis: PathBuf,
#[arg(
long,
help = "The Base64-encoding of the bcs bytes of SenderSignedData"
)]
sender_signed_data: String,
},
}
async fn check_locked_object(
sui_client: &Arc<SuiClient>,
committee: Arc<BTreeMap<AuthorityPublicKeyBytes, u64>>,
id: ObjectID,
rescue: bool,
) -> anyhow::Result<()> {
let clients = Arc::new(make_clients(sui_client).await?);
let output = get_object(id, None, None, clients.clone()).await?;
let output = GroupedObjectOutput::new(output, committee);
if output.fully_locked {
println!("Object {} is fully locked.", id);
return Ok(());
}
let top_record = output.voting_power.first().unwrap();
let top_record_stake = top_record.1;
let top_record = top_record.0.clone().unwrap();
if top_record.4.is_none() {
println!(
"Object {} does not seem to be locked by majority of validators (unlocked stake: {})",
id, top_record_stake
);
return Ok(());
}
let tx_digest = top_record.2;
if !rescue {
println!("Object {} is rescueable, top tx: {:?}", id, tx_digest);
return Ok(());
}
println!("Object {} is rescueable, trying tx {}", id, tx_digest);
let validator = output
.grouped_results
.get(&Some(top_record))
.unwrap()
.first()
.unwrap();
let client = &clients.get(validator).unwrap().1;
let tx = client
.handle_transaction_info_request(TransactionInfoRequest {
transaction_digest: tx_digest,
})
.await?
.transaction;
let res = sui_client
.quorum_driver_api()
.execute_transaction_block(
Transaction::new(tx),
SuiTransactionBlockResponseOptions::full_content(),
None,
)
.await;
match res {
Ok(_) => {
println!("Transaction executed successfully ({:?})", tx_digest);
}
Err(e) => {
println!("Failed to execute transaction ({:?}): {:?}", tx_digest, e);
}
}
Ok(())
}
impl ToolCommand {
#[allow(clippy::format_in_format_args)]
pub async fn execute(self, tracing_handle: TracingHandle) -> Result<(), anyhow::Error> {
match self {
ToolCommand::LockedObject {
id,
fullnode_rpc_url,
rescue,
address,
} => {
let sui_client =
Arc::new(SuiClientBuilder::default().build(fullnode_rpc_url).await?);
let committee = Arc::new(
sui_client
.governance_api()
.get_committee_info(None)
.await?
.validators
.into_iter()
.collect::<BTreeMap<_, _>>(),
);
let object_ids = match id {
Some(id) => vec![id],
None => {
let address = address.expect("Either id or address must be provided");
sui_client
.coin_read_api()
.get_coins_stream(address, None)
.map(|c| c.coin_object_id)
.collect()
.await
}
};
for ids in object_ids.chunks(30) {
let mut tasks = vec![];
for id in ids {
tasks.push(check_locked_object(
&sui_client,
committee.clone(),
*id,
rescue,
))
}
join_all(tasks)
.await
.into_iter()
.collect::<Result<Vec<_>, _>>()?;
}
}
ToolCommand::FetchObject {
id,
validator,
version,
fullnode_rpc_url,
verbosity,
concise_no_header,
} => {
let sui_client =
Arc::new(SuiClientBuilder::default().build(fullnode_rpc_url).await?);
let clients = Arc::new(make_clients(&sui_client).await?);
let output = get_object(id, version, validator, clients).await?;
match verbosity {
Verbosity::Grouped => {
let committee = Arc::new(
sui_client
.governance_api()
.get_committee_info(None)
.await?
.validators
.into_iter()
.collect::<BTreeMap<_, _>>(),
);
println!("{}", GroupedObjectOutput::new(output, committee));
}
Verbosity::Verbose => {
println!("{}", VerboseObjectOutput(output));
}
Verbosity::Concise => {
if !concise_no_header {
println!("{}", ConciseObjectOutput::header());
}
println!("{}", ConciseObjectOutput(output));
}
}
}
ToolCommand::FetchTransaction {
digest,
show_input_tx,
fullnode_rpc_url,
} => {
print!(
"{}",
get_transaction_block(digest, show_input_tx, fullnode_rpc_url).await?
);
}
ToolCommand::DbTool { db_path, cmd } => {
let path = PathBuf::from(db_path);
match cmd {
Some(c) => execute_db_tool_command(path, c).await?,
None => print_db_all_tables(path)?,
}
}
ToolCommand::DumpPackages {
rpc_url,
output_dir,
before_checkpoint,
verbose,
} => {
if !verbose {
tracing_handle
.update_log("off")
.expect("Failed to update log level");
}
sui_package_dump::dump(rpc_url, output_dir, before_checkpoint).await?;
}
ToolCommand::DumpValidators { genesis, concise } => {
let genesis = Genesis::load(genesis).unwrap();
if !concise {
println!("{:#?}", genesis.validator_set_for_tooling());
} else {
for (i, val_info) in genesis.validator_set_for_tooling().iter().enumerate() {
let metadata = val_info.verified_metadata();
println!(
"#{:<2} {:<20} {:?} {:?} {}",
i,
metadata.name,
metadata.sui_pubkey_bytes().concise(),
metadata.net_address,
anemo::PeerId(metadata.network_pubkey.0.to_bytes()),
)
}
}
}
ToolCommand::DumpGenesis { genesis } => {
let genesis = Genesis::load(genesis)?;
println!("{:#?}", genesis);
}
ToolCommand::FetchCheckpoint {
sequence_number,
fullnode_rpc_url,
} => {
let sui_client =
Arc::new(SuiClientBuilder::default().build(fullnode_rpc_url).await?);
let clients = make_clients(&sui_client).await?;
for (name, (_, client)) in clients {
let resp = client
.handle_checkpoint(CheckpointRequest {
sequence_number,
request_content: true,
})
.await
.unwrap();
let CheckpointResponse {
checkpoint,
contents,
} = resp;
println!("Validator: {:?}\n", name.concise());
println!("Checkpoint: {:?}\n", checkpoint);
println!("Content: {:?}\n", contents);
}
}
ToolCommand::Anemo { args } => {
let config = crate::make_anemo_config();
anemo_cli::run(config, args).await
}
ToolCommand::RestoreFromDBCheckpoint {
config_path,
db_checkpoint_path,
} => {
let config = sui_config::NodeConfig::load(config_path)?;
restore_from_db_checkpoint(&config, &db_checkpoint_path).await?;
}
ToolCommand::DownloadFormalSnapshot {
epoch,
genesis,
path,
num_parallel_downloads,
verify,
network,
snapshot_bucket,
snapshot_bucket_type,
snapshot_path,
no_sign_request,
latest,
verbose,
all_checkpoints,
} => {
if !verbose {
tracing_handle
.update_log("off")
.expect("Failed to update log level");
}
let num_parallel_downloads = num_parallel_downloads.unwrap_or_else(|| {
num_cpus::get()
.checked_sub(1)
.expect("Failed to get number of CPUs")
});
let snapshot_bucket =
snapshot_bucket.or_else(|| match (network, no_sign_request) {
(Chain::Mainnet, false) => Some(
env::var("MAINNET_FORMAL_SIGNED_BUCKET")
.unwrap_or("mysten-mainnet-formal".to_string()),
),
(Chain::Mainnet, true) => env::var("MAINNET_FORMAL_UNSIGNED_BUCKET").ok(),
(Chain::Testnet, true) => env::var("TESTNET_FORMAL_UNSIGNED_BUCKET").ok(),
(Chain::Testnet, _) => Some(
env::var("TESTNET_FORMAL_SIGNED_BUCKET")
.unwrap_or("mysten-testnet-formal".to_string()),
),
(Chain::Unknown, _) => {
panic!("Cannot generate default snapshot bucket for unknown network");
}
});
let aws_endpoint = env::var("AWS_SNAPSHOT_ENDPOINT").ok().or_else(|| {
if no_sign_request {
if network == Chain::Mainnet {
Some("https://formal-snapshot.mainnet.sui.io".to_string())
} else if network == Chain::Testnet {
Some("https://formal-snapshot.testnet.sui.io".to_string())
} else {
None
}
} else {
None
}
});
let snapshot_bucket_type = if no_sign_request {
ObjectStoreType::S3
} else {
snapshot_bucket_type
.expect("You must set either --snapshot-bucket-type or --no-sign-request")
};
let snapshot_store_config = match snapshot_bucket_type {
ObjectStoreType::S3 => ObjectStoreConfig {
object_store: Some(ObjectStoreType::S3),
bucket: snapshot_bucket.filter(|s| !s.is_empty()),
aws_access_key_id: env::var("AWS_SNAPSHOT_ACCESS_KEY_ID").ok(),
aws_secret_access_key: env::var("AWS_SNAPSHOT_SECRET_ACCESS_KEY").ok(),
aws_region: env::var("AWS_SNAPSHOT_REGION").ok(),
aws_endpoint: aws_endpoint.filter(|s| !s.is_empty()),
aws_virtual_hosted_style_request: env::var(
"AWS_SNAPSHOT_VIRTUAL_HOSTED_REQUESTS",
)
.ok()
.and_then(|b| b.parse().ok())
.unwrap_or(no_sign_request),
object_store_connection_limit: 200,
no_sign_request,
..Default::default()
},
ObjectStoreType::GCS => ObjectStoreConfig {
object_store: Some(ObjectStoreType::GCS),
bucket: snapshot_bucket,
google_service_account: env::var("GCS_SNAPSHOT_SERVICE_ACCOUNT_FILE_PATH")
.ok(),
object_store_connection_limit: 200,
no_sign_request,
..Default::default()
},
ObjectStoreType::Azure => ObjectStoreConfig {
object_store: Some(ObjectStoreType::Azure),
bucket: snapshot_bucket,
azure_storage_account: env::var("AZURE_SNAPSHOT_STORAGE_ACCOUNT").ok(),
azure_storage_access_key: env::var("AZURE_SNAPSHOT_STORAGE_ACCESS_KEY")
.ok(),
object_store_connection_limit: 200,
no_sign_request,
..Default::default()
},
ObjectStoreType::File => {
if snapshot_path.is_some() {
ObjectStoreConfig {
object_store: Some(ObjectStoreType::File),
directory: snapshot_path,
..Default::default()
}
} else {
panic!(
"--snapshot-path must be specified for --snapshot-bucket-type=file"
);
}
}
};
let ingestion_url = match network {
Chain::Mainnet => "https://checkpoints.mainnet.sui.io",
Chain::Testnet => "https://checkpoints.testnet.sui.io",
_ => panic!("Cannot generate default ingestion url for unknown network"),
};
let latest_available_epoch =
latest.then_some(get_latest_available_epoch(&snapshot_store_config).await?);
let epoch_to_download = epoch.or(latest_available_epoch).expect(
"Either pass epoch with --epoch <epoch_num> or use latest with --latest",
);
if let Err(e) =
check_completed_snapshot(&snapshot_store_config, epoch_to_download).await
{
panic!(
"Aborting snapshot restore: {}, snapshot may not be uploaded yet",
e
);
}
let verify = verify.unwrap_or_default();
download_formal_snapshot(
&path,
epoch_to_download,
&genesis,
snapshot_store_config,
ingestion_url,
num_parallel_downloads,
network,
verify,
all_checkpoints,
)
.await?;
}
ToolCommand::DownloadDBSnapshot {
epoch,
path,
skip_indexes,
num_parallel_downloads,
network,
snapshot_bucket,
snapshot_bucket_type,
snapshot_path,
no_sign_request,
latest,
verbose,
} => {
if !verbose {
tracing_handle
.update_log("off")
.expect("Failed to update log level");
}
let num_parallel_downloads = num_parallel_downloads.unwrap_or_else(|| {
num_cpus::get()
.checked_sub(1)
.expect("Failed to get number of CPUs")
});
let snapshot_bucket =
snapshot_bucket.or_else(|| match (network, no_sign_request) {
(Chain::Mainnet, false) => Some(
env::var("MAINNET_DB_SIGNED_BUCKET")
.unwrap_or("mysten-mainnet-snapshots".to_string()),
),
(Chain::Mainnet, true) => env::var("MAINNET_DB_UNSIGNED_BUCKET").ok(),
(Chain::Testnet, true) => env::var("TESTNET_DB_UNSIGNED_BUCKET").ok(),
(Chain::Testnet, _) => Some(
env::var("TESTNET_DB_SIGNED_BUCKET")
.unwrap_or("mysten-testnet-snapshots".to_string()),
),
(Chain::Unknown, _) => {
panic!("Cannot generate default snapshot bucket for unknown network");
}
});
let aws_endpoint = env::var("AWS_SNAPSHOT_ENDPOINT").ok();
let snapshot_bucket_type = if no_sign_request {
ObjectStoreType::S3
} else {
snapshot_bucket_type
.expect("You must set either --snapshot-bucket-type or --no-sign-request")
};
let snapshot_store_config = if no_sign_request {
let aws_endpoint = env::var("AWS_SNAPSHOT_ENDPOINT").ok().or_else(|| {
if network == Chain::Mainnet {
Some("https://db-snapshot.mainnet.sui.io".to_string())
} else if network == Chain::Testnet {
Some("https://db-snapshot.testnet.sui.io".to_string())
} else {
None
}
});
ObjectStoreConfig {
object_store: Some(ObjectStoreType::S3),
aws_endpoint: aws_endpoint.filter(|s| !s.is_empty()),
aws_virtual_hosted_style_request: env::var(
"AWS_SNAPSHOT_VIRTUAL_HOSTED_REQUESTS",
)
.ok()
.and_then(|b| b.parse().ok())
.unwrap_or(no_sign_request),
object_store_connection_limit: 200,
no_sign_request,
..Default::default()
}
} else {
match snapshot_bucket_type {
ObjectStoreType::S3 => ObjectStoreConfig {
object_store: Some(ObjectStoreType::S3),
bucket: snapshot_bucket.filter(|s| !s.is_empty()),
aws_access_key_id: env::var("AWS_SNAPSHOT_ACCESS_KEY_ID").ok(),
aws_secret_access_key: env::var("AWS_SNAPSHOT_SECRET_ACCESS_KEY").ok(),
aws_region: env::var("AWS_SNAPSHOT_REGION").ok(),
aws_endpoint: aws_endpoint.filter(|s| !s.is_empty()),
aws_virtual_hosted_style_request: env::var(
"AWS_SNAPSHOT_VIRTUAL_HOSTED_REQUESTS",
)
.ok()
.and_then(|b| b.parse().ok())
.unwrap_or(no_sign_request),
object_store_connection_limit: 200,
no_sign_request,
..Default::default()
},
ObjectStoreType::GCS => ObjectStoreConfig {
object_store: Some(ObjectStoreType::GCS),
bucket: snapshot_bucket,
google_service_account: env::var(
"GCS_SNAPSHOT_SERVICE_ACCOUNT_FILE_PATH",
)
.ok(),
google_project_id: env::var("GCS_SNAPSHOT_SERVICE_ACCOUNT_PROJECT_ID")
.ok(),
object_store_connection_limit: 200,
no_sign_request,
..Default::default()
},
ObjectStoreType::Azure => ObjectStoreConfig {
object_store: Some(ObjectStoreType::Azure),
bucket: snapshot_bucket,
azure_storage_account: env::var("AZURE_SNAPSHOT_STORAGE_ACCOUNT").ok(),
azure_storage_access_key: env::var("AZURE_SNAPSHOT_STORAGE_ACCESS_KEY")
.ok(),
object_store_connection_limit: 200,
no_sign_request,
..Default::default()
},
ObjectStoreType::File => {
if snapshot_path.is_some() {
ObjectStoreConfig {
object_store: Some(ObjectStoreType::File),
directory: snapshot_path,
..Default::default()
}
} else {
panic!(
"--snapshot-path must be specified for --snapshot-bucket-type=file"
);
}
}
}
};
let latest_available_epoch =
latest.then_some(get_latest_available_epoch(&snapshot_store_config).await?);
let epoch_to_download = epoch.or(latest_available_epoch).expect(
"Either pass epoch with --epoch <epoch_num> or use latest with --latest",
);
if let Err(e) =
check_completed_snapshot(&snapshot_store_config, epoch_to_download).await
{
panic!(
"Aborting snapshot restore: {}, snapshot may not be uploaded yet",
e
);
}
download_db_snapshot(
&path,
epoch_to_download,
snapshot_store_config,
skip_indexes,
num_parallel_downloads,
)
.await?;
}
ToolCommand::Replay {
rpc_url,
safety_checks,
cmd,
use_authority,
cfg_path,
chain,
} => {
execute_replay_command(rpc_url, safety_checks, use_authority, cfg_path, chain, cmd)
.await?;
}
ToolCommand::SignTransaction {
genesis,
sender_signed_data,
} => {
let genesis = Genesis::load(genesis)?;
let sender_signed_data = bcs::from_bytes::<SenderSignedData>(
&fastcrypto::encoding::Base64::decode(sender_signed_data.as_str()).unwrap(),
)
.unwrap();
let transaction = Transaction::new(sender_signed_data);
let (agg, _) =
AuthorityAggregatorBuilder::from_genesis(&genesis).build_network_clients();
let result = agg.process_transaction(transaction, None).await;
println!("{:?}", result);
}
};
Ok(())
}
}