Skip to content

Commit

Permalink
improved README
Browse files Browse the repository at this point in the history
  • Loading branch information
ggrieco-tob committed May 16, 2022
1 parent 4822391 commit bae61ef
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,38 @@ To start a Echidna fuzzing campaign use:
$ echidna-test EchidnaTest.sol --contract Test --test-mode assertion --corpus-dir corpus --seq-len 1 --test-limit 1000000
```

The last argument, `--test-limit` should be tweaked according to the time you want to spend in testing.
The last argument, `--test-limit` should be tweaked according to the time you want to spend in the fuzzing campaign.
Additionally, from time to time, you should remove the corpus using `rm -Rf corpus`.

The recommended Solidity version for the fuzzing campaign is 0.8.1, however, more recent releases can be used as well.

# Documentation
## Expected Result

User should be able to fully test the *Math 64.64 library*. It is worth mentioning that the code is unmodified and there are no known issues.
If you find some security or correctness issue in the code do NOT post it in this repository nor upstream, since these are public messages.
Instead, [contact us by email](mailto:[email protected]) to confirm the issue and discuss how to proceed.

For Secureum, the resulting properties will be evaluated introducing an artificial bug in the code and running a short fuzzing campaign.

## Documentation

Before starting, please review the [Echidna README](https://github.com/crytic/echidna#echidna-a-fast-smart-contract-fuzzer-), as well as [the official tutorials](https://github.com/crytic/building-secure-contracts/tree/master/program-analysis/echidna). Additionally, there is specific documentation on the libraries:

## Math 64.64
### Math 64.64

Library of mathematical functions operating with signed 64.64-bit fixed point
numbers.

\[ [documentation](ABDKMath64x64.md) | [source](ABDKMath64x64.sol) \]

## Math Quad
### Math Quad

Library of mathematical functions operating with IEEE 754 quadruple precision
(128 bit) floating point numbers.

\[ [documentation](ABDKMathQuad.md) | [source](ABDKMathQuad.sol) \]

# Copyright
## Copyright

Copyright (c) 2019, [ABDK Consulting](https://abdk.consulting/)

Expand Down

0 comments on commit bae61ef

Please sign in to comment.