@venusprotocol/isolated-pools 1.0.0-dev.7 → 1.0.0-dev.9

package/contracts/Shortfall/IShortfall.sol

@@ -1,6 +1,11 @@
 // SPDX-License-Identifier: BSD-3-Clause
 pragma solidity 0.8.13;
 
+/**
+ * @title IShortfall
+ * @author Venus
+ * @notice Interface implemented by `Shortfall`.
+ */
 interface IShortfall {
     function convertibleBaseAsset() external returns (address);
 }

package/contracts/Shortfall/Shortfall.sol

@@ -17,6 +17,16 @@ import { PoolRegistryInterface } from "../Pool/PoolRegistryInterface.sol";
 import { ensureNonzeroAddress } from "../lib/validators.sol";
 import { EXP_SCALE } from "../lib/constants.sol";
 
+/**
+ * @title Shortfall
+ * @author Venus
+ * @notice Shortfall is an auction contract designed to auction off the `convertibleBaseAsset` accumulated in `RiskFund`. The `convertibleBaseAsset`
+ * is auctioned in exchange for users paying off the pool's bad debt. An auction can be started by anyone once a pool's bad debt has reached a minimum value.
+ * This value is set and can be changed by the authorized accounts. If the pool’s bad debt exceeds the risk fund plus a 10% incentive, then the auction winner
+ * is determined by who will pay off the largest percentage of the pool's bad debt. The auction winner then exchanges for the entire risk fund. Otherwise,
+ * if the risk fund covers the pool's bad debt plus the 10% incentive, then the auction winner is determined by who will take the smallest percentage of the
+ * risk fund in exchange for paying off all the pool's bad debt.
+ */
 contract Shortfall is Ownable2StepUpgradeable, AccessControlledV8, ReentrancyGuardUpgradeable, IShortfall {
     using SafeERC20Upgradeable for IERC20Upgradeable;
 

package/contracts/VToken.sol

@@ -15,8 +15,30 @@ import { IProtocolShareReserve } from "./RiskFund/IProtocolShareReserve.sol";
 import { ensureNonzeroAddress } from "./lib/validators.sol";
 
 /**
- * @title Venus VToken Contract
- * @author Venus Dev Team
+ * @title VToken
+ * @author Venus
+ * @notice Each asset that is supported by a pool is integrated through an instance of the `VToken` contract. As outlined in the protocol overview,
+ * each isolated pool creates its own `vToken` corresponding to an asset. Within a given pool, each included `vToken` is referred to as a market of
+ * the pool. The main actions a user regularly interacts with in a market are:
+
+- mint/redeem of vTokens;
+- transfer of vTokens;
+- borrow/repay a loan on an underlying asset;
+- liquidate a borrow or liquidate/heal an account.
+
+ * A user supplies the underlying asset to a pool by minting `vTokens`, where the corresponding `vToken` amount is determined by the `exchangeRate`.
+ * The `exchangeRate` will change over time, dependent on a number of factors, some of which accrue interest. Additionally, once users have minted
+ * `vToken` in a pool, they can borrow any asset in the isolated pool by using their `vToken` as collateral. In order to borrow an asset or use a `vToken`
+ * as collateral, the user must be entered into each corresponding market (else, the `vToken` will not be considered collateral for a borrow). Note that
+ * a user may borrow up to a portion of their collateral determined by the market’s collateral factor. However, if their borrowed amount exceeds an amount
+ * calculated using the market’s corresponding liquidation threshold, the borrow is eligible for liquidation. When a user repays a borrow, they must also
+ * pay off interest accrued on the borrow.
+ * 
+ * The Venus protocol includes unique mechanisms for healing an account and liquidating an account. These actions are performed in the `Comptroller`
+ * and consider all borrows and collateral for which a given account is entered within a market. These functions may only be called on an account with a
+ * total collateral amount that is no larger than a universal `minLiquidatableCollateral` value, which is used for all markets within a `Comptroller`.
+ * Both functions settle all of an account’s borrows, but `healAccount()` may add `badDebt` to a vToken. For more detail, see the description of
+ * `healAccount()` and `liquidateAccount()` in the `Comptroller` summary section below.
  */
 contract VToken is
     Ownable2StepUpgradeable,

package/contracts/VTokenInterfaces.sol

@@ -7,6 +7,11 @@ import { ResilientOracleInterface } from "@venusprotocol/oracle/contracts/interf
 import { ComptrollerInterface } from "./ComptrollerInterface.sol";
 import { InterestRateModel } from "./InterestRateModel.sol";
 
+/**
+ * @title VTokenStorage
+ * @author Venus
+ * @notice Storage layout used by the `VToken` contract
+ */
 // solhint-disable-next-line max-states-count
 contract VTokenStorage {
     /**
@@ -130,6 +135,11 @@ contract VTokenStorage {
     uint256[50] private __gap;
 }
 
+/**
+ * @title VTokenInterface
+ * @author Venus
+ * @notice Interface implemented by the `VToken` contract
+ */
 abstract contract VTokenInterface is VTokenStorage {
     struct RiskManagementInit {
         address shortfall;

package/contracts/lib/imports.sol

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: BSD-3-Clause
+pragma solidity 0.8.13;
+
+// This file is needed to make hardhat and typechain generate artifacts for
+// contracts we depend on (e.g. in tests or deployments) but not use directly.
+// Another way to do this would be to use hardhat-dependency-compiler, but
+// since we only have a couple of dependencies, installing a separate package
+// seems an overhead.
+
+import { UpgradeableBeacon } from "@openzeppelin/contracts/proxy/beacon/UpgradeableBeacon.sol";
+import { BeaconProxy } from "@openzeppelin/contracts/proxy/beacon/BeaconProxy.sol";

package/dist/deploy/006-deploy-factories.js

@@ -1,12 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const hardhat_1 = require("hardhat");
-const ADDRESS_ONE = "0x0000000000000000000000000000000000000001";
-const treasuryAddresses = {
-    hardhat: "0x70997970C51812dc3A010C7d01b50e0d17dc79C8",
-    bsctestnet: "0xFEA1c651A47FE29dB9b1bf3cC1f224d8D9CFF68C",
-    bscmainnet: "0xF322942f644A996A617BD29c16bd7d231d9F35E9", // Venus Treasury
-};
 const acmAddresses = {
     bsctestnet: "0x45f8a08F534f34A97187626E05d4b6648Eeaa9AA",
     bscmainnet: "0x4788629ABc6cFCA10F9f969efdEAa1cF70c23555",
@@ -23,24 +17,6 @@ const func = async function (hre) {
     else {
         accessControlManager = await hardhat_1.ethers.getContract("AccessControlManager");
     }
-    const vBep20Factory = await deploy("VTokenProxyFactory", {
-        from: deployer,
-        args: [],
-        log: true,
-        autoMine: true, // speed up deployment on local network (ganache, hardhat), no effect on live networks
-    });
-    const jumpRateModelFactory = await deploy("JumpRateModelFactory", {
-        from: deployer,
-        args: [],
-        log: true,
-        autoMine: true,
-    });
-    const whitePaperRateFactory = await deploy("WhitePaperInterestRateModelFactory", {
-        from: deployer,
-        args: [],
-        log: true,
-        autoMine: true,
-    });
     await deploy("PoolRegistry", {
         from: deployer,
         contract: "PoolRegistry",
@@ -49,14 +25,7 @@ const func = async function (hre) {
             proxyContract: "OpenZeppelinTransparentProxy",
             execute: {
                 methodName: "initialize",
-                args: [
-                    vBep20Factory.address,
-                    jumpRateModelFactory.address,
-                    whitePaperRateFactory.address,
-                    ADDRESS_ONE,
-                    treasuryAddresses[hre.network.name],
-                    accessControlManager.address,
-                ],
+                args: [accessControlManager.address],
             },
             upgradeIndex: 0,
         },

package/dist/deploy/007-access-control-configure.js

@@ -10,7 +10,6 @@ const func = async function (hre) {
     const { deploy } = deployments;
     const { deployer } = await getNamedAccounts();
     const poolRegistry = await hardhat_1.ethers.getContract("PoolRegistry");
-    const vBep20Factory = await hardhat_1.ethers.getContract("VTokenProxyFactory");
     let accessControlManager;
     if (hre.network.live) {
         const networkName = hre.network.name === "bscmainnet" ? "bscmainnet" : "bsctestnet";
@@ -51,15 +50,12 @@ const func = async function (hre) {
     tx = await accessControlManager.giveCallPermission(hardhat_1.ethers.constants.AddressZero, "supportMarket(address)", poolRegistry.address);
     await tx.wait();
     console.log("DEFAULT_ADMIN | PoolRegistry       | supportMarket(address)");
-    tx = await accessControlManager.giveCallPermission(hardhat_1.ethers.constants.AddressZero, "setInterestRateModel(address)", vBep20Factory.address);
-    await tx.wait();
-    console.log("DEFAULT_ADMIN | VTokenProxyFactory | setInterestRateModel(address)");
     tx = await accessControlManager.giveCallPermission(hardhat_1.ethers.constants.AddressZero, "swapPoolsAssets(address[],uint256[],address[][])", deployer);
     await tx.wait();
     console.log("DEFAULT_ADMIN | Deployer           | swapPoolsAssets(address[],uint256[])");
-    tx = await accessControlManager.giveCallPermission(poolRegistry.address, "createRegistryPool(string,address,uint256,uint256,uint256,address,uint256,address)", deployer);
+    tx = await accessControlManager.giveCallPermission(poolRegistry.address, "addPool(string,address,uint256,uint256,uint256)", deployer);
     await tx.wait();
-    console.log("PoolRegistry  | Deployer           | createRegistryPool(string,address,uint256,uint256,uint256,address,uint256,address)");
+    console.log("PoolRegistry  | Deployer           | addPool(string,address,uint256,uint256,uint256)");
     tx = await accessControlManager.giveCallPermission(poolRegistry.address, "addMarket(AddMarketInput)", deployer);
     await tx.wait();
     console.log("PoolRegistry  | Deployer           | addMarket(AddMarketInput)");

package/dist/deploy/009-deploy-pools.js

@@ -1,8 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const ethers_1 = require("ethers");
+const utils_1 = require("ethers/lib/utils");
 const hardhat_1 = require("hardhat");
 const deploymentConfig_1 = require("../helpers/deploymentConfig");
+const deploymentConfig_2 = require("../helpers/deploymentConfig");
+const ADDRESS_ONE = "0x0000000000000000000000000000000000000001";
 const treasuryAddresses = {
+    hardhat: "0x70997970C51812dc3A010C7d01b50e0d17dc79C8",
     bsctestnet: "0xFEA1c651A47FE29dB9b1bf3cC1f224d8D9CFF68C",
     bscmainnet: "0xF322942f644A996A617BD29c16bd7d231d9F35E9", // Venus Treasury
 };
@@ -10,6 +15,9 @@ const acmAddresses = {
     bsctestnet: "0x45f8a08F534f34A97187626E05d4b6648Eeaa9AA",
     bscmainnet: "0x4788629ABc6cFCA10F9f969efdEAa1cF70c23555",
 };
+const mantissaToBps = (num) => {
+    return ethers_1.BigNumber.from(num).div((0, utils_1.parseUnits)("1", 14)).toString();
+};
 const func = async function (hre) {
     const { deployments, getNamedAccounts } = hre;
     const { deploy } = deployments;
@@ -34,15 +42,15 @@ const func = async function (hre) {
         log: true,
         autoMine: true,
     });
-    const ComptrollerBeacon = await deploy("ComptrollerBeacon", {
-        contract: "Beacon",
+    const comptrollerBeacon = await deploy("ComptrollerBeacon", {
+        contract: "UpgradeableBeacon",
         from: deployer,
         args: [comptrollerImpl.address],
         log: true,
         autoMine: true,
     });
     // VToken Beacon
-    const vTokenImpl = await deploy("VtokenImpl", {
+    const vTokenImpl = await deploy("VTokenImpl", {
         contract: "VToken",
         from: deployer,
         args: [],
@@ -50,27 +58,41 @@ const func = async function (hre) {
         autoMine: true,
     });
     const vTokenBeacon = await deploy("VTokenBeacon", {
-        contract: "Beacon",
+        contract: "UpgradeableBeacon",
         from: deployer,
         args: [vTokenImpl.address],
         log: true,
         autoMine: true,
     });
     const { tokensConfig, poolConfig } = await (0, deploymentConfig_1.getConfig)(hre.network.name);
-    let pools = await poolRegistry.callStatic.getAllPools();
+    const pools = await poolRegistry.callStatic.getAllPools();
     for (let i = 0; i < poolConfig.length; i++) {
         const pool = poolConfig[i];
         let comptrollerProxy;
         if (i >= pools.length) {
+            // Deploying a proxy for Comptroller
+            console.log("Deploying a proxy for Comptroller");
+            const Comptroller = await hardhat_1.ethers.getContractFactory("Comptroller");
+            comptrollerProxy = await deploy(`Comptroller_${pool.name}`, {
+                from: deployer,
+                contract: "BeaconProxy",
+                args: [
+                    comptrollerBeacon.address,
+                    Comptroller.interface.encodeFunctionData("initialize", [maxLoopsLimit, accessControlManager.address]),
+                ],
+                log: true,
+                autoMine: true,
+            });
+            // Deploying a proxy for Comptroller
+            console.log("Setting price oracle for Comptroller");
+            const comptroller = await hardhat_1.ethers.getContractAt("Comptroller", comptrollerProxy.address);
+            tx = await comptroller.setPriceOracle(priceOracle.address);
+            await tx.wait();
             // Create pool
             console.log("Registering new pool with name " + pool.name);
-            tx = await poolRegistry.createRegistryPool(pool.name, ComptrollerBeacon.address, pool.closeFactor, pool.liquidationIncentive, pool.minLiquidatableCollateral, priceOracle.address, maxLoopsLimit, accessControlManager.address);
+            tx = await poolRegistry.addPool(pool.name, comptroller.address, pool.closeFactor, pool.liquidationIncentive, pool.minLiquidatableCollateral);
             await tx.wait();
             console.log("New Pool Registered");
-            pools = await poolRegistry.callStatic.getAllPools();
-            comptrollerProxy = await hardhat_1.ethers.getContractAt("Comptroller", pools[i].comptroller);
-            tx = await comptrollerProxy.acceptOwnership();
-            await tx.wait();
         }
         else {
             comptrollerProxy = await hardhat_1.ethers.getContractAt("Comptroller", pools[i].comptroller);
@@ -90,26 +112,65 @@ const func = async function (hre) {
                 tokenContract = await hardhat_1.ethers.getContractAt("@openzeppelin/contracts/token/ERC20/ERC20.sol:ERC20", token.tokenAddress);
                 // Make sure that deployer has at least `initialSupply` balance of the token
             }
+            let rateModelAddress;
+            if (rateModel === deploymentConfig_2.InterestRateModels.JumpRate.toString()) {
+                const [b, m, j, k] = [baseRatePerYear, multiplierPerYear, jumpMultiplierPerYear, kink_].map(mantissaToBps);
+                const rateModelName = `JumpRateModelV2_base${b}bps_slope${m}bps_jump${j}bps_kink${k}bps`;
+                console.log(`Deploying interest rate model ${rateModelName}`);
+                const result = await deploy(rateModelName, {
+                    from: deployer,
+                    contract: "JumpRateModelV2",
+                    args: [baseRatePerYear, multiplierPerYear, jumpMultiplierPerYear, kink_, accessControlManager.address],
+                    log: true,
+                    autoMine: true,
+                });
+                rateModelAddress = result.address;
+            }
+            else {
+                const [b, m] = [baseRatePerYear, multiplierPerYear].map(mantissaToBps);
+                const rateModelName = `WhitePaperInterestRateModel_base${b}bps_slope${m}bps`;
+                console.log(`Deploying interest rate model ${rateModelName}`);
+                const result = await deploy(rateModelName, {
+                    from: deployer,
+                    contract: "WhitePaperInterestRateModel",
+                    args: [baseRatePerYear, multiplierPerYear],
+                    log: true,
+                    autoMine: true,
+                });
+                rateModelAddress = result.address;
+            }
+            console.log(`Deploying VToken proxy for ${symbol}`);
+            const VToken = await hardhat_1.ethers.getContractFactory("VToken");
+            const underlyingDecimals = Number(await tokenContract.decimals());
+            const vTokenDecimals = 8;
+            const args = [
+                tokenContract.address,
+                comptrollerProxy.address,
+                rateModelAddress,
+                (0, utils_1.parseUnits)("1", underlyingDecimals + 18 - vTokenDecimals),
+                name,
+                symbol,
+                vTokenDecimals,
+                deployer,
+                accessControlManager.address,
+                [treasuryAddresses[hre.network.name], ADDRESS_ONE],
+                reserveFactor,
+            ];
+            const vToken = await deploy(`VToken_${name}`, {
+                from: deployer,
+                contract: "BeaconProxy",
+                args: [vTokenBeacon.address, VToken.interface.encodeFunctionData("initialize", args)],
+                log: true,
+                autoMine: true,
+            });
             console.log("Approving PoolRegistry for: " + initialSupply);
             tx = await tokenContract.approve(poolRegistry.address, initialSupply);
             await tx.wait(1);
             console.log("Adding market " + name + " to pool " + pool.name);
             tx = await poolRegistry.addMarket({
-                comptroller: comptrollerProxy.address,
-                asset: tokenContract.address,
-                decimals: 8,
-                name: name,
-                symbol: symbol,
-                rateModel: rateModel,
-                baseRatePerYear: baseRatePerYear,
-                multiplierPerYear: multiplierPerYear,
-                jumpMultiplierPerYear: jumpMultiplierPerYear,
-                kink_: kink_,
+                vToken: vToken.address,
                 collateralFactor: collateralFactor,
                 liquidationThreshold: liquidationThreshold,
-                reserveFactor: reserveFactor,
-                accessControlManager: accessControlManager.address,
-                beaconAddress: vTokenBeacon.address,
                 initialSupply: initialSupply,
                 vTokenReceiver: hre.network.name === "hardhat" ? deployer : treasuryAddresses[hre.network.name],
                 supplyCap: supplyCap,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@venusprotocol/isolated-pools",
-  "version": "1.0.0-dev.7",
+  "version": "1.0.0-dev.9",
   "description": "",
   "files": [
     "artifacts",

package/artifacts/@openzeppelin/contracts/access/AccessControl.sol/AccessControl.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/eb7e5feedaca37f948646aa7bfff0291.json"
-}

package/artifacts/@openzeppelin/contracts/access/AccessControl.sol/AccessControl.json

@@ -1,215 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "AccessControl",
-  "sourceName": "@openzeppelin/contracts/access/AccessControl.sol",
-  "abi": [
-    {
-      "anonymous": false,
-      "inputs": [
-        {
-          "indexed": true,
-          "internalType": "bytes32",
-          "name": "role",
-          "type": "bytes32"
-        },
-        {
-          "indexed": true,
-          "internalType": "bytes32",
-          "name": "previousAdminRole",
-          "type": "bytes32"
-        },
-        {
-          "indexed": true,
-          "internalType": "bytes32",
-          "name": "newAdminRole",
-          "type": "bytes32"
-        }
-      ],
-      "name": "RoleAdminChanged",
-      "type": "event"
-    },
-    {
-      "anonymous": false,
-      "inputs": [
-        {
-          "indexed": true,
-          "internalType": "bytes32",
-          "name": "role",
-          "type": "bytes32"
-        },
-        {
-          "indexed": true,
-          "internalType": "address",
-          "name": "account",
-          "type": "address"
-        },
-        {
-          "indexed": true,
-          "internalType": "address",
-          "name": "sender",
-          "type": "address"
-        }
-      ],
-      "name": "RoleGranted",
-      "type": "event"
-    },
-    {
-      "anonymous": false,
-      "inputs": [
-        {
-          "indexed": true,
-          "internalType": "bytes32",
-          "name": "role",
-          "type": "bytes32"
-        },
-        {
-          "indexed": true,
-          "internalType": "address",
-          "name": "account",
-          "type": "address"
-        },
-        {
-          "indexed": true,
-          "internalType": "address",
-          "name": "sender",
-          "type": "address"
-        }
-      ],
-      "name": "RoleRevoked",
-      "type": "event"
-    },
-    {
-      "inputs": [],
-      "name": "DEFAULT_ADMIN_ROLE",
-      "outputs": [
-        {
-          "internalType": "bytes32",
-          "name": "",
-          "type": "bytes32"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "bytes32",
-          "name": "role",
-          "type": "bytes32"
-        }
-      ],
-      "name": "getRoleAdmin",
-      "outputs": [
-        {
-          "internalType": "bytes32",
-          "name": "",
-          "type": "bytes32"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "bytes32",
-          "name": "role",
-          "type": "bytes32"
-        },
-        {
-          "internalType": "address",
-          "name": "account",
-          "type": "address"
-        }
-      ],
-      "name": "grantRole",
-      "outputs": [],
-      "stateMutability": "nonpayable",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "bytes32",
-          "name": "role",
-          "type": "bytes32"
-        },
-        {
-          "internalType": "address",
-          "name": "account",
-          "type": "address"
-        }
-      ],
-      "name": "hasRole",
-      "outputs": [
-        {
-          "internalType": "bool",
-          "name": "",
-          "type": "bool"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "bytes32",
-          "name": "role",
-          "type": "bytes32"
-        },
-        {
-          "internalType": "address",
-          "name": "account",
-          "type": "address"
-        }
-      ],
-      "name": "renounceRole",
-      "outputs": [],
-      "stateMutability": "nonpayable",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "bytes32",
-          "name": "role",
-          "type": "bytes32"
-        },
-        {
-          "internalType": "address",
-          "name": "account",
-          "type": "address"
-        }
-      ],
-      "name": "revokeRole",
-      "outputs": [],
-      "stateMutability": "nonpayable",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "bytes4",
-          "name": "interfaceId",
-          "type": "bytes4"
-        }
-      ],
-      "name": "supportsInterface",
-      "outputs": [
-        {
-          "internalType": "bool",
-          "name": "",
-          "type": "bool"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    }
-  ],
-  "bytecode": "0x",
-  "deployedBytecode": "0x",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/artifacts/@openzeppelin/contracts/access/IAccessControl.sol/IAccessControl.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/eb7e5feedaca37f948646aa7bfff0291.json"
-}