Struct InvariantConfig

pub struct InvariantConfig {
    pub runs: u32,
    pub depth: u32,
    pub fail_on_revert: bool,
    pub call_override: bool,
    pub dictionary: FuzzDictionaryConfig,
    pub shrink_run_limit: u32,
    pub max_assume_rejects: u32,
    pub gas_report_samples: u32,
    pub failure_persist_dir: Option<PathBuf>,
    pub show_metrics: bool,
}

Contains for invariant testing

Fields

runs: u32

The number of runs that must execute for each invariant test group.

depth: u32

The number of calls executed to attempt to break invariants in one run.

fail_on_revert: bool

Fails the invariant fuzzing if a revert occurs

call_override: bool

Allows overriding an unsafe external call when running invariant tests. eg. reentrancy checks

dictionary: FuzzDictionaryConfig

The fuzz dictionary configuration

shrink_run_limit: u32

The maximum number of attempts to shrink the sequence

max_assume_rejects: u32

The maximum number of rejects via vm.assume which can be encountered during a single invariant run.

gas_report_samples: u32

Number of runs to execute and include in the gas report.

failure_persist_dir: Option<PathBuf>

Path where invariant failures are recorded and replayed.

show_metrics: bool

Whether to collect and display fuzzed selectors metrics.

Implementations

impl InvariantConfig

pub fn new(cache_dir: PathBuf) -> Self

Creates invariant configuration to write failures in {PROJECT_ROOT}/cache/fuzz dir.

pub fn failure_dir(self, contract_name: &str) -> PathBuf

Returns path to failure dir of given invariant test contract.

Trait Implementations

impl Clone for InvariantConfig

fn clone(&self) -> InvariantConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InvariantConfig

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

Formats the value using the given formatter.

impl Default for InvariantConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for InvariantConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl InlineConfigParser for InvariantConfig

fn config_key() -> String

Returns a config key that is common to all valid configuration lines for the current impl. This helps to extract correct values out of a text.

fn try_merge( &self, configs: &[String], ) -> Result<Option<Self>, InlineConfigParserError>

Tries to override self properties with values specified in the configs parameter.

fn merge(&self, natspec: &NatSpec) -> Result<Option<Self>, InlineConfigError>

Validates and merges the natspec configs for current profile into the current config.

fn get_config_overrides(config_lines: &[String]) -> Vec<(String, String)>

Given a list of config lines, returns all available pairs (key, value) matching the current config key.

impl PartialEq for InvariantConfig

fn eq(&self, other: &InvariantConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for InvariantConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for InvariantConfig

impl StructuralPartialEq for InvariantConfig

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: 72 bytes