FundMe is a minimal crowdfunding platform written in Solidity and targeting the Ethereum EVM.
- git
- You'll know you did it right if you can run
git --version
and you see a response likegit version 2.34.1
.
- You'll know you did it right if you can run
- foundry
- You'll know you did it right if you can run
forge --version
and you see a response likeforge 0.2.0 (6fcbbd8 2023-12-15T00:23:04.369635679Z
.
- You'll know you did it right if you can run
git clone https://github.com/oxcabe/foundry-fund-me.git
cd foundry-fund-me
forge build
forge script script/DeployFundMe.s.sol
Run tests:
forge test
Run specific tests that match some RegEx by running:
forge test --mt <regexForMatchingTests>
Run tests in Sepolia with:
forge test --fork-url <SEPOLIA_RPC_URL>
forge coverage
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). 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.
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
Optionally, add your ETHERSCAN_API_KEY
if you want to verify your contract on Etherscan.
Head over to faucets.chain.link and get some testnet ETH. You should see the ETH show up in your metamask.
forge script script/DeployFundMe.s.sol --rpc-url $SEPOLIA_RPC_URL --private-key $PRIVATE_KEY --broadcast --verify --etherscan-api-key $ETHERSCAN_API_KEY
After deploying to a testnet or local net, you can run the following scripts:
cast send <FUNDME_CONTRACT_ADDRESS> "fund()" --value 0.1ether --private-key <PRIVATE_KEY>
cast send <FUNDME_CONTRACT_ADDRESS> "withdraw()" --private-key <PRIVATE_KEY>
To run code formatting:
forge fmt
Big thanks to Cyfrin for providing free learning resources that allowed me to learn Foundry and Solidity development by doing this amazing project ❤️