https://github.com/chaineasy/f-kit
Foundry Starter Kit
https://github.com/chaineasy/f-kit
Last synced: 3 months ago
JSON representation
Foundry Starter Kit
- Host: GitHub
- URL: https://github.com/chaineasy/f-kit
- Owner: ChainEasy
- License: mit
- Created: 2023-08-02T12:36:35.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-02T12:36:39.000Z (almost 2 years ago)
- Last Synced: 2025-01-09T03:45:31.186Z (5 months ago)
- Language: Solidity
- Size: 95.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
*Note: This repo has been recently updated for Sepolia*
# Foundry Starter Kit
[](https://gitpod.io/#https://github.com/smartcontractkit/foundry-starter-kit)
Foundry Starter Kit is a repo that shows developers how to quickly build, test, and deploy smart contracts with one of the fastest frameworks out there, [foundry](https://github.com/gakonst/foundry)!
- [Foundry Starter Kit](#foundry-starter-kit)
- [Getting Started](#getting-started)
- [Requirements](#requirements)
- [Quickstart](#quickstart)
- [Testing](#testing)
- [Deploying to a network](#deploying-to-a-network)
- [Setup](#setup)
- [Deploying](#deploying)
- [Working with a local network](#working-with-a-local-network)
- [Working with other chains](#working-with-other-chains)
- [Security](#security)
- [Contributing](#contributing)
- [Thank You!](#thank-you)
- [Resources](#resources)
- [TODO](#todo)
# Getting Started
## Requirements
Please install the following:
- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- You'll know you've done it right if you can run `git --version`
- [Foundry / Foundryup](https://github.com/gakonst/foundry)
- This will install `forge`, `cast`, and `anvil`
- You can test you've installed them right by running `forge --version` and get an output like: `forge 0.2.0 (f016135 2022-07-04T00:15:02.930499Z)`
- To get the latest of each, just run `foundryup`
And you probably already have `make` installed... but if not [try looking here.](https://askubuntu.com/questions/161104/how-do-i-install-make)
## Quickstart
```sh
git clone https://github.com/smartcontractkit/foundry-starter-kit
cd foundry-starter-kit
make # This installs the project's dependencies.
make test
```
## Testing
```
make test
```
or
```
forge test
```
# Deploying to a network
Deploying to a network uses the [foundry scripting system](https://book.getfoundry.sh/tutorials/solidity-scripting.html), where you write your deploy scripts in solidity!
## Setup
We'll demo using the Sepolia testnet. (Go here for [testnet sepolia ETH](https://faucets.chain.link/).)
You'll need to add the following variables to a `.env` file:
- `SEPOLIA_RPC_URL`: A URL to connect to the blockchain. You can get one for free from [Infura](https://www.infura.io/) account
- `PRIVATE_KEY`: A private key from your wallet. You can get a private key from a new [Metamask](https://metamask.io/) account
- Additionally, if you want to deploy to a testnet, you'll need test ETH and/or LINK. You can get them from [faucets.chain.link](https://faucets.chain.link/).
- Optional `ETHERSCAN_API_KEY`: If you want to verify on etherscan
## Deploying
```
make deploy-sepolia contract=
```
For example:
```
make deploy-sepolia contract=PriceFeedConsumer
```
This will run the forge script, the script it's running is:
```
@forge script script/${contract}.s.sol:Deploy${contract} --rpc-url ${SEPOLIA_RPC_URL} --private-key ${PRIVATE_KEY} --broadcast --verify --etherscan-api-key ${ETHERSCAN_API_KEY} -vvvv
```
If you don't have an `ETHERSCAN_API_KEY`, you can also just run:
```
@forge script script/${contract}.s.sol:Deploy${contract} --rpc-url ${SEPOLIA_RPC_URL} --private-key ${PRIVATE_KEY} --broadcast
```
These pull from the files in the `script` folder.
### Working with a local network
Foundry comes with local network [anvil](https://book.getfoundry.sh/anvil/index.html) baked in, and allows us to deploy to our local network for quick testing locally.
To start a local network run:
```
make anvil
```
This will spin up a local blockchain with a determined private key, so you can use the same private key each time.
Then, you can deploy to it with:
```
make deploy-anvil contract=
```
Similar to `deploy-sepolia`
### Working with other chains
To add a chain, you'd just need to make a new entry in the `Makefile`, and replace `` with whatever your chain's information is.
```
deploy- :; @forge script script/${contract}.s.sol:Deploy${contract} --rpc-url ${_RPC_URL} --private-key ${PRIVATE_KEY} --broadcast -vvvv
```
# Security
This framework comes with slither parameters, a popular security framework from [Trail of Bits](https://www.trailofbits.com/). To use slither, you'll first need to [install python](https://www.python.org/downloads/) and [install slither](https://github.com/crytic/slither#how-to-install).
Then, you can run:
```
make slither
```
And get your slither output.
# Contributing
Contributions are always welcome! Open a PR or an issue!
# Thank You!
## Resources
- [Chainlink Documentation](https://docs.chain.link/)
- [Foundry Documentation](https://book.getfoundry.sh/)
### TODO
[ ] Add bash scripts to interact with contracts using `cast`
[ ] Make deploying contracts to `anvil` simpler