@gearbox-protocol/periphery-v3 1.3.6 → 1.3.8

package/README.md

@@ -1,2 +1,2 @@
-## Gearbox Periphery
+## Gearbox PeripheryV3
 

package/contracts/data/DataCompressor_2_1.sol

@@ -31,7 +31,14 @@ import {IAddressProvider} from "@gearbox-protocol/core-v2/contracts/interfaces/I
 import {IDataCompressorV2_10} from "../interfaces/IDataCompressorV2_10.sol";
 
 import {
-    COUNT, QUERY, CreditAccountData, CreditManagerData, PoolData, TokenBalance, ContractAdapter
+    COUNT,
+    QUERY,
+    CreditAccountData,
+    CreditManagerData,
+    PoolData,
+    TokenBalance,
+    ContractAdapter,
+    CreditManagerDebtParams
 } from "./Types.sol";
 
 // EXCEPTIONS
@@ -113,6 +120,7 @@ contract DataCompressorV2_10 is
 
         result.borrower = borrower;
         result.creditManager = _creditManager;
+        result.cmName = cmDescriptions[_creditManager];
         result.creditFacade = address(creditFacade);
         result.addr = creditAccount;
 
@@ -157,6 +165,8 @@ contract DataCompressorV2_10 is
         result.cumulativeIndexLastUpdate = ICreditAccount(creditAccount).cumulativeIndexAtOpen();
 
         result.since = uint64(ICreditAccount(creditAccount).since());
+        (,, uint40 ed,) = creditFacade.params();
+        result.expirationDate = ed;
     }
 
     /// @dev Returns CreditManagerData for all Credit Managers
@@ -186,6 +196,8 @@ contract DataCompressorV2_10 is
         result.addr = _creditManager;
         result.cfVersion = ver;
         result.name = cmDescriptions[_creditManager];
+        result.creditFacade = address(creditFacade);
+        result.creditConfigurator = creditManagerV2.creditConfigurator();
 
         result.underlying = creditManagerV2.underlying();
 
@@ -195,6 +207,9 @@ contract DataCompressorV2_10 is
             result.baseBorrowRate = pool.borrowAPY_RAY();
 
             (uint128 currentTotalDebt, uint128 totalDebtLimit) = creditFacade.totalDebt();
+
+            result.totalDebt = currentTotalDebt;
+            result.totalDebtLimit = totalDebtLimit;
             result.availableToBorrow = pool.creditManagersCanBorrow(_creditManager)
                 ? Math.min(pool.availableLiquidity(), totalDebtLimit - currentTotalDebt)
                 : 0;
@@ -231,9 +246,8 @@ contract DataCompressorV2_10 is
             }
         }
 
-        result.creditFacade = address(creditFacade);
-        result.creditConfigurator = creditManagerV2.creditConfigurator();
         result.degenNFT = creditFacade.degenNFT();
+        result.isDegenMode = result.degenNFT != address(0);
         {
             bool isIncreaseDebtForbidden;
             (, isIncreaseDebtForbidden,,) = creditFacade.params(); // V2 only: true if increasing debt is forbidden
@@ -265,29 +279,58 @@ contract DataCompressorV2_10 is
         PoolService pool = PoolService(_pool);
 
         result.addr = _pool;
-        result.expectedLiquidity = pool.expectedLiquidity();
-        result.availableLiquidity = pool.availableLiquidity();
-        result.totalBorrowed = pool.totalBorrowed();
-        result.dieselRate_RAY = pool.getDieselRate_RAY();
-        result.baseInterestIndex = pool.calcLinearCumulative_RAY();
-        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.baseInterestIndex = pool.calcLinearCumulative_RAY();
+        result.availableLiquidity = pool.availableLiquidity();
+        result.expectedLiquidity = pool.expectedLiquidity();
+
+        result.totalBorrowed = pool.totalBorrowed();
+
+        result.totalSupply = IERC20(result.dieselToken).totalSupply();
+        result.totalAssets = pool.fromDiesel(result.totalSupply);
+
+        result.dieselRate_RAY = pool.getDieselRate_RAY();
+
+        result.baseInterestRate = pool.borrowAPY_RAY();
+
         result.dieselRate_RAY = pool.getDieselRate_RAY();
+
         result.withdrawFee = pool.withdrawFee();
         result.lastBaseInterestUpdate = pool._timestampLU();
         result.baseInterestIndexLU = pool._cumulativeIndex_RAY();
 
-        uint256 dieselSupply = IERC20(result.dieselToken).totalSupply();
-        uint256 totalLP = pool.fromDiesel(dieselSupply);
-        result.supplyRate = totalLP == 0
+        result.supplyRate = result.totalAssets == 0
             ? result.baseInterestRate
-            : (result.baseInterestRate * result.totalBorrowed) * (PERCENTAGE_FACTOR - result.withdrawFee) / totalLP
-                / PERCENTAGE_FACTOR;
+            : (result.baseInterestRate * result.totalBorrowed) * (PERCENTAGE_FACTOR - result.withdrawFee)
+                / result.totalAssets / PERCENTAGE_FACTOR;
+
+        uint256 len = pool.creditManagersCount();
+        result.creditManagerDebtParams = new CreditManagerDebtParams[](len);
+
+        unchecked {
+            for (uint256 i; i < len; ++i) {
+                address creditManager = pool.creditManagers(i);
+
+                uint128 currentTotalDebt;
+                uint128 totalDebtLimit;
+                if (_isContractV2(creditManager)) {
+                    (,, ICreditFacadeV2 creditFacade,) = getCreditContracts(creditManager);
+                    (currentTotalDebt, totalDebtLimit) = creditFacade.totalDebt();
+                }
+
+                result.creditManagerDebtParams[i] = CreditManagerDebtParams({
+                    creditManager: creditManager,
+                    borrowed: currentTotalDebt,
+                    limit: pool.creditManagersCanBorrow(creditManager) ? totalDebtLimit : 0,
+                    availableToBorrow: pool.creditManagersCanBorrow(creditManager) ? result.availableLiquidity : 0
+                });
+            }
+        }
 
         result.version = uint8(pool.version());
         result.lirm = getLIRMData(address(pool.interestRateModel()));

package/contracts/data/DataCompressor_3_0.sol

@@ -187,7 +187,7 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         ICreditManagerV3 creditManager = ICreditManagerV3(_cm);
         ICreditFacadeV3 creditFacade = _getCreditFacade(address(creditManager));
         // ICreditConfiguratorV3 creditConfigurator = ICreditConfiguratorV3(creditManager.creditConfigurator());
-
+        result.creditFacade = address(creditFacade);
         result.cfVersion = _getVersion(address(creditFacade));
 
         address borrower = _getBorrowerOrRevert(address(creditManager), _creditAccount);
@@ -197,6 +197,7 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         result.addr = _creditAccount;
 
         result.underlying = _getUnderlying(creditManager);
+        result.cmName = _getName(_cm);
 
         address pool = _getPool(_cm);
         result.baseBorrowRate = _getBaseInterestRate(pool);
@@ -259,6 +260,9 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         returns (CollateralDebtData memory collateralDebtData) {
             result.accruedInterest = collateralDebtData.accruedInterest;
             result.accruedFees = collateralDebtData.accruedFees;
+            result.totalDebtUSD = collateralDebtData.totalDebtUSD;
+            result.totalValueUSD = collateralDebtData.totalValueUSD;
+            result.twvUSD = collateralDebtData.twvUSD;
             result.healthFactor = collateralDebtData.twvUSD * PERCENTAGE_FACTOR / collateralDebtData.totalDebtUSD;
             result.totalValue = collateralDebtData.totalValue;
             result.isSuccessful = true;
@@ -348,6 +352,9 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         result.name = _getName(_cm);
         result.cfVersion = _getVersion(address(creditFacade));
 
+        result.creditFacade = address(creditFacade);
+        result.creditConfigurator = address(creditConfigurator);
+
         result.underlying = _getUnderlying(creditManager);
 
         {
@@ -392,9 +399,8 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
             }
         }
 
-        result.creditFacade = address(creditFacade);
-        result.creditConfigurator = address(creditConfigurator);
         result.degenNFT = creditFacade.degenNFT();
+        result.isDegenMode = result.degenNFT != address(0);
         // (, result.isIncreaseDebtForbidden,,) = creditFacade.params(); // V2 only: true if increasing debt is forbidden
         result.forbiddenTokenMask = creditFacade.forbiddenTokenMask(); // V2 only: mask which forbids some particular tokens
         result.maxEnabledTokensLength = creditManager.maxEnabledTokens(); // V2 only: a limit on enabled tokens imposed for security
@@ -665,6 +671,7 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
                 gaugeInfo.addr = gauge;
                 gaugeInfo.pool = _getPool(gauge);
                 (gaugeInfo.symbol, gaugeInfo.name) = _getSymbolAndName(gaugeInfo.pool);
+                gaugeInfo.underlying = IPoolV3(gaugeInfo.pool).asset();
 
                 address[] memory quotaTokens = _getQuotedTokens(pqk);
                 uint256 quotaTokensLen = quotaTokens.length;

package/contracts/data/LinearInterestModelHelper.sol

@@ -6,24 +6,18 @@ 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";
+import "forge-std/console.sol";
 
 contract LinearInterestModelHelper {
     function getLIRMData(address _model) internal view returns (LinearModel memory irm) {
         irm.interestModel = _model;
         irm.version = LinearInterestRateModel(_model).version();
 
-        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();
+        console.log(irm.version);
 
-            irm.isBorrowingMoreU2Forbidden = LinearInterestRateModelV3(_model).isBorrowingMoreU2Forbidden();
-        }
+        (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

@@ -46,11 +46,10 @@ struct CreditAccountData {
     address addr;
     address borrower;
     address creditManager;
-    string cmDescription;
+    string cmName;
     address creditFacade;
     address underlying;
     uint256 debt;
-    uint256 cumulativeIndexNow;
     uint256 cumulativeIndexLastUpdate;
     uint128 cumulativeQuotaInterest;
     uint256 accruedInterest;
@@ -177,6 +176,7 @@ struct GaugeInfo {
     address pool;
     string symbol;
     string name;
+    address underlying;
     uint16 currentEpoch;
     bool epochFrozen;
     GaugeQuotaParams[] quotaParams;

package/contracts/test/DC_Test.sol

@@ -14,7 +14,7 @@ import {NetworkDetector} from "@gearbox-protocol/sdk-gov/contracts/NetworkDetect
 
 import "forge-std/console.sol";
 
-address constant ap = 0xfb78A83730aBd595A362645368D10fE5a20525a6;
+address constant ap = 0x9ea7b04Da02a5373317D745c1571c84aaD03321D;
 
 contract DCTest {
     DataCompressorV2_10 public dc2;

package/package.json

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

package/contracts/test/DC_Printer.sol

@@ -1,136 +0,0 @@
-// 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 {NetworkDetector} from "@gearbox-protocol/sdk-gov/contracts/NetworkDetector.sol";
-
-import "forge-std/console.sol";
-
-address constant ap = 0x5BcB06c56e8F28da0b038a373199240ca3F5a2f4;
-
-contract DCPrinterTest {
-    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("baseInterestIndex: ", pool.baseInterestIndex);
-                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("lastBaseInterestUpdate:", pool.lastBaseInterestUpdate);
-                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 view liveTestOnly {
-        CreditAccountData[] memory cas = dc2.getCreditAccountsByBorrower(address(this));
-        console.log("V2 credit accounts", cas.length);
-    }
-}