Module invariant 

Modules

IInvariantTest

Module containing a contract’s types and functions.

campaign 🔒

error 🔒

replay 🔒

result 🔒

shrink 🔒

Structs

CheckSequenceOptions

Options controlling how check_sequence evaluates a candidate call sequence.

CheckSequenceOutcome

Outcome from replaying an invariant call sequence through check_sequence.

HandlerAssertionFailure

A handler-side assertion bug: a require/assert inside a fuzzed handler that the campaign reached. Deduped by (reverter, selector) site (Echidna/Medusa semantics), shortest sequence wins on collision.

HandlerReplayOutcome

Result of a strict handler-bug replay: anchor asserts, no earlier call asserts, and the recomputed edge fingerprint identifies which path the assertion took.

InvariantCampaignSeed 🔒

Immutable state selected once for a logical invariant campaign and cloned into each worker.

InvariantExecutor

Wrapper around any Executor implementer which provides fuzzing support using [proptest].

InvariantFailureMetrics 🔒

Tracks invariant failure counts during a campaign.

InvariantFailures

Stores invariant test failures and revert counts.

InvariantFuzzTestResult

The outcome of an invariant fuzz test

InvariantMetrics

Contains invariant metrics for a single fuzzed selector.

InvariantProgressContext 🔒

InvariantTest 🔒

Contains invariant test data.

InvariantTestData 🔒

Contains data collected during invariant test runs.

InvariantTestRun 🔒

Contains data for an invariant test run.

InvariantThroughputMetrics 🔒

Campaign-level throughput metrics for invariant progress reporting.

SequenceShrink

Shrinker for a call sequence failure. Iterates sequence call sequence top down and removes calls one by one. If the failure is still reproducible with removed call then moves to the next one. If the failure is not reproducible then restore removed call and moves to next one.

ShrinkCandidateKeys

Shared key set for shrinkers that need to skip duplicate concrete replays.

ShrinkRun

Shared shrink attempt driver.

ShrinkRunStats

Attempt counters collected while trying shrink candidates.

Enums

CheckSequenceFailureSite

Concrete failure site observed while replaying a sequence through check_sequence.

FailureKey

Identifies a single entry in the InvariantFailures map. Invariant predicate failures and handler-side assertion bugs share one map keyed by this enum.

InvariantCorpusPersistence 🔒

InvariantFuzzError

Constants

DEFAULT_DEPTH_FOR_INVARIANT_WORKER_CAP 🔒

Baseline depth used to preserve the previous default-depth worker heuristic.

INVARIANT_FOCUS_WORKER_DIVISOR 🔒

Share of parallel workers reserved for selector focus mode.

MIN_ESTIMATED_CALLS_PER_INVARIANT_WORKER 🔒

Minimum estimated handler calls assigned to each auto invariant worker.

MIN_RUNS_PER_INVARIANT_WORKER 🔒

Minimum number of logical runs assigned to each auto invariant worker at the default invariant depth.

Functions

auto_invariant_worker_count 🔒

build_handler_failure_event 🔒

build_invariant_progress_json 🔒

Builds the machine-readable invariant progress payload emitted during a campaign.

call_after_invariant_function 🔒

Calls the afterInvariant() function on a contract. Returns call result and if call succeeded. The state after the call is not persisted.

call_invariant_function 🔒

Calls the invariant function and returns call result and if succeeded.

campaign_seed_and_corpus_seed_for_worker 🔒

check_sequence

Checks if the given call sequence breaks the invariant.

check_sequence_value

Executes a call sequence and returns the optimization value (int256) from the invariant function. Used during shrinking for optimization mode.

collect_data 🔒

Collects data from call for fuzzing. However, it first verifies that the sender is not an EOA before inserting it into the dictionary. Otherwise, we flood the dictionary with randomly generated addresses.

execute_tx

Executes an invariant replay fuzz call and returns the result.

execute_tx_and_register_created

Executes an invariant replay call on a validation executor and registers created targets.

focused_campaign_seed_for_worker 🔒

focused_targeted_contracts 🔒

gas_report_samples_for_worker 🔒

handler_site_already_minimal

True iff there is already a HandlerAssertionFailure for site no longer than candidate_len. Used to skip inserting a not-strictly-shorter repro.

invariant_focus_seed 🔒

invariant_focus_worker_count 🔒

invariant_focus_worker_index 🔒

invariant_run_depth 🔒

invariant_worker_collects_evm_cmp_log 🔒

invariant_worker_config 🔒

invariant_worker_count_with_threads 🔒

invariant_worker_runner 🔒

invariant_worker_seed 🔒

max_invariant_workers_for_campaign 🔒

rate_per_sec 🔒

Converts a cumulative campaign total into an average per-second rate.

record_new_invariant_failures 🔒

Bridges newly-recorded invariant breaks from failures.errors into the pulse failure_metrics so the live progress stream reflects breaks as they happen. Iterates in declaration order so the emitted “failure” events are deterministic.

replay_error

Replays and shrinks a call sequence, collecting logs and traces.

replay_handler_failure_sequence

Replays a handler-bug sequence and returns whether the anchor still asserts on the same path. Rejects sequences with a pre-anchor assertion (would be a different bug).

replay_run

Replays a call sequence for collecting logs and traces. Returns counterexample to be used when the call sequence is a failed scenario.

round_rate_for_progress 🔒

should_continue_invariant_worker 🔒

shrink_sequence_by_removing

Shared sequence shrinker. Tries to drop each call; predicate decides whether the candidate should be accepted, rejected, or skipped without spending a replay attempt.