fix: Rename user config key to dynamic config key for consistency (#952)

Author: miguelmtzinf

src/spoke/Spoke.sol

@@ -61,7 +61,7 @@ abstract contract Spoke is ISpoke, Multicall, NoncesKeyed, AccessManagedUpgradea
   mapping(address user => PositionStatus) internal _positionStatus;
   mapping(uint256 reserveId => Reserve) internal _reserves;
   mapping(address positionManager => PositionManagerConfig) internal _positionManager;
-  mapping(uint256 reserveId => mapping(uint16 configKey => DynamicReserveConfig))
+  mapping(uint256 reserveId => mapping(uint16 dynamicConfigKey => DynamicReserveConfig))
     internal _dynamicConfig; // dictionary of dynamic configs per reserve
   LiquidationConfig internal _liquidationConfig;
   mapping(address hub => mapping(uint256 assetId => bool)) internal _reserveExists;
@@ -163,26 +163,26 @@ abstract contract Spoke is ISpoke, Multicall, NoncesKeyed, AccessManagedUpgradea
   ) external restricted returns (uint16) {
     require(reserveId < _reserveCount, ReserveNotListed());
     _validateDynamicReserveConfig(dynamicConfig);
-    uint16 configKey;
+    uint16 dynamicConfigKey;
     // overflow is desired, we implicitly invalidate & override stale config
     unchecked {
-      configKey = ++_reserves[reserveId].dynamicConfigKey;
+      dynamicConfigKey = ++_reserves[reserveId].dynamicConfigKey;
     }
-    _dynamicConfig[reserveId][configKey] = dynamicConfig;
-    emit AddDynamicReserveConfig(reserveId, configKey, dynamicConfig);
-    return configKey;
+    _dynamicConfig[reserveId][dynamicConfigKey] = dynamicConfig;
+    emit AddDynamicReserveConfig(reserveId, dynamicConfigKey, dynamicConfig);
+    return dynamicConfigKey;
   }
 
   /// @inheritdoc ISpoke
   function updateDynamicReserveConfig(
     uint256 reserveId,
-    uint16 configKey,
+    uint16 dynamicConfigKey,
     DynamicReserveConfig calldata dynamicConfig
   ) external restricted {
     require(reserveId < _reserveCount, ReserveNotListed());
-    _validateUpdateDynamicReserveConfig(_dynamicConfig[reserveId][configKey], dynamicConfig);
-    _dynamicConfig[reserveId][configKey] = dynamicConfig;
-    emit UpdateDynamicReserveConfig(reserveId, configKey, dynamicConfig);
+    _validateUpdateDynamicReserveConfig(_dynamicConfig[reserveId][dynamicConfigKey], dynamicConfig);
+    _dynamicConfig[reserveId][dynamicConfigKey] = dynamicConfig;
+    emit UpdateDynamicReserveConfig(reserveId, dynamicConfigKey, dynamicConfig);
   }
 
   /// @inheritdoc ISpoke
@@ -346,7 +346,7 @@ abstract contract Spoke is ISpoke, Multicall, NoncesKeyed, AccessManagedUpgradea
     );
 
     DynamicReserveConfig storage collateralDynConfig = _dynamicConfig[collateralReserveId][
-      _userPositions[user][collateralReserveId].configKey
+      _userPositions[user][collateralReserveId].dynamicConfigKey
     ];
 
     bool isUserInDeficit = LiquidationLogic.liquidateUser(
@@ -538,10 +538,10 @@ abstract contract Spoke is ISpoke, Multicall, NoncesKeyed, AccessManagedUpgradea
   /// @inheritdoc ISpoke
   function getDynamicReserveConfig(
     uint256 reserveId,
-    uint16 configKey
+    uint16 dynamicConfigKey
   ) external view returns (DynamicReserveConfig memory) {
     _getReserve(reserveId);
-    return _dynamicConfig[reserveId][configKey];
+    return _dynamicConfig[reserveId][dynamicConfigKey];
   }
 
   /// @inheritdoc ISpoke
@@ -617,8 +617,9 @@ abstract contract Spoke is ISpoke, Multicall, NoncesKeyed, AccessManagedUpgradea
         healthFactorForMaxBonus: _liquidationConfig.healthFactorForMaxBonus,
         liquidationBonusFactor: _liquidationConfig.liquidationBonusFactor,
         healthFactor: healthFactor,
-        maxLiquidationBonus: _dynamicConfig[reserveId][_userPositions[user][reserveId].configKey]
-          .maxLiquidationBonus
+        maxLiquidationBonus: _dynamicConfig[reserveId][
+          _userPositions[user][reserveId].dynamicConfigKey
+        ].maxLiquidationBonus
       });
   }
 
@@ -708,8 +709,8 @@ abstract contract Spoke is ISpoke, Multicall, NoncesKeyed, AccessManagedUpgradea
       if (collateral) {
         uint256 collateralFactor = _dynamicConfig[reserveId][
           refreshConfig
-            ? (userPosition.configKey = reserve.dynamicConfigKey)
-            : userPosition.configKey
+            ? (userPosition.dynamicConfigKey = reserve.dynamicConfigKey)
+            : userPosition.dynamicConfigKey
         ].collateralFactor;
         if (collateralFactor > 0) {
           uint256 suppliedShares = userPosition.suppliedShares;
@@ -785,7 +786,7 @@ abstract contract Spoke is ISpoke, Multicall, NoncesKeyed, AccessManagedUpgradea
   }
 
   function _refreshDynamicConfig(address user, uint256 reserveId) internal {
-    _userPositions[user][reserveId].configKey = _reserves[reserveId].dynamicConfigKey;
+    _userPositions[user][reserveId].dynamicConfigKey = _reserves[reserveId].dynamicConfigKey;
     emit RefreshSingleUserDynamicConfig(user, reserveId);
   }
 

src/spoke/SpokeConfigurator.sol

@@ -134,16 +134,16 @@ contract SpokeConfigurator is Ownable2Step, ISpokeConfigurator {
   function updateCollateralFactor(
     address spoke,
     uint256 reserveId,
-    uint16 configKey,
+    uint16 dynamicConfigKey,
     uint16 collateralFactor
   ) external onlyOwner {
     ISpoke targetSpoke = ISpoke(spoke);
     ISpoke.DynamicReserveConfig memory dynamicReserveConfig = targetSpoke.getDynamicReserveConfig(
       reserveId,
-      configKey
+      dynamicConfigKey
     );
     dynamicReserveConfig.collateralFactor = collateralFactor;
-    targetSpoke.updateDynamicReserveConfig(reserveId, configKey, dynamicReserveConfig);
+    targetSpoke.updateDynamicReserveConfig(reserveId, dynamicConfigKey, dynamicReserveConfig);
   }
 
   /// @inheritdoc ISpokeConfigurator
@@ -164,16 +164,16 @@ contract SpokeConfigurator is Ownable2Step, ISpokeConfigurator {
   function updateMaxLiquidationBonus(
     address spoke,
     uint256 reserveId,
-    uint16 configKey,
+    uint16 dynamicConfigKey,
     uint256 maxLiquidationBonus
   ) external onlyOwner {
     ISpoke targetSpoke = ISpoke(spoke);
     ISpoke.DynamicReserveConfig memory dynamicReserveConfig = targetSpoke.getDynamicReserveConfig(
       reserveId,
-      configKey
+      dynamicConfigKey
     );
     dynamicReserveConfig.maxLiquidationBonus = maxLiquidationBonus.toUint32();
-    targetSpoke.updateDynamicReserveConfig(reserveId, configKey, dynamicReserveConfig);
+    targetSpoke.updateDynamicReserveConfig(reserveId, dynamicConfigKey, dynamicReserveConfig);
   }
 
   /// @inheritdoc ISpokeConfigurator
@@ -194,16 +194,16 @@ contract SpokeConfigurator is Ownable2Step, ISpokeConfigurator {
   function updateLiquidationFee(
     address spoke,
     uint256 reserveId,
-    uint16 configKey,
+    uint16 dynamicConfigKey,
     uint256 liquidationFee
   ) external onlyOwner {
     ISpoke targetSpoke = ISpoke(spoke);
     ISpoke.DynamicReserveConfig memory dynamicReserveConfig = targetSpoke.getDynamicReserveConfig(
       reserveId,
-      configKey
+      dynamicConfigKey
     );
     dynamicReserveConfig.liquidationFee = liquidationFee.toUint16();
-    targetSpoke.updateDynamicReserveConfig(reserveId, configKey, dynamicReserveConfig);
+    targetSpoke.updateDynamicReserveConfig(reserveId, dynamicConfigKey, dynamicReserveConfig);
   }
 
   /// @inheritdoc ISpokeConfigurator
@@ -219,10 +219,10 @@ contract SpokeConfigurator is Ownable2Step, ISpokeConfigurator {
   function updateDynamicReserveConfig(
     address spoke,
     uint256 reserveId,
-    uint16 configKey,
+    uint16 dynamicConfigKey,
     ISpoke.DynamicReserveConfig calldata dynamicConfig
   ) external onlyOwner {
-    ISpoke(spoke).updateDynamicReserveConfig(reserveId, configKey, dynamicConfig);
+    ISpoke(spoke).updateDynamicReserveConfig(reserveId, dynamicConfigKey, dynamicConfig);
   }
 
   /// @inheritdoc ISpokeConfigurator

src/spoke/interfaces/ISpoke.sol

@@ -52,7 +52,7 @@ interface ISpoke is ISpokeBase, IMulticall, INoncesKeyed, IAccessManaged {
     uint128 premiumOffset;
     //
     uint128 suppliedShares;
-    uint16 configKey; // key of the last user config
+    uint16 dynamicConfigKey; // key of the last user config
   }
 
   struct PositionManagerConfig {
@@ -100,21 +100,21 @@ interface ISpoke is ISpokeBase, IMulticall, INoncesKeyed, IAccessManaged {
   /// key of the reserve. It can be an existing key that was previously used and is now being
   /// overridden.
   /// @param reserveId The identifier of the reserve.
-  /// @param configKey The key of the added dynamic config.
+  /// @param dynamicConfigKey The key of the added dynamic config.
   /// @param config The dynamic reserve config.
   event AddDynamicReserveConfig(
     uint256 indexed reserveId,
-    uint16 indexed configKey,
+    uint16 indexed dynamicConfigKey,
     DynamicReserveConfig config
   );
 
   /// @notice Emitted when a dynamic reserve config is updated.
   /// @param reserveId The identifier of the reserve.
-  /// @param configKey The key of the updated dynamic config.
+  /// @param dynamicConfigKey The key of the updated dynamic config.
   /// @param config The dynamic reserve config.
   event UpdateDynamicReserveConfig(
     uint256 indexed reserveId,
-    uint16 indexed configKey,
+    uint16 indexed dynamicConfigKey,
     DynamicReserveConfig config
   );
 
@@ -285,22 +285,22 @@ interface ISpoke is ISpokeBase, IMulticall, INoncesKeyed, IAccessManaged {
   /// @dev Appends dynamic config to the next valid config key, and overrides existing config if the key is already used.
   /// @param reserveId The identifier of the reserve.
   /// @param dynamicConfig The new dynamic reserve config.
-  /// @return configKey The key of the added dynamic config.
+  /// @return dynamicConfigKey The key of the added dynamic config.
   function addDynamicReserveConfig(
     uint256 reserveId,
     DynamicReserveConfig calldata dynamicConfig
-  ) external returns (uint16 configKey);
+  ) external returns (uint16 dynamicConfigKey);
 
   /// @notice Updates the dynamic reserve config for a given reserve at the specified key.
   /// @dev It reverts if the reserve associated with the given reserve identifier is not listed.
   /// @dev Reverts with `ConfigKeyUninitialized` if the config key has not been initialized yet.
   /// @dev Reverts with `InvalidCollateralFactor` if the collateral factor is 0.
   /// @param reserveId The identifier of the reserve.
-  /// @param configKey The key of the config to update.
+  /// @param dynamicConfigKey The key of the config to update.
   /// @param dynamicConfig The new dynamic reserve config.
   function updateDynamicReserveConfig(
     uint256 reserveId,
-    uint16 configKey,
+    uint16 dynamicConfigKey,
     DynamicReserveConfig calldata dynamicConfig
   ) external;
 
@@ -400,12 +400,12 @@ interface ISpoke is ISpokeBase, IMulticall, INoncesKeyed, IAccessManaged {
 
   /// @notice Returns the dynamic reserve configuration struct at the specified key.
   /// @dev It reverts if the reserve associated with the given reserve identifier is not listed.
-  /// @dev Does not revert if `configKey` is unset.
+  /// @dev Does not revert if `dynamicConfigKey` is unset.
   /// @param reserveId The identifier of the reserve.
-  /// @param configKey The key of the dynamic config.
+  /// @param dynamicConfigKey The key of the dynamic config.
   function getDynamicReserveConfig(
     uint256 reserveId,
-    uint16 configKey
+    uint16 dynamicConfigKey
   ) external view returns (DynamicReserveConfig memory);
 
   /// @notice Returns true if the reserve is set as collateral for the user.

src/spoke/interfaces/ISpokeConfigurator.sol

@@ -85,7 +85,7 @@ interface ISpokeConfigurator {
   /// @param spoke The address of the spoke.
   /// @param reserveId The identifier of the reserve.
   /// @param collateralFactor The new collateral factor.
-  /// @return The configKey of the added dynamic configuration.
+  /// @return The dynamicConfigKey of the added dynamic configuration.
   function addCollateralFactor(
     address spoke,
     uint256 reserveId,
@@ -95,20 +95,20 @@ interface ISpokeConfigurator {
   /// @notice Updates an existing collateral factor of a reserve at the specified key.
   /// @param spoke The address of the spoke.
   /// @param reserveId The identifier of the reserve.
-  /// @param configKey The key of the dynamic config to update.
+  /// @param dynamicConfigKey The key of the dynamic config to update.
   /// @param collateralFactor The new collateral factor.
   function updateCollateralFactor(
     address spoke,
     uint256 reserveId,
-    uint16 configKey,
+    uint16 dynamicConfigKey,
     uint16 collateralFactor
   ) external;
 
   /// @notice Adds a dynamic config to a reserve, identical to the latest one but with the specified max liquidation bonus.
   /// @param spoke The address of the spoke.
   /// @param reserveId The identifier of the reserve.
   /// @param maxLiquidationBonus The new max liquidation bonus.
-  /// @return The configKey of the added dynamic configuration.
+  /// @return The dynamicConfigKey of the added dynamic configuration.
   function addMaxLiquidationBonus(
     address spoke,
     uint256 reserveId,
@@ -118,20 +118,20 @@ interface ISpokeConfigurator {
   /// @notice Updates an existing liquidation bonus of a reserve at the specified key.
   /// @param spoke The address of the spoke.
   /// @param reserveId The identifier of the reserve.
-  /// @param configKey The key of the dynamic config to update.
+  /// @param dynamicConfigKey The key of the dynamic config to update.
   /// @param maxLiquidationBonus The new liquidation bonus.
   function updateMaxLiquidationBonus(
     address spoke,
     uint256 reserveId,
-    uint16 configKey,
+    uint16 dynamicConfigKey,
     uint256 maxLiquidationBonus
   ) external;
 
   /// @notice Adds a dynamic config to a reserve, identical to the latest one but with the specified liquidation fee.
   /// @param spoke The address of the spoke.
   /// @param reserveId The identifier of the reserve.
   /// @param liquidationFee The new liquidation fee.
-  /// @return The configKey of the added dynamic configuration.
+  /// @return The dynamicConfigKey of the added dynamic configuration.
   function addLiquidationFee(
     address spoke,
     uint256 reserveId,
@@ -141,20 +141,20 @@ interface ISpokeConfigurator {
   /// @notice Updates an existing liquidation fee of a reserve at the specified key.
   /// @param spoke The address of the spoke.
   /// @param reserveId The identifier of the reserve.
-  /// @param configKey The key of the dynamic config to update.
+  /// @param dynamicConfigKey The key of the dynamic config to update.
   /// @param liquidationFee The new liquidation fee.
   function updateLiquidationFee(
     address spoke,
     uint256 reserveId,
-    uint16 configKey,
+    uint16 dynamicConfigKey,
     uint256 liquidationFee
   ) external;
 
   /// @notice Adds a dynamic config to a reserve.
   /// @param spoke The address of the spoke.
   /// @param reserveId The identifier of the reserve.
   /// @param dynamicConfig The new dynamic config.
-  /// @return configKey The key of the added dynamic config.
+  /// @return dynamicConfigKey The key of the added dynamic config.
   function addDynamicReserveConfig(
     address spoke,
     uint256 reserveId,
@@ -164,12 +164,12 @@ interface ISpokeConfigurator {
   /// @notice Updates the dynamic config of a reserve at the specified key.
   /// @param spoke The address of the spoke.
   /// @param reserveId The identifier of the reserve.
-  /// @param configKey The key of the dynamic config to update.
+  /// @param dynamicConfigKey The key of the dynamic config to update.
   /// @param dynamicConfig The new dynamic config.
   function updateDynamicReserveConfig(
     address spoke,
     uint256 reserveId,
-    uint16 configKey,
+    uint16 dynamicConfigKey,
     ISpoke.DynamicReserveConfig calldata dynamicConfig
   ) external;