Skip to content

Commit 0a9f36e

Browse files
committed
Update Echidna configuration options
1 parent b2c07d5 commit 0a9f36e

File tree

1 file changed

+45
-18
lines changed

1 file changed

+45
-18
lines changed

program-analysis/echidna/configuration.md

Lines changed: 45 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,14 @@ Maximum amount of seconds of delay between transactions.
197197

198198
Maximum amount of block numbers between transactions.
199199

200+
### `codeSize`
201+
202+
| Type | Default | Available in |
203+
| ---- | ------------ | ------------ |
204+
| Int | `0xffffffff` | \* |
205+
206+
Maximum code size for deployed contracts.
207+
200208
### `solcArgs`
201209

202210
| Type | Default | Available in | CLI equivalent |
@@ -354,7 +362,8 @@ formats.
354362
| ---- | ------- | ------------ | -------------- |
355363
| Int | `1` | 2.2.0+ | `--workers` |
356364

357-
Number of workers.
365+
Number of workers. Starting on 2.2.4, the default value is equal to the
366+
number of cores on the system, with a minimum of 1 and a maximum of 4.
358367

359368
### `server`
360369

@@ -420,19 +429,28 @@ Number of times we may revisit a particular branching point before we consult
420429
the smt solver to check reachability. Only relevant if `symExec` is true and
421430
`symExecConcolic` is false.
422431

423-
## Experimental options
432+
### `disableSlither`
424433

425-
There are some options in Echidna that are meant for advanced debugging and
426-
experimenting. Those are listed below.
434+
| Type | Default | Available in | CLI Equivalent |
435+
| ---- | ------- | ------------ | ------------------- |
436+
| Bool | `false` | 2.2.6+ | `--disable-slither` |
427437

428-
### `estimateGas`
438+
Allows disabling the Slither integration. This is only intended for development,
439+
and we do not recommend using this flag as it degrades fuzzing efficiency.
429440

430-
| Type | Default | Available in |
431-
| ---- | ------- | ------------ |
432-
| Bool | `false` | \* |
441+
### `projectName`
433442

434-
Enables the collection of worst-case gas usage. The information is stored as
435-
part of the corpus on the `gas_info` field. This functionality is experimental.
443+
| Type | Default | Available in |
444+
| ------ | ------- | ------------ |
445+
| String | `null` | 2.2.7+ |
446+
447+
A friendly name to identify what is being fuzzed. It is shown next to the
448+
Echidna version in the UI.
449+
450+
## Experimental options
451+
452+
There are some options in Echidna that are meant for advanced debugging and
453+
experimenting. Those are listed below.
436454

437455
### `dictfreq`
438456

@@ -457,16 +475,25 @@ value consists of four integers, `[c1, c2, c3, c4]`. Refer to the
457475
code](https://github.com/crytic/echidna/blob/8d20836c4a5bba6779c7a5b58cc7907c89a4e581/lib/Echidna/Mutator/Corpus.hs#L70-L101)
458476
for their meaning and impact. We do not recommend changing the default value.
459477

460-
## Deprecated options
478+
## Removed options
461479

462-
There are some options in Echidna that have been deprecated and will be removed soon. Those are listed below.
480+
There are some options in Echidna that have been removed. Those are listed below.
463481

464482
### `initialize`
465483

466-
| Type | Default | Available in |
467-
| ------ | ------- | ------------ |
468-
| String | `null` | \* |
484+
| Type | Default | Available in |
485+
| ------ | ------- | -------------- |
486+
| String | `null` | \* until 2.2.7 |
487+
488+
This allowed initializing the chain state in Echidna with a series of
489+
transactions, typically captured with [Etheno](https://github.com/crytic/etheno). With the
490+
introduction of on-chain fuzzing in Echidna, it had become deprecated, and was later removed.
491+
492+
### `estimateGas`
493+
494+
| Type | Default | Available in |
495+
| ---- | ------- | -------------- |
496+
| Bool | `false` | \* until 2.2.7 |
469497

470-
This allows initializing the chain state in Echidna with a series of
471-
transactions, typically captured with [Etheno](https://github.com/crytic/etheno). Nowadays, with the
472-
introduction of on-chain fuzzing in Echidna, it has become deprecated.
498+
Enabled the collection of worst-case gas usage. The information was stored as
499+
part of the corpus on the `gas_info` field. This functionality was experimental.

0 commit comments

Comments
 (0)