@gearbox-protocol/periphery-v3 1.7.0-next.25 → 1.7.0-next.26

package/contracts/compressors/PoolCompressor.sol

@@ -24,8 +24,8 @@ import {PERCENTAGE_FACTOR, RAY} from "@gearbox-protocol/core-v3/contracts/librar
 import {IRateKeeper} from "@gearbox-protocol/core-v3/contracts/interfaces/base/IRateKeeper.sol";
 
 // Serializers
-import {IStateSerializer} from "../interfaces/IStateSerializer.sol";
-import {IStateSerializerLegacy} from "../interfaces/IStateSerializerLegacy.sol";
+import {BaseLib} from "../libraries/BaseLib.sol";
+
 import {GaugeSerializer} from "../serializers/pool/GaugeSerializer.sol";
 import {LinearInterestModelSerializer} from "../serializers/pool/LinearInterestModelSerializer.sol";
 
@@ -42,19 +42,15 @@ contract PoolCompressorV3 {
 
     constructor() {
         gaugeSerializer = address(new GaugeSerializer());
-        linearInterestModelSerializer = address(
-            new LinearInterestModelSerializer()
-        );
+        linearInterestModelSerializer = address(new LinearInterestModelSerializer());
     }
 
-    function getPoolState(
-        address pool
-    ) public view returns (PoolState memory result) {
+    function getPoolState(address pool) public view returns (PoolState memory result) {
         PoolV3 _pool = PoolV3(pool);
         //
         // CONTRACT PARAMETERS
         //
-        result.baseParams = getBaseParams(pool, "POOL", address(0));
+        result.baseParams = BaseLib.getBaseParams(pool, "POOL", address(0));
 
         //
         // ERC20 Properties
@@ -139,12 +135,10 @@ contract PoolCompressorV3 {
         result.isPaused = _pool.paused();
     }
 
-    function getPoolQuotaKeeperState(
-        address pqk
-    ) external view returns (PoolQuotaKeeperState memory result) {
+    function getPoolQuotaKeeperState(address pqk) external view returns (PoolQuotaKeeperState memory result) {
         IPoolQuotaKeeperV3 _pqk = IPoolQuotaKeeperV3(pqk);
 
-        result.baseParams = getBaseParams(pqk, "POOL_QUOTA_KEEPER", address(0));
+        result.baseParams = BaseLib.getBaseParams(pqk, "POOL_QUOTA_KEEPER", address(0));
 
         // address rateKeeper;
         result.rateKeeper = _pqk.gauge();
@@ -173,18 +167,14 @@ contract PoolCompressorV3 {
         result.lastQuotaRateUpdate = _pqk.lastQuotaRateUpdate();
     }
 
-    function getRateKeeperState(
-        address rateKeeper
-    ) external view returns (RateKeeperState memory result) {
+    function getRateKeeperState(address rateKeeper) external view returns (RateKeeperState memory result) {
         IRateKeeper _rateKeeper = IRateKeeper(rateKeeper);
 
         bytes32 contractType;
 
-        result.baseParams = getBaseParams(rateKeeper, "GAUGE", gaugeSerializer);
+        result.baseParams = BaseLib.getBaseParams(rateKeeper, "GAUGE", gaugeSerializer);
 
-        IPoolQuotaKeeperV3 _pqk = IPoolQuotaKeeperV3(
-            PoolV3(_rateKeeper.pool()).poolQuotaKeeper()
-        );
+        IPoolQuotaKeeperV3 _pqk = IPoolQuotaKeeperV3(PoolV3(_rateKeeper.pool()).poolQuotaKeeper());
 
         address[] memory quotaTokens = _pqk.quotedTokens();
         uint256 quotaTokensLen = quotaTokens.length;
@@ -200,18 +190,12 @@ contract PoolCompressorV3 {
 
     /// @dev Returns CreditManagerData for a particular _cm
     /// @param _cm CreditManager address
-    function getCreditManagerState(
-        address _cm
-    ) public view returns (CreditManagerState memory result) {
+    function getCreditManagerState(address _cm) public view returns (CreditManagerState memory result) {
         ICreditManagerV3 creditManager = ICreditManagerV3(_cm);
-        ICreditConfiguratorV3 creditConfigurator = ICreditConfiguratorV3(
-            creditManager.creditConfigurator()
-        );
-        CreditFacadeV3 creditFacade = CreditFacadeV3(
-            creditManager.creditFacade()
-        );
-
-        result.baseParams = getBaseParams(_cm, "CREDIT_MANAGER", address(0));
+        ICreditConfiguratorV3 creditConfigurator = ICreditConfiguratorV3(creditManager.creditConfigurator());
+        CreditFacadeV3 creditFacade = CreditFacadeV3(creditManager.creditFacade());
+
+        result.baseParams = BaseLib.getBaseParams(_cm, "CREDIT_MANAGER", address(0));
         // string name;
         result.name = ICreditManagerV3(_cm).name();
 
@@ -232,18 +216,15 @@ contract PoolCompressorV3 {
         // address[] collateralTokens;
         // uint16[] liquidationThresholds;
         {
-            uint256 collateralTokenCount = creditManager
-                .collateralTokensCount();
+            uint256 collateralTokenCount = creditManager.collateralTokensCount();
 
             result.collateralTokens = new address[](collateralTokenCount);
             result.liquidationThresholds = new uint16[](collateralTokenCount);
 
             unchecked {
                 for (uint256 i = 0; i < collateralTokenCount; ++i) {
-                    (
-                        result.collateralTokens[i],
-                        result.liquidationThresholds[i]
-                    ) = creditManager.collateralTokenByMask(1 << i);
+                    (result.collateralTokens[i], result.liquidationThresholds[i]) =
+                        creditManager.collateralTokenByMask(1 << i);
                 }
             }
         }
@@ -265,12 +246,10 @@ contract PoolCompressorV3 {
 
     /// @dev Returns CreditManagerData for a particular _cm
     /// @param _cf CreditFacade address
-    function getCreditFacadeState(
-        address _cf
-    ) public view returns (CreditFacadeState memory result) {
+    function getCreditFacadeState(address _cf) public view returns (CreditFacadeState memory result) {
         CreditFacadeV3 creditFacade = CreditFacadeV3(_cf);
 
-        result.baseParams = getBaseParams(_cf, "CREDIT_FACADE", address(0));
+        result.baseParams = BaseLib.getBaseParams(_cf, "CREDIT_FACADE", address(0));
         //
         result.maxQuotaMultiplier = creditFacade.maxQuotaMultiplier();
         // address treasury;
@@ -282,8 +261,7 @@ contract PoolCompressorV3 {
         // uint40 expirationDate;
         result.expirationDate = creditFacade.expirationDate();
         // uint8 maxDebtPerBlockMultiplier;
-        result.maxDebtPerBlockMultiplier = creditFacade
-            .maxDebtPerBlockMultiplier();
+        result.maxDebtPerBlockMultiplier = creditFacade.maxDebtPerBlockMultiplier();
         // address botList;
         result.botList = creditFacade.botList();
         // uint256 minDebt;
@@ -297,52 +275,7 @@ contract PoolCompressorV3 {
         result.isPaused = creditFacade.paused();
     }
 
-    function getBaseParams(
-        address addr,
-        bytes32 defaultContractType,
-        address legacySerializer
-    ) public view returns (BaseParams memory baseParams) {
-        baseParams.addr = addr;
-        try IVersion(addr).contractType() returns (bytes32 contractType) {
-            baseParams.contractType = contractType;
-        } catch {
-            baseParams.version = 3_00;
-            baseParams.contractType = defaultContractType;
-        }
-
-        baseParams.version = IVersion(addr).version();
-        try IStateSerializer(addr).serialize() returns (
-            bytes memory serializedParams
-        ) {
-            baseParams.serializedParams = serializedParams;
-        } catch {
-            if (legacySerializer != address(0)) {
-                baseParams.serializedParams = IStateSerializerLegacy(
-                    legacySerializer
-                ).serialize(addr);
-            }
-        }
-    }
-
-    function getBaseState(
-        address addr,
-        bytes32 defaultContractType,
-        address legacySerializer
-    ) public view returns (BaseState memory baseState) {
-        baseState.baseParams = getBaseParams(
-            addr,
-            defaultContractType,
-            legacySerializer
-        );
-    }
-
-    function getInterestModelState(
-        address addr
-    ) public view returns (BaseState memory baseState) {
-        baseState = getBaseState(
-            addr,
-            "INTEREST_MODEL",
-            linearInterestModelSerializer
-        );
+    function getInterestModelState(address addr) public view returns (BaseState memory baseState) {
+        baseState = BaseLib.getBaseState(addr, "INTEREST_MODEL", linearInterestModelSerializer);
     }
 }

package/contracts/compressors/PriceFeedCompressor.sol

@@ -10,6 +10,8 @@ import {IPriceFeedCompressor} from "../interfaces/IPriceFeedCompressor.sol";
 import {PriceFeedType} from "@gearbox-protocol/sdk-gov/contracts/PriceFeedType.sol";
 import {IVersion} from "../interfaces/IVersion.sol";
 
+import {BaseLib} from "../libraries/BaseLib.sol";
+
 import {IStateSerializerLegacy} from "../interfaces/IStateSerializerLegacy.sol";
 import {IStateSerializer} from "../interfaces/IStateSerializer.sol";
 import {NestedPriceFeeds} from "../libraries/NestedPriceFeeds.sol";
@@ -45,32 +47,50 @@ contract PriceFeedCompressor is IPriceFeedCompressor {
 
     /// @notice Map of state serializers for different price feed types
     /// @dev    Serializers only apply to feeds that don't implement `IStateSerializer` themselves
-    mapping(uint8 => address) public serializers;
+    mapping(bytes32 => address) public serializers;
+
+    mapping(uint8 => bytes32) public contractTypes;
 
     /// @notice Constructor
     /// @dev    Sets serializers for existing price feed types.
     ///         It is recommended to implement `IStateSerializer` in new price feeds.
     constructor() {
         address lpSerializer = address(new LPPriceFeedSerializer());
+
+        contractTypes[uint8(PriceFeedType.BALANCER_STABLE_LP_ORACLE)] = "PF_BALANCER_STABLE_LP_ORACLE";
+        contractTypes[uint8(PriceFeedType.COMPOUND_V2_ORACLE)] = "NOT_USED";
+        contractTypes[uint8(PriceFeedType.CURVE_2LP_ORACLE)] = "PF_CURVE_STABLE_LP_ORACLE";
+        contractTypes[uint8(PriceFeedType.CURVE_3LP_ORACLE)] = "PF_CURVE_STABLE_LP_ORACLE";
+        contractTypes[uint8(PriceFeedType.CURVE_4LP_ORACLE)] = "PF_CURVE_STABLE_LP_ORACLE";
+        contractTypes[uint8(PriceFeedType.CURVE_CRYPTO_ORACLE)] = "PF_CURVE_CRYPTO_LP_ORACLE";
+        contractTypes[uint8(PriceFeedType.CURVE_USD_ORACLE)] = "PF_CURVE_USD_ORACLE";
+        contractTypes[uint8(PriceFeedType.ERC4626_VAULT_ORACLE)] = "PF_ERC4626_ORACLE";
+        contractTypes[uint8(PriceFeedType.WRAPPED_AAVE_V2_ORACLE)] = "NOT_USER";
+        contractTypes[uint8(PriceFeedType.WSTETH_ORACLE)] = "PF_WSTETH_ORACLE";
+        contractTypes[uint8(PriceFeedType.YEARN_ORACLE)] = "PF_YEARN_ORACLE";
+        contractTypes[uint8(PriceFeedType.MELLOW_LRT_ORACLE)] = "PF_MELLOW_LRT_ORACLE";
+
+        // these types need special serialization
+        contractTypes[uint8(PriceFeedType.BALANCER_WEIGHTED_LP_ORACLE)] = "PF_BALANCER_WEIGHTED_LP_ORACLE";
+        contractTypes[uint8(PriceFeedType.BOUNDED_ORACLE)] = "PF_BOUNDED_ORACLE";
+        contractTypes[uint8(PriceFeedType.PYTH_ORACLE)] = "PF_PYTH_ORACLE";
+        contractTypes[uint8(PriceFeedType.REDSTONE_ORACLE)] = "PF_REDSTONE_ORACLE";
+
         // these types can be serialized as generic LP price feeds
-        _setSerializer(uint8(PriceFeedType.BALANCER_STABLE_LP_ORACLE), lpSerializer);
-        _setSerializer(uint8(PriceFeedType.COMPOUND_V2_ORACLE), lpSerializer);
-        _setSerializer(uint8(PriceFeedType.CURVE_2LP_ORACLE), lpSerializer);
-        _setSerializer(uint8(PriceFeedType.CURVE_3LP_ORACLE), lpSerializer);
-        _setSerializer(uint8(PriceFeedType.CURVE_4LP_ORACLE), lpSerializer);
-        _setSerializer(uint8(PriceFeedType.CURVE_CRYPTO_ORACLE), lpSerializer);
-        _setSerializer(uint8(PriceFeedType.CURVE_USD_ORACLE), lpSerializer);
-        _setSerializer(uint8(PriceFeedType.ERC4626_VAULT_ORACLE), lpSerializer);
-        _setSerializer(uint8(PriceFeedType.WRAPPED_AAVE_V2_ORACLE), lpSerializer);
-        _setSerializer(uint8(PriceFeedType.WSTETH_ORACLE), lpSerializer);
-        _setSerializer(uint8(PriceFeedType.YEARN_ORACLE), lpSerializer);
-        _setSerializer(uint8(PriceFeedType.MELLOW_LRT_ORACLE), lpSerializer);
+        _setSerializer("PF_BALANCER_STABLE_LP_ORACLE", lpSerializer);
+        _setSerializer("PF_CURVE_STABLE_LP_ORACLE", lpSerializer);
+        _setSerializer("PF_CURVE_CRYPTO_LP_ORACLE", lpSerializer);
+        _setSerializer("PF_CURVE_USD_ORACLE", lpSerializer);
+        _setSerializer("PF_ERC4626_ORACLE", lpSerializer);
+        _setSerializer("PF_WSTETH_ORACLE", lpSerializer);
+        _setSerializer("PF_YEARN_ORACLE", lpSerializer);
+        _setSerializer("PF_MELLOW_LRT_ORACLE", lpSerializer);
 
         // these types need special serialization
-        _setSerializer(uint8(PriceFeedType.BALANCER_WEIGHTED_LP_ORACLE), address(new BPTWeightedPriceFeedSerializer()));
-        _setSerializer(uint8(PriceFeedType.BOUNDED_ORACLE), address(new BoundedPriceFeedSerializer()));
-        _setSerializer(uint8(PriceFeedType.PYTH_ORACLE), address(new PythPriceFeedSerializer()));
-        _setSerializer(uint8(PriceFeedType.REDSTONE_ORACLE), address(new RedstonePriceFeedSerializer()));
+        _setSerializer("PF_BALANCER_WEIGHTED_LP_ORACLE", address(new BPTWeightedPriceFeedSerializer()));
+        _setSerializer("PF_BOUNDED_ORACLE", address(new BoundedPriceFeedSerializer()));
+        _setSerializer("PF_PYTH_ORACLE", address(new PythPriceFeedSerializer()));
+        _setSerializer("PF_REDSTONE_ORACLE", address(new RedstonePriceFeedSerializer()));
     }
 
     /// @notice Returns all potentially useful price feeds data for a given price oracle in the form of two arrays:
@@ -94,14 +114,7 @@ contract PriceFeedCompressor is IPriceFeedCompressor {
         view
         returns (PriceOracleState memory result)
     {
-        result.addr = priceOracle;
-        result.version = IPriceOracleV3(priceOracle).version();
-        try IVersion(priceOracle).contractType() returns (bytes32 contractType) {
-            result.contractType = contractType;
-        } catch {
-            result.contractType = "PRICE_ORACLE";
-        }
-
+        result.baseParams = BaseLib.getBaseParams(priceOracle, "PRICE_ORACLE", address(0));
         (result.priceFeedMapping, result.priceFeedStructure) = getPriceFeeds(priceOracle, tokens);
     }
 
@@ -177,10 +190,10 @@ contract PriceFeedCompressor is IPriceFeedCompressor {
     // --------- //
 
     /// @dev Sets `serializer` for `priceFeedType`
-    function _setSerializer(uint8 priceFeedType, address serializer) internal {
-        if (serializers[priceFeedType] != serializer) {
-            serializers[priceFeedType] = serializer;
-            emit SetSerializer(priceFeedType, serializer);
+    function _setSerializer(bytes32 contractType, address serializer) internal {
+        if (serializers[contractType] != serializer) {
+            serializers[contractType] = serializer;
+            emit SetSerializer(contractType, serializer);
         }
     }
 
@@ -218,7 +231,7 @@ contract PriceFeedCompressor is IPriceFeedCompressor {
         // duplicates are possible since price feed can be in `priceFeedMap` for more than one (token, reserve) pair
         // or serve as an underlying in more than one nested feed, and the whole subtree can be skipped in this case
         for (uint256 i; i < offset; ++i) {
-            if (priceFeedTree[i].priceFeed == priceFeed) return offset;
+            if (priceFeedTree[i].baseParams.addr == priceFeed) return offset;
         }
 
         PriceFeedTreeNode memory node = _getPriceFeedTreeNode(priceFeed);
@@ -231,16 +244,21 @@ contract PriceFeedCompressor is IPriceFeedCompressor {
 
     /// @dev Returns price feed tree node, see `PriceFeedTreeNode` for detailed description of struct fields
     function _getPriceFeedTreeNode(address priceFeed) internal view returns (PriceFeedTreeNode memory data) {
-        data.priceFeed = priceFeed;
-        data.decimals = IPriceFeed(priceFeed).decimals();
-        data.version = IPriceFeed(priceFeed).version();
-
-        try ImplementsPriceFeedType(priceFeed).priceFeedType() returns (uint8 priceFeedType) {
-            data.priceFeedType = priceFeedType;
+        try IVersion(priceFeed).contractType() returns (bytes32 contractType) {
+            data.baseParams.contractType = contractType;
         } catch {
-            data.priceFeedType = uint8(PriceFeedType.CHAINLINK_ORACLE);
+            try ImplementsPriceFeedType(priceFeed).priceFeedType() returns (uint8 priceFeedType) {
+                data.baseParams.contractType = contractTypes[priceFeedType];
+            } catch {
+                data.baseParams.contractType = "PF_CHAINLINK_ORACLE";
+            }
         }
 
+        data.baseParams =
+            BaseLib.getBaseParams(priceFeed, data.baseParams.contractType, serializers[data.baseParams.contractType]);
+
+        data.decimals = IPriceFeed(priceFeed).decimals();
+
         try IPriceFeed(priceFeed).skipPriceCheck() returns (bool skipCheck) {
             data.skipCheck = skipCheck;
         } catch {}
@@ -249,15 +267,6 @@ contract PriceFeedCompressor is IPriceFeedCompressor {
             data.updatable = updatable;
         } catch {}
 
-        try IStateSerializer(priceFeed).serialize() returns (bytes memory specificParams) {
-            data.specificParams = specificParams;
-        } catch {
-            address serializer = serializers[data.priceFeedType];
-            if (serializer != address(0)) {
-                data.specificParams = IStateSerializerLegacy(serializer).serialize(priceFeed);
-            }
-        }
-
         (data.underlyingFeeds, data.underlyingStalenessPeriods) = IPriceFeed(priceFeed).getUnderlyingFeeds();
 
         try IPriceFeed(priceFeed).latestRoundData() returns (uint80, int256 price, uint256, uint256 updatedAt, uint80) {

package/contracts/interfaces/IPriceFeedCompressor.sol

@@ -9,7 +9,7 @@ import {IVersion} from "@gearbox-protocol/core-v3/contracts/interfaces/base/IVer
 
 interface IPriceFeedCompressor is IVersion {
     /// @notice Emitted when new state serializer is set for a given price feed type
-    event SetSerializer(uint8 indexed priceFeedType, address indexed serializer);
+    event SetSerializer(bytes32 indexed contractType, address indexed serializer);
 
     function getPriceFeeds(address priceOracle)
         external

package/contracts/libraries/BaseLib.sol

@@ -0,0 +1,42 @@
+// SPDX-License-Identifier: MIT
+// Gearbox Protocol. Generalized leverage for DeFi protocols
+// (c) Gearbox Foundation, 2024.
+pragma solidity ^0.8.17;
+
+import {BaseParams, BaseState} from "../types/BaseState.sol";
+import {IVersion} from "../interfaces/IVersion.sol";
+import {IStateSerializer} from "../interfaces/IStateSerializer.sol";
+import {IStateSerializerLegacy} from "../interfaces/IStateSerializerLegacy.sol";
+
+library BaseLib {
+    function getBaseParams(address addr, bytes32 defaultContractType, address legacySerializer)
+        internal
+        view
+        returns (BaseParams memory baseParams)
+    {
+        baseParams.addr = addr;
+        try IVersion(addr).contractType() returns (bytes32 contractType) {
+            baseParams.contractType = contractType;
+        } catch {
+            baseParams.version = 3_00;
+            baseParams.contractType = defaultContractType;
+        }
+
+        baseParams.version = IVersion(addr).version();
+        try IStateSerializer(addr).serialize() returns (bytes memory serializedParams) {
+            baseParams.serializedParams = serializedParams;
+        } catch {
+            if (legacySerializer != address(0)) {
+                baseParams.serializedParams = IStateSerializerLegacy(legacySerializer).serialize(addr);
+            }
+        }
+    }
+
+    function getBaseState(address addr, bytes32 defaultContractType, address legacySerializer)
+        internal
+        view
+        returns (BaseState memory baseState)
+    {
+        baseState.baseParams = getBaseParams(addr, defaultContractType, legacySerializer);
+    }
+}

package/contracts/types/PriceOracleState.sol

@@ -3,10 +3,10 @@
 // (c) Gearbox Holdings, 2024
 pragma solidity ^0.8.17;
 
+import {BaseParams} from "./BaseState.sol";
+
 struct PriceOracleState {
-    address addr;
-    uint256 version;
-    bytes32 contractType;
+    BaseParams baseParams;
     PriceFeedMapEntry[] priceFeedMapping;
     PriceFeedTreeNode[] priceFeedStructure;
 }
@@ -45,9 +45,7 @@ struct PriceFeedMapEntry {
 /// @param  underlyingStalenessPeriods Staleness periods of underlying feeds, filled when `priceFeed` is nested
 /// @param  answer Price feed answer packed in a struct
 struct PriceFeedTreeNode {
-    address priceFeed;
-    uint8 priceFeedType;
-    uint256 version;
+    BaseParams baseParams;
     uint8 decimals;
     bool skipCheck;
     bool updatable;
@@ -55,5 +53,4 @@ struct PriceFeedTreeNode {
     address[] underlyingFeeds;
     uint32[] underlyingStalenessPeriods;
     PriceFeedAnswer answer;
-    bytes specificParams;
 }

package/package.json

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

package/contracts/types/ZapperRegisterState.sol

@@ -1,10 +0,0 @@
-// SPDX-License-Identifier: MIT
-// Gearbox Protocol. Generalized leverage for DeFi protocols
-// (c) Gearbox Holdings, 2024
-pragma solidity ^0.8.17;
-
-struct ZapperInfo {
-    address zapper;
-    address tokenIn;
-    address tokenOut;
-}