Enum ToolCommand

pub enum ToolCommand {
    ScanConsensusCommits {
        db_path: String,
        start_commit: Option<u32>,
        end_commit: Option<u32>,
    },
    LockedObject {
        id: Option<ObjectID>,
        address: Option<SuiAddress>,
        fullnode_rpc_url: String,
        rescue: bool,
    },
    FetchObject {
        id: ObjectID,
        version: Option<u64>,
        validator: Option<AuthorityName>,
        fullnode_rpc_url: String,
        verbosity: Verbosity,
        concise_no_header: bool,
    },
    FetchTransaction {
        fullnode_rpc_url: String,
        digest: TransactionDigest,
        show_input_tx: bool,
    },
    DbTool {
        db_path: String,
        cmd: Option<DbToolCommand>,
    },
    DumpPackages {
        rpc_url: String,
        output_dir: PathBuf,
        before_checkpoint: Option<u64>,
        verbose: bool,
    },
    DumpValidators {
        genesis: PathBuf,
        concise: bool,
    },
    DumpGenesis {
        genesis: PathBuf,
    },
    FetchCheckpoint {
        fullnode_rpc_url: String,
        sequence_number: Option<CheckpointSequenceNumber>,
    },
    Anemo {
        args: Args,
    },
    RestoreFromDBCheckpoint {
        config_path: PathBuf,
        db_checkpoint_path: PathBuf,
    },
    DownloadDBSnapshot {
        epoch: Option<u64>,
        path: PathBuf,
        skip_indexes: bool,
        num_parallel_downloads: Option<usize>,
        network: Chain,
        snapshot_bucket: Option<String>,
        snapshot_bucket_type: Option<ObjectStoreType>,
        snapshot_path: Option<PathBuf>,
        no_sign_request: bool,
        latest: bool,
        verbose: bool,
        max_retries: usize,
    },
    DownloadFormalSnapshot {

        epoch: Option<u64>,
        genesis: PathBuf,
        path: PathBuf,
        num_parallel_downloads: Option<usize>,
        verify: Option<SnapshotVerifyMode>,
        network: Chain,
        snapshot_bucket: Option<String>,
        snapshot_bucket_type: Option<ObjectStoreType>,
        snapshot_path: Option<PathBuf>,
        no_sign_request: bool,
        latest: bool,
        verbose: bool,
        max_retries: usize,
    
},
    Replay {
        rpc_url: Option<String>,
        safety_checks: bool,
        use_authority: bool,
        cfg_path: Option<PathBuf>,
        chain: Option<String>,
        cmd: ReplayToolCommand,
    },
    SignTransaction {
        genesis: PathBuf,
        sender_signed_data: String,
    },
}

Variants

ScanConsensusCommits

Fields

db_path: String

start_commit: Option<u32>

end_commit: Option<u32>

LockedObject

Inspect if a specific object is or all gas objects owned by an address are locked by validators

Fields

id: Option<ObjectID>

Either id or address must be provided The object to check

address: Option<SuiAddress>

Either id or address must be provided If provided, check all gas objects owned by this account

fullnode_rpc_url: String

RPC address to provide the up-to-date committee info

rescue: bool

Should attempt to rescue the object if it’s locked but not fully locked

FetchObject

Fetch the same object from all validators

Fields

id: ObjectID

version: Option<u64>

validator: Option<AuthorityName>

fullnode_rpc_url: String

verbosity: Verbosity

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:

$ sui-tool fetch-object --id 0x260efde76ebccf57f4c5e951157f5c361cde822c \
     --genesis $HOME/.sui/sui_config/genesis.blob \
     --verbosity concise --concise-no-header

concise_no_header: bool

FetchTransaction

Fetch the effects association with transaction digest

Fields

fullnode_rpc_url: String

digest: TransactionDigest

show_input_tx: bool

If true, show the input transaction as well as the effects

DbTool

Tool to read validator & node db.

Fields

db_path: String

Path of the DB to read

cmd: Option<DbToolCommand>

DumpPackages

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).

Fields

rpc_url: String

Connection information for a GraphQL service.

output_dir: PathBuf

Path to a non-existent directory that can be created and filled with package information.

before_checkpoint: Option<u64>

Only fetch packages that were created before this checkpoint (given by its sequence number).

verbose: bool

If false (default), log level will be overridden to “off”, and output will be reduced to necessary status information.

DumpValidators

Fields

genesis: PathBuf

concise: bool

DumpGenesis

Fields

genesis: PathBuf

FetchCheckpoint

Fetch authenticated checkpoint information at a specific sequence number. If sequence number is not specified, get the latest authenticated checkpoint.

Fields

fullnode_rpc_url: String

sequence_number: Option<CheckpointSequenceNumber>

Anemo

Fields

args: Args

RestoreFromDBCheckpoint

Fields

config_path: PathBuf

db_checkpoint_path: PathBuf

DownloadDBSnapshot

Fields

epoch: Option<u64>

path: PathBuf

skip_indexes: bool

skip downloading indexes dir

num_parallel_downloads: Option<usize>

Number of parallel downloads to perform. Defaults to a reasonable value based on number of available logical cores.

network: Chain

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.

snapshot_bucket: Option<String>

Snapshot bucket name. If not specified, defaults are based on value of --network flag.

snapshot_bucket_type: Option<ObjectStoreType>

Snapshot bucket type

snapshot_path: Option<PathBuf>

Path to snapshot directory on local filesystem. Only applicable if --snapshot-bucket-type is “file”.

no_sign_request: bool

If true, no authentication is needed for snapshot restores

latest: bool

Download snapshot of the latest available epoch. If --epoch is specified, then this flag gets ignored.

verbose: bool

If false (default), log level will be overridden to “off”, and output will be reduced to necessary status information.

max_retries: usize

Number of retries for failed HTTP requests when downloading snapshot files. Defaults to 3 retries. Set to 0 to disable retries.

DownloadFormalSnapshot

for protocol versions supporting commit_root_state_digest. For mainnet, this is epoch 20+, and for testnet this is epoch 12+

Fields

epoch: Option<u64>

genesis: PathBuf

path: PathBuf

num_parallel_downloads: Option<usize>

Number of parallel downloads to perform. Defaults to a reasonable value based on number of available logical cores.

verify: Option<SnapshotVerifyMode>

Verification mode to employ.

network: Chain

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.

snapshot_bucket: Option<String>

Snapshot bucket name. If not specified, defaults are based on value of --network flag.

snapshot_bucket_type: Option<ObjectStoreType>

Snapshot bucket type

snapshot_path: Option<PathBuf>

Path to snapshot directory on local filesystem. Only applicable if --snapshot-bucket-type is “file”.

no_sign_request: bool

If true, no authentication is needed for snapshot restores

latest: bool

Download snapshot of the latest available epoch. If --epoch is specified, then this flag gets ignored.

verbose: bool

If false (default), log level will be overridden to “off”, and output will be reduced to necessary status information.

max_retries: usize

Number of retries for failed HTTP requests when downloading snapshot files. Defaults to 3 retries. Set to 0 to disable retries.

Replay

Fields

rpc_url: Option<String>

safety_checks: bool

use_authority: bool

cfg_path: Option<PathBuf>

chain: Option<String>

cmd: ReplayToolCommand

SignTransaction

Ask all validators to sign a transaction through AuthorityAggregator.

Fields

genesis: PathBuf

sender_signed_data: String

Implementations

impl ToolCommand

pub async fn execute(self, tracing_handle: TracingHandle) -> Result<(), Error>

Trait Implementations

impl CommandFactory for ToolCommand

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl FromArgMatches for ToolCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for ToolCommand

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Subcommand for ToolCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self.

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand