Skip to content

Commit d633fb3

Browse files
committed
Add CLI equivalent flags and version information
1 parent 7059e81 commit d633fb3

File tree

1 file changed

+38
-38
lines changed

1 file changed

+38
-38
lines changed

program-analysis/echidna/configuration.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ The following is a list of all the options that may be provided in the Echidna c
66

77
## `testMode`
88

9-
Type | Default | Available in
10-
-----|---------|-------------
11-
String | `"property"` | *
9+
Type | Default | Available in | CLI equivalent
10+
-----|---------|--------------|---------------
11+
String | `"property"` | * | `--test-mode MODE`
1212

1313
The test mode to run. It should be one of the following items:
1414

@@ -20,33 +20,33 @@ The test mode to run. It should be one of the following items:
2020

2121
## `testLimit`
2222

23-
Type | Default | Available in
24-
-----|---------|-------------
25-
Int | `50000` | *
23+
Type | Default | Available in | CLI equivalent
24+
-----|---------|--------------|---------------
25+
Int | `50000` | * | `--test-limit N`
2626

2727
Number of sequences of transactions to generate during testing.
2828

2929
## `seqLen`
3030

31-
Type | Default | Available in
32-
-----|---------|-------------
33-
Int | `100` | *
31+
Type | Default | Available in | CLI equivalent
32+
-----|---------|--------------|---------------
33+
Int | `100` | * | `--seq-len N`
3434

3535
Number of transactions to generate during testing.
3636

3737
## `shrinkLimit`
3838

39-
Type | Default | Available in
40-
-----|---------|-------------
41-
Int | `5000` | *
39+
Type | Default | Available in | CLI equivalent
40+
-----|---------|--------------|---------------
41+
Int | `5000` | * | `-shrink-limit N`
4242

4343
Number of attempts to shrink a failing sequence of transactions.
4444

4545
## `contractAddr`
4646

47-
Type | Default | Available in
48-
-----|---------|-------------
49-
Address | `"0x00a329c0648769a73afac7f9381e08fb43dbea72"` | *
47+
Type | Default | Available in | CLI equivalent
48+
-----|---------|--------------|---------------
49+
Address | `"0x00a329c0648769a73af` `ac7f9381e08fb43dbea72"` | * | `--contract-addr ADDR`
5050

5151
Address to deploy the contract to test.
5252

@@ -60,41 +60,41 @@ Enable the use of coverage-guided fuzzing and corpus collection.
6060

6161
## `corpusDir`
6262

63-
Type | Default | Available in
64-
-----|---------|-------------
65-
String | `null` | *
63+
Type | Default | Available in | CLI equivalent
64+
-----|---------|--------------|---------------
65+
String | `null` | * | `--corpus-dir PATH`
6666

6767
Directory to save the corpus collected (requires coverage enabled).
6868

6969
## `deployer`
7070

71-
Type | Default | Available in
72-
-----|---------|-------------
73-
Address | `"0x30000"` | *
71+
Type | Default | Available in | CLI equivalent
72+
-----|---------|--------------|---------------
73+
Address | `"0x30000"` | * | `--deployer`
7474

7575
Address of the deployer of the contract to test.
7676

7777
## `deployContracts`
7878

7979
Type | Default | Available in
8080
-----|---------|-------------
81-
[[⁠Address, String⁠]] | `[]` | *
81+
[[⁠Address, String⁠]] | `[]` | 2.0.2+
8282

8383
Addresses and contract names to deploy using the available source code. The deployer address is the same as the contract to test. Echidna will error if the deployment fails.
8484

8585
## `deployBytecodes`
8686

8787
Type | Default | Available in
8888
-----|---------|-------------
89-
[[⁠Address, String⁠]] | `[]` | *
89+
[[⁠Address, String⁠]] | `[]` | 2.0.2+
9090

9191
Addresses and bytecodes to deploy. The deployer address is the same as the contract to test. Echidna will error if the deployment fails.
9292

9393
## `sender`
9494

95-
Type | Default | Available in
96-
-----|---------|-------------
97-
[Address] | `["0x10000", "0x20000", "0x30000"]` | *
95+
Type | Default | Available in | CLI equivalent
96+
-----|---------|--------------|---------------
97+
[Address] | `["0x10000", "0x20000", "0x30000"]` | * | `--sender`
9898

9999
List of addresses to (randomly) use for the transactions sent during testing.
100100

@@ -156,17 +156,17 @@ Maximum amount of block numbers between transactions.
156156

157157
## `solcArgs`
158158

159-
Type | Default | Available in
160-
-----|---------|-------------
161-
String | `""` | *
159+
Type | Default | Available in | CLI equivalent
160+
-----|---------|--------------|---------------
161+
String | `""` | * | `--solc-args ARGS`
162162

163163
Additional arguments to use in `solc` for compiling the contract to test.
164164

165165
## `cryticArgs`
166166

167-
Type | Default | Available in
168-
-----|---------|-------------
169-
[String] | `[]` | *
167+
Type | Default | Available in | CLI equivalent
168+
-----|---------|--------------|---------------
169+
[String] | `[]` | * | `--crytic-args ARGS`
170170

171171
Additional arguments to use in `crytic-compile` for compiling the contract to test.
172172

@@ -180,9 +180,9 @@ Hide `solc` stderr output and additional information during the testing.
180180

181181
## `format`
182182

183-
Type | Default | Available in
184-
-----|---------|-------------
185-
String | `null` | *
183+
Type | Default | Available in | CLI equivalent
184+
-----|---------|--------------|---------------
185+
String | `null` | * | `--format FORMAT`
186186

187187
Select a textual output format. By default, interactive TUI is run or text if a terminal is absent.
188188

@@ -232,9 +232,9 @@ Stops the fuzzing campaign when the first test fails.
232232

233233
## `allContracts`
234234

235-
Type | Default | Available in
236-
-----|---------|-------------
237-
Bool | `false` | *
235+
Type | Default | Available in | CLI equivalent
236+
-----|---------|--------------|---------------
237+
Bool | `false` | 2.1.0+ (previously `multi-abi`) | `--all-contracts`
238238

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

0 commit comments

Comments
 (0)