|
1 | 1 | # Configuration options |
2 | 2 |
|
| 3 | +<!-- To left align the tables --> |
3 | 4 | <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. |
6 | 10 |
|
7 | 11 | ## `testMode` |
8 | 12 |
|
@@ -34,6 +38,22 @@ Int | `100` | * | `--seq-len N` |
34 | 38 |
|
35 | 39 | Number of transactions to generate during testing. |
36 | 40 |
|
| 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 | + |
37 | 57 | ## `shrinkLimit` |
38 | 58 |
|
39 | 59 | Type | Default | Available in | CLI equivalent |
@@ -238,6 +258,26 @@ Bool | `false` | 2.1.0+ (previously `multi-abi`) | `--all-contracts` |
238 | 258 |
|
239 | 259 | Makes Echidna fuzz the provided test contracts and any other deployed contract whose ABI is known at runtime. |
240 | 260 |
|
| 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 | + |
241 | 281 | ## `allowFFI` |
242 | 282 |
|
243 | 283 | Type | Default | Available in |
|
0 commit comments