fix: rename getters and move to IHubBase, rename error (#865)

Author: miguelmtzinf

snapshots/Hub.Operations.json

@@ -7,7 +7,7 @@
   "refreshPremium": "103280",
   "remove: full": "77252",
   "remove: partial": "83769",
-  "reportDeficit": "121619",
+  "reportDeficit": "121597",
   "restore: full": "100313",
   "restore: partial": "113945",
   "transferShares": "79049"

snapshots/Spoke.Operations.ZeroRiskPremium.json

@@ -1,13 +1,13 @@
 {
-  "borrow: first": "226295",
-  "borrow: second action, same reserve": "206816",
-  "liquidationCall: full": "311530",
-  "liquidationCall: partial": "331508",
-  "permitReserve + repay (multicall)": "266194",
+  "borrow: first": "226273",
+  "borrow: second action, same reserve": "206794",
+  "liquidationCall: full": "311508",
+  "liquidationCall: partial": "331486",
+  "permitReserve + repay (multicall)": "266172",
   "permitReserve + supply (multicall)": "144267",
   "permitReserve + supply + enable collateral (multicall)": "178228",
   "repay: full": "158136",
-  "repay: partial": "210026",
+  "repay: partial": "210004",
   "setUserPositionManagerWithSig: disable": "44882",
   "setUserPositionManagerWithSig: enable": "68905",
   "supply + enable collateral (multicall)": "156170",
@@ -17,16 +17,16 @@
   "supply: second action, same reserve": "105173",
   "updateUserDynamicConfig: 1 collateral": "73802",
   "updateUserDynamicConfig: 2 collaterals": "88662",
-  "updateUserRiskPremium: 1 borrow": "162232",
-  "updateUserRiskPremium: 2 borrows": "235601",
+  "updateUserRiskPremium: 1 borrow": "162210",
+  "updateUserRiskPremium: 2 borrows": "235557",
   "usingAsCollateral: 0 borrows, enable": "58976",
-  "usingAsCollateral: 1 borrow, disable": "172491",
+  "usingAsCollateral: 1 borrow, disable": "172469",
   "usingAsCollateral: 1 borrow, enable": "32298",
-  "usingAsCollateral: 2 borrows, disable": "259197",
+  "usingAsCollateral: 2 borrows, disable": "259153",
   "usingAsCollateral: 2 borrows, enable": "41876",
   "withdraw: 0 borrows, full": "129936",
   "withdraw: 0 borrows, partial": "136271",
-  "withdraw: 1 borrow, partial": "228386",
-  "withdraw: 2 borrows, partial": "315081",
+  "withdraw: 1 borrow, partial": "228364",
+  "withdraw: 2 borrows, partial": "315037",
   "withdraw: non collateral": "127837"
 }

snapshots/Spoke.Operations.json

@@ -1,13 +1,13 @@
 {
-  "borrow: first": "251795",
-  "borrow: second action, same reserve": "215216",
-  "liquidationCall: full": "320146",
-  "liquidationCall: partial": "340124",
-  "permitReserve + repay (multicall)": "274810",
+  "borrow: first": "251773",
+  "borrow: second action, same reserve": "215194",
+  "liquidationCall: full": "320124",
+  "liquidationCall: partial": "340102",
+  "permitReserve + repay (multicall)": "274788",
   "permitReserve + supply (multicall)": "144267",
   "permitReserve + supply + enable collateral (multicall)": "178228",
   "repay: full": "152352",
-  "repay: partial": "218642",
+  "repay: partial": "218620",
   "setUserPositionManagerWithSig: disable": "44882",
   "setUserPositionManagerWithSig: enable": "68905",
   "supply + enable collateral (multicall)": "156170",
@@ -17,16 +17,16 @@
   "supply: second action, same reserve": "105173",
   "updateUserDynamicConfig: 1 collateral": "73802",
   "updateUserDynamicConfig: 2 collaterals": "88662",
-  "updateUserRiskPremium: 1 borrow": "179032",
-  "updateUserRiskPremium: 2 borrows": "269201",
+  "updateUserRiskPremium: 1 borrow": "179010",
+  "updateUserRiskPremium: 2 borrows": "269157",
   "usingAsCollateral: 0 borrows, enable": "58976",
-  "usingAsCollateral: 1 borrow, disable": "189291",
+  "usingAsCollateral: 1 borrow, disable": "189269",
   "usingAsCollateral: 1 borrow, enable": "32298",
-  "usingAsCollateral: 2 borrows, disable": "292797",
+  "usingAsCollateral: 2 borrows, disable": "292753",
   "usingAsCollateral: 2 borrows, enable": "41876",
   "withdraw: 0 borrows, full": "129936",
   "withdraw: 0 borrows, partial": "136271",
-  "withdraw: 1 borrow, partial": "245186",
-  "withdraw: 2 borrows, partial": "348681",
+  "withdraw: 1 borrow, partial": "245164",
+  "withdraw: 2 borrows, partial": "348637",
   "withdraw: non collateral": "127837"
 }

src/hub/AssetInterestRateStrategy.sol

@@ -75,7 +75,7 @@ contract AssetInterestRateStrategy is IAssetInterestRateStrategy {
   }
 
   /// @inheritdoc IAssetInterestRateStrategy
-  function getBaseVariableBorrowRate(uint256 assetId) external view override returns (uint256) {
+  function getBaseVariableBorrowRate(uint256 assetId) external view returns (uint256) {
     return _interestRateData[assetId].baseVariableBorrowRate;
   }
 
@@ -90,7 +90,7 @@ contract AssetInterestRateStrategy is IAssetInterestRateStrategy {
   }
 
   /// @inheritdoc IAssetInterestRateStrategy
-  function getMaxVariableBorrowRate(uint256 assetId) external view override returns (uint256) {
+  function getMaxVariableBorrowRate(uint256 assetId) external view returns (uint256) {
     return
       _interestRateData[assetId].baseVariableBorrowRate +
       _interestRateData[assetId].variableRateSlope1 +
@@ -104,7 +104,7 @@ contract AssetInterestRateStrategy is IAssetInterestRateStrategy {
     uint256 drawn,
     uint256 /* deficit */,
     uint256 swept
-  ) external view virtual override returns (uint256) {
+  ) external view returns (uint256) {
     InterestRateData memory rateData = _interestRateData[assetId];
     require(rateData.optimalUsageRatio > 0, InterestRateDataNotSet(assetId));
 

src/hub/Hub.sol

@@ -420,7 +420,7 @@ contract Hub is IHub, AccessManaged {
   }
 
   /// @inheritdoc IHub
-  function getAssetCount() external view override returns (uint256) {
+  function getAssetCount() external view returns (uint256) {
     return _assetCount;
   }
 
@@ -522,6 +522,16 @@ contract Hub is IHub, AccessManaged {
     return (asset.premiumShares, asset.premiumOffset, asset.realizedPremium);
   }
 
+  /// @inheritdoc IHubBase
+  function getAssetLiquidity(uint256 assetId) external view returns (uint256) {
+    return _assets[assetId].liquidity;
+  }
+
+  /// @inheritdoc IHubBase
+  function getAssetDeficit(uint256 assetId) external view returns (uint256) {
+    return _assets[assetId].deficit;
+  }
+
   /// @inheritdoc IHub
   function getAsset(uint256 assetId) external view returns (Asset memory) {
     return _assets[assetId];
@@ -540,17 +550,7 @@ contract Hub is IHub, AccessManaged {
   }
 
   /// @inheritdoc IHub
-  function getLiquidity(uint256 assetId) external view returns (uint256) {
-    return _assets[assetId].liquidity;
-  }
-
-  /// @inheritdoc IHub
-  function getAssetDeficit(uint256 assetId) external view returns (uint256) {
-    return _assets[assetId].deficit;
-  }
-
-  /// @inheritdoc IHub
-  function getSwept(uint256 assetId) external view override returns (uint256) {
+  function getAssetSwept(uint256 assetId) external view returns (uint256) {
     return _assets[assetId].swept;
   }
 
@@ -609,6 +609,11 @@ contract Hub is IHub, AccessManaged {
     return (spokeData.premiumShares, spokeData.premiumOffset, spokeData.realizedPremium);
   }
 
+  /// @inheritdoc IHubBase
+  function getSpokeDeficit(uint256 assetId, address spoke) external view returns (uint256) {
+    return _spokes[assetId][spoke].deficit;
+  }
+
   /// @inheritdoc IHub
   function isSpokeListed(uint256 assetId, address spoke) external view returns (bool) {
     return _assetToSpokes[assetId].contains(spoke);
@@ -633,11 +638,6 @@ contract Hub is IHub, AccessManaged {
     return SpokeConfig(spokeData.active, spokeData.addCap, spokeData.drawCap);
   }
 
-  /// @inheritdoc IHub
-  function getSpokeDeficit(uint256 assetId, address spoke) external view returns (uint256) {
-    return _spokes[assetId][spoke].deficit;
-  }
-
   /// @notice Adds a new spoke to an asset with default feeReceiver configuration (maximum add cap, zero draw cap).
   /// @dev Emits `AddSpoke` and `UpdateSpokeConfig` events.
   function _addFeeReceiver(uint256 assetId, address feeReceiver) internal {
@@ -721,6 +721,7 @@ contract Hub is IHub, AccessManaged {
     return spoke.realizedPremium + accruedPremium;
   }
 
+  /// @dev Spoke with maximum cap have unlimited add capacity.
   function _validateAdd(
     Asset storage asset,
     SpokeData storage spoke,

src/hub/HubConfigurator.sol

@@ -26,7 +26,7 @@ contract HubConfigurator is Ownable2Step, IHubConfigurator {
     address feeReceiver,
     address irStrategy,
     bytes calldata irData
-  ) external override onlyOwner returns (uint256) {
+  ) external onlyOwner returns (uint256) {
     return
       IHub(hub).addAsset(
         underlying,
@@ -45,7 +45,7 @@ contract HubConfigurator is Ownable2Step, IHubConfigurator {
     address feeReceiver,
     address irStrategy,
     bytes calldata irData
-  ) external override onlyOwner returns (uint256) {
+  ) external onlyOwner returns (uint256) {
     return IHub(hub).addAsset(underlying, decimals, feeReceiver, irStrategy, irData);
   }
 
@@ -54,19 +54,15 @@ contract HubConfigurator is Ownable2Step, IHubConfigurator {
     address hub,
     uint256 assetId,
     uint256 liquidityFee
-  ) external override onlyOwner {
+  ) external onlyOwner {
     IHub targetHub = IHub(hub);
     IHub.AssetConfig memory config = targetHub.getAssetConfig(assetId);
     config.liquidityFee = liquidityFee.toUint16();
     targetHub.updateAssetConfig(assetId, config, new bytes(0));
   }
 
   /// @inheritdoc IHubConfigurator
-  function updateFeeReceiver(
-    address hub,
-    uint256 assetId,
-    address feeReceiver
-  ) external override onlyOwner {
+  function updateFeeReceiver(address hub, uint256 assetId, address feeReceiver) external onlyOwner {
     IHub targetHub = IHub(hub);
     IHub.AssetConfig memory config = targetHub.getAssetConfig(assetId);
     config.feeReceiver = feeReceiver;
@@ -79,7 +75,7 @@ contract HubConfigurator is Ownable2Step, IHubConfigurator {
     uint256 assetId,
     uint256 liquidityFee,
     address feeReceiver
-  ) external override onlyOwner {
+  ) external onlyOwner {
     IHub targetHub = IHub(hub);
     IHub.AssetConfig memory config = targetHub.getAssetConfig(assetId);
     config.liquidityFee = liquidityFee.toUint16();
@@ -93,7 +89,7 @@ contract HubConfigurator is Ownable2Step, IHubConfigurator {
     uint256 assetId,
     address irStrategy,
     bytes calldata irData
-  ) external override onlyOwner {
+  ) external onlyOwner {
     IHub targetHub = IHub(hub);
     IHub.AssetConfig memory config = targetHub.getAssetConfig(assetId);
     config.irStrategy = irStrategy;
@@ -105,15 +101,15 @@ contract HubConfigurator is Ownable2Step, IHubConfigurator {
     address hub,
     uint256 assetId,
     address reinvestmentController
-  ) external override onlyOwner {
+  ) external onlyOwner {
     IHub targetHub = IHub(hub);
     IHub.AssetConfig memory config = targetHub.getAssetConfig(assetId);
     config.reinvestmentController = reinvestmentController;
     targetHub.updateAssetConfig(assetId, config, new bytes(0));
   }
 
   /// @inheritdoc IHubConfigurator
-  function freezeAsset(address hub, uint256 assetId) external override onlyOwner {
+  function freezeAsset(address hub, uint256 assetId) external onlyOwner {
     IHub targetHub = IHub(hub);
     uint256 spokesCount = targetHub.getSpokeCount(assetId);
     for (uint256 i = 0; i < spokesCount; ++i) {
@@ -123,7 +119,7 @@ contract HubConfigurator is Ownable2Step, IHubConfigurator {
   }
 
   /// @inheritdoc IHubConfigurator
-  function pauseAsset(address hub, uint256 assetId) external override onlyOwner {
+  function pauseAsset(address hub, uint256 assetId) external onlyOwner {
     IHub targetHub = IHub(hub);
     uint256 spokesCount = targetHub.getSpokeCount(assetId);
     for (uint256 i = 0; i < spokesCount; ++i) {
@@ -163,7 +159,7 @@ contract HubConfigurator is Ownable2Step, IHubConfigurator {
     uint256 assetId,
     address spoke,
     bool active
-  ) external override onlyOwner {
+  ) external onlyOwner {
     IHub targetHub = IHub(hub);
     IHub.SpokeConfig memory config = targetHub.getSpokeConfig(assetId, spoke);
     config.active = active;
@@ -176,7 +172,7 @@ contract HubConfigurator is Ownable2Step, IHubConfigurator {
     uint256 assetId,
     address spoke,
     uint256 addCap
-  ) external override onlyOwner {
+  ) external onlyOwner {
     IHub targetHub = IHub(hub);
     IHub.SpokeConfig memory config = targetHub.getSpokeConfig(assetId, spoke);
     config.addCap = addCap.toUint56();
@@ -189,7 +185,7 @@ contract HubConfigurator is Ownable2Step, IHubConfigurator {
     uint256 assetId,
     address spoke,
     uint256 drawCap
-  ) external override onlyOwner {
+  ) external onlyOwner {
     IHub targetHub = IHub(hub);
     IHub.SpokeConfig memory config = targetHub.getSpokeConfig(assetId, spoke);
     config.drawCap = drawCap.toUint56();
@@ -203,12 +199,12 @@ contract HubConfigurator is Ownable2Step, IHubConfigurator {
     address spoke,
     uint256 addCap,
     uint256 drawCap
-  ) external override onlyOwner {
+  ) external onlyOwner {
     _updateSpokeCaps(IHub(hub), assetId, spoke, addCap, drawCap);
   }
 
   /// @inheritdoc IHubConfigurator
-  function pauseSpoke(address hub, address spoke) external override onlyOwner {
+  function pauseSpoke(address hub, address spoke) external onlyOwner {
     IHub targetHub = IHub(hub);
     uint256 assetCount = targetHub.getAssetCount();
     for (uint256 assetId = 0; assetId < assetCount; ++assetId) {
@@ -221,7 +217,7 @@ contract HubConfigurator is Ownable2Step, IHubConfigurator {
   }
 
   /// @inheritdoc IHubConfigurator
-  function freezeSpoke(address hub, address spoke) external override onlyOwner {
+  function freezeSpoke(address hub, address spoke) external onlyOwner {
     IHub targetHub = IHub(hub);
     uint256 assetCount = targetHub.getAssetCount();
     for (uint256 assetId = 0; assetId < assetCount; ++assetId) {
@@ -236,7 +232,7 @@ contract HubConfigurator is Ownable2Step, IHubConfigurator {
     address hub,
     uint256 assetId,
     bytes calldata irData
-  ) external override onlyOwner {
+  ) external onlyOwner {
     IHub(hub).setInterestRateData(assetId, irData);
   }
 

src/hub/interfaces/IHub.sol

@@ -313,20 +313,10 @@ interface IHub is IHubBase, IAccessManaged {
   /// @return The asset configuration struct.
   function getAssetConfig(uint256 assetId) external view returns (AssetConfig memory);
 
-  /// @notice Returns the amount of available liquidity for the specified asset.
-  /// @param assetId The identifier of the asset.
-  /// @return The amount of available liquidity.
-  function getLiquidity(uint256 assetId) external view returns (uint256);
-
-  /// @notice Returns the amount of deficit of the specified asset.
-  /// @param assetId The identifier of the asset.
-  /// @return The amount of deficit.
-  function getAssetDeficit(uint256 assetId) external view returns (uint256);
-
   /// @notice Returns the amount of liquidity swept by the reinvestment controller for the specified asset.
   /// @param assetId The identifier of the asset.
   /// @return The amount of liquidity swept.
-  function getSwept(uint256 assetId) external view returns (uint256);
+  function getAssetSwept(uint256 assetId) external view returns (uint256);
 
   /// @notice Calculates the current drawn index for the specified asset.
   /// @param assetId The identifier of the asset.
@@ -370,12 +360,6 @@ interface IHub is IHubBase, IAccessManaged {
     address spoke
   ) external view returns (SpokeConfig memory);
 
-  /// @notice Returns the amount of a given spoke's deficit for the specified asset.
-  /// @param assetId The identifier of the asset.
-  /// @param spoke The address of the spoke.
-  /// @return The amount of deficit.
-  function getSpokeDeficit(uint256 assetId, address spoke) external view returns (uint256);
-
   /// @notice Returns the maximum allowed number of decimals for the underlying asset.
   /// @return The maximum number of decimals (inclusive).
   function MAX_ALLOWED_UNDERLYING_DECIMALS() external view returns (uint8);