-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
our first commit! But not my first commit for sure :)
- Loading branch information
1 parent
358bc5b
commit 98b81f3
Showing
19 changed files
with
795 additions
and
93 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 |
---|---|---|
@@ -0,0 +1,10 @@ | ||
FundMeTest:testAddsFunderToArrayOfFunders() (gas: 100097) | ||
FundMeTest:testFundFailsWithoutEnoughETH() (gas: 22996) | ||
FundMeTest:testFundUpdatesFundedDataStructure() (gas: 99892) | ||
FundMeTest:testMinimumDollarIsFive() (gas: 8423) | ||
FundMeTest:testOnlyOwnerCanWithdraw() (gas: 100033) | ||
FundMeTest:testOwnerIsMsgSender() (gas: 8520) | ||
FundMeTest:testPriceFeedVersionIsAccurate() (gas: 13608) | ||
FundMeTest:testWithdrawWithASingleFunder() (gas: 85176) | ||
FundMeTest:testWithdrawWithMultipleFunders() (gas: 488521) | ||
FundMeTest:testWithdrawWithMultipleFundersCheraper() (gas: 487672) |
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 |
---|---|---|
|
@@ -12,3 +12,6 @@ docs/ | |
|
||
# Dotenv file | ||
.env | ||
|
||
broadcast/ | ||
lib/ |
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,3 +1,9 @@ | ||
[submodule "lib/forge-std"] | ||
path = lib/forge-std | ||
url = https://github.com/foundry-rs/forge-std | ||
[submodule "lib/chainlink-brownie-contracts"] | ||
path = lib/chainlink-brownie-contracts | ||
url = https://github.com/smartcontractkit/chainlink-brownie-contracts | ||
[submodule "lib/foundry-devops"] | ||
path = lib/foundry-devops | ||
url = https://github.com/Cyfrin/foundry-devops |
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 |
---|---|---|
@@ -0,0 +1,64 @@ | ||
-include .env | ||
|
||
.PHONY: all test clean deploy fund help install snapshot format anvil zktest | ||
|
||
DEFAULT_ANVIL_KEY := 0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80 | ||
DEFAULT_ZKSYNC_LOCAL_KEY := 0x7726827caac94a7f9e1b160f7ea819f172f7b6f9d2a97f992c38edeab82d4110 | ||
|
||
all: clean remove install update build | ||
|
||
# Clean the repo | ||
clean :; forge clean | ||
|
||
# Remove modules | ||
remove :; rm -rf .gitmodules && rm -rf .git/modules/* && rm -rf lib && touch .gitmodules && git add . && git commit -m "modules" | ||
|
||
install :; forge install cyfrin/[email protected] --no-commit && forge install smartcontractkit/[email protected] --no-commit && forge install foundry-rs/[email protected] --no-commit | ||
|
||
# Update Dependencies | ||
update:; forge update | ||
|
||
build:; forge build | ||
|
||
zkbuild :; forge build --zksync | ||
|
||
test :; forge test | ||
|
||
zktest :; foundryup-zksync && forge test --zksync && foundryup | ||
|
||
snapshot :; forge snapshot | ||
|
||
format :; forge fmt | ||
|
||
anvil :; anvil -m 'test test test test test test test test test test test junk' --steps-tracing --block-time 1 | ||
|
||
zk-anvil :; npx zksync-cli dev start | ||
|
||
deploy: | ||
@forge script script/DeployFundMe.s.sol:DeployFundMe $(NETWORK_ARGS) | ||
|
||
NETWORK_ARGS := --rpc-url http://localhost:8545 --private-key $(DEFAULT_ANVIL_KEY) --broadcast | ||
|
||
ifeq ($(findstring --network sepolia,$(ARGS)),--network sepolia) | ||
NETWORK_ARGS := --rpc-url $(SEPOLIA_RPC_URL) --account $(ACCOUNT) --broadcast --verify --etherscan-api-key $(ETHERSCAN_API_KEY) -vvvv | ||
endif | ||
|
||
deploy-sepolia: | ||
@forge script script/DeployFundMe.s.sol:DeployFundMe $(NETWORK_ARGS) | ||
|
||
# As of writing, the Alchemy zkSync RPC URL is not working correctly | ||
deploy-zk: | ||
forge create src/FundMe.sol:FundMe --rpc-url http://127.0.0.1:8011 --private-key $(DEFAULT_ZKSYNC_LOCAL_KEY) --constructor-args $(shell forge create test/mock/MockV3Aggregator.sol:MockV3Aggregator --rpc-url http://127.0.0.1:8011 --private-key $(DEFAULT_ZKSYNC_LOCAL_KEY) --constructor-args 8 200000000000 --legacy --zksync | grep "Deployed to:" | awk '{print $$3}') --legacy --zksync | ||
|
||
deploy-zk-sepolia: | ||
forge create src/FundMe.sol:FundMe --rpc-url ${ZKSYNC_SEPOLIA_RPC_URL} --account default --constructor-args 0xfEefF7c3fB57d18C5C6Cdd71e45D2D0b4F9377bF --legacy --zksync | ||
|
||
|
||
# For deploying Interactions.s.sol:FundFundMe as well as for Interactions.s.sol:WithdrawFundMe we have to include a sender's address `--sender <ADDRESS>` | ||
SENDER_ADDRESS := <sender's address> | ||
|
||
fund: | ||
@forge script script/Interactions.s.sol:FundFundMe --sender $(SENDER_ADDRESS) $(NETWORK_ARGS) | ||
|
||
withdraw: | ||
@forge script script/Interactions.s.sol:WithdrawFundMe --sender $(SENDER_ADDRESS) $(NETWORK_ARGS) |
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,246 @@ | ||
## Foundry | ||
# Foundry Fund Me | ||
|
||
**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.** | ||
This is a section of the Cyfrin Solidity Course. | ||
|
||
Foundry consists of: | ||
*[⭐️ Updraft | Foundry Fund Me](https://updraft.cyfrin.io/courses/foundry/foundry-fund-me/fund-me-project-setup)* | ||
|
||
- **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. | ||
- [Foundry Fund Me](#foundry-fund-me) | ||
- [Getting Started](#getting-started) | ||
- [Requirements](#requirements) | ||
- [Quickstart](#quickstart) | ||
- [Optional Gitpod](#optional-gitpod) | ||
- [Usage](#usage) | ||
- [Deploy](#deploy) | ||
- [Testing](#testing) | ||
- [Test Coverage](#test-coverage) | ||
- [Local zkSync](#local-zksync) | ||
- [(Additional) Requirements](#additional-requirements) | ||
- [Setup local zkSync node](#setup-local-zksync-node) | ||
- [Deploy to local zkSync node](#deploy-to-local-zksync-node) | ||
- [Deployment to a testnet or mainnet](#deployment-to-a-testnet-or-mainnet) | ||
- [Scripts](#scripts) | ||
- [Withdraw](#withdraw) | ||
- [Estimate gas](#estimate-gas) | ||
- [Formatting](#formatting) | ||
- [Additional Info:](#additional-info) | ||
- [Let's talk about what "Official" means](#lets-talk-about-what-official-means) | ||
- [Summary](#summary) | ||
- [Thank you!](#thank-you) | ||
|
||
## Documentation | ||
|
||
https://book.getfoundry.sh/ | ||
# Getting Started | ||
|
||
## Usage | ||
## Requirements | ||
|
||
### Build | ||
- [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)` | ||
|
||
```shell | ||
$ forge build | ||
|
||
## Quickstart | ||
|
||
``` | ||
git clone https://github.com/Cyfrin/foundry-fund-me-cu | ||
cd foundry-fund-me-cu | ||
make | ||
``` | ||
|
||
### Optional Gitpod | ||
|
||
If you can't or don't want to run and install locally, you can work with this repo in Gitpod. If you do this, you can skip the `clone this repo` part. | ||
|
||
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#github.com/PatrickAlphaC/foundry-fund-me-cu) | ||
|
||
# Usage | ||
|
||
## Deploy | ||
|
||
``` | ||
forge script script/DeployFundMe.s.sol | ||
``` | ||
|
||
## Testing | ||
|
||
We talk about 4 test tiers in the video. | ||
|
||
1. Unit | ||
2. Integration | ||
3. Forked | ||
4. Staging | ||
|
||
This repo we cover #1 and #3. | ||
|
||
|
||
``` | ||
forge test | ||
``` | ||
|
||
or | ||
|
||
``` | ||
// Only run test functions matching the specified regex pattern. | ||
"forge test -m testFunctionName" is deprecated. Please use | ||
forge test --match-test testFunctionName | ||
``` | ||
|
||
or | ||
|
||
``` | ||
forge test --fork-url $SEPOLIA_RPC_URL | ||
``` | ||
|
||
### Test Coverage | ||
|
||
``` | ||
forge coverage | ||
``` | ||
|
||
## Local zkSync | ||
|
||
The instructions here will allow you to work with this repo on zkSync. | ||
|
||
### (Additional) Requirements | ||
|
||
In addition to the requirements above, you'll need: | ||
- [foundry-zksync](https://github.com/matter-labs/foundry-zksync) | ||
- You'll know you did it right if you can run `forge --version` and you see a response like `forge 0.0.2 (816e00b 2023-03-16T00:05:26.396218Z)`. | ||
- [npx & npm](https://docs.npmjs.com/cli/v10/commands/npm-install) | ||
- You'll know you did it right if you can run `npm --version` and you see a response like `7.24.0` and `npx --version` and you see a response like `8.1.0`. | ||
- [docker](https://docs.docker.com/engine/install/) | ||
- You'll know you did it right if you can run `docker --version` and you see a response like `Docker version 20.10.7, build f0df350`. | ||
- Then, you'll want the daemon running, you'll know it's running if you can run `docker --info` and in the output you'll see something like the following to know it's running: | ||
```bash | ||
Client: | ||
Context: default | ||
Debug Mode: false | ||
``` | ||
|
||
### Setup local zkSync node | ||
|
||
Run the following: | ||
|
||
```bash | ||
npx zksync-cli dev config | ||
``` | ||
|
||
### Test | ||
And select: `In memory node` and do not select any additional modules. | ||
|
||
Then run: | ||
```bash | ||
npx zksync-cli dev start | ||
``` | ||
|
||
```shell | ||
$ forge test | ||
And you'll get an output like: | ||
``` | ||
In memory node started v0.1.0-alpha.22: | ||
- zkSync Node (L2): | ||
- Chain ID: 260 | ||
- RPC URL: http://127.0.0.1:8011 | ||
- Rich accounts: https://era.zksync.io/docs/tools/testing/era-test-node.html#use-pre-configured-rich-wallets | ||
``` | ||
|
||
### Format | ||
### Deploy to local zkSync node | ||
|
||
```shell | ||
$ forge fmt | ||
```bash | ||
make deploy-zk | ||
``` | ||
|
||
### Gas Snapshots | ||
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) | ||
|
||
```shell | ||
$ forge snapshot | ||
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 | ||
``` | ||
|
||
### Anvil | ||
## Scripts | ||
|
||
```shell | ||
$ anvil | ||
After deploying to a testnet or local net, you can run the scripts. | ||
|
||
Using cast deployed locally example: | ||
|
||
``` | ||
cast send <FUNDME_CONTRACT_ADDRESS> "fund()" --value 0.1ether --private-key <PRIVATE_KEY> | ||
``` | ||
|
||
### Deploy | ||
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 | ||
``` | ||
|
||
```shell | ||
$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key> | ||
### Withdraw | ||
|
||
``` | ||
cast send <FUNDME_CONTRACT_ADDRESS> "withdraw()" --private-key <PRIVATE_KEY> | ||
``` | ||
|
||
### Cast | ||
## Estimate gas | ||
|
||
You can estimate how much gas things cost by running: | ||
|
||
```shell | ||
$ cast <subcommand> | ||
``` | ||
forge snapshot | ||
``` | ||
|
||
And you'll see an output file called `.gas-snapshot` | ||
|
||
### Help | ||
|
||
```shell | ||
$ forge --help | ||
$ anvil --help | ||
$ cast --help | ||
# Formatting | ||
|
||
|
||
To run code formatting: | ||
``` | ||
forge fmt | ||
``` | ||
|
||
# Additional Info: | ||
Some users were having a confusion that whether Chainlink-brownie-contracts is an official Chainlink repository or not. Here is the info. | ||
Chainlink-brownie-contracts is an official repo. The repository is owned and maintained by the chainlink team for this very purpose, and gets releases from the proper chainlink release process. You can see it's still the `smartcontractkit` org as well. | ||
|
||
https://github.com/smartcontractkit/chainlink-brownie-contracts | ||
|
||
## Let's talk about what "Official" means | ||
The "official" release process is that chainlink deploys it's packages to [npm](https://www.npmjs.com/package/@chainlink/contracts). So technically, even downloading directly from `smartcontractkit/chainlink` is wrong, because it could be using unreleased code. | ||
|
||
So, then you have two options: | ||
|
||
1. Download from NPM and have your codebase have dependencies foreign to foundry | ||
2. Download from the chainlink-brownie-contracts repo which already downloads from npm and then packages it nicely for you to use in foundry. | ||
## Summary | ||
1. That is an official repo maintained by the same org | ||
2. It downloads from the official release cycle `chainlink/contracts` use (npm) and packages it nicely for digestion from foundry. | ||
|
||
|
||
# Thank you! | ||
|
||
If you appreciated this, feel free to follow me or donate! | ||
|
||
ETH/Arbitrum/Optimism/Polygon/etc Address: 0x9680201d9c93d65a3603d2088d125e955c73BD65 | ||
|
||
[![Patrick Collins Twitter](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/PatrickAlphaC) | ||
[![Patrick Collins YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](https://www.youtube.com/channel/UCn-3f8tw_E1jZvhuHatROwA) | ||
[![Patrick Collins Linkedin](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/patrickalphac/) | ||
[![Patrick Collins Medium](https://img.shields.io/badge/Medium-000000?style=for-the-badge&logo=medium&logoColor=white)](https://patrickalphac.medium.com/) | ||
|
||
|
||
<!-- Testing krunchdata https://kdta.io/b6T40 --> |
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
Submodule chainlink-brownie-contracts
added at
6e324d
Submodule foundry-devops
added at
df9f90
Oops, something went wrong.