@gearbox-protocol/periphery-v3 1.0.9 → 1.2.0

package/contracts/data/DataCompressor_2_1.sol

@@ -116,6 +116,7 @@ contract DataCompressorV2_10 is IDataCompressorV2_10, ContractsRegisterTrait, Li
 
         address pool = creditManagerV2.pool();
         result.baseBorrowRate = IPoolService(pool).borrowAPY_RAY();
+        result.aggregatedBorrowRate = result.baseBorrowRate;
 
         uint256 collateralTokenCount = creditManagerV2.collateralTokensCount();
 

package/contracts/data/DataCompressor_3_0.sol

@@ -4,6 +4,7 @@
 pragma solidity ^0.8.10;
 pragma experimental ABIEncoderV2;
 
+import "@gearbox-protocol/core-v3/contracts/interfaces/IAddressProviderV3.sol";
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import {PERCENTAGE_FACTOR, RAY} from "@gearbox-protocol/core-v2/contracts/libraries/Constants.sol";
 
@@ -38,6 +39,7 @@ import {IVersion} from "@gearbox-protocol/core-v2/contracts/interfaces/IVersion.
 
 import {AddressProvider} from "@gearbox-protocol/core-v2/contracts/core/AddressProvider.sol";
 import {IDataCompressorV3_00, PriceOnDemand} from "../interfaces/IDataCompressorV3_00.sol";
+import {IZapper} from "@gearbox-protocol/integrations-v3/contracts/interfaces/zappers/IZapper.sol";
 
 import {
     COUNT,
@@ -51,12 +53,14 @@ import {
     GaugeInfo,
     GaugeQuotaParams,
     CreditManagerDebtParams,
-    GaugeVote
+    GaugeVote,
+    ZapperInfo
 } from "./Types.sol";
 
 // EXCEPTIONS
 import "@gearbox-protocol/core-v3/contracts/interfaces/IExceptions.sol";
 import {LinearInterestModelHelper} from "./LinearInterestModelHelper.sol";
+import {ZapperRegister} from "./ZapperRegister.sol";
 
 /// @title Data compressor 3.0.
 /// @notice Collects data from various contracts for use in the dApp
@@ -65,9 +69,14 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
     // Contract version
     uint256 public constant version = 3_00;
 
+    ZapperRegister public zapperRegister;
+
     error CreditManagerIsNotV3Exception();
 
-    constructor(address _addressProvider) ContractsRegisterTrait(_addressProvider) {}
+    constructor(address _addressProvider) ContractsRegisterTrait(_addressProvider) {
+        zapperRegister =
+            ZapperRegister(IAddressProviderV3(_addressProvider).getAddressOrRevert("ZAPPER_REGISTER", 3_00));
+    }
 
     /// @dev Returns CreditAccountData for all opened accounts for particular borrower
     /// @param borrower Borrower address
@@ -194,6 +203,8 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
         result.enabledTokensMask = creditManager.enabledTokensMaskOf(_creditAccount);
 
         result.balances = new TokenBalance[](collateralTokenCount);
+
+        uint256 quotaRevenue = 0;
         {
             uint256 forbiddenTokenMask = creditFacade.forbiddenTokenMask();
             uint256 quotedTokensMask = creditManager.quotedTokensMask();
@@ -215,6 +226,8 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
                     if (balance.isQuoted) {
                         (balance.quota,) = pqk.getQuota(_creditAccount, balance.token);
                         balance.quotaRate = pqk.getQuotaRate(balance.token);
+
+                        quotaRevenue += balance.quota * balance.quotaRate;
                     }
 
                     result.balances[i] = balance;
@@ -222,6 +235,8 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
             }
         }
 
+        result.aggregatedBorrowRate = result.baseBorrowRate + RAY * quotaRevenue / PERCENTAGE_FACTOR / result.debt;
+
         // uint256 debt;
         // uint256 cumulativeIndexNow;
         // uint256 cumulativeIndexLastUpdate;
@@ -435,12 +450,26 @@ contract DataCompressorV3_00 is IDataCompressorV3_00, ContractsRegisterTrait, Li
 
         result.supplyRate = pool.supplyRate();
 
-        result.version = uint8(pool.version());
+        result.version = pool.version();
 
         result.quotas = _getQuotas(_pool);
         result.lirm = getLIRMData(pool.interestRateModel());
         result.isPaused = pool.paused();
 
+        address[] memory zappers = zapperRegister.zappers(address(pool));
+        len = zappers.length;
+        result.zappers = new ZapperInfo[](len);
+
+        unchecked {
+            for (uint256 i; i < len; ++i) {
+                address tokenFrom = IZapper(zappers[i]).unwrappedToken();
+                result.zappers[i] = ZapperInfo({tokenFrom: tokenFrom, zapper: zappers[i]});
+            }
+        }
+
+        result.poolQuotaKeeper = pool.poolQuotaKeeper();
+        result.gauge = IPoolQuotaKeeperV3(result.poolQuotaKeeper).gauge();
+
         return result;
     }
 

package/contracts/data/Types.sol

@@ -32,6 +32,11 @@ struct ContractAdapter {
     address adapter;
 }
 
+struct ZapperInfo {
+    address tokenFrom;
+    address zapper;
+}
+
 struct CreditAccountData {
     // if not successful, priceFeedsNeeded are filled with the data
     bool isSuccessful;
@@ -137,7 +142,10 @@ struct PoolData {
     uint256 cumulativeIndex_RAY;
     uint256 baseInterestIndexLU;
     uint256 version;
+    address poolQuotaKeeper;
+    address gauge;
     QuotaInfo[] quotas;
+    ZapperInfo[] zappers;
     LinearModel lirm;
     bool isPaused;
 }

package/contracts/data/ZapperRegister.sol

@@ -0,0 +1,44 @@
+// SPDX-License-Identifier: BUSL-1.1
+// Gearbox Protocol. Generalized leverage for DeFi protocols
+// (c) Gearbox Holdings, 2023
+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 {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 {
+    using EnumerableSet for EnumerableSet.AddressSet;
+
+    mapping(address => EnumerableSet.AddressSet) internal _zappersMap;
+
+    constructor(address addressProvider)
+        ACLNonReentrantTrait(addressProvider)
+        ContractsRegisterTrait(addressProvider)
+    {}
+
+    function addZapper(address zapper) external nonZeroAddress(zapper) controllerOnly {
+        address pool = IZapper(zapper).pool();
+        _ensureRegisteredPool(pool);
+
+        EnumerableSet.AddressSet storage zapperSet = _zappersMap[pool];
+        if (!zapperSet.contains(zapper)) {
+            zapperSet.add(zapper);
+            emit AddZapper(zapper);
+        }
+    }
+
+    function removeZapper(address zapper) external nonZeroAddress(zapper) controllerOnly {
+        EnumerableSet.AddressSet storage zapperSet = _zappersMap[IZapper(zapper).pool()];
+        if (zapperSet.contains(zapper)) {
+            zapperSet.remove(zapper);
+            emit RemoveZapper(zapper);
+        }
+    }
+
+    function zappers(address pool) external view override returns (address[] memory) {
+        return _zappersMap[pool].values();
+    }
+}

package/contracts/interfaces/IZapperRegistry.sol

@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: BUSL-1.1
+// Gearbox Protocol. Generalized leverage for DeFi protocols
+// (c) Gearbox Holdings, 2023
+pragma solidity ^0.8.10;
+
+interface IZapperRegistry {
+    event AddZapper(address);
+    event RemoveZapper(address);
+
+    function zappers(address pool) external view returns (address[] memory);
+}

package/contracts/test/DC_Printer.sol

@@ -9,6 +9,8 @@ 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;
@@ -17,7 +19,20 @@ contract DCTest {
     DataCompressorV2_10 public dc2;
     DataCompressorV3_00 public dc3;
 
-    function setUp() public {
+    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);
     }
@@ -94,7 +109,7 @@ contract DCTest {
         }
     }
 
-    function test_dc_01_pools() public view {
+    function test_dc_01_pools() public view liveTestOnly {
         PoolData[] memory pools = dc2.getPoolsV1List();
         console.log("V1 pools");
         _printPools(pools);
@@ -104,7 +119,7 @@ contract DCTest {
         _printPools(pools);
     }
 
-    function test_dc_02_credit_managers() public view {
+    function test_dc_02_credit_managers() public view liveTestOnly {
         CreditManagerData[] memory cms = dc2.getCreditManagersV2List();
         console.log("V2 credit managers");
         _printCreditManagers(cms);
@@ -114,7 +129,7 @@ contract DCTest {
         _printCreditManagers(cms);
     }
 
-    function test_dc_03_credit_accounts() public view {
+    function test_dc_03_credit_accounts() public view liveTestOnly {
         CreditAccountData[] memory cas = dc2.getCreditAccountsByBorrower(address(this));
         console.log("V2 credit accounts", cas.length);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gearbox-protocol/periphery-v3",
-  "version": "1.0.9",
+  "version": "1.2.0",
   "main": "index.js",
   "repository": "git@github.com:Gearbox-protocol/periphery-v3.git",
   "author": "Mikael <26343374+0xmikko@users.noreply.github.com>",
@@ -21,7 +21,10 @@
     "@gearbox-protocol/core-v3": "^1.39.0",
     "@gearbox-protocol/oracles-v3": "^1.7.2",
     "@gearbox-protocol/sdk-gov": "^1.5.10",
-    "@openzeppelin/contracts": "4.8.3",
+    "@gearbox-protocol/integrations-v3": "^1.16.0",
+    "@openzeppelin/contracts": "4.8.3"
+  },
+  "dependencies": {
     "husky": "^8.0.3",
     "lint-staged": "^13.0.3",
     "prettier": "^3.0.3"