a1111198/foundry-fundMe

This Repo is a for a smart contract developed using Foundry and related to chainlink oracles.

Foundry Fund Me

• Foundry Fund Me
• Getting Started
  • Requirements
  • Quickstart
• Usage
  • Deploy
  • Testing
    • Test Coverage
• Deployment to a testnet or mainnet
  • Scripts
    • Withdraw
  • Estimate gas
• Formatting

Getting Started

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/a1111198/foundry-fundMe
cd foundry-fundMe
forge build

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

Deployment to a testnet or mainnet

1. Setup environment variables

You'll want to set your SEPOLIA_RPC_URL and MAINNET_RPC_URL as environment variables. You can add them to a .env file.

• Private key is maintained by Keystore tools so it is created using Cast wallet import and password is saved in bash varible. -key used for anvil name is defaultKey and for sepolia it is account1.

Optionally, add your ETHERSCAN_API_KEY if you want to verify your contract on Etherscan.

2. Get testnet ETH

Head over to 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 <FUNDME_CONTRACT_ADDRESS> "fund()" --value 0.1ether --private-key <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 <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