Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/n-bhasin/foundry
https://github.com/n-bhasin/foundry
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/n-bhasin/foundry
- Owner: n-bhasin
- Created: 2024-09-12T01:33:43.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-16T19:12:02.000Z (3 months ago)
- Last Synced: 2024-09-17T22:21:56.851Z (3 months ago)
- Language: Solidity
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Getting Started
## Requirements
- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
- You'll know you did it right if you can run `git --version` and you see a response like `git version x.x.x`
- [foundry](https://getfoundry.sh/)
- You'll know you did it right if you can run `forge --version` and you see a response like `forge 0.2.0 (816e00b 2023-03-16T00:05:26.396218Z)`
## Quickstart
```
git clone https://github.com/n-bhasin/foundry
cd foundry
make
```
# Usage
## Deploy
```
forge script script/DeployFundMe.s.sol
```
## Testing
1. Unit
2. Integration
This repo we cover #1 and #3.
```
forge test
```
or
```
// Only run test functions matching the specified regex pattern.
forge test --match-test testFunctionName
```
or
```
forge test --fork-url $SEPOLIA_RPC_URL
```
### Test Coverage
```
forge coverage
This will deploy a mock price feed and a fund me contract to the zkSync node.
# Deployment to a testnet or mainnet
1. Setup environment variables
You'll want to set your `SEPOLIA_RPC_URL` and `PRIVATE_KEY` as environment variables. You can add them to a `.env` file, similar to what you see in `.env.example`.
- `PRIVATE_KEY`: The private key of your account (like from [metamask](https://metamask.io/)). **NOTE:** FOR DEVELOPMENT, PLEASE USE A KEY THAT DOESN'T HAVE ANY REAL FUNDS ASSOCIATED WITH IT.
- You can [learn how to export it here](https://metamask.zendesk.com/hc/en-us/articles/360015289632-How-to-Export-an-Account-Private-Key).
- `SEPOLIA_RPC_URL`: This is url of the sepolia testnet node you're working with. You can get setup with one for free from [Alchemy](https://alchemy.com/?a=673c802981)
Optionally, add your `ETHERSCAN_API_KEY` if you want to verify your contract on [Etherscan](https://etherscan.io/).
2. Get testnet ETH
Head over to [faucets.chain.link](https://faucets.chain.link/) and get some testnet ETH. You should see the ETH show up in your metamask.
3. Deploy
```
forge script script/DeployFundMe.s.sol --rpc-url $SEPOLIA_RPC_URL --private-key $PRIVATE_KEY --broadcast --verify --etherscan-api-key $ETHERSCAN_API_KEY
## Scripts
After deploying to a testnet or local net, you can run the scripts.
Using cast deployed locally example:
```
cast send "fund()" --value 0.1ether --private-key
```
or
```
forge script script/Interactions.s.sol:FundFundMe --rpc-url sepolia --private-key $PRIVATE_KEY --broadcast
forge script script/Interactions.s.sol:WithdrawFundMe --rpc-url sepolia --private-key $PRIVATE_KEY --broadcast
```
### Withdraw
```
cast send "withdraw()" --private-key
```
## Estimate gas
You can estimate how much gas things cost by running:
```
forge snapshot
```
And you'll see an output file called `.gas-snapshot`
# Formatting
To run code formatting:
```
forge fmt
```
# Thank you!