Struct ScriptArgs

pub struct ScriptArgs {

    pub global: GlobalOpts,
    pub path: String,
    pub args: Vec<String>,
    pub target_contract: Option<String>,
    pub sig: String,
    pub priority_gas_price: Option<U256>,
    pub legacy: bool,
    pub broadcast: bool,
    pub batch_size: usize,
    pub skip_simulation: bool,
    pub gas_estimate_multiplier: u64,
    pub unlocked: bool,
    pub resume: bool,
    pub multi: bool,
    pub debug: bool,
    pub dump: Option<PathBuf>,
    pub slow: bool,
    pub non_interactive: bool,
    pub etherscan_api_key: Option<String>,
    pub verify: bool,
    pub with_gas_price: Option<U256>,
    pub timeout: Option<u64>,
    pub opts: CoreBuildArgs,
    pub wallets: MultiWalletOpts,
    pub evm_args: EvmArgs,
    pub verifier: VerifierArgs,
    pub retry: RetryArgs,
}

CLI arguments for forge script.

Fields

global: GlobalOpts

path: String

The contract you want to run. Either the file path or contract name.

If multiple contracts exist in the same file you must specify the target contract with –target-contract.

args: Vec<String>

Arguments to pass to the script function.

target_contract: Option<String>

The name of the contract you want to run.

sig: String

The signature of the function you want to call in the contract, or raw calldata.

priority_gas_price: Option<U256>

Max priority fee per gas for EIP1559 transactions.

legacy: bool

Use legacy transactions instead of EIP1559 ones.

This is auto-enabled for common networks without EIP1559.

broadcast: bool

Broadcasts the transactions.

batch_size: usize

Batch size of transactions.

This is ignored and set to 1 if batching is not available or --slow is enabled.

skip_simulation: bool

Skips on-chain simulation.

gas_estimate_multiplier: u64

Relative percentage to multiply gas estimates by.

unlocked: bool

Send via eth_sendTransaction using the --from argument or $ETH_FROM as sender

resume: bool

Resumes submitting transactions that failed or timed-out previously.

It DOES NOT simulate the script again and it expects nonces to have remained the same.

Example: If transaction N has a nonce of 22, then the account should have a nonce of 22, otherwise it fails.

multi: bool

If present, –resume or –verify will be assumed to be a multi chain deployment.

debug: bool

Open the script in the debugger.

Takes precedence over broadcast.

dump: Option<PathBuf>

Dumps all debugger steps to file.

slow: bool

Makes sure a transaction is sent, only after its previous one has been confirmed and succeeded.

non_interactive: bool

Disables interactive prompts that might appear when deploying big contracts.

For more info on the contract size limit, see EIP-170: https://eips.ethereum.org/EIPS/eip-170

etherscan_api_key: Option<String>

The Etherscan (or equivalent) API key

verify: bool

Verifies all the contracts found in the receipts of a script, if any.

with_gas_price: Option<U256>

Gas price for legacy transactions, or max fee per gas for EIP1559 transactions, either specified in wei, or as a string with a unit type.

Examples: 1ether, 10gwei, 0.01ether

timeout: Option<u64>

Timeout to use for broadcasting transactions.

opts: CoreBuildArgs

wallets: MultiWalletOpts

evm_args: EvmArgs

verifier: VerifierArgs

retry: RetryArgs

Implementations

impl ScriptArgs

pub async fn preprocess(self) -> Result<PreprocessedState>

pub async fn run_script(self) -> Result<()>

Executes the script

pub(crate) fn maybe_load_private_key(&self) -> Result<Option<Address>>

In case the user has loaded only one private-key, we can assume that he’s using it as the --sender

pub(crate) fn get_method_and_calldata( &self, abi: &JsonAbi, ) -> Result<(Function, Bytes)>

Returns the Function and calldata based on the signature

If the sig is a valid human-readable function we find the corresponding function in the abi If the sig is valid hex, we assume it’s calldata and try to find the corresponding function by matching the selector, first 4 bytes in the calldata.

Note: We assume that the sig is already stripped of its prefix, See ScriptArgs

pub(crate) fn check_contract_sizes( &self, result: &ScriptResult, known_contracts: &ContractsByArtifact, create2_deployer: Address, ) -> Result<()>

Checks if the transaction is a deployment with either a size above the CONTRACT_MAX_SIZE or specified code_size_limit.

If self.broadcast is enabled, it asks confirmation of the user. Otherwise, it just warns the user.

pub(crate) fn should_broadcast(&self) -> bool

We only broadcast transactions if –broadcast or –resume was passed.

Trait Implementations

impl Args for ScriptArgs

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

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

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

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

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for ScriptArgs

fn clone(&self) -> ScriptArgs

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CommandFactory for ScriptArgs

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

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

Formats the value using the given formatter.

impl Default for ScriptArgs

fn default() -> ScriptArgs

Returns the “default value” for a type.

impl<'a> From<&'a ScriptArgs> for Config

fn from(args: &'a ScriptArgs) -> Self

Converts to this type from the input type.

impl<'a> From<&'a ScriptArgs> for Figment

fn from(args: &'a ScriptArgs) -> Self

Converts to this type from the input type.

impl FromArgMatches for ScriptArgs

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 ScriptArgs

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 Provider for ScriptArgs

fn metadata(&self) -> Metadata

Returns the [Metadata] for this provider, identifying itself and its configuration sources.

fn data(&self) -> Result<Map<Profile, Dict>, Error>

Returns the configuration data.

fn profile(&self) -> Option<Profile>

Optionally returns a profile to set on the Figment this provider is merged into. The profile is only set if self is merged.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1432 bytes