docs: add project readme
This commit is contained in:
1 parent
6372fec4f0
commit
0d00707902
1 file changed
+66
@@ -0,0 +1,66 @@
|
|||||||
|
## Foundry
|
||||||
|
|
||||||
|
**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
|
||||||
|
|
||||||
|
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
|
||||||
|
```
|
||||||
Reference in new issue
Block a user