Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
engn33r committed Feb 27, 2024
1 parent 6bdef3b commit fa397e3
Showing 1 changed file with 3 additions and 64 deletions.
67 changes: 3 additions & 64 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <your_rpc_url> --private-key <your_private_key>
```

### Cast

```shell
$ cast <subcommand>
```

### 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/[email protected]` before running the tests.

0 comments on commit fa397e3

Please sign in to comment.