@gearbox-protocol/periphery-v3 1.2.4 → 1.2.6

package/contracts/data/DataCompressor_2_1.sol

@@ -7,6 +7,8 @@ pragma experimental ABIEncoderV2;
 import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
 
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
 import {Pausable} from "@openzeppelin/contracts/security/Pausable.sol";
 
 import {PERCENTAGE_FACTOR} from "@gearbox-protocol/core-v2/contracts/libraries/PercentageMath.sol";
@@ -23,6 +25,8 @@ import {PoolService} from "@gearbox-protocol/core-v2/contracts/pool/PoolService.
 
 import {IVersion} from "@gearbox-protocol/core-v2/contracts/interfaces/IVersion.sol";
 
+import {ACLNonReentrantTrait} from "@gearbox-protocol/core-v3/contracts/traits/ACLNonReentrantTrait.sol";
+
 import {IAddressProvider} from "@gearbox-protocol/core-v2/contracts/interfaces/IAddressProvider.sol";
 import {IDataCompressorV2_10} from "../interfaces/IDataCompressorV2_10.sol";
 
@@ -37,11 +41,21 @@ import {LinearInterestModelHelper} from "./LinearInterestModelHelper.sol";
 /// @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
-contract DataCompressorV2_10 is IDataCompressorV2_10, ContractsRegisterTrait, LinearInterestModelHelper {
+contract DataCompressorV2_10 is
+    IDataCompressorV2_10,
+    ACLNonReentrantTrait,
+    ContractsRegisterTrait,
+    LinearInterestModelHelper
+{
     // Contract version
     uint256 public constant version = 2_10;
 
-    constructor(address _addressProvider) ContractsRegisterTrait(_addressProvider) {}
+    mapping(address => string) public cmDescriptions;
+
+    constructor(address _addressProvider)
+        ACLNonReentrantTrait(_addressProvider)
+        ContractsRegisterTrait(_addressProvider)
+    {}
 
     /// @dev Returns CreditAccountData for all opened accounts for particular borrower
     /// @param borrower Borrower address
@@ -170,6 +184,7 @@ contract DataCompressorV2_10 is IDataCompressorV2_10, ContractsRegisterTrait, Li
 
         result.addr = _creditManager;
         result.cfVersion = ver;
+        result.description = cmDescriptions[_creditManager];
 
         result.underlying = creditManagerV2.underlying();
 
@@ -257,6 +272,10 @@ contract DataCompressorV2_10 is IDataCompressorV2_10, ContractsRegisterTrait, Li
         result.baseInterestRate = pool.borrowAPY_RAY();
         result.underlying = pool.underlyingToken();
         result.dieselToken = pool.dieselToken();
+
+        result.symbol = IERC20Metadata(result.dieselToken).symbol();
+        result.name = IERC20Metadata(result.dieselToken).name();
+
         result.dieselRate_RAY = pool.getDieselRate_RAY();
         result.withdrawFee = pool.withdrawFee();
         result.baseInterestIndexLU = pool._timestampLU();
@@ -384,4 +403,8 @@ contract DataCompressorV2_10 is IDataCompressorV2_10, ContractsRegisterTrait, Li
             }
         }
     }
+
+    function setCreditManagerDescription(address _cm, string calldata description) external controllerOnly {
+        cmDescriptions[_cm] = description;
+    }
 }

package/contracts/data/DataCompressor_3_0.sol

@@ -6,6 +6,8 @@ pragma experimental ABIEncoderV2;
 
 import "@gearbox-protocol/core-v3/contracts/interfaces/IAddressProviderV3.sol";
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+
 import {PERCENTAGE_FACTOR, RAY} from "@gearbox-protocol/core-v2/contracts/libraries/Constants.sol";
 
 import {ContractsRegisterTrait} from "@gearbox-protocol/core-v3/contracts/traits/ContractsRegisterTrait.sol";
@@ -54,7 +56,8 @@ import {
     GaugeQuotaParams,
     CreditManagerDebtParams,
     GaugeVote,
-    ZapperInfo
+    ZapperInfo,
+    LinearModel
 } from "./Types.sol";
 
 // EXCEPTIONS
@@ -165,22 +168,22 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
     {
         ICreditAccountV3 creditAccount = ICreditAccountV3(_creditAccount);
 
-        address _pool = creditAccount.creditManager();
-        _ensureRegisteredCreditManager(_pool);
+        address _cm = creditAccount.creditManager();
+        _ensureRegisteredCreditManager(_cm);
 
-        if (!_isContractV3(_pool)) revert CreditManagerIsNotV3Exception();
+        if (!_isContractV3(_cm)) revert CreditManagerIsNotV3Exception();
 
-        _updatePrices(_pool, priceUpdates);
+        _updatePrices(_cm, priceUpdates);
 
-        return _getCreditAccountData(_pool, _creditAccount);
+        return _getCreditAccountData(_cm, _creditAccount);
     }
 
-    function _getCreditAccountData(address _pool, address _creditAccount)
+    function _getCreditAccountData(address _cm, address _creditAccount)
         internal
         view
         returns (CreditAccountData memory result)
     {
-        ICreditManagerV3 creditManager = ICreditManagerV3(_pool);
+        ICreditManagerV3 creditManager = ICreditManagerV3(_cm);
         ICreditFacadeV3 creditFacade = _getCreditFacade(address(creditManager));
         // ICreditConfiguratorV3 creditConfigurator = ICreditConfiguratorV3(creditManager.creditConfigurator());
 
@@ -189,15 +192,15 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         address borrower = _getBorrowerOrRevert(address(creditManager), _creditAccount);
 
         result.borrower = borrower;
-        result.creditManager = _pool;
+        result.creditManager = _cm;
         result.addr = _creditAccount;
 
         result.underlying = creditManager.underlying();
 
-        address pool = creditManager.pool();
+        address pool = _getPool(_cm);
         result.baseBorrowRate = _getBaseInterestRate(pool);
 
-        uint256 collateralTokenCount = creditManager.collateralTokensCount();
+        uint256 collateralTokenCount = _getCollateralTokensCount(address(creditManager));
 
         result.enabledTokensMask = creditManager.enabledTokensMaskOf(_creditAccount);
 
@@ -259,7 +262,7 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
             result.totalValue = collateralDebtData.totalValue;
             result.isSuccessful = true;
         } catch {
-            _getPriceFeedFailedList(_pool, result.balances);
+            _getPriceFeedFailedList(_cm, result.balances);
             result.isSuccessful = false;
         }
 
@@ -276,13 +279,13 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         // address borrower;
 
         (result.debt, result.cumulativeIndexLastUpdate, result.cumulativeQuotaInterest,,,, result.since,) =
-            CreditManagerV3(_pool).creditAccountInfo(_creditAccount);
+            CreditManagerV3(_cm).creditAccountInfo(_creditAccount);
 
         result.expirationDate = creditFacade.expirationDate();
         result.maxApprovedBots = CreditFacadeV3(address(creditFacade)).maxApprovedBots();
 
         result.activeBots =
-            IBotListV3(CreditFacadeV3(address(creditFacade)).botList()).getActiveBots(_pool, _creditAccount);
+            IBotListV3(CreditFacadeV3(address(creditFacade)).botList()).getActiveBots(_cm, _creditAccount);
 
         // QuotaInfo[] quotas;
         result.schedultedWithdrawals = IWithdrawalManagerV3(CreditFacadeV3(address(creditFacade)).withdrawalManager())
@@ -303,10 +306,10 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
                 }
 
                 for (uint256 i = 0; i < len; ++i) {
-                    address _pool = IContractsRegister(contractsRegister).creditManagers(i);
+                    address _cm = IContractsRegister(contractsRegister).creditManagers(i);
 
-                    if (_isContractV3(_pool)) {
-                        if (op == QUERY) result[index] = _pool;
+                    if (_isContractV3(_cm)) {
+                        if (op == QUERY) result[index] = _cm;
                         ++index;
                     }
                 }
@@ -314,8 +317,8 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         }
     }
 
-    function _isContractV3(address _pool) internal view returns (bool) {
-        uint256 cmVersion = _getVersion(_pool);
+    function _isContractV3(address _cm) internal view returns (bool) {
+        uint256 cmVersion = _getVersion(_cm);
         return cmVersion >= 3_00 && cmVersion < 3_99;
     }
 
@@ -341,22 +344,23 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         ICreditFacadeV3 creditFacade = _getCreditFacade(address(creditManager));
 
         result.addr = _cm;
+        result.description = _getDescription(_cm);
         result.cfVersion = _getVersion(address(creditFacade));
 
         result.underlying = creditManager.underlying();
 
         {
-            result.pool = creditManager.pool();
+            result.pool = _getPool(_cm);
             IPoolV3 pool = IPoolV3(result.pool);
             result.baseBorrowRate = _getBaseInterestRate(address(pool));
             result.availableToBorrow = pool.creditManagerBorrowable(_cm);
-            result.lirm = getLIRMData(pool.interestRateModel());
+            result.lirm = _getInterestRateModel(address(pool));
         }
 
         (result.minDebt, result.maxDebt) = creditFacade.debtLimits();
 
         {
-            uint256 collateralTokenCount = creditManager.collateralTokensCount();
+            uint256 collateralTokenCount = _getCollateralTokensCount(address(creditManager));
 
             result.collateralTokens = new address[](collateralTokenCount);
             result.liquidationThresholds = new uint256[](collateralTokenCount);
@@ -419,6 +423,7 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         result.baseInterestRate = _getBaseInterestRate(address(pool));
         result.underlying = pool.underlyingToken();
         result.dieselToken = address(pool);
+        (result.symbol, result.name) = _getSymbolAndName(_pool);
 
         result.dieselRate_RAY = pool.convertToAssets(RAY);
         result.withdrawFee = pool.withdrawFee();
@@ -435,7 +440,6 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
 
         unchecked {
             for (uint256 i; i < len; ++i) {
-                console.log("i: ", i);
                 address creditManager = creditManagers[i];
                 result.creditManagerDebtParams[i] = CreditManagerDebtParams({
                     creditManager: creditManager,
@@ -454,7 +458,8 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         result.version = _getVersion(address(pool));
 
         result.quotas = _getQuotas(_pool);
-        result.lirm = getLIRMData(pool.interestRateModel());
+        result.lirm = _getInterestRateModel(_pool);
+
         result.isPaused = pool.paused();
 
         address[] memory zappers = zapperRegister.zappers(address(pool));
@@ -584,10 +589,35 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         return ICreditFacadeV3(ICreditManagerV3(cm).creditFacade());
     }
 
+    function _getSymbolAndName(address token) internal view returns (string memory symbol, string memory name) {
+        symbol = IERC20Metadata(token).symbol();
+        name = IERC20Metadata(token).name();
+    }
+
+    function _getInterestRateModel(address pool) internal view returns (LinearModel memory) {
+        return getLIRMData(IPoolV3(pool).interestRateModel());
+    }
+
+    function _getQuotedTokens(IPoolQuotaKeeperV3 pqk) internal view returns (address[] memory result) {
+        result = pqk.quotedTokens();
+    }
+
+    function _getPool(address cnt) internal view returns (address) {
+        return ICreditManagerV3(cnt).pool();
+    }
+
+    function _getDescription(address _cm) internal view returns (string memory) {
+        return ICreditManagerV3(_cm).description();
+    }
+
+    function _getCollateralTokensCount(address _cm) internal view returns (uint256) {
+        return ICreditManagerV3(_cm).collateralTokensCount();
+    }
+
     function _getQuotas(address _pool) internal view returns (QuotaInfo[] memory quotas) {
         IPoolQuotaKeeperV3 pqk = _getPoolQuotaKeeper(_pool);
 
-        address[] memory quotaTokens = pqk.quotedTokens();
+        address[] memory quotaTokens = _getQuotedTokens(pqk);
         uint256 len = quotaTokens.length;
         quotas = new QuotaInfo[](len);
         unchecked {
@@ -616,8 +646,10 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
                 IPoolQuotaKeeperV3 pqk = _getPoolQuotaKeeper(poolsV3[i]);
                 address gauge = pqk.gauge();
                 gaugeInfo.addr = gauge;
+                gaugeInfo.pool = _getPool(gauge);
+                (gaugeInfo.symbol, gaugeInfo.name) = _getSymbolAndName(gaugeInfo.pool);
 
-                address[] memory quotaTokens = pqk.quotedTokens();
+                address[] memory quotaTokens = _getQuotedTokens(pqk);
                 uint256 quotaTokensLen = quotaTokens.length;
                 gaugeInfo.quotaParams = new GaugeQuotaParams[](quotaTokensLen);
 
@@ -666,7 +698,7 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
                         IPoolQuotaKeeperV3 pqk = _getPoolQuotaKeeper(poolsV3[i]);
                         gauge = pqk.gauge();
 
-                        quotaTokens = pqk.quotedTokens();
+                        quotaTokens = _getQuotedTokens(pqk);
                     }
                     uint256 quotaTokensLen = quotaTokens.length;
 

package/contracts/data/Types.sol

@@ -44,6 +44,7 @@ struct CreditAccountData {
     address addr;
     address borrower;
     address creditManager;
+    string cmDescription;
     address creditFacade;
     address underlying;
     uint256 debt;
@@ -85,6 +86,7 @@ struct LinearModel {
 
 struct CreditManagerData {
     address addr;
+    string description;
     uint256 cfVersion;
     address creditFacade; // V2 only: address of creditFacade
     address creditConfigurator; // V2 only: address of creditConfigurator
@@ -126,6 +128,8 @@ struct PoolData {
     address addr;
     address underlying;
     address dieselToken;
+    string symbol;
+    string name;
     ///
     uint256 linearCumulativeIndex;
     uint256 availableLiquidity;
@@ -166,6 +170,9 @@ struct GaugeQuotaParams {
 
 struct GaugeInfo {
     address addr;
+    address pool;
+    string symbol;
+    string name;
     GaugeQuotaParams[] quotaParams;
 }
 
@@ -175,79 +182,3 @@ 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/package.json

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

package/contracts/interfaces/IDataCompressorV2.sol

@@ -1,53 +0,0 @@
-// 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);
-}