Add readme

This commit is contained in:
Theo 2023-06-06 03:50:30 -07:00
parent c5f127cf2e
commit a972fbf8e5
2 changed files with 27 additions and 0 deletions

26
README.md Normal file

@ -0,0 +1,26 @@
# Penalisation of cheating relayers
### Changes
- Almost all cheating relayers staked balances will be nullified
- Cheating relayer `abracadabra-money-gone.eth` compensated the unpaid commission in double volume, this amount will be burned
### Requirements
- Rust ([Need only for Windows](https://doc.rust-lang.org/cargo/getting-started/installation.html))
- Foundryup ([Windows](https://github.com/altugbakan/foundryup-windows), [Linux](https://book.getfoundry.sh/getting-started/installation))
- Node 14 or higher ([Windows](https://github.com/coreybutler/nvm-windows), [Linux](https://github.com/nvm-sh/nvm))
### Installation
```text
git clone --recurse-submodules <proposal-repo-link>
cd <proposal-name>
npm install
```
### Testing
```text
npm run test
```

1
lib/forge-std Submodule

@ -0,0 +1 @@
Subproject commit e8a047e3f40f13fa37af6fe14e6e06283d9a060e