Skip to content

Commit 642afa5

Browse files
committed
Lint and text wrap
1 parent 2d9e871 commit 642afa5

File tree

1 file changed

+47
-19
lines changed

1 file changed

+47
-19
lines changed

program-analysis/echidna/configuration.md

Lines changed: 47 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -23,39 +23,49 @@ The test mode to run. It should be one of the following items:
2323
- `"overflow"`: Detect integer overflows (only available in Solidity 0.8.0 or greater).
2424
- `"exploration"`: Run contract code without executing any tests.
2525

26-
Review the [testing modes tutorial](./basic/testing-modes.md) to select the one most suitable to your project.
26+
Review the [testing modes tutorial](./basic/testing-modes.md) to select the one
27+
most suitable to your project.
2728

2829
## `testLimit`
2930

3031
| Type | Default | Available in | CLI equivalent |
3132
| ---- | ------- | ------------ | ---------------- |
3233
| Int | `50000` | \* | `--test-limit N` |
3334

34-
Number of transactions to generate during testing. The campaign will stop when the `testLimit` is reached or if a `timeout` is set and the execution time exceeds it.
35+
Number of transactions to generate during testing. The campaign will stop when
36+
the `testLimit` is reached or if a `timeout` is set and the execution time
37+
exceeds it.
3538

3639
## `seqLen`
3740

3841
| Type | Default | Available in | CLI equivalent |
3942
| ---- | ------- | ------------ | -------------- |
4043
| Int | `100` | \* | `--seq-len N` |
4144

42-
Number of transactions that a transaction sequence will have during testing, and maximum length of transaction sequences in the corpus. After every N transactions, Echidna will reset the EVM to the initial post-deployment state.
45+
Number of transactions that a transaction sequence will have during testing, and
46+
maximum length of transaction sequences in the corpus. After every N
47+
transactions, Echidna will reset the EVM to the initial post-deployment state.
4348

4449
## `timeout`
4550

4651
| Type | Default | Available in | CLI equivalent |
4752
| ---- | ------- | ------------ | -------------- |
4853
| Int | `null` | \* | `--timeout N` |
4954

50-
Campaign timeout, in seconds. By default it is not time-limited. If a value is set, the campaign will stop when the time is exhausted or the `testLimit` is reached, whichever happens first.
55+
Campaign timeout, in seconds. By default it is not time-limited. If a value is
56+
set, the campaign will stop when the time is exhausted or the `testLimit` is
57+
reached, whichever happens first.
5158

5259
## `seed`
5360

5461
| Type | Default | Available in | CLI equivalent |
5562
| ---- | ------- | ------------ | -------------- |
5663
| Int | random | \* | `--seed N` |
5764

58-
Seed used for random value generation. By default it is a random integer. The seed may not guarantee reproducibility if multiple `workers` are used, as the operating system thread scheduling may introduce additional randomness into the process.
65+
Seed used for random value generation. By default it is a random integer. The
66+
seed may not guarantee reproducibility if multiple `workers` are used, as the
67+
operating system thread scheduling may introduce additional randomness into the
68+
process.
5969

6070
## `shrinkLimit`
6171

@@ -79,7 +89,8 @@ Address to deploy the contract to test.
7989
| ---- | ------- | ------------ |
8090
| Bool | `true` | \* |
8191

82-
Enable the use of coverage-guided fuzzing and corpus collection. We recommend keeping this enabled.
92+
Enable the use of coverage-guided fuzzing and corpus collection. We recommend
93+
keeping this enabled.
8394

8495
## `corpusDir`
8596

@@ -103,15 +114,18 @@ Address of the deployer of the contract to test.
103114
| ----------------------- | ------- | ------------ |
104115
| [[⁠Address, String⁠]] | `[]` | 2.0.2+ |
105116

106-
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.
117+
Addresses and contract names to deploy using the available source code. The
118+
deployer address is the same as the contract to test. Echidna will error if the
119+
deployment fails.
107120

108121
## `deployBytecodes`
109122

110123
| Type | Default | Available in |
111124
| ----------------------- | ------- | ------------ |
112125
| [[⁠Address, String⁠]] | `[]` | 2.0.2+ |
113126

114-
Addresses and bytecodes to deploy. The deployer address is the same as the contract to test. Echidna will error if the deployment fails.
127+
Addresses and bytecodes to deploy. The deployer address is the same as the
128+
contract to test. Echidna will error if the deployment fails.
115129

116130
## `sender`
117131

@@ -143,23 +157,27 @@ Prefix of the function names used as properties in the contract to test.
143157
| ---- | -------------------------------------- | ------------ |
144158
| Int | `12500000` (current max gas per block) | \* |
145159

146-
Maximum amount of gas to consume when running function properties. If a property runs out of gas, it will be considered as a failure.
160+
Maximum amount of gas to consume when running function properties. If a property
161+
runs out of gas, it will be considered as a failure.
147162

148163
## `testMaxGas`
149164

150165
| Type | Default | Available in |
151166
| ---- | -------------------------------------- | ------------ |
152167
| Int | `12500000` (current max gas per block) | \* |
153168

154-
Maximum amount of gas to consume when running random transactions. A non-property transaction that runs out of gas (e.g. a transaction in assertion mode) will not be considered a failure.
169+
Maximum amount of gas to consume when running random transactions. A
170+
non-property transaction that runs out of gas (e.g. a transaction in assertion
171+
mode) will not be considered a failure.
155172

156173
## `maxGasprice`
157174

158175
| Type | Default | Available in |
159176
| ---- | ------- | ------------ |
160177
| Int | `0` | \* |
161178

162-
Maximum amount of gas price to randomly use in transactions. Do not change it unless you absolutely need it.
179+
Maximum amount of gas price to randomly use in transactions. Do not change it
180+
unless you absolutely need it.
163181

164182
## `maxTimeDelay`
165183

@@ -191,7 +209,8 @@ Additional arguments to use in `solc` for compiling the contract to test.
191209
| -------- | ------- | ------------ | -------------------- |
192210
| [String] | `[]` | \* | `--crytic-args ARGS` |
193211

194-
Additional arguments to use in `crytic-compile` for compiling the contract to test.
212+
Additional arguments to use in `crytic-compile` for compiling the contract to
213+
test.
195214

196215
## `quiet`
197216

@@ -207,7 +226,8 @@ Hide `solc` stderr output and additional information during the testing.
207226
| ------ | ------- | ------------ | ----------------- |
208227
| String | `null` | \* | `--format FORMAT` |
209228

210-
Select a textual output format. By default, interactive TUI is run or text if a terminal is absent.
229+
Select a textual output format. By default, interactive TUI is run or text if a
230+
terminal is absent.
211231

212232
- `"text"`: simple textual interface.
213233
- `"json"`: JSON output.
@@ -219,23 +239,26 @@ Select a textual output format. By default, interactive TUI is run or text if a
219239
| ---- | ------- | ------------ |
220240
| Int | `0` | \* |
221241

222-
Initial Ether balance of `contractAddr`. See our tutorial on [working with ETH](./basic/working-with-eth.md) for more details.
242+
Initial Ether balance of `contractAddr`. See our tutorial on [working with
243+
ETH](./basic/working-with-eth.md) for more details.
223244

224245
## `balanceAddr`
225246

226247
| Type | Default | Available in |
227248
| ---- | ------------ | ------------ |
228249
| Int | `0xffffffff` | \* |
229250

230-
Initial Ether balance of `deployer` and each of the `sender` accounts. See our tutorial on [working with ETH](./basic/working-with-eth.md) for more details.
251+
Initial Ether balance of `deployer` and each of the `sender` accounts. See our
252+
tutorial on [working with ETH](./basic/working-with-eth.md) for more details.
231253

232254
## `maxValue`
233255

234256
| Type | Default | Available in |
235257
| ---- | --------------------------------- | ------------ |
236258
| Int | `100000000000000000000` (100 ETH) | \* |
237259

238-
Max amount of value in each randomly generated transaction. See our tutorial on [working with ETH](./basic/working-with-eth.md) for more details.
260+
Max amount of value in each randomly generated transaction. See our tutorial on
261+
[working with ETH](./basic/working-with-eth.md) for more details.
239262

240263
## `testDestruction`
241264

@@ -259,7 +282,8 @@ Stops the fuzzing campaign when the first test fails.
259282
| ---- | ------- | ------------------------------- | ----------------- |
260283
| Bool | `false` | 2.1.0+ (previously `multi-abi`) | `--all-contracts` |
261284

262-
Makes Echidna fuzz the provided test contracts and any other deployed contract whose ABI is known at runtime.
285+
Makes Echidna fuzz the provided test contracts and any other deployed contract
286+
whose ABI is known at runtime.
263287

264288
## `filterBlacklist`
265289

@@ -361,15 +385,19 @@ relevant if `symExec` is true.
361385
| ---- | ------- | ------------ |
362386
| Int | `1` | 2.2.4+ |
363387

364-
Number of SMT solvers used in symbolic execution. While there is a single symExec worker, N threads may be used to solve SMT queries. Only relevant if `symExec` is true.
388+
Number of SMT solvers used in symbolic execution. While there is a single
389+
symExec worker, N threads may be used to solve SMT queries. Only relevant if
390+
`symExec` is true.
365391

366392
## `symExecTimeout`
367393

368394
| Type | Default | Available in |
369395
| ---- | ------- | ------------ |
370396
| Int | `30` | 2.2.4+ |
371397

372-
Timeout for symbolic execution SMT solver. Only relevant if `symExec` is true. When the SMT solver used is Z3, this timeout applies per query, and is not global.
398+
Timeout for symbolic execution SMT solver. Only relevant if `symExec` is true.
399+
When the SMT solver used is Z3, this timeout applies per query, and is not
400+
global.
373401

374402
## `symExecMaxIters`
375403

0 commit comments

Comments
 (0)