Foundry DeFi Stablecoin

This project is a decentralized, exogenous, anchored (pegged), crypto-collateralized stablecoin system built with Foundry. It is part of the Cyfrin Foundry Solidity Course.

Etherscan Links (Examples):

• DSCEngine
• Decentralized Stablecoin

About

This protocol aims to maintain a $1.00 peg through an algorithmic stability mechanism.

• Collateral Type: Exogenous (wETH and wBTC).
• Minting: Users can only mint the stablecoin by providing collateral (over-collateralized).
• Stability Mechanism: Algorithmic / Decentralized.
• Price Feed: Utilizes Chainlink Price Feeds to maintain the peg and calculate collateral values.

Table of Contents

• Getting Started
  • Requirements
  • Quickstart
• Updates
• Usage
  • Start a local node
  • Deploy
  • Testing
  • Test Coverage
• Deployment to a testnet or mainnet
• Scripts (Manual Interaction)
• Formatting
• Slither

Getting Started

Requirements

• Git: Installation Guide
• Foundry: Installation Guide
  • Run curl -L https://foundry.paradigm.xyz | bash followed by foundryup.

Quickstart

git clone git@github.com:Vavinan/DeFi-try.git
cd DeFi-try
forge install
forge build

Updates

• OpenZeppelin Versioning: The latest version of openzeppelin-contracts has changes in the ERC20Mock file. To ensure compatibility with the course logic, install version 4.8.3:

  forge install openzeppelin/openzeppelin-contracts@v4.8.3

Usage

Testing

Run the full test suite:

forge test

Run a specific test with high verbosity (useful for debugging traces):

forge test --match-test testName -vvv

Formatting

Ensure the code adheres to the Solidity style guide:

forge fmt

Gas Snapshots

Generate a gas usage report:

forge snapshot

Local Node

Start a local Ethereum node (Anvil):

anvil

Deployment

To run your deployment scripts (e.g., on a local or testnet environment):

forge script script/DeployDSC.s.sol --rpc-url <your_rpc_url> --private-key <your_private_key> --broadcast

Start a local node

make anvil
# OR
anvil

Deploy

Defaults to the local Anvil node. Ensure Anvil is running in a separate terminal.

forge script script/DeployDSC.s.sol --rpc-url http://127.0.0.1:8545 --private-key <ANVIL_PRIVATE_KEY> --broadcast

Testing

The project includes Unit tests and Fuzzing logic.

Run all tests:

forge test

Run a specific test (e.g., Liquidation Bonus):

forge test --match-test testLiquidatorReceivesBonusCollateral -vvv

Test Coverage

Check how much of your code is covered by tests:

forge coverage

For a detailed coverage report:

forge coverage --report debug

Deployment to a testnet or mainnet

1. Setup Environment Variables Create a .env file or export them in your terminal:

   • SEPOLIA_RPC_URL: Your Alchemy/Infura URL.
   • PRIVATE_KEY: Your wallet private key (Use a burner wallet for safety!).
   • ETHERSCAN_API_KEY: (Optional) For contract verification.

2. Deploy to Sepolia

   forge script script/DeployDSC.s.sol --rpc-url $SEPOLIA_RPC_URL --private-key $PRIVATE_KEY --broadcast --verify

Gas Estimation

Generate a gas usage snapshot:

forge snapshot

This creates a .gas-snapshot file containing the gas cost for every function.

Formatting

To keep the codebase clean and compliant with the Solidity style guide:

forge fmt

Thank you!