Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/smartcontractkit/defi-minimal

This repo is dedicated to making minimal repos of existing defi primatives.
https://github.com/smartcontractkit/defi-minimal

blockchain defi web3

Last synced: about 2 months ago
JSON representation

This repo is dedicated to making minimal repos of existing defi primatives.

Host: GitHub
URL: https://github.com/smartcontractkit/defi-minimal
Owner: smartcontractkit
License: mit
Created: 2022-03-18T22:29:43.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2022-10-18T22:32:58.000Z (almost 2 years ago)
Last Synced: 2024-06-12T08:55:13.281Z (3 months ago)
Topics: blockchain, defi, web3
Language: JavaScript
Homepage:
Size: 697 KB
Stars: 461
Watchers: 17
Forks: 104
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Defi Minimal

This repo is dedicated to making minimal repos of existing defi primatives. 

| :exclamation:  ** WARNING None of the contracts are audited!  |

|-----------------------------------------|

### Completed (but unreviewed) minimal contracts:

- `Lending.sol`: Based off [Aave](https://aave.com/)

- `Staking.sol`: Based off [Synthetix](https://synthetix.io/)

- `RewardToken.sol`: Based off [Synthetix](https://synthetix.io/)

- `Exchange.sol` , `Factory.sol` , `Token.sol` : Based off [Uniswap v1](https://docs.uniswap.org/protocol/V1/introduction). The used pricing formula is documented [here](./docs/uniswap-v1/)

- `DecentralizedStableCoin`: Based off DAI

- `CentralizedStableCoin`: Based off USDC

### Uncompleted:

- `Options.sol`: Based off nothing

### Not a minimal contract:

- `Swap.sol`: Based off [Uniswap](https://uniswap.org/) - shows how a smart contract can integrate with a Uniswap-like dex. 

# Table Of Contents

- [Defi Minimal](#defi-minimal)

    - [Completed (but unreviewed) minimal contracts:](#completed-but-unreviewed-minimal-contracts)

    - [Uncompleted:](#uncompleted)

    - [Not a minimal contract:](#not-a-minimal-contract)

- [Table Of Contents](#table-of-contents)

- [Getting Started](#getting-started)

  - [Requirements](#requirements)

  - [Quickstart](#quickstart)

- [Usage](#usage)

  - [Deploying Contracts](#deploying-contracts)

  - [Run a Local Network](#run-a-local-network)

  - [Using a Testnet or Live Network (like Mainnet or Polygon)](#using-a-testnet-or-live-network-like-mainnet-or-polygon)

    - [Rinkeby Ethereum Testnet Setup](#rinkeby-ethereum-testnet-setup)

- [Code Formating](#code-formating)

- [Slither Static Analysis](#slither-static-analysis)

- [Contributing](#contributing)

- [Thank You!](#thank-you)

- [Resources](#resources)

# Getting Started 

It's recommended that you've gone through the [hardhat getting started documentation](https://hardhat.org/getting-started/) before proceeding here. 

## Requirements

- [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-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`

- [Nodejs](https://nodejs.org/en/)

  - You'll know you've installed nodejs right if you can run:

    - `node --version`and get an ouput like: `vx.x.x`

- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/) instead of `npm`

  - You'll know you've installed yarn right if you can run:

    - `yarn --version` And get an output like: `x.x.x`

    - You might need to install it with npm

> If you're familiar with `npx` and `npm` instead of `yarn`, you can use `npx` for execution and `npm` for installing dependencies. 

## Quickstart

1. Clone and install dependencies

After installing all the requirements, run the following:

```bash

git clone https://github.com/smartcontractkit/defi-minimal/

cd defi-minimal

```

Then:

```

yarn

```

or

```

npm i

```

2. You can now do stuff!

```

yarn hardhat test

```

or

```

npx hardhat test

```

# Usage

If you run `yarn hardhat --help` you'll get an output of all the tasks you can run. 

## Deploying Contracts

```

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](#interacting-with-deployed-contracts).

## Run a Local Network

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. 

## Using a Testnet or Live Network (like Mainnet or Polygon)

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.](https://hardhat.org/config/)

To interact with a live or test network, you'll need:

1. An rpc URL 

2. A Private Key

3. ETH & LINK token (either testnet or real)

Let's look at an example of setting these up using the Rinkeby testnet. 

### Rinkeby Ethereum Testnet Setup

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](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html) 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 `.env` FILE. 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. 

1. Set your `RINKEBY_RPC_URL` [environment variable.](https://www.twilio.com/blog/2017/01/how-to-set-environment-variables.html)

You can get one for free from [Alchmey](https://www.alchemy.com/), [Infura](https://infura.io/), or [Moralis](https://moralis.io/speedy-nodes/). This is your connection to the blockchain. 

2. Set your `PRIVATE_KEY` environment variable. 

This is your private key from your wallet, ie [MetaMask](https://metamask.io/). 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](https://via.placeholder.com/15/f03c15/000000?text=+) **WARNING** ![WARNING](https://via.placeholder.com/15/f03c15/000000?text=+)

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 `MNEMONIC` instead of a `PRIVATE_KEY` environment variable by uncommenting the section in the `hardhat.config.js`, and commenting out the `PRIVATE_KEY` line. 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. 

3. Get some Rinkeby Testnet ETH and LINK 

Head over to the [Chainlink faucets](https://faucets.chain.link/) and get some ETH and LINK. Please follow [the chainlink documentation](https://docs.chain.link/docs/acquire-link/) if unfamiliar. 

# Code Formating

This will format both your javascript and solidity to look nicer. 

```

yarn format

```

# Slither Static Analysis

You'll need [python](https://www.python.org/downloads/) and [slither](https://github.com/crytic/slither) installed. 

```

yarn slither

```

# Contributing

Contributions are always welcome! Open a PR or an issue!

# Thank You!

# Resources

- [Chainlink Documentation](https://docs.chain.link/)

- [Hardhat Documentation](https://hardhat.org/getting-started/)

- [Solidity by Example](https://solidity-by-example.org/)