Skip to content

Latest commit

 

History

History
87 lines (57 loc) · 2.49 KB

README.md

File metadata and controls

87 lines (57 loc) · 2.49 KB
Raw

FundMe smart contract

The FundMe smart contract enables users to deposit funds in Wei, with the requirement that the amount must exceed a specified MINIMUM_USD value in USD. This project leverages Chainlink Data Feeds to convert the deposited Wei into its equivalent USD value. Subsequently, the contract owner has the ability to withdraw these funds.

Requirements

Work with project

  1. Clone git repo and build project
git clone https://github.com/AsyaMaior/foundry-fund-me-f23
cd foundry-fund-me-f23
forge build
  1. Install the dependencies
make install

This project relies on the following dependencies:

To utilize foundry-devops, you may need to install jq, a lightweight and flexible command-line JSON processor. You can install jq using sudo apt-get install jq (for Debian) or verify its installation by running jq --version. Additionally, ensure the ffi = true setting is enabled in the foundry.toml file for the tool to function correctly.

  1. To deploy and interact with the contract, create your .env file; an example is provided in the repository. Than utilize a Makefile .
# to deploy to a specific network
make deploy-anvil
make deploy-sepolia

# to interact with contract in a specific network
make fund-anvil
make fund-sepolia

make withdraw-anvil
make withdraw-anvil
  1. To run tests use the following command:
forge test

To run tests using a forked mainnet network, use the following command:

make fork-test_mainnet-eth
#or
make fork-test_mainnet-arb

To view the test coverage, utilize the following command:

forge coverage

test_coverage

  1. You can generate two types of reports: gas report and coverage report

To use the coverage report, you need to install the genhtml utilite. To install use pip install genhtml or verify its installation by running genhtml -version

Then, use the command:

make coverage-report

To create a gas report, use:

make gas-report

This project was created and finalized while completing a course on Cyfrin Updraft