-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
17 additions
and
105 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,66 +1,35 @@ | ||
## Foundry | ||
# <img src="logo.svg" alt="Uniswap Hooks" height="40px"> | ||
|
||
**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.** | ||
Solidity library for secure and modular Uniswap hooks. | ||
|
||
Foundry consists of: | ||
## Overview | ||
|
||
- **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. | ||
### Installation | ||
|
||
## Documentation | ||
#### Foundry | ||
|
||
https://book.getfoundry.sh/ | ||
> [!WARNING] | ||
> Foundry installs the latest version initially, but subsequent `forge update` commands will use the `master` branch. | ||
## Usage | ||
|
||
### Build | ||
|
||
```shell | ||
$ forge build | ||
``` | ||
|
||
### Test | ||
|
||
```shell | ||
$ forge test | ||
``` | ||
|
||
### Format | ||
|
||
```shell | ||
$ forge fmt | ||
$ forge install OpenZeppelin/uniswap-hooks | ||
``` | ||
|
||
### Gas Snapshots | ||
Add `@openzeppelin/uniswap-hooks/=lib/uniswap-hooks/src/` in `remappings.txt`. | ||
#### Hardhat | ||
|
||
```shell | ||
$ forge snapshot | ||
``` | ||
|
||
### Anvil | ||
|
||
```shell | ||
$ anvil | ||
$ npm install @openzeppelin/uniswap-hooks | ||
``` | ||
|
||
### Deploy | ||
## Contribute | ||
|
||
```shell | ||
$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key> | ||
``` | ||
There are many ways you can participate and help build high quality software. Check out the [contribution guide](CONTRIBUTING.md)! | ||
|
||
### Cast | ||
## License | ||
|
||
```shell | ||
$ cast <subcommand> | ||
``` | ||
OpenZeppelin Contracts is released under the [MIT License](LICENSE). | ||
|
||
### Help | ||
## Legal | ||
|
||
```shell | ||
$ forge --help | ||
$ anvil --help | ||
$ cast --help | ||
``` | ||
Your use of this Project is governed by the terms found at www.openzeppelin.com/tos (the "Terms"). |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.