Struct forc_client::ops::run::cmd::RunCommand

pub struct RunCommand {

    pub data: Option<String>,
    pub path: Option<String>,
    pub use_orig_asm: bool,
    pub dry_run: bool,
    pub node_url: Option<String>,
    pub kill_node: bool,
    pub print_ast: bool,
    pub print_finalized_asm: bool,
    pub print_intermediate_asm: bool,
    pub print_ir: bool,
    pub binary_outfile: Option<String>,
    pub debug_outfile: Option<String>,
    pub silent_mode: bool,
    pub time_phases: bool,
    pub pretty_print: bool,
    pub contract: Option<Vec<String>>,
    pub output_directory: Option<String>,
    pub minify_json_abi: bool,
    pub minify_json_storage_slots: bool,
    pub byte_price: Option<u64>,
    pub gas_limit: Option<u64>,
    pub gas_price: Option<u64>,
    pub locked: bool,
    pub simulate: bool,
}

Run script project. Crafts a script transaction then sends it to a running node.

Fields

data: Option<String>

Hex string of data to input to script.

path: Option<String>

Path to the project, if not specified, current working directory will be used.

use_orig_asm: bool

Whether to compile using the original (pre- IR) pipeline.

dry_run: bool

Only craft transaction and print it out.

node_url: Option<String>

URL of the Fuel Client Node

kill_node: bool

Kill Fuel Node Client after running the code. This is only available if the node is started from forc run

print_ast: bool

Print the generated Sway AST (Abstract Syntax Tree).

print_finalized_asm: bool

Print the finalized ASM.

This is the state of the ASM with registers allocated and optimisations applied.

print_intermediate_asm: bool

Print the generated ASM.

This is the state of the ASM prior to performing register allocation and other ASM optimisations.

print_ir: bool

Print the generated Sway IR (Intermediate Representation).

binary_outfile: Option<String>

If set, outputs a binary file representing the script bytes.

debug_outfile: Option<String>

If set, outputs source file mapping in JSON format

silent_mode: bool

Silent mode. Don’t output any warnings or errors to the command line.

time_phases: bool

Output the time elapsed over each part of the compilation process.

pretty_print: bool

Pretty-print the outputs from the node.

contract: Option<Vec<String>>

32-byte contract ID that will be called during the transaction.

output_directory: Option<String>

The directory in which the sway compiler output artifacts are placed.

By default, this is <project-root>/out.

minify_json_abi: bool

By default the JSON for ABIs is formatted for human readability. By using this option JSON output will be “minified”, i.e. all on one line without whitespace.

minify_json_storage_slots: bool

By default the JSON for initial storage slots is formatted for human readability. By using this option JSON output will be “minified”, i.e. all on one line without whitespace.

byte_price: Option<u64>

Set the transaction byte price. Defaults to 0.

gas_limit: Option<u64>

Set the transaction gas limit. Defaults to the maximum gas limit.

gas_price: Option<u64>

Set the transaction gas price. Defaults to 0.

locked: bool

Requires that the Forc.lock file is up-to-date. If the lock file is missing, or it needs to be updated, Forc will exit with an error

simulate: bool

Execute the transaction and return the final mutated transaction along with receipts (which includes whether the transaction reverted or not). The transaction is not inserted in the node’s view of the blockchain, (i.e. it does not affect the chain state).

Trait Implementations

impl Args for RunCommand

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

Append to Command so it can instantiate Self.

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

Append to Command so it can update self.

impl CommandFactory for RunCommand

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

Deprecated, replaced with CommandFactory::command

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

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 Debug for RunCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RunCommand

fn default() -> RunCommand

Returns the “default value” for a type.

impl FromArgMatches for RunCommand

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(
    &mut self,
    __clap_arg_matches: &mut ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for RunCommand

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.