https://github.com/alexisbalayre/foundry-template
Foundry Template
https://github.com/alexisbalayre/foundry-template
Last synced: 7 months ago
JSON representation
Foundry Template
- Host: GitHub
- URL: https://github.com/alexisbalayre/foundry-template
- Owner: AlexisBalayre
- Created: 2022-11-01T10:34:39.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-11-03T11:42:43.000Z (almost 3 years ago)
- Last Synced: 2025-01-23T09:35:38.532Z (9 months ago)
- Language: Solidity
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Foundry Template
##
## Requirements
Please install the following:
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- Know the running version : ```git --version```
- [Foundry](https://book.getfoundry.sh/getting-started/installation)
- Know the running version : ```forge --version```
- Download **foundryup** : ```curl -L https://foundry.paradigm.xyz | bash```
- Install the last version of **forge**, **cast** and **anvil** : ```foundryup```
## Quickstart
```shell
git clone https://github.com/AlexisBal/foundry-template
cd foundry-template
```
## Commands
- Run solidity compiler : ```forge build```
- Run tests : ```forge test```
- Run an anvil node : ```anvil```
- Run an anvil node and fork a network : ```anvil --fork-url ```
- Run tests with the anvil node : ```forge test --rpc-url http://127.0.0.1:8545```
- Run a test and debug it : ```forge test --debug ```
## Security
Run a Slither security test
```shell
pip3 install slither-analyzer
pip3 install solc-select
solc-select install
solc-select use
slither src/
```
## Resources
- [Foundry Official Documentation](https://book.getfoundry.sh/getting-started/first-steps)
- [Foundry template by Chainlink](https://github.com/smartcontractkit/foundry-starter-kit)