Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Akagi201 committed Aug 14, 2024
1 parent 05a02cb commit a6267f7
Showing 1 changed file with 6 additions and 62 deletions.
68 changes: 6 additions & 62 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,10 @@
## Foundry
# Uniswap Lib

**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
## Features

Foundry consists of:
* Foundry project.
* Meet newest solidity version.

- **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.
## Refs

## 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
```
* <https://github.com/Uniswap/solidity-lib>

0 comments on commit a6267f7

Please sign in to comment.