This protocol enables users to mint a USD-pegged stablecoin by depositing collateral in the form of WETH and WBTC. The system maintains price stability through overcollateralization while providing users with a reliable medium of exchange backed by blue-chip crypto assets.
- Foundry DeFi Stablecoin
- About
- Getting Started
- Updates
- Usage
- Deployment to a testnet or mainnet
- Formatting
- Slither
- Additional Info:
- git
- To confirm successful installation, run
git --versionin your terminal. You should see a response displaying your installed Git version (for example:git version 2.39.2)
- To confirm successful installation, run
- foundry
- To verify successful installation, run
forge --versionin your terminal. You should see a response likeforge 0.2.0 (816e00b 2023-03-16T00:05:26.396218Z)indicating the installed version.`
- To verify successful installation, run
- The latest version of openzeppelin-contracts has changes in the ERC20Mock file. The specific version used in this project is you need to install version 4.8.3 which can be done by
forge install openzeppelin/openzeppelin-contracts@v4.8.3 --no-commitinstead offorge install openzeppelin/openzeppelin-contracts --no-commit
make anvil
This will default to your local node. You need to have it running in another terminal in order for it to deploy.
make deploy
We talk about 4 test tiers in the video.
- Unit
- Integration
- Forked
- Staging
In this repo I cover #1 and Fuzzing.
forge test
forge coverage
and for coverage based testing:
forge coverage --report debug
- 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.
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.
- Get testnet ETH
Head over to faucets.chain.link and get some testnet ETH. You should see the ETH show up in your metamask.
- Deploy
make deploy ARGS="--network sepolia"
Instead of scripts, you can directly use the cast command to interact with the contract.
For example, on Sepolia:
- Get some WETH
cast send 0xdd13E55209Fd76AfE204dBda4007C227904f0a81 "deposit()" --value 0.1ether --rpc-url $SEPOLIA_RPC_URL --private-key $PRIVATE_KEY
- Approve the WETH
cast send 0xdd13E55209Fd76AfE204dBda4007C227904f0a81 "approve(address,uint256)" 0x091EA0838eBD5b7ddA2F2A641B068d6D59639b98 1000000000000000000 --rpc-url $SEPOLIA_RPC_URL --private-key $PRIVATE_KEY
- Deposit and Mint DSC
cast send 0x091EA0838eBD5b7ddA2F2A641B068d6D59639b98 "depositCollateralAndMintDsc(address,uint256,uint256)" 0xdd13E55209Fd76AfE204dBda4007C227904f0a81 100000000000000000 10000000000000000 --rpc-url $SEPOLIA_RPC_URL --private-key $PRIVATE_KEY
You can estimate how much gas things cost by running:
forge snapshot
And you'll see an output file called .gas-snapshot
To run code formatting:
forge fmt
slither :; slither . --config-file slither.config.json
Some users were having a confusion that whether Chainlink-brownie-contracts is an official Chainlink repository or not. Here is the info.
Chainlink-brownie-contracts is an official repo. The repository is owned and maintained by the chainlink team for this very purpose, and gets releases from the proper chainlink release process. You can see it's still the smartcontractkit org as well.
https://github.com/smartcontractkit/chainlink-brownie-contracts
The "official" release process is that chainlink deploys it's packages to npm. So technically, even downloading directly from smartcontractkit/chainlink is wrong, because it could be using unreleased code.
So, then you have two options:
- Download from NPM and have your codebase have dependencies foreign to foundry
- Download from the chainlink-brownie-contracts repo which already downloads from npm and then packages it nicely for you to use in foundry.
- That is an official repo maintained by the same org
- It downloads from the official release cycle
chainlink/contractsuse (npm) and packages it nicely for digestion from foundry.