This repo is dedicated to making minimal repos of existing defi primatives.
| ❗ ** WARNING None of the contracts are audited! |
|---|
Lending.sol: Based off AaveStaking.sol: Based off SynthetixRewardToken.sol: Based off SynthetixExchange.sol,Factory.sol,Token.sol: Based off Uniswap v1. The used pricing formula is documented hereDecentralizedStableCoin: Based off DAICentralizedStableCoin: Based off USDC
Options.sol: Based off nothing
Swap.sol: Based off Uniswap - shows how a smart contract can integrate with a Uniswap-like dex.
- Defi Minimal
- Table Of Contents
- Getting Started
- Usage
- Code Formating
- Slither Static Analysis
- Contributing
- Thank You!
- Resources
It's recommended that you've gone through the hardhat getting started documentation before proceeding here.
- git
- You'll know you did it right if you can run
git --versionand you see a response likegit version x.x.x
- You'll know you did it right if you can run
- Nodejs
- You'll know you've installed nodejs right if you can run:
node --versionand get an ouput like:vx.x.x
- You'll know you've installed nodejs right if you can run:
- Yarn instead of
npm- You'll know you've installed yarn right if you can run:
yarn --versionAnd get an output like:x.x.x- You might need to install it with npm
- You'll know you've installed yarn right if you can run:
If you're familiar with
npxandnpminstead ofyarn, you can usenpxfor execution andnpmfor installing dependencies.
- Clone and install dependencies
After installing all th 8000 e requirements, run the following:
git clone https://github.com/smartcontractkit/defi-minimal/
cd defi-minimalThen:
yarn
or
npm i
- You can now do stuff!
yarn hardhat test
or
npx hardhat test
If you run yarn hardhat --help you'll get an output of all the tasks you can run.
yarn hardhat deploy
This will deploy your contracts to a local network. Additionally, if on a local network, it will deploy mock Chainlink contracts for you to interact with. If you'd like to interact with your deployed contracts, skip down to Interacting with Deployed Contracts.
One of the best ways to test and interact with smart contracts is with a local network. To run a local network with all your contracts in it, run the following:
yarn hardhat node
You'll get a local blockchain, private keys, contracts deployed (from the deploy folder scripts), and an endpoint to potentially add to an EVM wallet.
In your hardhat.config.js you'll see section like:
module.exports = {
defaultNetwork: "hardhat",
networks: {
This section of the file is where you define which networks you want to interact with. You can read more about that whole file in the hardhat documentation.
To interact with a live or test network, you'll need:
- An rpc URL
- A Private Key
- ETH & LINK token (either testnet or real)
Let's look at an example of setting these up using the Rinkeby testnet.
First, we will need to set environment variables. We can do so by setting them in our .env file (create it if it's not there). You can also read more about environment variables from the linked twilio blog. You'll find a sample of what this file will look like in .env.example
IMPORTANT: MAKE SURE YOU'D DONT EXPOSE THE KEYS YOU PUT IN THIS
.envFILE. By that, I mean don't push them to a public repo, and please try to keep them keys you use in development not associated with any real funds.
- Set your
RINKEBY_RPC_URLenvironment variable.
You can get one for free from Alchmey, Infura, or Moralis. This is your connection to the blockchain.
- Set your
PRIVATE_KEYenvironment variable.
This is your private key from your wallet, ie MetaMask. This is needed for deploying contracts to public networks. You can optionally set your MNEMONIC environment variable instead with some changes to the hardhat.config.js.
WARNING
When developing, it's best practice to use a Metamask that isn't associated with any real money. A good way to do this is to make a new browser profile (on Chrome, Brave, Firefox, etc) and install Metamask on that brower, and never send this wallet money.
Don't commit and push any changes to .env files that may contain sensitive information, such as a private key! If this information reaches a public GitHub repository, someone can use it to check if you have any Mainnet funds in that wallet address, and steal them!
.env example:
RINKEBY_RPC_URL='www.infura.io/asdfadsfafdadf'
PRIVATE_KEY='abcdef'
bash example
export RINKEBY_RPC_URL='www.infura.io/asdfadsfafdadf'
export PRIVATE_KEY='abcdef'
You can also use a
MNEMONICinstead of aPRIVATE_KEYenvironment variable by uncommenting the section in thehardhat.config.js, and commenting out thePRIVATE_KEYline. However this is not recommended.
For other networks like mainnet and polygon, you can use different environment variables for your RPC URL and your private key. See the hardhat.config.js to learn more.
- Get some Rinkeby Testnet ETH and LINK
Head over to the Chainlink faucets and get some ETH and LINK. Please follow the chainlink documentation if unfamiliar.
This will format both your javascript and solidity to look nicer.
yarn format
You'll need python and slither installed.
yarn slither
Contributions are always welcome! Open a PR or an issue!