Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme #18

Merged
merged 5 commits into from
Apr 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions README.MD
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Fee Flow

Generic contract for auctioning multiple tokens in a single auction.
Efficient, decentralised and MEV resistant mechanism to convert fee assets to a single token. Powered by a continuous auto-adjusting Dutch auction mechanism.

For more information, refer to the [whitepaper](docs/whitepaper.md)

## How to run

Expand All @@ -11,4 +13,15 @@ forge build
forge test
# generate coverage
forge coverage --report lcov && genhtml lcov.info --branch-coverage --output-dir coverage
```
```

## Security

Fee Flow has been audited by Zellic, Ottersec and Team Omega. You can find the audit reports [here](audits/).

**No warranties are provided** and **no liability will be accepted for any loss** incurred through the use of this codebase.


## License

Licensed under the [GPL-2.0-or-later](LICENSE) license.
Binary file added audits/FeeFlow Ottersec Report.pdf
Binary file not shown.
Binary file added audits/FeeFlow Team Omega Report.pdf
Binary file not shown.
Binary file added audits/FeeFlow Zellic Report.pdf
Binary file not shown.
12 changes: 0 additions & 12 deletions script/Counter.s.sol

This file was deleted.

Loading