Enum move_cli::sandbox::cli::SandboxCommand

pub enum SandboxCommand {
    Publish {
        no_republish: bool,
        ignore_breaking_changes: bool,
        override_ordering: Option<Vec<String>>,
    },
    Run {
        script_file: PathBuf,
        script_name: Option<String>,
        signers: Vec<String>,
        args: Vec<TransactionArgument>,
        type_args: Vec<TypeTag>,
        gas_budget: Option<u64>,
        dry_run: bool,
    },
    Test {
        use_temp_dir: bool,
        track_cov: bool,
    },
    View {
        file: PathBuf,
    },
    Clean {},
    Doctor {},
    Generate {
        cmd: GenerateCommand,
    },
}

Variants

Publish

Fields

no_republish: bool

If set, fail when attempting to publish a module that already exists in global storage.

ignore_breaking_changes: bool

By default, code that might cause breaking changes for bytecode linking or data layout compatibility checks will not be published. Set this flag to ignore breaking changes checks and publish anyway.

override_ordering: Option<Vec<String>>

Manually specify the publishing order of modules.

Compile the modules in this package and its dependencies and publish the resulting bytecodes in global storage.

Run

Fields

script_file: PathBuf

Path to .mv file containing either script or module bytecodes. If the file is a module, the script_name parameter must be set.

script_name: Option<String>

Name of the script function inside script_file to call. Should only be set if script_file points to a module.

signers: Vec<String>

Possibly-empty list of signers for the current transaction (e.g., account in main(&account: signer)). Must match the number of signers expected by script_file.

args: Vec<TransactionArgument>

Possibly-empty list of arguments passed to the transaction (e.g., i in main(i: u64)). Must match the arguments types expected by script_file. Supported argument types are bool literals (true, false), u64 literals (e.g., 10, 58), address literals (e.g., 0x12, 0x0000000000000000000000000000000f), hexadecimal strings (e.g., x“0012“ will parse as the vector value [00, 12]), and ASCII strings (e.g., ’b“hi“ will parse as the vector value [68, 69]).

type_args: Vec<TypeTag>

Possibly-empty list of type arguments passed to the transaction (e.g., T in main<T>()). Must match the type arguments kinds expected by script_file.

gas_budget: Option<u64>

Maximum number of gas units to be consumed by execution. When the budget is exhaused, execution will abort. By default, no gas-budget is specified and gas metering is disabled.

dry_run: bool

If set, the effects of executing script_file (i.e., published, updated, and deleted resources) will NOT be committed to disk.

Run a Move script that reads/writes resources stored on disk in storage-dir. The script must be defined in the package.

Test

Fields

use_temp_dir: bool

Use an ephemeral directory to serve as the testing workspace. By default, the directory containing the args.txt will be the workspace.

track_cov: bool

Show coverage information after tests are done. By default, coverage will not be tracked nor shown.

Run expected value tests using the given batch file.

View

Fields

file: PathBuf

Path to a resource, events file, or module stored on disk.

View Move resources, events files, and modules stored on disk.

Clean

Fields

Delete all resources, events, and modules stored on disk under storage-dir. Does not delete anything in src.

Doctor

Fields

Run well-formedness checks on the storage-dir and install-dir directories.

Generate

Fields

cmd: GenerateCommand

Generate struct layout bindings for the modules stored on disk under storage-dir

Implementations

impl SandboxCommand

pub fn handle_command(
    &self,
    natives: Vec<(AccountAddress, Identifier, Identifier, NativeFunction)>,
    cost_table: &CostTable,
    error_descriptions: &ErrorMapping,
    move_args: &Move,
    storage_dir: &Path
) -> Result<()>

Trait Implementations

impl CommandFactory for SandboxCommand

fn into_app<'b>() -> Command<'b>

👎 Deprecated since 3.1.0:

Replaced with `CommandFactory::command

Deprecated, replaced with CommandFactory::command

fn into_app_for_update<'b>() -> Command<'b>

👎 Deprecated since 3.1.0:

Replaced with `CommandFactory::command_for_update

Deprecated, replaced with CommandFactory::command_for_update

fn command<'help>() -> App<'help>

Build a Command that can instantiate Self.

fn command_for_update<'help>() -> App<'help>

Build a Command that can update self.

impl FromArgMatches for SandboxCommand

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

Instantiate Self from ArgMatches, parsing the arguments as needed.

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

Assign values from ArgMatches to self.

impl Parser for SandboxCommand

fn parse() -> Self

Parse from std::env::args_os(), 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 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 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 SandboxCommand

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

Append to Command so it can instantiate Self.

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

Append to Command so it can update self.

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand