https://github.com/gacwr/unlockd-protocol-immunefi
https://github.com/gacwr/unlockd-protocol-immunefi
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/gacwr/unlockd-protocol-immunefi
- Owner: GACWR
- License: other
- Created: 2023-01-17T21:49:23.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-11T22:39:11.000Z (over 3 years ago)
- Last Synced: 2025-03-05T07:46:53.284Z (over 1 year ago)
- Size: 11.5 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://discord.gg/unlockd)
Unlockd is a decentralized non-custodial NFT lending protocol where users can participate as depositors or borrowers. Depositors provide liquidity to the market to earn a passive income, while borrowers are able to borrow in an overcollateralized fashion, using NFTs as collaterl.
This repository contains the smart contracts source code and markets configuration for Unlockd Protocol. The repository uses Hardhat as development enviroment for compilation, testing and deployment tasks.
> **🙇♂️ Thanks**
> Unlockd protocol refers to the architecture design and adopts some of the code of [AAVE](https://github.com/aave).
> We are very grateful to AAVE for providing us with an excellent DeFi platform.
You can join at the [Discord](https://discord.gg/unlockd) channel or at the [Governance](https://snapshot.org/#/unlockddao.eth) for asking questions about the protocol or talk about Unlockd with other peers.
# 🗂️ Index
- [Documentation](#-documentation)
- [Setup](#-setup)
- [Test](#-test)
- [Tasks](#-tasks)
- [Deployments](#-deployments)
# 📝 Documentation
The documentation of Unlockd Protocol is in the following [Unlockd documentation](https://github.com/UnlockdFinance/unlockd-protocol-immunefi/tree/main/docs) link. At the documentation you can learn more about the protocol, see the contract interfaces, integration guides and audits.
For getting the latest contracts addresses, please check the [Deployed contracts](https://github.com/UnlockdFinance/unlockd-protocol-immunefi/blob/main/docs/deployed-contracts/lendingpool-protocol.md) page at the documentation to stay up to date.
# 🎬 Setup
- Install
To run Unlockd, install its dependencies using yarn. You will need [yarn](https://classic.yarnpkg.com/en/docs/install/#mac-stable) installed in your system.
```bash
yarn install
```
- Create an enviroment file named `.env` and fill the next enviroment variables
```bash
# Private key. Add it if you just want to interact with Hardhat with a single address.
PRIVATE_KEY=""
# Mnemonic. Used by Hardhat if PRIVATE_KEY is not set. Also used in `./unlockd-tasks`.
MNEMONIC=""
# Used in `./unlockd-tasks` to simulate a user different than the owner.
PRIVATE_KEY_USER=""
# Alchemy/Infura RPC endpoint URL.
RPC_ENDPOINT=""
# Optional Etherscan key, for automatize the verification of the contracts at Etherscan
ETHERSCAN_KEY=""
ETHERSCAN_NETWORK="" # network in use
# Optional, add it if you want to run tasks in a forked network environment
FORK=""
# Optional, add it if you want to specify block number running tasks in a forked network
FORK_BLOCK_NUMBER=""
```
# 🧪 Test
You can run the full test suite with the following commands. All of them are explained in detail in the [tasks section](#tasks):
```bash
yarn test
yarn test:localhost
yarn test:file
```
## Markets configuration
The configurations related with the Unlockd Markets are located at `markets` directory. You can follow the `IUnlockdConfiguration` interface to create new Markets configuration or extend the current Unlockd configuration.
Each market should have his own Market configuration file, and their own set of deployment tasks, using the Unlockd market config and tasks as a reference.
# ✅ Tasks
## General tasks
You can run the general tasks defined in the `package.json` file by using yarn and specifying the task you want to run. For example, we can run the `compile` task with the following command:
``` bash
yarn compile
```
Show general tasks
| Task | Description |
| ------------- | ------------- |
| run-env | Installs dependencies without verbose logging |
| hardhat | Executes hardhat command |
| hardhat:node | Starts a Hardhat Network node |
| hardhat:localhost | Executes hardhat command, setting network to `localhost` |
| hardhat:goerli | Executes hardhat command, setting network to `goerli` |
| hardhat:main | Executes hardhat command, setting network to `main` |
| size | Logs size of current contracts |
| compile | Compiles the contracts |
| test | Runs all tests in `./test/`, setting network to `Hardhat` network |
| test:localhost | Runs all tests in `./test/`, setting network to `localhost` network |
| test:file | Allows to test for a specific file. The file can be specified in the command line setting it to be equal to `TEST_FILE` var |
| dev:update-abis | Fetches abis from latest contracts data in `./artifacts` and sets them to `./abis` folder |
| prettier:abis | Standarizes the abis code style in `./abis` folder |
| prettier:check | Checks the code style in the project |
| prettier:write | Standarizes the code style in the project |
| ci:clean | Runs a hardhat clean and removes all temporal and autogenerated files and folders |
| unlockd:hardhat:dev:migration | Deploys the Unlockd protocol development environment in the hardhat network |
| unlockd:localhost:dev:migration | Deploys the Unlockd protocol development environment in localhost |
| unlockd:goerli:mock:migration | Deploys mock environment in Goerli testnet |
| unlockd:localhost:full:migration | Deploys the full Unlockd protocol in localhost |
| unlockd:goerli:full:migration | Deploys the full Unlockd protocol in Goerli testnet |
| unlockd:fork:full:migration | Deploys the full Unlockd protocol in the forked network of choice, set at the environment variables |
| unlockd:main:full:migration | Deploys the full Unlockd protocol in Ethereum mainnet |
| goerli:verify | Verifies in Etherscan all contracts deployed in Goerli |
| goerli:verify:reserves | Verifies in Etherscan all reserves contracts deployed in Goerli testnet |
| goerli:print-contracts | Prints all current deployed contracts in Goerli testnet |
| goerli:print-config | Prints all addresses and configuration set in Goerli deployed contracts |
| main:verify | Verifies in Etherscan all reserves contracts deployed in Ethereum mainnet |
| main:verify:reserves | Verifies in Etherscan all reserves contracts deployed in Ethereum mainnet |
| main:print-contracts | Prints all current deployed contracts in Ethereum mainnet |
| main:print-config | Prints all addresses and configuration set in Ethereum mainnet deployed contracts
## Unlockd tasks
Unlockd tasks are a specific set of tasks that allow direct interaction with the currently deployed contracts. They require a set of params to be passed as flags in the command, which will be translated to be the params passed to the function to be executed. All params are explained in the definition of each task. These set of tasks can be run in terminal by using Hardhat commands. Network specification is fetched from the RPC_ENDPOINT environment variable. As an example, we'll try to run a 1 WETH deposit into the LendPool. The `deposit` task takes three params (`amount`, `reservename`, and `to`), and the task name is `lendpool:deposit`, so the command to run will be:
```bash
npx hardhat lendpool:deposit --amount 100000000000000000 --reservename WETH --to 0x1a470e9916f3dFF8E268A69A39fa2E9F7B954927
```
Show Unlockd tasks
| Task | Description |
| ------------- | ------------- |
| lendpool:deposit | Deposits an amount in the LendPool |
| lendpool:withdraw | Withdraws an amount from the LendPool |
| configurator:configureNftAsCollateral | Sets the configuration parameters to the specified NFT |
| lendpool:borrow | Borrows an amount of a specific reserve from unlockd, depositing an NFT as collateral |
| lendpool:getdebtdata | Returns de debt data for a given loan |
| lendpool:getauctiondata | Returns de auction data for a given loan that is in auction state |
| lendpool:repay | Repays a specified amount from a previous borrow to the LendPool |
| lendpool:redeem | Redeems a specific amount from an auctioned NFT and pays a bid fine |
| lendpool:auction | Places a bid for an unhealthy position in the protocol |
| lendpool:liquidate | Liquidates an unhealthy position, transferring the NFT to the liquidator |
| lendpool:liquidateNFTX | Liquidates an unhealthy position in NFTX market |
# 🚀 Deployments
For deploying Unlockd Protocol, you can use the available scripts located at `package.json`. For a complete list, run `npm run` to see all the tasks.
### Prepare
```bash
# install dependencies
yarn install
```
### Localhost dev deployment
```bash
# In first terminal
npm run hardhat:node
# In second terminal
npm run unlockd:localhost:dev:migration
```
### Localhost full deployment
```bash
# In first terminal
npm run hardhat:node
# In second terminal
npx hardhat --network localhost "dev:deploy-mock-reserves"
# then update pool config reserve address
npx hardhat --network localhost "dev:deploy-mock-nfts"
# then update pool config nft address
npx hardhat --network localhost "dev:deploy-mock-aggregators" --pool Unlockd
# then update pool config reserve aggregators address
npx hardhat --network localhost "dev:deploy-mock-unft-registry" --pool Unlockd
# then update pool config unft registry address
npx hardhat --network localhost "dev:deploy-mock-unft-tokens" --pool Unlockd
```
### Goerli mock deployment (a full deployment may not run because of ERC20 and ERC721 Reserves)
```bash
# In one terminal
npm run unlockd:goerli:mock:migration
```
## Interact with Unlockd in Mainnet via console
You can interact with Unlockd at Mainnet network using the Hardhat console, in the scenario where the frontend is down or you want to interact directly. You can check the deployed addresses at [deployed-contracts](https://docs.unlockddao.xyz/developers/deployed-contracts).
Run the Hardhat console pointing to the Mainnet network:
```bash
npx hardhat --network main console
```
At the Hardhat console, you can interact with the protocol:
```javascript
// Load the HRE into helpers to access signers
run("set-DRE");
// Import getters to instance any Unlockd contract
const contractGetters = require("./helpers/contracts-getters");
// Load the first signer
const signer = await contractGetters.getFirstSigner();
// Lend pool instance
const lendPool = await contractGetters.getLendPool("");
// ERC20 token WETH Mainnet instance
const WETH = await contractGetters.getIErc20Detailed("");
// Approve 10 WETH to LendPool address
await WETH.connect(signer).approve(lendPool.address, ethers.utils.parseUnits("10"));
// Deposit 10 WETH
await lendPool.connect(signer).deposit(DAI.address, ethers.utils.parseUnits("10"), await signer.getAddress(), "0");
```