Fix supply and borrow cap visibility

Author: TRiLeZ

contracts/PoolLens.sol

@@ -110,12 +110,7 @@ contract PoolLens is Initializable {
    */
   function getPublicPoolsWithData()
     external
-    returns (
-      uint256[] memory,
-      PoolDirectory.Pool[] memory,
-      IonicPoolData[] memory,
-      bool[] memory
-    )
+    returns (uint256[] memory, PoolDirectory.Pool[] memory, IonicPoolData[] memory, bool[] memory)
   {
     (uint256[] memory indexes, PoolDirectory.Pool[] memory publicPools) = directory.getPublicPools();
     (IonicPoolData[] memory data, bool[] memory errored) = getPoolsData(publicPools);
@@ -127,15 +122,9 @@ contract PoolLens is Initializable {
    * @dev This function is not designed to be called in a transaction: it is too gas-intensive.
    * Ideally, we can add the `view` modifier, but many cToken functions potentially modify the state.
    */
-  function getPublicPoolsByVerificationWithData(bool whitelistedAdmin)
-    external
-    returns (
-      uint256[] memory,
-      PoolDirectory.Pool[] memory,
-      IonicPoolData[] memory,
-      bool[] memory
-    )
-  {
+  function getPublicPoolsByVerificationWithData(
+    bool whitelistedAdmin
+  ) external returns (uint256[] memory, PoolDirectory.Pool[] memory, IonicPoolData[] memory, bool[] memory) {
     (uint256[] memory indexes, PoolDirectory.Pool[] memory publicPools) = directory.getPublicPoolsByVerification(
       whitelistedAdmin
     );
@@ -148,15 +137,9 @@ contract PoolLens is Initializable {
    * @dev This function is not designed to be called in a transaction: it is too gas-intensive.
    * Ideally, we can add the `view` modifier, but many cToken functions potentially modify the state.
    */
-  function getPoolsByAccountWithData(address account)
-    external
-    returns (
-      uint256[] memory,
-      PoolDirectory.Pool[] memory,
-      IonicPoolData[] memory,
-      bool[] memory
-    )
-  {
+  function getPoolsByAccountWithData(
+    address account
+  ) external returns (uint256[] memory, PoolDirectory.Pool[] memory, IonicPoolData[] memory, bool[] memory) {
     (uint256[] memory indexes, PoolDirectory.Pool[] memory accountPools) = directory.getPoolsByAccount(account);
     (IonicPoolData[] memory data, bool[] memory errored) = getPoolsData(accountPools);
     return (indexes, accountPools, data, errored);
@@ -167,15 +150,9 @@ contract PoolLens is Initializable {
    * @dev This function is not designed to be called in a transaction: it is too gas-intensive.
    * Ideally, we can add the `view` modifier, but many cToken functions potentially modify the state.
    */
-  function getPoolsOIonicrWithData(address user)
-    external
-    returns (
-      uint256[] memory,
-      PoolDirectory.Pool[] memory,
-      IonicPoolData[] memory,
-      bool[] memory
-    )
-  {
+  function getPoolsOIonicrWithData(
+    address user
+  ) external returns (uint256[] memory, PoolDirectory.Pool[] memory, IonicPoolData[] memory, bool[] memory) {
     (uint256[] memory indexes, PoolDirectory.Pool[] memory userPools) = directory.getPoolsOfUser(user);
     (IonicPoolData[] memory data, bool[] memory errored) = getPoolsData(userPools);
     return (indexes, userPools, data, errored);
@@ -210,16 +187,9 @@ contract PoolLens is Initializable {
   /**
    * @notice Returns total supply balance (in ETH), total borrow balance (in ETH), underlying token addresses, and underlying token symbols of a Ionic pool.
    */
-  function getPoolSummary(IonicComptroller comptroller)
-    external
-    returns (
-      uint256,
-      uint256,
-      address[] memory,
-      string[] memory,
-      bool
-    )
-  {
+  function getPoolSummary(
+    IonicComptroller comptroller
+  ) external returns (uint256, uint256, address[] memory, string[] memory, bool) {
     uint256 totalBorrow = 0;
     uint256 totalSupply = 0;
     ICErc20[] memory cTokens = comptroller.getAllMarkets();
@@ -359,7 +329,10 @@ contract PoolLens is Initializable {
     return (detailedAssets);
   }
 
-  function getBorrowCapsPerCollateral(ICErc20 borrowedAsset, IonicComptroller comptroller)
+  function getBorrowCapsPerCollateral(
+    ICErc20 borrowedAsset,
+    IonicComptroller comptroller
+  )
     internal
     view
     returns (
@@ -448,7 +421,7 @@ contract PoolLens is Initializable {
     uint256[] memory supplyCapsPerAsset = new uint256[](poolMarkets.length);
     for (uint256 i = 0; i < poolMarkets.length; i++) {
       assets[i] = address(poolMarkets[i]);
-      supplyCapsPerAsset[i] = comptroller.supplyCaps(assets[i]);
+      supplyCapsPerAsset[i] = comptroller.effectiveSupplyCaps(assets[i]);
     }
 
     return (assets, supplyCapsPerAsset);
@@ -458,23 +431,17 @@ contract PoolLens is Initializable {
    * @notice returns the total supply cap for each asset in the pool and the total non-whitelist supplied assets
    * @dev This function is not designed to be called in a transaction: it is too gas-intensive.
    */
-  function getSupplyCapsDataForPool(IonicComptroller comptroller)
-    public
-    view
-    returns (
-      address[] memory,
-      uint256[] memory,
-      uint256[] memory
-    )
-  {
+  function getSupplyCapsDataForPool(
+    IonicComptroller comptroller
+  ) public view returns (address[] memory, uint256[] memory, uint256[] memory) {
     ICErc20[] memory poolMarkets = comptroller.getAllMarkets();
 
     address[] memory assets = new address[](poolMarkets.length);
     uint256[] memory supplyCapsPerAsset = new uint256[](poolMarkets.length);
     uint256[] memory nonWhitelistedTotalSupply = new uint256[](poolMarkets.length);
     for (uint256 i = 0; i < poolMarkets.length; i++) {
       assets[i] = address(poolMarkets[i]);
-      supplyCapsPerAsset[i] = comptroller.supplyCaps(assets[i]);
+      supplyCapsPerAsset[i] = comptroller.effectiveSupplyCaps(assets[i]);
       uint256 assetTotalSupplied = poolMarkets[i].getTotalUnderlyingSupplied();
       uint256 whitelistedSuppliersSupply = comptroller.getWhitelistedSuppliersSupply(assets[i]);
       if (whitelistedSuppliersSupply >= assetTotalSupplied) nonWhitelistedTotalSupply[i] = 0;
@@ -488,7 +455,9 @@ contract PoolLens is Initializable {
    * @notice returns the total borrow cap and the per collateral borrowing cap/blacklist for the asset
    * @dev This function is not designed to be called in a transaction: it is too gas-intensive.
    */
-  function getBorrowCapsForAsset(ICErc20 asset)
+  function getBorrowCapsForAsset(
+    ICErc20 asset
+  )
     public
     view
     returns (
@@ -500,14 +469,16 @@ contract PoolLens is Initializable {
   {
     IonicComptroller comptroller = IonicComptroller(asset.comptroller());
     (collateral, borrowCapsPerCollateral, collateralBlacklisted) = getBorrowCapsPerCollateral(asset, comptroller);
-    totalBorrowCap = comptroller.borrowCaps(address(asset));
+    totalBorrowCap = comptroller.effectiveBorrowCaps(address(asset));
   }
 
   /**
    * @notice returns the total borrow cap, the per collateral borrowing cap/blacklist for the asset and the total non-whitelist borrows
    * @dev This function is not designed to be called in a transaction: it is too gas-intensive.
    */
-  function getBorrowCapsDataForAsset(ICErc20 asset)
+  function getBorrowCapsDataForAsset(
+    ICErc20 asset
+  )
     public
     view
     returns (
@@ -520,7 +491,7 @@ contract PoolLens is Initializable {
   {
     IonicComptroller comptroller = IonicComptroller(asset.comptroller());
     (collateral, borrowCapsPerCollateral, collateralBlacklisted) = getBorrowCapsPerCollateral(asset, comptroller);
-    totalBorrowCap = comptroller.borrowCaps(address(asset));
+    totalBorrowCap = comptroller.effectiveBorrowCaps(address(asset));
     uint256 totalBorrows = asset.totalBorrowsCurrent();
     uint256 whitelistedBorrowersBorrows = comptroller.getWhitelistedBorrowersBorrows(address(asset));
     if (whitelistedBorrowersBorrows >= totalBorrows) nonWhitelistedTotalBorrows = 0;
@@ -532,11 +503,9 @@ contract PoolLens is Initializable {
    * Note that the whitelist does not have to be enforced.
    * @dev This function is not designed to be called in a transaction: it is too gas-intensive.
    */
-  function getWhitelistedPoolsByAccount(address account)
-    public
-    view
-    returns (uint256[] memory, PoolDirectory.Pool[] memory)
-  {
+  function getWhitelistedPoolsByAccount(
+    address account
+  ) public view returns (uint256[] memory, PoolDirectory.Pool[] memory) {
     (, PoolDirectory.Pool[] memory pools) = directory.getActivePools();
     uint256 arrayLength = 0;
 
@@ -569,15 +538,9 @@ contract PoolLens is Initializable {
    * @dev This function is not designed to be called in a transaction: it is too gas-intensive.
    * Ideally, we can add the `view` modifier, but many cToken functions potentially modify the state.
    */
-  function getWhitelistedPoolsByAccountWithData(address account)
-    external
-    returns (
-      uint256[] memory,
-      PoolDirectory.Pool[] memory,
-      IonicPoolData[] memory,
-      bool[] memory
-    )
-  {
+  function getWhitelistedPoolsByAccountWithData(
+    address account
+  ) external returns (uint256[] memory, PoolDirectory.Pool[] memory, IonicPoolData[] memory, bool[] memory) {
     (uint256[] memory indexes, PoolDirectory.Pool[] memory accountPools) = getWhitelistedPoolsByAccount(account);
     (IonicPoolData[] memory data, bool[] memory errored) = getPoolsData(accountPools);
     return (indexes, accountPools, data, errored);

contracts/compound/Comptroller.sol

@@ -10,7 +10,6 @@ import { IFeeDistributor } from "./IFeeDistributor.sol";
 import { IIonicFlywheel } from "../ionic/strategies/flywheel/IIonicFlywheel.sol";
 import { DiamondExtension, DiamondBase, LibDiamond } from "../ionic/DiamondExtension.sol";
 import { ComptrollerExtensionInterface, ComptrollerBase, ComptrollerInterface } from "./ComptrollerInterface.sol";
-import { PrudentiaLib } from "../adrastia/PrudentiaLib.sol";
 
 import "@openzeppelin/contracts/utils/structs/EnumerableSet.sol";
 
@@ -69,6 +68,26 @@ contract Comptroller is ComptrollerBase, ComptrollerInterface, ComptrollerErrorR
     _;
   }
 
+  /**
+   * @notice Gets the supply cap of a cToken in the units of the underlying asset.
+   * @param cToken The address of the cToken.
+   */
+  function effectiveSupplyCaps(
+    address cToken
+  ) public view override(ComptrollerBase, ComptrollerInterface) returns (uint256 supplyCap) {
+    return ComptrollerBase.effectiveSupplyCaps(cToken);
+  }
+
+  /**
+   * @notice Gets the borrow cap of a cToken in the units of the underlying asset.
+   * @param cToken The address of the cToken.
+   */
+  function effectiveBorrowCaps(
+    address cToken
+  ) public view override(ComptrollerBase, ComptrollerInterface) returns (uint256 borrowCap) {
+    return ComptrollerBase.effectiveBorrowCaps(cToken);
+  }
+
   /*** Assets You Are In ***/
 
   /**
@@ -243,7 +262,7 @@ contract Comptroller is ComptrollerBase, ComptrollerInterface, ComptrollerErrorR
       return uint256(Error.SUPPLIER_NOT_WHITELISTED);
     }
 
-    uint256 supplyCap = supplyCaps(cTokenAddress);
+    uint256 supplyCap = effectiveSupplyCaps(cTokenAddress);
 
     // Supply cap of 0 corresponds to unlimited supplying
     if (supplyCap != 0 && !supplyCapWhitelist[cTokenAddress].contains(minter)) {
@@ -451,7 +470,7 @@ contract Comptroller is ComptrollerBase, ComptrollerInterface, ComptrollerErrorR
       return uint256(Error.SUPPLIER_NOT_WHITELISTED);
     }
 
-    uint256 borrowCap = borrowCaps(cToken);
+    uint256 borrowCap = effectiveBorrowCaps(cToken);
 
     // Borrow cap of 0 corresponds to unlimited borrowing
     if (borrowCap != 0 && !borrowCapWhitelist[cToken].contains(borrower)) {
@@ -1266,8 +1285,8 @@ contract Comptroller is ComptrollerBase, ComptrollerInterface, ComptrollerErrorR
     functionSelectors[--fnsCount] = this._beforeNonReentrant.selector;
     functionSelectors[--fnsCount] = this._afterNonReentrant.selector;
     functionSelectors[--fnsCount] = this._becomeImplementation.selector;
-    functionSelectors[--fnsCount] = this.supplyCaps.selector;
-    functionSelectors[--fnsCount] = this.borrowCaps.selector;
+    functionSelectors[--fnsCount] = this.effectiveSupplyCaps.selector;
+    functionSelectors[--fnsCount] = this.effectiveBorrowCaps.selector;
 
     require(fnsCount == 0, "use the correct array length");
   }

contracts/compound/ComptrollerFirstExtension.sol

@@ -140,7 +140,7 @@ contract ComptrollerFirstExtension is
       }
     }
 
-    uint256 supplyCap = supplyCaps(address(collateral));
+    uint256 supplyCap = effectiveSupplyCaps(address(collateral));
 
     // if there is any supply cap, don't allow donations to the market/plugin to go around it
     if (supplyCap > 0 && !supplyCapWhitelist[address(collateral)].contains(account)) {
@@ -168,7 +168,7 @@ contract ComptrollerFirstExtension is
     require(numMarkets != 0 && numMarkets == numSupplyCaps, "!input");
 
     for (uint256 i = 0; i < numMarkets; i++) {
-      _supplyCaps[address(cTokens[i])] = newSupplyCaps[i];
+      supplyCaps[address(cTokens[i])] = newSupplyCaps[i];
       emit NewSupplyCap(cTokens[i], newSupplyCaps[i]);
     }
   }
@@ -188,7 +188,7 @@ contract ComptrollerFirstExtension is
     require(numMarkets != 0 && numMarkets == numBorrowCaps, "!input");
 
     for (uint256 i = 0; i < numMarkets; i++) {
-      _borrowCaps[address(cTokens[i])] = newBorrowCaps[i];
+      borrowCaps[address(cTokens[i])] = newBorrowCaps[i];
       emit NewBorrowCap(cTokens[i], newBorrowCaps[i]);
     }
   }

contracts/compound/ComptrollerInterface.sol

@@ -110,6 +110,20 @@ interface ComptrollerInterface {
   function _beforeNonReentrant() external;
 
   function _afterNonReentrant() external;
+
+  /*** New supply and borrow cap view functions ***/
+
+  /**
+   * @notice Gets the supply cap of a cToken in the units of the underlying asset.
+   * @param cToken The address of the cToken.
+   */
+  function effectiveSupplyCaps(address cToken) external view returns (uint256 supplyCap);
+
+  /**
+   * @notice Gets the borrow cap of a cToken in the units of the underlying asset.
+   * @param cToken The address of the cToken.
+   */
+  function effectiveBorrowCaps(address cToken) external view returns (uint256 borrowCap);
 }
 
 interface ComptrollerStorageInterface {
@@ -145,8 +159,22 @@ interface ComptrollerStorageInterface {
 
   function cTokensByUnderlying(address) external view returns (address);
 
+  /**
+   * Gets the supply cap of a cToken in the units of the underlying asset.
+   * @dev WARNING: This function is misleading if Adrastia Prudentia is being used for the supply cap. Instead, use
+   * `effectiveSupplyCaps` to get the correct supply cap.
+   * @param cToken The address of the cToken.
+   * @return The supply cap in the units of the underlying asset.
+   */
   function supplyCaps(address cToken) external view returns (uint256);
 
+  /**
+   * Gets the borrow cap of a cToken in the units of the underlying asset.
+   * @dev WARNING: This function is misleading if Adrastia Prudentia is being used for the borrow cap. Instead, use
+   * `effectiveBorrowCaps` to get the correct borrow cap.
+   * @param cToken The address of the cToken.
+   * @return The borrow cap in the units of the underlying asset.
+   */
   function borrowCaps(address cToken) external view returns (uint256);
 
   function markets(address cToken) external view returns (bool, uint256);
@@ -321,7 +349,7 @@ abstract contract ComptrollerBase is ComptrollerV4Storage {
    * @notice Gets the supply cap of a cToken in the units of the underlying asset.
    * @param cToken The address of the cToken.
    */
-  function supplyCaps(address cToken) public view returns (uint256 supplyCap) {
+  function effectiveSupplyCaps(address cToken) public view virtual returns (uint256 supplyCap) {
     PrudentiaLib.PrudentiaConfig memory capConfig = supplyCapConfig;
 
     // Check if we're using Adrastia Prudentia for the supply cap
@@ -356,15 +384,15 @@ abstract contract ComptrollerBase is ComptrollerV4Storage {
       // We don't have a controller, so we're using the local supply cap
 
       // Get the supply cap from the local supply cap
-      supplyCap = _supplyCaps[cToken];
+      supplyCap = supplyCaps[cToken];
     }
   }
 
   /**
    * @notice Gets the borrow cap of a cToken in the units of the underlying asset.
    * @param cToken The address of the cToken.
    */
-  function borrowCaps(address cToken) public view returns (uint256 borrowCap) {
+  function effectiveBorrowCaps(address cToken) public view virtual returns (uint256 borrowCap) {
     PrudentiaLib.PrudentiaConfig memory capConfig = borrowCapConfig;
 
     // Check if we're using Adrastia Prudentia for the borrow cap
@@ -397,7 +425,7 @@ abstract contract ComptrollerBase is ComptrollerV4Storage {
       }
     } else {
       // We don't have a controller, so we're using the local borrow cap
-      borrowCap = _borrowCaps[cToken];
+      borrowCap = borrowCaps[cToken];
     }
   }
 }