Skip to content

Developed "CrowdFunding" which enables decentralized crowdfunding campaigns with a minimum USD funding requirement, Foundry Framework (Solidity) is used to develop this by following professional practices. ChainLink and Alchemy have also referred.

Notifications You must be signed in to change notification settings

sonukumar7258/Foundry-CrowdFunding

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This is a CrowdFunding App using Foundry Framework (Solidity Smart Contracts)

Functionality is same as i have uploaded Crowdfunding smart contract, but this project follows professional practices and divided whole project into three things

  1. Src - contain smart contract solidity code
  2. Script - write scripts to deploy on different chains (Sepolia, Anvil, Ethereum Mainnet etc)
  3. Tests - developed tests to aviod any error or mislead before deployment

Requirements

  • 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
    • 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/Cyfrin/foundry-fund-me-f23
cd foundry-fund-me-f23
forge build

Usage

Deploy:

forge script scripts/DeployCrowdFunding.s.sol

Testing

I have tried to cover below tests in this repo, you can find the specific tests in the tests folder in the repo

  1. Unit
  2. Integration
  3. Forked
forge test

or

// Only run test functions matching the specified regex pattern.

"forge test --mt testFunctionName" is deprecated. Please use 

forge test --match-test testFunctionName

or

forge test --fork-url $SEPOLIA_RPC_URL

Test Coverage

forge coverage

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).
  • 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.

  1. Get testnet ETH

Head over to faucets.chain.link and get some testnet ETH. You should see the ETH show up in your metamask.

  1. Deploy
forge script script/DeployCrowdFunding.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 <FUNDME_CONTRACT_ADDRESS> "fund()" --value 0.1ether --private-key <PRIVATE_KEY>

or

forge script script/FundMe.s.sol --rpc-url sepolia  --private-key $PRIVATE_KEY  --broadcast

Withdraw

cast send <FUNDME_CONTRACT_ADDRESS> "withdraw()"  --private-key <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 so much Patrick Collins for such help, Really appreciated !

About

Developed "CrowdFunding" which enables decentralized crowdfunding campaigns with a minimum USD funding requirement, Foundry Framework (Solidity) is used to develop this by following professional practices. ChainLink and Alchemy have also referred.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published