@gearbox-protocol/periphery-v3 1.2.1 → 1.2.3

package/contracts/data/DataCompressor_3_0.sol

@@ -60,7 +60,9 @@ import {
 // EXCEPTIONS
 import "@gearbox-protocol/core-v3/contracts/interfaces/IExceptions.sol";
 import {LinearInterestModelHelper} from "./LinearInterestModelHelper.sol";
-import {ZapperRegister} from "./ZapperRegister.sol";
+import {IZapperRegister} from "../interfaces/IZapperRegister.sol";
+
+import "forge-std/console.sol";
 
 /// @title Data compressor 3.0.
 /// @notice Collects data from various contracts for use in the dApp
@@ -69,13 +71,13 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
     // Contract version
     uint256 public constant version = 3_00;
 
-    ZapperRegister public zapperRegister;
+    IZapperRegister public zapperRegister;
 
     error CreditManagerIsNotV3Exception();
 
     constructor(address _addressProvider) ContractsRegisterTrait(_addressProvider) {
         zapperRegister =
-            ZapperRegister(IAddressProviderV3(_addressProvider).getAddressOrRevert("ZAPPER_REGISTER", 3_00));
+            IZapperRegister(IAddressProviderV3(_addressProvider).getAddressOrRevert("ZAPPER_REGISTER", 3_00));
     }
 
     /// @dev Returns CreditAccountData for all opened accounts for particular borrower
@@ -130,24 +132,21 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
                 }
 
                 for (uint256 i = 0; i < len; ++i) {
-                    address _pool = creditManagers[i];
+                    address _cm = creditManagers[i];
 
-                    _updatePrices(_pool, priceUpdates);
-                    address[] memory creditAccounts = ICreditManagerV3(_pool).creditAccounts();
+                    _updatePrices(_cm, priceUpdates);
+                    address[] memory creditAccounts = ICreditManagerV3(_cm).creditAccounts();
                     uint256 caLen = creditAccounts.length;
                     for (uint256 j; j < caLen; ++j) {
                         if (
-                            (
-                                borrower == address(0)
-                                    || ICreditManagerV3(_pool).getBorrowerOrRevert(creditAccounts[i]) == borrower
-                            )
+                            (borrower == address(0) || _getBorrowerOrRevert(_cm, creditAccounts[j]) == borrower)
                                 && (
                                     !liquidatableOnly
-                                        || ICreditManagerV3(_pool).isLiquidatable(creditAccounts[i], PERCENTAGE_FACTOR)
+                                        || ICreditManagerV3(_cm).isLiquidatable(creditAccounts[j], PERCENTAGE_FACTOR)
                                 )
                         ) {
                             if (op == QUERY) {
-                                result[index] = _getCreditAccountData(_pool, creditAccounts[j]);
+                                result[index] = _getCreditAccountData(_cm, creditAccounts[j]);
                             }
                             ++index;
                         }
@@ -182,12 +181,12 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         returns (CreditAccountData memory result)
     {
         ICreditManagerV3 creditManager = ICreditManagerV3(_pool);
-        ICreditFacadeV3 creditFacade = ICreditFacadeV3(creditManager.creditFacade());
+        ICreditFacadeV3 creditFacade = _getCreditFacade(address(creditManager));
         // ICreditConfiguratorV3 creditConfigurator = ICreditConfiguratorV3(creditManager.creditConfigurator());
 
-        result.cfVersion = creditFacade.version();
+        result.cfVersion = _getVersion(address(creditFacade));
 
-        address borrower = creditManager.getBorrowerOrRevert(_creditAccount);
+        address borrower = _getBorrowerOrRevert(address(creditManager), _creditAccount);
 
         result.borrower = borrower;
         result.creditManager = _pool;
@@ -196,7 +195,7 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         result.underlying = creditManager.underlying();
 
         address pool = creditManager.pool();
-        result.baseBorrowRate = IPoolV3(pool).baseInterestRate();
+        result.baseBorrowRate = _getBaseInterestRate(pool);
 
         uint256 collateralTokenCount = creditManager.collateralTokensCount();
 
@@ -208,7 +207,7 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         {
             uint256 forbiddenTokenMask = creditFacade.forbiddenTokenMask();
             uint256 quotedTokensMask = creditManager.quotedTokensMask();
-            IPoolQuotaKeeperV3 pqk = IPoolQuotaKeeperV3(creditManager.poolQuotaKeeper());
+            IPoolQuotaKeeperV3 pqk = _getPoolQuotaKeeper(pool);
 
             unchecked {
                 for (uint256 i = 0; i < collateralTokenCount; ++i) {
@@ -235,7 +234,8 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
             }
         }
 
-        result.aggregatedBorrowRate = result.baseBorrowRate + RAY * quotaRevenue / PERCENTAGE_FACTOR / result.debt;
+        result.aggregatedBorrowRate =
+            result.baseBorrowRate + (result.debt == 0 ? 0 : RAY * quotaRevenue / PERCENTAGE_FACTOR / result.debt);
 
         // uint256 debt;
         // uint256 cumulativeIndexNow;
@@ -315,7 +315,7 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
     }
 
     function _isContractV3(address _pool) internal view returns (bool) {
-        uint256 cmVersion = IVersion(_pool).version();
+        uint256 cmVersion = _getVersion(_pool);
         return cmVersion >= 3_00 && cmVersion < 3_99;
     }
 
@@ -333,23 +333,23 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         }
     }
 
-    /// @dev Returns CreditManagerData for a particular _pool
-    /// @param _pool CreditManager address
-    function getCreditManagerData(address _pool) public view returns (CreditManagerData memory result) {
-        ICreditManagerV3 creditManager = ICreditManagerV3(_pool);
+    /// @dev Returns CreditManagerData for a particular _cm
+    /// @param _cm CreditManager address
+    function getCreditManagerData(address _cm) public view returns (CreditManagerData memory result) {
+        ICreditManagerV3 creditManager = ICreditManagerV3(_cm);
         ICreditConfiguratorV3 creditConfigurator = ICreditConfiguratorV3(creditManager.creditConfigurator());
-        ICreditFacadeV3 creditFacade = ICreditFacadeV3(creditManager.creditFacade());
+        ICreditFacadeV3 creditFacade = _getCreditFacade(address(creditManager));
 
-        result.addr = _pool;
-        result.cfVersion = creditFacade.version();
+        result.addr = _cm;
+        result.cfVersion = _getVersion(address(creditFacade));
 
         result.underlying = creditManager.underlying();
 
         {
             result.pool = creditManager.pool();
             IPoolV3 pool = IPoolV3(result.pool);
-            result.baseBorrowRate = pool.baseInterestRate();
-            result.availableToBorrow = pool.creditManagerBorrowable(_pool);
+            result.baseBorrowRate = _getBaseInterestRate(address(pool));
+            result.availableToBorrow = pool.creditManagerBorrowable(_cm);
             result.lirm = getLIRMData(pool.interestRateModel());
         }
 
@@ -416,7 +416,7 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
 
         result.dieselRate_RAY = pool.convertToAssets(RAY);
         result.linearCumulativeIndex = pool.calcLinearCumulative_RAY();
-        result.baseInterestRate = pool.baseInterestRate();
+        result.baseInterestRate = _getBaseInterestRate(address(pool));
         result.underlying = pool.underlyingToken();
         result.dieselToken = address(pool);
 
@@ -450,7 +450,7 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
 
         result.supplyRate = pool.supplyRate();
 
-        result.version = pool.version();
+        result.version = _getVersion(address(pool));
 
         result.quotas = _getQuotas(_pool);
         result.lirm = getLIRMData(pool.interestRateModel());
@@ -467,7 +467,7 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
             }
         }
 
-        result.poolQuotaKeeper = pool.poolQuotaKeeper();
+        result.poolQuotaKeeper = address(_getPoolQuotaKeeper(_pool));
         result.gauge = IPoolQuotaKeeperV3(result.poolQuotaKeeper).gauge();
 
         return result;
@@ -515,8 +515,7 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         uint256 len = priceUpdates.length;
         unchecked {
             for (uint256 i; i < len; ++i) {
-                address priceFeed =
-                    IPriceOracleV3(ICreditManagerV3(creditManager).priceOracle()).priceFeeds(priceUpdates[i].token);
+                address priceFeed = _getPriceOracle(creditManager).priceFeeds(priceUpdates[i].token);
                 if (priceFeed == address(0)) revert PriceFeedDoesNotExistException();
 
                 IUpdatablePriceFeed(priceFeed).updatePrice(priceUpdates[i].callData);
@@ -524,14 +523,14 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         }
     }
 
-    function _getPriceFeedFailedList(address _pool, TokenBalance[] memory balances)
+    function _getPriceFeedFailedList(address _cm, TokenBalance[] memory balances)
         internal
         view
         returns (address[] memory priceFeedFailed)
     {
         uint256 len = balances.length;
 
-        IPriceOracleV3 priceOracle = IPriceOracleV3(ICreditManagerV3(_pool).priceOracle());
+        IPriceOracleV3 priceOracle = _getPriceOracle(_cm);
 
         uint256 index;
 
@@ -560,8 +559,32 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         }
     }
 
+    function _getPoolQuotaKeeper(address pool) internal view returns (IPoolQuotaKeeperV3) {
+        return IPoolQuotaKeeperV3(IPoolV3(pool).poolQuotaKeeper());
+    }
+
+    function _getPriceOracle(address _cm) internal view returns (IPriceOracleV3) {
+        return IPriceOracleV3(ICreditManagerV3(_cm).priceOracle());
+    }
+
+    function _getBaseInterestRate(address pool) internal view returns (uint256) {
+        return IPoolV3(pool).baseInterestRate();
+    }
+
+    function _getBorrowerOrRevert(address cm, address creditAccount) internal view returns (address) {
+        return ICreditManagerV3(cm).getBorrowerOrRevert(creditAccount);
+    }
+
+    function _getVersion(address versionedContract) internal view returns (uint256) {
+        return IVersion(versionedContract).version();
+    }
+
+    function _getCreditFacade(address cm) internal view returns (ICreditFacadeV3) {
+        return ICreditFacadeV3(ICreditManagerV3(cm).creditFacade());
+    }
+
     function _getQuotas(address _pool) internal view returns (QuotaInfo[] memory quotas) {
-        IPoolQuotaKeeperV3 pqk = IPoolQuotaKeeperV3(IPoolV3(_pool).poolQuotaKeeper());
+        IPoolQuotaKeeperV3 pqk = _getPoolQuotaKeeper(_pool);
 
         address[] memory quotaTokens = pqk.quotedTokens();
         uint256 len = quotaTokens.length;
@@ -589,7 +612,7 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         unchecked {
             for (uint256 i; i < len; ++i) {
                 GaugeInfo memory gaugeInfo = result[i];
-                IPoolQuotaKeeperV3 pqk = IPoolQuotaKeeperV3(IPoolV3(poolsV3[i]).poolQuotaKeeper());
+                IPoolQuotaKeeperV3 pqk = _getPoolQuotaKeeper(poolsV3[i]);
                 address gauge = pqk.gauge();
                 gaugeInfo.addr = gauge;
 
@@ -639,7 +662,7 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
                     address[] memory quotaTokens;
                     address gauge;
                     {
-                        IPoolQuotaKeeperV3 pqk = IPoolQuotaKeeperV3(IPoolV3(poolsV3[i]).poolQuotaKeeper());
+                        IPoolQuotaKeeperV3 pqk = _getPoolQuotaKeeper(poolsV3[i]);
                         gauge = pqk.gauge();
 
                         quotaTokens = pqk.quotedTokens();

package/contracts/data/LinearInterestModelHelper.sol

@@ -22,6 +22,8 @@ contract LinearInterestModelHelper {
         } else {
             (irm.U_1, irm.U_2, irm.R_base, irm.R_slope1, irm.R_slope2, irm.R_slope3) =
                 LinearInterestRateModelV3(_model).getModelParameters();
+
+            irm.isBorrowingMoreU2Forbidden = LinearInterestRateModelV3(_model).isBorrowingMoreU2Forbidden();
         }
     }
 }

package/contracts/data/Types.sol

@@ -80,6 +80,7 @@ struct LinearModel {
     uint16 R_slope1;
     uint16 R_slope2;
     uint16 R_slope3;
+    bool isBorrowingMoreU2Forbidden;
 }
 
 struct CreditManagerData {

package/contracts/data/ZapperRegister.sol

@@ -5,11 +5,11 @@ pragma solidity ^0.8.10;
 
 import {EnumerableSet} from "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
 import {IZapper} from "@gearbox-protocol/integrations-v3/contracts/interfaces/zappers/IZapper.sol";
-import {IZapperRegistry} from "../interfaces/IZapperRegistry.sol";
+import {IZapperRegister} from "../interfaces/IZapperRegister.sol";
 import {ACLNonReentrantTrait} from "@gearbox-protocol/core-v3/contracts/traits/ACLNonReentrantTrait.sol";
 import {ContractsRegisterTrait} from "@gearbox-protocol/core-v3/contracts/traits/ContractsRegisterTrait.sol";
 
-contract ZapperRegister is ACLNonReentrantTrait, ContractsRegisterTrait, IZapperRegistry {
+contract ZapperRegister is ACLNonReentrantTrait, ContractsRegisterTrait, IZapperRegister {
     using EnumerableSet for EnumerableSet.AddressSet;
 
     // Contract version

package/contracts/interfaces/{IZapperRegistry.sol → IZapperRegister.sol}

@@ -3,7 +3,7 @@
 // (c) Gearbox Holdings, 2023
 pragma solidity ^0.8.10;
 
-interface IZapperRegistry {
+interface IZapperRegister {
     event AddZapper(address);
     event RemoveZapper(address);
 

package/contracts/test/DC_Printer.sol

@@ -15,7 +15,7 @@ import "forge-std/console.sol";
 
 address constant ap = 0x5BcB06c56e8F28da0b038a373199240ca3F5a2f4;
 
-contract DCTest {
+contract DCPrinterTest {
     DataCompressorV2_10 public dc2;
     DataCompressorV3_00 public dc3;
 

package/contracts/test/DC_Test.sol

@@ -0,0 +1,140 @@
+// SPDX-License-Identifier: UNLICENSED
+// Gearbox Protocol. Generalized leverage for DeFi protocols
+// (c) Gearbox Foundation, 2023.
+pragma solidity ^0.8.17;
+
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
+import {DataCompressorV2_10} from "../data/DataCompressor_2_1.sol";
+import {DataCompressorV3_00} from "../data/DataCompressor_3_0.sol";
+import {IDataCompressorV3_00, PriceOnDemand} from "../interfaces/IDataCompressorV3_00.sol";
+import {CreditAccountData, CreditManagerData, PoolData, TokenBalance, ContractAdapter} from "../data/Types.sol";
+
+import {NetworkDetector} from "@gearbox-protocol/sdk-gov/contracts/NetworkDetector.sol";
+
+import "forge-std/console.sol";
+
+address constant ap = 0x0Bf1626d4925F8A872801968be11c052862AC2D3;
+
+contract DCTest {
+    DataCompressorV2_10 public dc2;
+    DataCompressorV3_00 public dc3;
+
+    uint256 chainId;
+
+    constructor() {
+        NetworkDetector nd = new NetworkDetector();
+        chainId = nd.chainId();
+    }
+
+    modifier liveTestOnly() {
+        if (chainId == 1) {
+            _;
+        }
+    }
+
+    function setUp() public liveTestOnly {
+        dc2 = new DataCompressorV2_10(ap);
+        dc3 = new DataCompressorV3_00(ap);
+    }
+
+    function _printPools(PoolData[] memory pools) internal view {
+        uint256 len = pools.length;
+        unchecked {
+            for (uint256 i; i < len; ++i) {
+                PoolData memory pool = pools[i];
+                console.log("\n\n");
+                console.log(IERC20Metadata(pool.underlying).symbol(), pool.addr);
+                console.log("-------------------------------");
+
+                console.log("dieselToken: ", pool.dieselToken);
+                ///
+                console.log("linearCumulativeIndex: ", pool.linearCumulativeIndex);
+                console.log("availableLiquidity: ", pool.availableLiquidity);
+                console.log("expectedLiquidity: ", pool.expectedLiquidity);
+                //
+                console.log("totalBorrowed: ", pool.totalBorrowed);
+                console.log("totalDebtLimit: ", pool.totalDebtLimit);
+                // CreditManagerDebtParams[] creditManagerDebtParams;
+                console.log("totalAssets: ", pool.totalAssets);
+                console.log("totalSupply: ", pool.totalSupply);
+                console.log("supplyRate", pool.supplyRate);
+                console.log("baseInterestRate: ", pool.baseInterestRate);
+                console.log("dieselRate_RAY: ", pool.dieselRate_RAY);
+                console.log("withdrawFee", pool.withdrawFee);
+                console.log("cumulativeIndex_RAY:", pool.cumulativeIndex_RAY);
+                console.log("baseInterestIndexLU:", pool.baseInterestIndexLU);
+                console.log("version: ", pool.version);
+                // QuotaInfo[] quotas;
+                // LinearModel lirm;
+                console.log("isPaused", pool.isPaused);
+            }
+        }
+    }
+
+    function _printCreditManagers(CreditManagerData[] memory cms) internal view {
+        uint256 len = cms.length;
+        unchecked {
+            for (uint256 i; i < len; ++i) {
+                CreditManagerData memory cm = cms[i];
+                console.log("\n\n");
+                console.log(IERC20Metadata(cm.underlying).symbol(), cm.addr);
+                console.log("-------------------------------");
+                console.log("cfVersion: ", cm.cfVersion);
+                console.log("creditFacace: ", cm.creditFacade); // V2 only: address of creditFacade
+                console.log("creditConfigurator: ", cm.creditConfigurator); // V2 only: address of creditConfigurator
+                console.log("pool: ", cm.pool);
+                console.log("totalDebt: ", cm.totalDebt);
+                console.log("totalDebtLimit: ", cm.totalDebtLimit);
+                console.log("baseBorrowRate: ", cm.baseBorrowRate);
+                console.log("minDebt: ", cm.minDebt);
+                console.log("maxDebt: ", cm.maxDebt);
+                console.log("availableToBorrow: ", cm.availableToBorrow);
+                // address[] collateralTokens);
+                // ContractAdapter[] adapters);
+                // uint256[] liquidationThresholds);
+                console.log("isDegenMode: ", cm.isDegenMode); // V2 only: true if contract is in Degen mode
+                console.log("degenNFT: ", cm.degenNFT); // V2 only: degenNFT, address(0) if not in degen mode
+                console.log("forbiddenTokenMask: ", cm.forbiddenTokenMask); // V2 only: mask which forbids some particular tokens
+                console.log("maxEnabledTokensLength: ", cm.maxEnabledTokensLength); // V2 only: in V1 as many tokens as the CM can support (256)
+                console.log("feeInterest: ", cm.feeInterest); // Interest fee protocol charges: fee = interest accrues * feeInterest
+                console.log("feeLiquidation: ", cm.feeLiquidation); // Liquidation fee protocol charges: fee = totalValue * feeLiquidation
+                console.log("liquidationDiscount: ", cm.liquidationDiscount); // Miltiplier to get amount which liquidator should pay: amount = totalValue * liquidationDiscount
+                console.log("feeLiquidationExpired: ", cm.feeLiquidationExpired); // Liquidation fee protocol charges on expired accounts
+                console.log("liquidationDiscountExpired: ", cm.liquidationDiscountExpired); // Multiplier for the amount the liquidator has to pay when closing an expired account
+                // V3 Fileds
+                // QuotaInfo[] quotas);
+                // LinearModel lirm);
+                console.log("sPaused: ", cm.isPaused);
+            }
+        }
+    }
+
+    function test_dc_01_pools() public view liveTestOnly {
+        PoolData[] memory pools = dc2.getPoolsV1List();
+        console.log("V1 pools");
+        _printPools(pools);
+
+        pools = dc3.getPoolsV3List();
+        console.log("\nV3 pools");
+        _printPools(pools);
+    }
+
+    function test_dc_02_credit_managers() public view liveTestOnly {
+        CreditManagerData[] memory cms = dc2.getCreditManagersV2List();
+        console.log("V2 credit managers");
+        _printCreditManagers(cms);
+
+        cms = dc3.getCreditManagersV3List();
+        console.log("\n\nV3 credit managers");
+        _printCreditManagers(cms);
+    }
+
+    function test_dc_03_credit_accounts() public liveTestOnly {
+        CreditAccountData[] memory cas = dc2.getCreditAccountsByBorrower(address(this));
+        console.log("V2 credit accounts", cas.length);
+
+        cas = dc3.getCreditAccountsByBorrower(address(this), new PriceOnDemand[](0));
+        console.log("V3 credit accounts", cas.length);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/periphery-v3",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "main": "index.js",
   "repository": "git@github.com:Gearbox-protocol/periphery-v3.git",
   "author": "Mikael <26343374+0xmikko@users.noreply.github.com>",