From fa397e3b52972747fb3e928bb16e36177ad52b72 Mon Sep 17 00:00:00 2001 From: engn33r Date: Tue, 27 Feb 2024 00:00:00 +0000 Subject: [PATCH] update readme --- README.md | 67 +++---------------------------------------------------- 1 file changed, 3 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index 9265b45..f75e2c0 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,5 @@ -## Foundry +## ETH Lock Contract -**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.** +Design for fellows to stake ETH during a yAcademy fellow block. After the block ends, `newLock()` is called by the yAcademy admin to set a merkle root and the proofs are sent to each fellow individually to allow them to redeem their staked ETH. -Foundry consists of: - -- **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools). -- **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data. -- **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network. -- **Chisel**: Fast, utilitarian, and verbose solidity REPL. - -## Documentation - -https://book.getfoundry.sh/ - -## Usage - -### Build - -```shell -$ forge build -``` - -### Test - -```shell -$ forge test -``` - -### Format - -```shell -$ forge fmt -``` - -### Gas Snapshots - -```shell -$ forge snapshot -``` - -### Anvil - -```shell -$ anvil -``` - -### Deploy - -```shell -$ forge script script/Counter.s.sol:CounterScript --rpc-url --private-key -``` - -### Cast - -```shell -$ cast -``` - -### Help - -```shell -$ forge --help -$ anvil --help -$ cast --help -``` +If you are trying to run the tests are getting an error, try using `forge install OpenZeppelin/openzeppelin-contracts@v5.0.1` before running the tests. \ No newline at end of file