Enum ToolCommand

Source

pub enum ToolCommand {
Show 19 variants    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>,
    },
    VerifyArchive {
        genesis: PathBuf,
        object_store_config: ObjectStoreConfig,
        download_concurrency: usize,
    },
    PrintArchiveManifest {
        object_store_config: ObjectStoreConfig,
    },
    UpdateArchiveManifest {
        object_store_config: ObjectStoreConfig,
        archive_json_path: PathBuf,
    },
    VerifyArchiveByChecksum {
        object_store_config: ObjectStoreConfig,
        download_concurrency: usize,
    },
    DumpArchiveByChecksum {
        object_store_config: ObjectStoreConfig,
        start: u64,
        end: u64,
        max_content_length: usize,
    },
    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,
    },
    DownloadFormalSnapshot {Show 13 fields
        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,
        all_checkpoints: bool,
    },
    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§

§

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>

§