Optimize storage for borrow

Author: lastperson

contracts/LiquidityPool.sol

@@ -4,7 +4,6 @@ pragma solidity 0.8.28;
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 import {BitMaps} from "@openzeppelin/contracts/utils/structs/BitMaps.sol";
 import {AccessControl} from "@openzeppelin/contracts/access/AccessControl.sol";
-import {Pausable} from "@openzeppelin/contracts/utils/Pausable.sol";
 import {ECDSA} from "@openzeppelin/contracts/utils/cryptography/ECDSA.sol";
 import {EIP712} from "@openzeppelin/contracts/utils/cryptography/EIP712.sol";
 import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
@@ -21,7 +20,7 @@ import {IBorrower} from "./interfaces/IBorrower.sol";
 /// Borrowing can be paused by the WITHDRAW_PROFIT_ROLE before withdrawing the profit.
 /// The contract is pausable by the PAUSER_ROLE.
 /// @author Tanya Bushenyova <[email protected]>
-contract LiquidityPool is ILiquidityPool, AccessControl, EIP712, Pausable {
+contract LiquidityPool is ILiquidityPool, AccessControl, EIP712 {
     using SafeERC20 for IERC20;
     using ECDSA for bytes32;
     using BitMaps for BitMaps.BitMap;
@@ -40,11 +39,12 @@ contract LiquidityPool is ILiquidityPool, AccessControl, EIP712, Pausable {
 
     IERC20 immutable public ASSETS;
 
-    bool public borrowPaused;
-    address public mpcAddress;
+    BitMaps.BitMap private _usedNonces;
     uint256 public totalDeposited;
 
-    BitMaps.BitMap private _usedNonces;
+    bool public paused;
+    bool public borrowPaused;
+    address public mpcAddress;
 
     bytes32 public constant LIQUIDITY_ADMIN_ROLE = "LIQUIDITY_ADMIN_ROLE";
     bytes32 public constant WITHDRAW_PROFIT_ROLE = "WITHDRAW_PROFIT_ROLE";
@@ -62,13 +62,27 @@ contract LiquidityPool is ILiquidityPool, AccessControl, EIP712, Pausable {
     error InvalidBorrowToken();
     error NotImplemented();
     error NoProfit();
+    error EnforcedPause();
+    error ExpectedPause();
 
     event Deposit(address from, uint256 amount);
     event Withdraw(address caller, address to, uint256 amount);
     event ProfitWithdrawn(address token, address to, uint256 amount);
     event BorrowPaused();
     event BorrowUnpaused();
     event MPCAddressSet(address oldMPCAddress, address newMPCAddress);
+    event Paused(address account);
+    event Unpaused(address account);
+
+    modifier whenNotPaused() {
+        require(!paused, EnforcedPause());
+        _;
+    }
+
+    modifier whenPaused() {
+        require(paused, ExpectedPause());
+        _;
+    }
 
     constructor(
         address liquidityToken,
@@ -181,15 +195,13 @@ contract LiquidityPool is ILiquidityPool, AccessControl, EIP712, Pausable {
     }
 
     function pause() external override onlyRole(PAUSER_ROLE) whenNotPaused() {
-        _pause();
+        paused = true;
+        emit Paused(msg.sender);
     }
 
     function unpause() external override onlyRole(PAUSER_ROLE) whenPaused() {
-        _unpause();
-    }
-
-    function paused() public view override(Pausable, ILiquidityPool) returns (bool) {
-        return super.paused();
+        paused = false;
+        emit Unpaused(msg.sender);
     }
 
     // Internal functions

contracts/LiquidityPoolAave.sol

@@ -23,15 +23,15 @@ import {LiquidityPool} from "./LiquidityPool.sol";
 contract LiquidityPoolAave is LiquidityPool {
     using SafeERC20 for IERC20;
 
-    uint256 private constant MULTIPLIER = 1e18;
+    uint256 private constant MULTIPLIER = 10000;
 
     IAavePoolAddressesProvider immutable public AAVE_POOL_PROVIDER;
     IAavePool immutable public AAVE_POOL;
     IERC20 immutable public ATOKEN;
     uint8 immutable public ASSETS_DECIMALS;
 
-    uint256 public minHealthFactor;
-    uint256 public defaultLTV;
+    uint32 public minHealthFactor;
+    uint32 public defaultLTV;
 
     mapping(address token => uint256 ltv) public borrowTokenLTV;
 
@@ -55,8 +55,8 @@ contract LiquidityPoolAave is LiquidityPool {
         address aavePoolProvider,
         address admin,
         address mpcAddress_,
-        uint256 minHealthFactor_,
-        uint256 defaultLTV_
+        uint32 minHealthFactor_,
+        uint32 defaultLTV_
     ) LiquidityPool(liquidityToken, admin, mpcAddress_) {
         ASSETS_DECIMALS = IERC20Metadata(liquidityToken).decimals();
         require(aavePoolProvider != address(0), ZeroAddress());
@@ -68,9 +68,8 @@ contract LiquidityPoolAave is LiquidityPool {
         IAavePoolDataProvider poolDataProvider = IAavePoolDataProvider(provider.getPoolDataProvider());
         (,,,,,bool usageAsCollateralEnabled,,,,) = poolDataProvider.getReserveConfigurationData(liquidityToken);
         require(usageAsCollateralEnabled, CollateralNotSupported());
-        minHealthFactor = minHealthFactor_;
-        defaultLTV = defaultLTV_;
-        mpcAddress = mpcAddress_;
+        _setHealthFactor(minHealthFactor_);
+        _setDefaultLTV(defaultLTV_);
     }
 
     function repay(address[] calldata borrowTokens) external override {
@@ -86,7 +85,7 @@ contract LiquidityPoolAave is LiquidityPool {
 
     function setBorrowTokenLTVs(
         address[] calldata tokens,
-        uint256[] calldata ltvs
+        uint32[] calldata ltvs
     ) external onlyRole(DEFAULT_ADMIN_ROLE) {
         require(tokens.length == ltvs.length, InvalidLength());
         for (uint256 i = 0; i < tokens.length; ++i) {
@@ -98,20 +97,28 @@ contract LiquidityPoolAave is LiquidityPool {
         }
     }
 
-    function setDefaultLTV(uint256 defaultLTV_) external onlyRole(DEFAULT_ADMIN_ROLE) {
-        uint256 oldDefaultLTV = defaultLTV;
+    function setDefaultLTV(uint32 defaultLTV_) external onlyRole(DEFAULT_ADMIN_ROLE) {
+        _setDefaultLTV(defaultLTV_);
+    }
+
+    function setHealthFactor(uint32 minHealthFactor_) external onlyRole(DEFAULT_ADMIN_ROLE) {
+        _setHealthFactor(minHealthFactor_);
+    }
+
+    // Internal functions
+
+    function _setDefaultLTV(uint32 defaultLTV_) internal {
+        uint32 oldDefaultLTV = defaultLTV;
         defaultLTV = defaultLTV_;
         emit DefaultLTVSet(oldDefaultLTV, defaultLTV_);
     }
 
-    function setHealthFactor(uint256 minHealthFactor_) external onlyRole(DEFAULT_ADMIN_ROLE) {
-        uint256 oldHealthFactor = minHealthFactor;
+    function _setHealthFactor(uint32 minHealthFactor_) internal {
+        uint32 oldHealthFactor = minHealthFactor;
         minHealthFactor = minHealthFactor_;
         emit HealthFactorSet(oldHealthFactor, minHealthFactor_);
     }
 
-    // Internal functions
-
     function _checkTokenLTV(address borrowToken) private view {
         uint256 ltv = borrowTokenLTV[borrowToken];
         if (ltv == 0) ltv = defaultLTV;
@@ -160,7 +167,7 @@ contract LiquidityPoolAave is LiquidityPool {
 
         // - Check health factor for user after borrow (can be read from aave, getUserAccountData)
         (,,,,,uint256 currentHealthFactor) = AAVE_POOL.getUserAccountData(address(this));
-        require(currentHealthFactor >= minHealthFactor, HealthFactorTooLow());
+        require(currentHealthFactor / 1e14 >= minHealthFactor, HealthFactorTooLow());
 
         // check ltv for token
         _checkTokenLTV(borrowToken);
@@ -171,7 +178,7 @@ contract LiquidityPoolAave is LiquidityPool {
         uint256 withdrawn = AAVE_POOL.withdraw(address(ASSETS), amount, to);
         // health factor after withdraw
         (,,,,,uint256 currentHealthFactor) = AAVE_POOL.getUserAccountData(address(this));
-        require(currentHealthFactor >= minHealthFactor, HealthFactorTooLow());
+        require(currentHealthFactor / 1e14 >= minHealthFactor, HealthFactorTooLow());
         emit WithdrawnFromAave(to, withdrawn);
         return withdrawn;
     }

hardhat.config.ts

@@ -32,7 +32,7 @@ task("grant-role", "Grant some role on some AccessControl")
 
 task("set-default-ltv", "Update Liquidity Pool config")
 .addOptionalParam("pool", "Liquidity Pool proxy address or id", "LiquidityPoolAaveUSDC", types.string)
-.addOptionalParam("ltv", "New default LTV value", 20n * 10n**16n, types.bigint)
+.addOptionalParam("ltv", "New default LTV value, where 10000 is 100%", 2000n, types.bigint)
 .setAction(async ({pool, ltv}: {pool: string, ltv: bigint}, hre) => {
   const {resolveXAddress} = await loadTestHelpers();
   const [admin] = await hre.ethers.getSigners();
@@ -46,7 +46,7 @@ task("set-default-ltv", "Update Liquidity Pool config")
 
 task("set-token-ltvs", "Update Liquidity Pool config")
 .addParam("tokens", "Comma separated list of tokens to update LTV for")
-.addParam("ltvs", "Comma separated list of new LTV values")
+.addParam("ltvs", "Comma separated list of new LTV values where 10000 is 100%")
 .addOptionalParam("pool", "Liquidity Pool proxy address or id", "LiquidityPoolAaveUSDC", types.string)
 .setAction(async (args: {tokens: string, ltvs: string, pool: string}, hre) => {
   const {resolveXAddress} = await loadTestHelpers();
@@ -65,7 +65,7 @@ task("set-token-ltvs", "Update Liquidity Pool config")
 
 task("set-min-health-factor", "Update Liquidity Pool config")
 .addOptionalParam("pool", "Liquidity Pool proxy address or id", "LiquidityPoolAaveUSDC", types.string)
-.addOptionalParam("healthfactor", "New min health factor value", 500n * 10n**16n, types.bigint)
+.addOptionalParam("healthfactor", "New min health factor value, where 10000 is 1", 50000n, types.bigint)
 .setAction(async ({pool, healthfactor}: {pool: string, healthfactor: bigint}, hre) => {
   const {resolveXAddress} = await loadTestHelpers();
   const [admin] = await hre.ethers.getSigners();

scripts/deploy.ts

@@ -97,8 +97,8 @@ export async function main() {
   let mainPool: LiquidityPool;
   let aavePool: LiquidityPoolAave;
   if (config.AavePool) {
-    const minHealthFactor = BigInt(config.AavePool.minHealthFactor) * 10n ** 18n / 100n;
-    const defaultLTV = BigInt(config.AavePool.defaultLTV) * 10n ** 18n / 100n;
+    const minHealthFactor = BigInt(config.AavePool.minHealthFactor) * 10000n / 100n;
+    const defaultLTV = BigInt(config.AavePool.defaultLTV) * 10000n / 100n;
     console.log("Deploying AAVE Liquidity Pool");
     aavePool = (await verifier.deployX(
       "LiquidityPoolAave",

test/LiquidityPoolAave.ts

@@ -65,9 +65,9 @@ describe("LiquidityPoolAave", function () {
     const UNI_DEC = 10n ** (await uni.decimals());
 
     // Initialize health factor as 5 (500%)
-    const healthFactor = 500n * 10n ** 18n / 100n;
+    const healthFactor = 500n * 10000n / 100n;
     // Initialize token LTV as 5%
-    const defaultLtv = 5n * 10n ** 18n / 100n;
+    const defaultLtv = 5n * 10000n / 100n;
     const liquidityPool = (
       await deploy("LiquidityPoolAave", deployer, {},
         usdc.target, AAVE_POOL_PROVIDER, admin.address, mpc_signer.address, healthFactor, defaultLtv 
@@ -892,7 +892,7 @@ describe("LiquidityPoolAave", function () {
       await expect(liquidityPool.connect(liquidityAdmin).deposit(amountCollateral))
         .to.emit(liquidityPool, "SuppliedToAave");
 
-      await expect(liquidityPool.connect(admin).setHealthFactor(4000n * 10n ** 18n / 100n))
+      await expect(liquidityPool.connect(admin).setHealthFactor(4000n * 10000n / 100n))
         .to.emit(liquidityPool, "HealthFactorSet");
 
       const amountToBorrow = 3n * UNI_DEC;
@@ -1414,7 +1414,7 @@ describe("LiquidityPoolAave", function () {
     it("Should allow admin to set minimal health factor", async function () {
       const {liquidityPool, admin} = await loadFixture(deployAll);
       const oldHealthFactor = await liquidityPool.minHealthFactor();
-      const healthFactor = 300n * 10n ** 18n / 100n;
+      const healthFactor = 300n * 10000n / 100n;
       await expect(liquidityPool.connect(admin).setHealthFactor(healthFactor))
         .to.emit(liquidityPool, "HealthFactorSet").withArgs(oldHealthFactor, healthFactor);
       expect(await liquidityPool.minHealthFactor())
@@ -1423,7 +1423,7 @@ describe("LiquidityPoolAave", function () {
 
     it("Should NOT allow others to set minimal health factor", async function () {
       const {liquidityPool, user} = await loadFixture(deployAll);
-      const healthFactor = 500n * 10n ** 18n / 100n;
+      const healthFactor = 500n * 10000n / 100n;
       await expect(liquidityPool.connect(user).setHealthFactor(healthFactor))
         .to.be.revertedWithCustomError(liquidityPool, "AccessControlUnauthorizedAccount");
     });