generated from PaulRBerg/foundry-template
-
Notifications
You must be signed in to change notification settings - Fork 3
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
1 parent
d17e8f8
commit 9848918
Showing
6 changed files
with
16 additions
and
217 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 |
---|---|---|
|
@@ -11,6 +11,7 @@ out | |
.pnp.* | ||
lcov.info | ||
yarn.lock | ||
.secret | ||
|
||
# broadcasts | ||
!broadcast | ||
|
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,187 +1,11 @@ | ||
# Foundry Template [![Open in Gitpod][gitpod-badge]][gitpod] [![Github Actions][gha-badge]][gha] [![Foundry][foundry-badge]][foundry] [![License: MIT][license-badge]][license] | ||
# ERC7399 Wrappers | ||
|
||
[gitpod]: https://gitpod.io/#https://github.com/alcueca/erc3156pp-wrappers | ||
[gitpod-badge]: https://img.shields.io/badge/Gitpod-Open%20in%20Gitpod-FFB45B?logo=gitpod | ||
[gha]: https://github.com/alcueca/erc3156pp-wrappers/actions | ||
[gha-badge]: https://github.com/alcueca/erc3156pp-wrappers/actions/workflows/ci.yml/badge.svg | ||
[foundry]: https://getfoundry.sh/ | ||
[foundry-badge]: https://img.shields.io/badge/Built%20with-Foundry-FFDB1C.svg | ||
[license]: https://opensource.org/licenses/MIT | ||
[license-badge]: https://img.shields.io/badge/License-MIT-blue.svg | ||
Wrappers to bridge popular flash loan providers into the proposed ERC7399 standard | ||
|
||
A Foundry-based template for developing Solidity smart contracts, with sensible defaults. | ||
# Addresses | ||
|
||
## What's Inside | ||
The wrappers have been deployed to the following chains: Arbitrum | ||
|
||
- [Forge](https://github.com/foundry-rs/foundry/blob/master/forge): compile, test, fuzz, format, and deploy smart | ||
contracts | ||
- [Forge Std](https://github.com/foundry-rs/forge-std): collection of helpful contracts and cheatcodes for testing | ||
- [PRBTest](https://github.com/PaulRBerg/prb-test): modern collection of testing assertions and logging utilities | ||
- [Prettier](https://github.com/prettier/prettier): code formatter for non-Solidity files | ||
- [Solhint Community](https://github.com/solhint-community/solhint-community): linter for Solidity code | ||
|
||
## Getting Started | ||
|
||
Click the [`Use this template`](https://github.com/PaulRBerg/foundry-template/generate) button at the top of the page to | ||
create a new repository with this repo as the initial state. | ||
|
||
Or, if you prefer to install the template manually: | ||
|
||
```sh | ||
$ mkdir my-project | ||
$ cd my-project | ||
$ forge init --template PaulRBerg/foundry-template | ||
$ pnpm install # install Solhint, Prettier, and other Node.js deps | ||
``` | ||
|
||
If this is your first time with Foundry, check out the | ||
[installation](https://github.com/foundry-rs/foundry#installation) instructions. | ||
|
||
## Features | ||
|
||
This template builds upon the frameworks and libraries mentioned above, so for details about their specific features, | ||
please consult their respective documentation. | ||
|
||
For example, if you're interested in exploring Foundry in more detail, you should look at the | ||
[Foundry Book](https://book.getfoundry.sh/). In particular, you may be interested in reading the | ||
[Writing Tests](https://book.getfoundry.sh/forge/writing-tests.html) tutorial. | ||
|
||
### Sensible Defaults | ||
|
||
This template comes with a set of sensible default configurations for you to use. These defaults can be found in the | ||
following files: | ||
|
||
```text | ||
├── .editorconfig | ||
├── .gitignore | ||
├── .prettierignore | ||
├── .prettierrc.yml | ||
├── .solhint.json | ||
├── foundry.toml | ||
└── remappings.txt | ||
``` | ||
|
||
### VSCode Integration | ||
|
||
This template is IDE agnostic, but for the best user experience, you may want to use it in VSCode alongside Nomic | ||
Foundation's [Solidity extension](https://marketplace.visualstudio.com/items?itemName=NomicFoundation.hardhat-solidity). | ||
|
||
For guidance on how to integrate a Foundry project in VSCode, please refer to this | ||
[guide](https://book.getfoundry.sh/config/vscode). | ||
|
||
### GitHub Actions | ||
|
||
This template comes with GitHub Actions pre-configured. Your contracts will be linted and tested on every push and pull | ||
request made to the `main` branch. | ||
|
||
You can edit the CI script in [.github/workflows/ci.yml](./.github/workflows/ci.yml). | ||
|
||
## Writing Tests | ||
|
||
To write a new test contract, you start by importing [PRBTest](https://github.com/PaulRBerg/prb-test) and inherit from | ||
it in your test contract. PRBTest comes with a pre-instantiated [cheatcodes](https://book.getfoundry.sh/cheatcodes/) | ||
environment accessible via the `vm` property. If you would like to view the logs in the terminal output you can add the | ||
`-vvv` flag and use [console.log](https://book.getfoundry.sh/faq?highlight=console.log#how-do-i-use-consolelog). | ||
|
||
This template comes with an example test contract [Foo.t.sol](./test/Foo.t.sol) | ||
|
||
## Usage | ||
|
||
This is a list of the most frequently needed commands. | ||
|
||
### Build | ||
|
||
Build the contracts: | ||
|
||
```sh | ||
$ forge build | ||
``` | ||
|
||
### Clean | ||
|
||
Delete the build artifacts and cache directories: | ||
|
||
```sh | ||
$ forge clean | ||
``` | ||
|
||
### Compile | ||
|
||
Compile the contracts: | ||
|
||
```sh | ||
$ forge build | ||
``` | ||
|
||
### Coverage | ||
|
||
Get a test coverage report: | ||
|
||
```sh | ||
$ forge coverage | ||
``` | ||
|
||
### Deploy | ||
|
||
Deploy to Anvil: | ||
|
||
```sh | ||
$ forge script script/Deploy.s.sol --broadcast --fork-url http://localhost:8545 | ||
``` | ||
|
||
For this script to work, you need to have a `MNEMONIC` environment variable set to a valid | ||
[BIP39 mnemonic](https://iancoleman.io/bip39/). | ||
|
||
For instructions on how to deploy to a testnet or mainnet, check out the | ||
[Solidity Scripting](https://book.getfoundry.sh/tutorials/solidity-scripting.html) tutorial. | ||
|
||
### Format | ||
|
||
Format the contracts: | ||
|
||
```sh | ||
$ forge fmt | ||
``` | ||
|
||
### Gas Usage | ||
|
||
Get a gas report: | ||
|
||
```sh | ||
$ forge test --gas-report | ||
``` | ||
|
||
### Lint | ||
|
||
Lint the contracts: | ||
|
||
```sh | ||
$ pnpm lint | ||
``` | ||
|
||
### Test | ||
|
||
Run the tests: | ||
|
||
```sh | ||
$ forge test | ||
``` | ||
|
||
## Notes | ||
|
||
1. Foundry uses [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to manage dependencies. For | ||
detailed instructions on working with dependencies, please refer to the | ||
[guide](https://book.getfoundry.sh/projects/dependencies.html) in the book | ||
2. You don't have to create a `.env` file, but filling in the environment variables may be useful when debugging and | ||
testing against a fork. | ||
|
||
## Related Efforts | ||
|
||
- [abigger87/femplate](https://github.com/abigger87/femplate) | ||
- [cleanunicorn/ethereum-smartcontract-template](https://github.com/cleanunicorn/ethereum-smartcontract-template) | ||
- [foundry-rs/forge-template](https://github.com/foundry-rs/forge-template) | ||
- [FrankieIsLost/forge-template](https://github.com/FrankieIsLost/forge-template) | ||
|
||
## License | ||
|
||
This project is licensed under MIT. | ||
- UniswapV3Wrapper: 0x23de8e0bB91A105bEFf9d40d8d75C1A9fE40f523 | ||
- BalancerWrapper: 0x3d4DF8596e5750A4F721c8764d585dcc8623d009 | ||
- AaveWrapper: 0x02C7632b84B3447845531541d0285D67E656e50c |
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
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
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
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