@gearbox-protocol/periphery-v3 1.0.5 → 1.0.7

package/contracts/data/DataCompressor_2_1.sol

@@ -32,6 +32,9 @@ import {CreditAccountData, CreditManagerData, PoolData, TokenBalance, ContractAd
 import {ZeroAddressException} from "@gearbox-protocol/core-v2/contracts/interfaces/IErrors.sol";
 import {LinearInterestModelHelper} from "./LinearInterestModelHelper.sol";
 
+uint256 constant COUNT = 0;
+uint256 constant QUERY = 1;
+
 /// @title Data compressor 2.1.
 /// @notice Collects data from various contracts for use in the dApp
 /// Do not use for data from data compressor for state-changing functions
@@ -148,15 +151,15 @@ contract DataCompressorV2_10 is IDataCompressorV2_10, ContractsRegisterTrait, Li
     }
 
     /// @dev Returns CreditManagerData for all Credit Managers
-    function getCreditManagersList() external view returns (CreditManagerData[] memory result) {
-        uint256 creditManagersCount = IContractsRegister(contractsRegister).getCreditManagersCount();
+    function getCreditManagersV2List() external view returns (CreditManagerData[] memory result) {
+        address[] memory cms = _listCreditManagersV2();
+        uint256 creditManagersCount = cms.length;
 
         result = new CreditManagerData[](creditManagersCount);
 
         unchecked {
             for (uint256 i = 0; i < creditManagersCount; ++i) {
-                address creditManager = IContractsRegister(contractsRegister).creditManagers(i);
-                result[i] = getCreditManagerData(creditManager);
+                result[i] = getCreditManagerData(cms[i]);
             }
         }
     }
@@ -281,14 +284,14 @@ contract DataCompressorV2_10 is IDataCompressorV2_10, ContractsRegisterTrait, Li
     }
 
     /// @dev Returns PoolData for all registered pools
-    function getPoolsList() external view returns (PoolData[] memory result) {
-        uint256 poolsLength = IContractsRegister(contractsRegister).getPoolsCount();
+    function getPoolsV1List() external view returns (PoolData[] memory result) {
+        address[] memory pools = _listPoolsV1();
+        uint256 poolsLength = pools.length;
 
         result = new PoolData[](poolsLength);
         unchecked {
             for (uint256 i = 0; i < poolsLength; ++i) {
-                address pool = IContractsRegister(contractsRegister).pools(i);
-                result[i] = getPoolData(pool);
+                result[i] = getPoolData(pools[i]);
             }
         }
     }
@@ -327,4 +330,64 @@ contract DataCompressorV2_10 is IDataCompressorV2_10, ContractsRegisterTrait, Li
         creditConfigurator = ICreditConfiguratorV2(creditManagerV2.creditConfigurator());
         ver = ICreditFacadeV2(creditFacade).version();
     }
+
+    function _isContractV2(address _cm) internal view returns (bool) {
+        uint256 cmVersion = IVersion(_cm).version();
+        return cmVersion >= 2 && cmVersion < 2_99;
+    }
+
+    function _isContractV1(address _pool) internal view returns (bool) {
+        uint256 cmVersion = IVersion(_pool).version();
+        return cmVersion == 1;
+    }
+
+    function _listPoolsV1() internal view returns (address[] memory result) {
+        uint256 len = IContractsRegister(contractsRegister).getPoolsCount();
+
+        uint256 index;
+        unchecked {
+            for (uint256 op = COUNT; op <= QUERY; ++op) {
+                if (op == QUERY && index == 0) {
+                    break;
+                } else {
+                    result = new address[](index);
+                    index = 0;
+                }
+
+                for (uint256 i = 0; i < len; ++i) {
+                    address _pool = IContractsRegister(contractsRegister).pools(i);
+
+                    if (_isContractV1(_pool)) {
+                        if (op == QUERY) result[index] = _pool;
+                        ++index;
+                    }
+                }
+            }
+        }
+    }
+
+    function _listCreditManagersV2() internal view returns (address[] memory result) {
+        uint256 len = IContractsRegister(contractsRegister).getCreditManagersCount();
+
+        uint256 index;
+        unchecked {
+            for (uint256 op = COUNT; op <= QUERY; ++op) {
+                if (op == QUERY && index == 0) {
+                    break;
+                } else {
+                    result = new address[](index);
+                    index = 0;
+                }
+
+                for (uint256 i = 0; i < len; ++i) {
+                    address _cm = IContractsRegister(contractsRegister).creditManagers(i);
+
+                    if (_isContractV2(_cm)) {
+                        if (op == QUERY) result[index] = _cm;
+                        ++index;
+                    }
+                }
+            }
+        }
+    }
 }

package/contracts/data/LinearInterestModelHelper.sol

@@ -4,13 +4,24 @@
 pragma solidity ^0.8.17;
 
 import {LinearInterestRateModelV3} from "@gearbox-protocol/core-v3/contracts/pool/LinearInterestRateModelV3.sol";
+import {LinearInterestRateModel} from "@gearbox-protocol/core-v2/contracts/pool/LinearInterestRateModel.sol";
 import {LinearModel} from "./Types.sol";
 
 contract LinearInterestModelHelper {
     function getLIRMData(address _model) internal view returns (LinearModel memory irm) {
         irm.interestModel = _model;
+        irm.version = LinearInterestRateModel(_model).version();
 
-        (irm.U_1, irm.U_2, irm.R_base, irm.R_slope1, irm.R_slope2, irm.R_slope3) =
-            LinearInterestRateModelV3(_model).getModelParameters();
+        if (irm.version == 1) {
+            (uint256 U_1, uint256 R_base, uint256 R_slope1, uint256 R_slope2) =
+                LinearInterestRateModel(_model).getModelParameters();
+            irm.U_1 = uint16(U_1);
+            irm.R_base = uint16(R_base);
+            irm.R_slope1 = uint16(R_slope1);
+            irm.R_slope2 = uint16(R_slope2);
+        } else {
+            (irm.U_1, irm.U_2, irm.R_base, irm.R_slope1, irm.R_slope2, irm.R_slope3) =
+                LinearInterestRateModelV3(_model).getModelParameters();
+        }
     }
 }

package/contracts/data/Types.sol

@@ -64,6 +64,7 @@ struct CreditAccountData {
 
 struct LinearModel {
     address interestModel;
+    uint256 version;
     uint16 U_1;
     uint16 U_2;
     uint16 R_base;
@@ -160,3 +161,79 @@ struct GaugeVote {
     uint96 totalVotesLpSide;
     uint96 totalVotesCaSide;
 }
+
+struct CreditManagerDataV2 {
+    address addr;
+    address underlying;
+    address pool;
+    bool isWETH;
+    bool canBorrow;
+    uint256 borrowRate;
+    uint256 minAmount;
+    uint256 maxAmount;
+    uint256 maxLeverageFactor; // for V1 only
+    uint256 availableLiquidity;
+    address[] collateralTokens;
+    ContractAdapter[] adapters;
+    uint256[] liquidationThresholds;
+    uint8 version;
+    address creditFacade; // V2 only: address of creditFacade
+    address creditConfigurator; // V2 only: address of creditConfigurator
+    bool isDegenMode; // V2 only: true if contract is in Degen mode
+    address degenNFT; // V2 only: degenNFT, address(0) if not in degen mode
+    bool isIncreaseDebtForbidden; // V2 only: true if increasing debt is forbidden
+    uint256 forbiddenTokenMask; // V2 only: mask which forbids some particular tokens
+    uint8 maxEnabledTokensLength; // V2 only: in V1 as many tokens as the CM can support (256)
+    uint16 feeInterest; // Interest fee protocol charges: fee = interest accrues * feeInterest
+    uint16 feeLiquidation; // Liquidation fee protocol charges: fee = totalValue * feeLiquidation
+    uint16 liquidationDiscount; // Miltiplier to get amount which liquidator should pay: amount = totalValue * liquidationDiscount
+    uint16 feeLiquidationExpired; // Liquidation fee protocol charges on expired accounts
+    uint16 liquidationDiscountExpired; // Multiplier for the amount the liquidator has to pay when closing an expired account
+}
+
+struct CreditAccountDataV2 {
+    address addr;
+    address borrower;
+    bool inUse;
+    address creditManager;
+    address underlying;
+    uint256 borrowedAmountPlusInterest;
+    uint256 borrowedAmountPlusInterestAndFees;
+    uint256 totalValue;
+    uint256 healthFactor;
+    uint256 borrowRate;
+    TokenBalance[] balances;
+    uint256 repayAmount; // for v1 accounts only
+    uint256 liquidationAmount; // for v1 accounts only
+    bool canBeClosed; // for v1 accounts only
+    uint256 borrowedAmount;
+    uint256 cumulativeIndexAtOpen;
+    uint256 since;
+    uint8 version;
+    uint256 enabledTokenMask;
+}
+
+struct PoolDataV2 {
+    address addr;
+    bool isWETH;
+    address underlying;
+    address dieselToken;
+    uint256 linearCumulativeIndex;
+    uint256 availableLiquidity;
+    uint256 expectedLiquidity;
+    uint256 expectedLiquidityLimit;
+    uint256 totalBorrowed;
+    uint256 depositAPY_RAY;
+    uint256 borrowAPY_RAY;
+    uint256 dieselRate_RAY;
+    uint256 withdrawFee;
+    uint256 cumulativeIndex_RAY;
+    uint256 timestampLU;
+    uint8 version;
+}
+
+struct TokenInfoV2 {
+    address addr;
+    string symbol;
+    uint8 decimals;
+}

package/contracts/interfaces/IDataCompressorV2.sol

@@ -0,0 +1,53 @@
+// SPDX-License-Identifier: MIT
+// Gearbox Protocol. Generalized leverage for DeFi protocols
+// (c) Gearbox Holdings, 2022
+pragma solidity ^0.8.10;
+
+import {CreditAccountDataV2, CreditManagerDataV2, PoolDataV2, TokenInfoV2} from "../data/Types.sol";
+import {IVersion} from "@gearbox-protocol/core-v2/contracts/interfaces/IVersion.sol";
+
+interface IDataCompressorV2Exceptions {
+    /// @dev Thrown if attempting to get data on a contract that is not a registered
+    ///      Credit Manager
+    error NotCreditManagerException();
+
+    /// @dev Thrown if attempting the get data on a contract that is not a registered
+    ///      pool
+    error NotPoolException();
+}
+
+interface IDataCompressorV2 is IDataCompressorV2Exceptions, IVersion {
+    /// @dev Returns CreditAccountData for all opened accounts for particular borrower
+    /// @param borrower Borrower address
+    function getCreditAccountList(address borrower) external view returns (CreditAccountDataV2[] memory);
+
+    /// @dev Returns whether the borrower has an open credit account with the credit manager
+    /// @param creditManager Credit manager to check
+    /// @param borrower Borrower to check
+    function hasOpenedCreditAccount(address creditManager, address borrower) external view returns (bool);
+
+    /// @dev Returns CreditAccountData for a particular Credit Account account, based on creditManager and borrower
+    /// @param _creditManager Credit manager address
+    /// @param borrower Borrower address
+    function getCreditAccountData(address _creditManager, address borrower)
+        external
+        view
+        returns (CreditAccountDataV2 memory);
+
+    /// @dev Returns CreditManagerData for all Credit Managers
+    function getCreditManagersList() external view returns (CreditManagerDataV2[] memory);
+
+    /// @dev Returns CreditManagerData for a particular _creditManager
+    /// @param _creditManager CreditManager address
+    function getCreditManagerData(address _creditManager) external view returns (CreditManagerDataV2 memory);
+
+    /// @dev Returns PoolData for a particular pool
+    /// @param _pool Pool address
+    function getPoolData(address _pool) external view returns (PoolDataV2 memory);
+
+    /// @dev Returns PoolData for all registered pools
+    function getPoolsList() external view returns (PoolDataV2[] memory);
+
+    /// @dev Returns the adapter address for a particular creditManager and targetContract
+    function getAdapter(address _creditManager, address _allowedContract) external view returns (address adapter);
+}

package/contracts/interfaces/IDataCompressorV2_10.sol

@@ -25,7 +25,7 @@ interface IDataCompressorV2_10 is IVersion {
         returns (CreditAccountData memory);
 
     /// @dev Returns CreditManagerData for all Credit Managers
-    function getCreditManagersList() external view returns (CreditManagerData[] memory);
+    function getCreditManagersV2List() external view returns (CreditManagerData[] memory);
 
     /// @dev Returns CreditManagerData for a particular _creditManager
     /// @param _creditManager CreditManager address
@@ -36,7 +36,7 @@ interface IDataCompressorV2_10 is IVersion {
     function getPoolData(address _pool) external view returns (PoolData memory);
 
     /// @dev Returns PoolData for all registered pools
-    function getPoolsList() external view returns (PoolData[] memory);
+    function getPoolsV1List() external view returns (PoolData[] memory);
 
     /// @dev Returns the adapter address for a particular creditManager and targetContract
     function getAdapter(address _creditManager, address _allowedContract) external view returns (address adapter);

package/contracts/test/DC_Printer.sol

@@ -0,0 +1,116 @@
+// 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 {CreditAccountData, CreditManagerData, PoolData, TokenBalance, ContractAdapter} from "../data/Types.sol";
+
+import "forge-std/console.sol";
+
+address constant ap = 0x5BcB06c56e8F28da0b038a373199240ca3F5a2f4;
+
+contract DCTest {
+    DataCompressorV2_10 public dc2;
+    DataCompressorV3_00 public dc3;
+
+    function setUp() public {
+        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_pools() public view {
+        PoolData[] memory pools = dc2.getPoolsV1List();
+        console.log("V1 pools");
+        _printPools(pools);
+
+        pools = dc3.getPoolsV3List();
+        console.log("\nV3 pools");
+        _printPools(pools);
+    }
+
+    function test_dc_credit_managers() public view {
+        CreditManagerData[] memory cms = dc2.getCreditManagersV2List();
+        console.log("V2 credit managers");
+        _printCreditManagers(cms);
+
+        cms = dc3.getCreditManagersV3List();
+        console.log("\n\nV3 credit managers");
+        _printCreditManagers(cms);
+    }
+}

package/package.json

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