Merge pull request #22 from Gearbox-protocol/token_compressor

0xmikko · web-flow · commit bdf87ce2dd59 · 2024-09-11T20:59:19.000+02:00
fix: add token compressor to market compressor
diff --git a/contracts/compressors/MarketCompressor.sol b/contracts/compressors/MarketCompressor.sol
@@ -17,11 +17,13 @@ import {MarketFilter} from "../types/CreditAccountState.sol";
 
 import {PoolCompressorV3} from "./PoolCompressor.sol";
 import {PriceFeedCompressor} from "./PriceFeedCompressor.sol";
+import {TokenCompressor} from "./TokenCompressor.sol";
 
 // // EXCEPTIONS
 // import "@gearbox-protocol/core-v3/contracts/interfaces/IExceptions.sol";
 
-import {MarketData, TokenInfo} from "../types/MarketData.sol";
+import {MarketData} from "../types/MarketData.sol";
+import {TokenData} from "../types/TokenData.sol";
 import {PoolState} from "../types/PoolState.sol";
 
 import {IMarketCompressor} from "../interfaces/IMarketCompressor.sol";
@@ -41,6 +43,7 @@ contract MarketCompressor is IMarketCompressor {
     /// @notice Address provider contract address
     address public immutable ADDRESS_PROVIDER;
 
+    TokenCompressor tokenCompressor;
     PriceFeedCompressor priceOracleCompressor;
     PoolCompressorV3 poolCompressor;
 
@@ -49,15 +52,12 @@ contract MarketCompressor is IMarketCompressor {
     constructor(address addressProvider, address priceOracleCompressorAddress) {
         ADDRESS_PROVIDER = addressProvider;
         addressProvider = addressProvider;
+        tokenCompressor = new TokenCompressor();
         poolCompressor = new PoolCompressorV3();
-        priceOracleCompressor = PriceFeedCompressor(
-            priceOracleCompressorAddress
-        );
+        priceOracleCompressor = PriceFeedCompressor(priceOracleCompressorAddress);
     }
 
-    function getMarkets(
-        MarketFilter memory filter
-    ) external view returns (MarketData[] memory result) {
+    function getMarkets(MarketFilter memory filter) external view returns (MarketData[] memory result) {
         address[] memory pools = _getPools(filter);
         result = new MarketData[](pools.length);
 
@@ -66,59 +66,39 @@ contract MarketCompressor is IMarketCompressor {
         }
     }
 
-    function getMarketData(
-        address pool
-    ) public view returns (MarketData memory result) {
+    function getMarketData(address pool) public view returns (MarketData memory result) {
         result.pool = poolCompressor.getPoolState(pool);
-        result.poolQuotaKeeper = poolCompressor.getPoolQuotaKeeperState(
-            result.pool.poolQuotaKeeper
-        );
-        result.rateKeeper = poolCompressor.getRateKeeperState(
-            result.poolQuotaKeeper.rateKeeper
-        );
-        result.interestRateModel = poolCompressor.getInterestModelState(
-            result.pool.interestRateModel
-        );
+        result.poolQuotaKeeper = poolCompressor.getPoolQuotaKeeperState(result.pool.poolQuotaKeeper);
+        result.rateKeeper = poolCompressor.getRateKeeperState(result.poolQuotaKeeper.rateKeeper);
+        result.interestRateModel = poolCompressor.getInterestModelState(result.pool.interestRateModel);
 
         address priceOracle = _getPriceOracle(result.pool);
-        address[] memory tokens = IPoolQuotaKeeperV3(
-            result.pool.poolQuotaKeeper
-        ).quotedTokens();
+        address[] memory tokens = IPoolQuotaKeeperV3(result.pool.poolQuotaKeeper).quotedTokens();
 
-        // TODO: add token data
-        result.tokens = new TokenInfo[](tokens.length + 1);
-        // result.tokens[0] = tokenCompressor.getTokenInfo(result.pool.underlying);
+        result.tokens = new TokenData[](tokens.length + 1);
+        address[] memory underlyingAndTokens = new address[](tokens.length + 1);
+        result.tokens[0] = tokenCompressor.getTokenInfo(result.pool.underlying);
+        underlyingAndTokens[0] = result.pool.underlying;
 
-        // for (uint256 i = 0; i < tokens.length; i++) {
-        //     result.tokens[i + 1] = tokenCompressor.getTokenInfo(tokens[i]);
-        // }
+        for (uint256 i = 0; i < tokens.length; i++) {
+            result.tokens[i + 1] = tokenCompressor.getTokenInfo(tokens[i]);
+            underlyingAndTokens[i + 1] = tokens[i];
+        }
         // How to query if no credit mangers are deployed?
-        // //
-        // TODO: add local address[]
-        // result.priceOracleData = priceOracleCompressor.getPriceOracleState(
-        //     priceOracle,
-        //     result.tokens
-        // );
+        result.priceOracleData = priceOracleCompressor.getPriceOracleState(priceOracle, underlyingAndTokens);
     }
 
-    function _getPriceOracle(
-        PoolState memory ps
-    ) internal view returns (address) {
+    function _getPriceOracle(PoolState memory ps) internal view returns (address) {
         if (ps.creditManagerDebtParams.length == 0) {
             return address(0);
         }
 
-        return
-            ICreditManagerV3(ps.creditManagerDebtParams[0].creditManager)
-                .priceOracle();
+        return ICreditManagerV3(ps.creditManagerDebtParams[0].creditManager).priceOracle();
     }
 
     /// @dev Pools discovery
-    function _getPools(
-        MarketFilter memory filter
-    ) internal view returns (address[] memory pools) {
-        address[] memory configurators = IAddressProviderV3_1(ADDRESS_PROVIDER)
-            .marketConfigurators();
+    function _getPools(MarketFilter memory filter) internal view returns (address[] memory pools) {
+        address[] memory configurators = IAddressProviderV3_1(ADDRESS_PROVIDER).marketConfigurators();
 
         // rough estimate of maximum number of credit pools
         uint256 max;
@@ -133,24 +113,20 @@ contract MarketCompressor is IMarketCompressor {
 
         for (uint256 i; i < configurators.length; ++i) {
             if (filter.curators.length != 0) {
-                if (
-                    !filter.curators.contains(
-                        IMarketConfiguratorV3(configurators[i]).owner()
-                    )
-                ) continue;
+                if (!filter.curators.contains(IMarketConfiguratorV3(configurators[i]).owner())) continue;
             }
 
-            address[] memory poolsMC = IMarketConfiguratorV3(configurators[i])
-                .pools();
+            address[] memory poolsMC = IMarketConfiguratorV3(configurators[i]).pools();
             for (uint256 j; j < poolsMC.length; ++j) {
                 address currentPool = poolsMC[j];
                 if (filter.pools.length != 0) {
                     if (!filter.pools.contains(currentPool)) continue;
                 }
 
                 if (filter.underlying != address(0)) {
-                    if (IPoolV3(currentPool).asset() != filter.underlying)
+                    if (IPoolV3(currentPool).asset() != filter.underlying) {
                         continue;
+                    }
                 }
 
                 pools[num++] = currentPool;
diff --git a/contracts/compressors/TokenCompressor.sol b/contracts/compressors/TokenCompressor.sol
@@ -3,13 +3,20 @@
 // (c) Gearbox Foundation, 2024.
 pragma solidity ^0.8.17;
 
-import {TokenInfo} from "../types/MarketData.sol";
+import {TokenData} from "../types/TokenData.sol";
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 import {LibString} from "@solady/utils/LibString.sol";
+import {ITokenCompressor} from "../interfaces/ITokenCompressor.sol";
 
-contract TokenCompressor {
-    function getTokenInfo(address token) public view returns (TokenInfo memory result) {
-        result.token = token;
+/// @title Token compressor 3.0.
+/// @notice Helper contract to fetch ERC20 token metadata
+contract TokenCompressor is ITokenCompressor {
+    /// @notice Contract version
+    uint256 public constant override version = 3_10;
+    bytes32 public constant override contractType = "TOKEN_COMPRESSOR";
+
+    function getTokenInfo(address token) public view returns (TokenData memory result) {
+        result.addr = token;
         result.decimals = IERC20Metadata(token).decimals();
 
         // Fallback to low-level call to handle bytes32 symbol
diff --git a/contracts/interfaces/IMarketCompressor.sol b/contracts/interfaces/IMarketCompressor.sol
@@ -3,8 +3,6 @@ import {PoolState} from "../types/PoolState.sol";
 import {IVersion} from "@gearbox-protocol/core-v3/contracts/interfaces/base/IVersion.sol";
 import {MarketFilter} from "../types/CreditAccountState.sol";
 
-import "forge-std/console.sol";
-
 /// @title Data compressor 3.0.
 /// @notice Collects data from various contracts for use in the dApp
 /// Do not use for data from data compressor for state-changing functions
diff --git a/contracts/interfaces/ITokenCompressor.sol b/contracts/interfaces/ITokenCompressor.sol
@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: BUSL-1.1
+// Gearbox Protocol. Generalized leverage for DeFi protocols
+// (c) Gearbox Holdings, 2024
+pragma solidity ^0.8.10;
+
+import {TokenData} from "../types/TokenData.sol";
+import {IVersion} from "@gearbox-protocol/core-v3/contracts/interfaces/base/IVersion.sol";
+
+/// @title Token compressor 3.0.
+/// @notice Helper contract to fetch ERC20 token metadata
+interface ITokenCompressor is IVersion {
+    function getTokenInfo(address token) external view returns (TokenData memory result);
+}
diff --git a/contracts/types/MarketData.sol b/contracts/types/MarketData.sol
@@ -11,6 +11,7 @@ import {PriceOracleState} from "./PriceOracleState.sol";
 import {CreditManagerState} from "./CreditManagerState.sol";
 import {CreditFacadeState} from "./CreditFacadeState.sol";
 import {BaseState, BaseParams} from "./BaseState.sol";
+import {TokenData} from "./TokenData.sol";
 
 struct MarketData {
     // MarketConfigurator baseParams
@@ -26,7 +27,7 @@ struct MarketData {
     BaseState interestRateModel;
     RateKeeperState rateKeeper;
     PriceOracleState priceOracleData;
-    TokenInfo[] tokens; // <- V3: collateral tokens, V3.1. from local price oracle
+    TokenData[] tokens; // <- V3: collateral tokens, V3.1. from local price oracle
     CreditManagerData[] creditManagers;
     // ZappersInfo
     ZapperInfo[] zappers;
@@ -44,13 +45,6 @@ struct ZapperInfo {
     address tokenOut;
 }
 
-struct TokenInfo {
-    address token;
-    uint8 decimals;
-    string symbol;
-    string name;
-}
-
 struct ContractAdapter {
     BaseParams baseParams;
     address targetContract;
