Skip to content

Commit 1d1af8d

Browse files
committed
Document further missing options
1 parent 489ad0a commit 1d1af8d

File tree

1 file changed

+42
-2
lines changed

1 file changed

+42
-2
lines changed

program-analysis/echidna/configuration.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# Configuration options
22

3+
<!-- To left align the tables -->
34
<style>table {margin: 0}</style>
4-
5-
The following is a list of all the options that may be provided in the Echidna configuration file.
5+
The following is a list of all the options that may be provided in the Echidna
6+
configuration file. Whenever an option can also be set via the command line, the
7+
CLI equivalent flag is provided as a reference. Some flags are relatively new
8+
and only available on recent Echidna builds; in those cases, the minimum Echidna
9+
version required to use the feature is indicated in the table.
610

711
## `testMode`
812

@@ -34,6 +38,22 @@ Int | `100` | * | `--seq-len N`
3438

3539
Number of transactions to generate during testing.
3640

41+
## `timeout`
42+
43+
Type | Default | Available in | CLI equivalent
44+
-----|---------|--------------|---------------
45+
Int | `null` | * | `--timeout N`
46+
47+
Campaign timeout, in seconds. By default it is not time-limited.
48+
49+
## `seed`
50+
51+
Type | Default | Available in | CLI equivalent
52+
-----|---------|--------------|---------------
53+
Int | random | * | `--seed N`
54+
55+
Seed used for random value generation. By default it is a random integer.
56+
3757
## `shrinkLimit`
3858

3959
Type | Default | Available in | CLI equivalent
@@ -238,6 +258,26 @@ Bool | `false` | 2.1.0+ (previously `multi-abi`) | `--all-contracts`
238258

239259
Makes Echidna fuzz the provided test contracts and any other deployed contract whose ABI is known at runtime.
240260

261+
## `filterBlacklist`
262+
263+
Type | Default | Available in
264+
-----|---------|-------------
265+
Bool | `true` | *
266+
267+
Allows Echidna to avoid calling (when set to true) or only call (when set to
268+
false) a set of functions. The function allowlist or denylist should be provided
269+
in `filterFunctions`.
270+
271+
## `filterFunctions`
272+
273+
Type | Default | Available in
274+
-----|---------|-------------
275+
[String] | `[]` | *
276+
277+
Configures the function allowlist or denylist from `filterBlacklist`. The list
278+
should contain strings in the format of
279+
`"Contract.functionName(uint256,uint256)"` following the signature convention.
280+
241281
## `allowFFI`
242282

243283
Type | Default | Available in

0 commit comments

Comments
 (0)