fix: make base generic, inherit from base

miguelmtzinf · miguelmtzinf · commit 4a7a24853d52 · 2025-10-31T12:22:37.000+01:00
diff --git a/src/contracts/facilitators/gsm/swapFreezer/ChainlinkOracleSwapFreezer.sol b/src/contracts/facilitators/gsm/swapFreezer/ChainlinkOracleSwapFreezer.sol
@@ -1,8 +1,8 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.10;
 
-import {IPoolAddressesProvider} from 'aave-v3-origin/contracts/interfaces/IPoolAddressesProvider.sol';
 import {AutomationCompatibleInterface} from 'src/contracts/dependencies/chainlink/AutomationCompatibleInterface.sol';
+import {IPoolAddressesProvider} from 'aave-v3-origin/contracts/interfaces/IPoolAddressesProvider.sol';
 import {IGsm} from 'src/contracts/facilitators/gsm/interfaces/IGsm.sol';
 import {OracleSwapFreezerBase} from 'src/contracts/facilitators/gsm/swapFreezer/OracleSwapFreezerBase.sol';
 
@@ -18,7 +18,7 @@ contract ChainlinkOracleSwapFreezer is OracleSwapFreezerBase, AutomationCompatib
    * @dev All bound ranges are inclusive
    * @param gsm The GSM that this contract will trigger freezes/unfreezes on
    * @param underlyingAsset The address of the collateral asset
-   * @param addressProvider The Aave Addresses Provider for looking up the Price Oracle
+   * @param addressesProvider The Aave Addresses Provider for looking up the Price Oracle
    * @param freezeLowerBound The lower price bound for freeze operations
    * @param freezeUpperBound The upper price bound for freeze operations
    * @param unfreezeLowerBound The lower price bound for unfreeze operations, must be 0 if unfreezing not allowed
@@ -28,7 +28,7 @@ contract ChainlinkOracleSwapFreezer is OracleSwapFreezerBase, AutomationCompatib
   constructor(
     IGsm gsm,
     address underlyingAsset,
-    IPoolAddressesProvider addressProvider,
+    IPoolAddressesProvider addressesProvider,
     uint128 freezeLowerBound,
     uint128 freezeUpperBound,
     uint128 unfreezeLowerBound,
@@ -38,7 +38,7 @@ contract ChainlinkOracleSwapFreezer is OracleSwapFreezerBase, AutomationCompatib
     OracleSwapFreezerBase(
       gsm,
       underlyingAsset,
-      addressProvider,
+      addressesProvider,
       freezeLowerBound,
       freezeUpperBound,
       unfreezeLowerBound,
@@ -49,16 +49,11 @@ contract ChainlinkOracleSwapFreezer is OracleSwapFreezerBase, AutomationCompatib
 
   /// @inheritdoc AutomationCompatibleInterface
   function performUpkeep(bytes calldata) external {
-    Action action = _getAction();
-    if (action == Action.FREEZE) {
-      GSM.setSwapFreeze(true);
-    } else if (action == Action.UNFREEZE) {
-      GSM.setSwapFreeze(false);
-    }
+    _execute();
   }
 
   /// @inheritdoc AutomationCompatibleInterface
   function checkUpkeep(bytes calldata) external view returns (bool, bytes memory) {
-    return (_getAction() == Action.NONE ? false : true, '');
+    return (_checkExecute(), '');
   }
 }
diff --git a/src/contracts/facilitators/gsm/swapFreezer/GelatoOracleSwapFreezer.sol b/src/contracts/facilitators/gsm/swapFreezer/GelatoOracleSwapFreezer.sol
@@ -1,23 +1,24 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.10;
 
+import {IGelatoOracleSwapFreezer} from 'src/contracts/facilitators/gsm/swapFreezer/interfaces/IGelatoOracleSwapFreezer.sol';
 import {IPoolAddressesProvider} from 'aave-v3-origin/contracts/interfaces/IPoolAddressesProvider.sol';
-import {OracleSwapFreezerBase} from 'src/contracts/facilitators/gsm/swapFreezer/OracleSwapFreezerBase.sol';
 import {IGsm} from 'src/contracts/facilitators/gsm/interfaces/IGsm.sol';
+import {OracleSwapFreezerBase} from 'src/contracts/facilitators/gsm/swapFreezer/OracleSwapFreezerBase.sol';
 
 /**
  * @title GelatoOracleSwapFreezer
  * @notice Gelato-compatible automated swap freezer for GSM.
  */
-contract GelatoOracleSwapFreezer is OracleSwapFreezerBase {
+contract GelatoOracleSwapFreezer is OracleSwapFreezerBase, IGelatoOracleSwapFreezer {
   /**
    * @dev Constructor
    * @dev Freeze/unfreeze bounds are specified in USD with 8-decimal precision, like Aave v3 Price Oracles
    * @dev Unfreeze boundaries are "contained" in freeze boundaries, where freezeLowerBound < unfreezeLowerBound and unfreezeUpperBound < freezeUpperBound
    * @dev All bound ranges are inclusive
    * @param gsm The GSM that this contract will trigger freezes/unfreezes on
    * @param underlyingAsset The address of the collateral asset
-   * @param addressProvider The Aave Addresses Provider for looking up the Price Oracle
+   * @param addressesProvider The Aave Addresses Provider for looking up the Price Oracle
    * @param freezeLowerBound The lower price bound for freeze operations
    * @param freezeUpperBound The upper price bound for freeze operations
    * @param unfreezeLowerBound The lower price bound for unfreeze operations, must be 0 if unfreezing not allowed
@@ -27,7 +28,7 @@ contract GelatoOracleSwapFreezer is OracleSwapFreezerBase {
   constructor(
     IGsm gsm,
     address underlyingAsset,
-    IPoolAddressesProvider addressProvider,
+    IPoolAddressesProvider addressesProvider,
     uint128 freezeLowerBound,
     uint128 freezeUpperBound,
     uint128 unfreezeLowerBound,
@@ -37,7 +38,7 @@ contract GelatoOracleSwapFreezer is OracleSwapFreezerBase {
     OracleSwapFreezerBase(
       gsm,
       underlyingAsset,
-      addressProvider,
+      addressesProvider,
       freezeLowerBound,
       freezeUpperBound,
       unfreezeLowerBound,
@@ -47,24 +48,18 @@ contract GelatoOracleSwapFreezer is OracleSwapFreezerBase {
   {}
 
   /**
-   * @notice Executes a given action on the GSM depending on the oracle value
+   * @dev Performs the swap freeze action depending on the oracle value
    */
-  function execute(bytes calldata) external {
-    Action action = _getAction();
-    if (action == Action.FREEZE) {
-      GSM.setSwapFreeze(true);
-    } else if (action == Action.UNFREEZE) {
-      GSM.setSwapFreeze(false);
-    }
+  function performUpkeep(bytes calldata) external {
+    _execute();
   }
 
   /**
    * @notice Returns whether the action can be performed and the encoded call data for execution.
    * @return True if the action can be performed, false otherwise.
    * @return The encoded call data for the action to be executed.
    */
-
-  function checkExecute(bytes calldata) external view returns (bool, bytes memory) {
-    return (_getAction() == Action.NONE ? false : true, abi.encodeCall(this.execute, ''));
+  function checkUpkeep(bytes calldata) external view returns (bool, bytes memory) {
+    return (_getAction() == Action.NONE ? false : true, abi.encodeCall(this.performUpkeep, ('')));
   }
 }
diff --git a/src/contracts/facilitators/gsm/swapFreezer/OracleSwapFreezerBase.sol b/src/contracts/facilitators/gsm/swapFreezer/OracleSwapFreezerBase.sol
@@ -36,7 +36,7 @@ abstract contract OracleSwapFreezerBase {
    * @dev All bound ranges are inclusive
    * @param gsm The GSM that this contract will trigger freezes/unfreezes on
    * @param underlyingAsset The address of the collateral asset
-   * @param addressProvider The Aave Addresses Provider for looking up the Price Oracle
+   * @param addressesProvider The Aave Addresses Provider for looking up the Price Oracle
    * @param freezeLowerBound The lower price bound for freeze operations
    * @param freezeUpperBound The upper price bound for freeze operations
    * @param unfreezeLowerBound The lower price bound for unfreeze operations, must be 0 if unfreezing not allowed
@@ -46,7 +46,7 @@ abstract contract OracleSwapFreezerBase {
   constructor(
     IGsm gsm,
     address underlyingAsset,
-    IPoolAddressesProvider addressProvider,
+    IPoolAddressesProvider addressesProvider,
     uint128 freezeLowerBound,
     uint128 freezeUpperBound,
     uint128 unfreezeLowerBound,
@@ -66,14 +66,34 @@ abstract contract OracleSwapFreezerBase {
     );
     GSM = gsm;
     UNDERLYING_ASSET = underlyingAsset;
-    ADDRESS_PROVIDER = addressProvider;
+    ADDRESS_PROVIDER = addressesProvider;
     _freezeLowerBound = freezeLowerBound;
     _freezeUpperBound = freezeUpperBound;
     _unfreezeLowerBound = unfreezeLowerBound;
     _unfreezeUpperBound = unfreezeUpperBound;
     _allowUnfreeze = allowUnfreeze;
   }
 
+  /**
+   * @dev Performs the swap freeze action depending on the oracle value
+   */
+  function _execute() internal {
+    Action action = _getAction();
+    if (action == Action.FREEZE) {
+      GSM.setSwapFreeze(true);
+    } else if (action == Action.UNFREEZE) {
+      GSM.setSwapFreeze(false);
+    }
+  }
+
+  /**
+   * @dev Returns whether the action can be performed
+   * @return True if the action can be performed, false otherwise.
+   */
+  function _checkExecute() internal view returns (bool) {
+    return _getAction() == Action.NONE ? false : true;
+  }
+
   /**
    * @notice Returns whether or not the swap freezer can unfreeze a GSM
    * @return True if the freezer can unfreeze, false otherwise
diff --git a/tests/unit/TestChainlinkOracleSwapFreezer.t.sol b/tests/unit/TestChainlinkOracleSwapFreezer.t.sol
@@ -7,47 +7,47 @@ contract TestChainlinkOracleSwapFreezer is TestOracleSwapFreezerBase {
   function _deployOracleSwapFreezer(
     IGsm gsm,
     address underlyingAsset,
-    IPoolAddressesProvider addressProvider,
+    IPoolAddressesProvider addressesProvider,
     uint128 freezeLowerBound,
     uint128 freezeUpperBound,
     uint128 unfreezeLowerBound,
     uint128 unfreezeUpperBound,
     bool allowUnfreeze
-  ) internal override returns (OracleSwapFreezerBase) {
+  ) internal override returns (address) {
     return
-      new ChainlinkOracleSwapFreezer(
-        gsm,
-        underlyingAsset,
-        addressProvider,
-        freezeLowerBound,
-        freezeUpperBound,
-        unfreezeLowerBound,
-        unfreezeUpperBound,
-        allowUnfreeze
+      address(
+        new ChainlinkOracleSwapFreezer(
+          gsm,
+          underlyingAsset,
+          addressesProvider,
+          freezeLowerBound,
+          freezeUpperBound,
+          unfreezeLowerBound,
+          unfreezeUpperBound,
+          allowUnfreeze
+        )
       );
   }
 
-  function _checkAutomation(
-    OracleSwapFreezerBase _swapFreezer
-  ) internal view override returns (bool) {
-    (bool shouldRunKeeper, ) = _swapFreezer.checkUpkeep('');
+  function _checkAutomation(address swapFreezer) internal view override returns (bool) {
+    bytes memory returnData = Address.functionStaticCall(
+      swapFreezer,
+      abi.encodeWithSelector(AutomationCompatibleInterface.checkUpkeep.selector, '')
+    );
+    (bool shouldRunKeeper, ) = abi.decode(returnData, (bool, bytes));
     return shouldRunKeeper;
   }
 
-  function _checkAndPerformAutomation(
-    OracleSwapFreezerBase _swapFreezer
-  ) internal override returns (bool) {
-    (bool shouldRunKeeper, bytes memory performData) = _swapFreezer.checkUpkeep('');
+  function _checkAndPerformAutomation(address swapFreezer) internal override returns (bool) {
+    bytes memory returnData = Address.functionStaticCall(
+      swapFreezer,
+      abi.encodeWithSelector(AutomationCompatibleInterface.checkUpkeep.selector, '')
+    );
+    (bool shouldRunKeeper, bytes memory performData) = abi.decode(returnData, (bool, bytes));
+
     if (shouldRunKeeper) {
-      _swapFreezer.performUpkeep(performData);
+      AutomationCompatibleInterface(swapFreezer).performUpkeep(performData);
     }
     return shouldRunKeeper;
   }
-
-  function _performAutomation(
-    OracleSwapFreezerBase _swapFreezer,
-    bytes memory performData
-  ) internal override {
-    _swapFreezer.performUpkeep(performData);
-  }
 }
diff --git a/tests/unit/TestGelatoOracleSwapFreezer.t.sol b/tests/unit/TestGelatoOracleSwapFreezer.t.sol
@@ -2,64 +2,57 @@
 pragma solidity ^0.8.0;
 
 import './TestOracleSwapFreezerBase.t.sol';
-import {Address} from 'openzeppelin-contracts/contracts/utils/Address.sol';
 
-contract TestGsmGelatoOracleSwapFreezer is TestOracleSwapFreezerBase {
+contract TestGelatoOracleSwapFreezer is TestOracleSwapFreezerBase {
   using Address for address;
 
   function testCheckUpkeepReturnsCorrectSelector() public view {
-    (, bytes memory data) = swapFreezer.checkExecute('');
+    (, bytes memory data) = IGelatoOracleSwapFreezer(swapFreezer).checkUpkeep('');
     bytes4 selector;
     assembly {
       selector := mload(add(data, 32))
     }
-    assertEq(selector, OracleSwapFreezerBase.performUpkeep.selector);
+    assertEq(selector, IGelatoOracleSwapFreezer.performUpkeep.selector);
   }
 
   function _deployOracleSwapFreezer(
     IGsm gsm,
     address underlyingAsset,
-    IPoolAddressesProvider addressProvider,
+    IPoolAddressesProvider addressesProvider,
     uint128 freezeLowerBound,
     uint128 freezeUpperBound,
     uint128 unfreezeLowerBound,
     uint128 unfreezeUpperBound,
     bool allowUnfreeze
-  ) internal override returns (OracleSwapFreezerBase) {
+  ) internal override returns (address) {
     return
-      new GelatoOracleSwapFreezer(
-        gsm,
-        underlyingAsset,
-        addressProvider,
-        freezeLowerBound,
-        freezeUpperBound,
-        unfreezeLowerBound,
-        unfreezeUpperBound,
-        allowUnfreeze
+      address(
+        new GelatoOracleSwapFreezer(
+          gsm,
+          underlyingAsset,
+          addressesProvider,
+          freezeLowerBound,
+          freezeUpperBound,
+          unfreezeLowerBound,
+          unfreezeUpperBound,
+          allowUnfreeze
+        )
       );
   }
 
-  function _checkAutomation(
-    OracleSwapFreezerBase _swapFreezer
-  ) internal view override returns (bool) {
-    (bool shouldRunKeeper, ) = _swapFreezer.checkExecute('');
+  function _checkAutomation(address swapFreezer) internal view override returns (bool) {
+    (bool shouldRunKeeper, ) = IGelatoOracleSwapFreezer(swapFreezer).checkUpkeep('');
     return shouldRunKeeper;
   }
 
   function _checkAndPerformAutomation(
-    OracleSwapFreezerBase _swapFreezer
+    address swapFreezer
   ) internal virtual override returns (bool) {
-    (bool shouldRunKeeper, bytes memory encodedPerformData) = _swapFreezer.checkExecute('');
+    (bool shouldRunKeeper, bytes memory encodedPerformCall) = IGelatoOracleSwapFreezer(swapFreezer)
+      .checkUpkeep('');
     if (shouldRunKeeper) {
-      address(_swapFreezer).functionCall(encodedPerformData);
+      swapFreezer.functionCall(encodedPerformCall);
     }
     return shouldRunKeeper;
   }
-
-  function _performAutomation(
-    OracleSwapFreezerBase _swapFreezer,
-    bytes memory encodedCalldata
-  ) internal override {
-    address(_swapFreezer).functionCall(encodedCalldata);
-  }
 }
diff --git a/tests/unit/TestGhoBase.t.sol b/tests/unit/TestGhoBase.t.sol
@@ -5,6 +5,10 @@ import 'forge-std/Test.sol';
 import 'forge-std/console2.sol';
 import {Vm} from 'forge-std/Vm.sol';
 
+// dependencies
+import {Address} from 'openzeppelin-contracts/contracts/utils/Address.sol';
+import {AutomationCompatibleInterface} from 'src/contracts/dependencies/chainlink/AutomationCompatibleInterface.sol';
+
 // helpers
 import {Constants} from '../helpers/Constants.sol';
 import {DebtUtils} from '../helpers/DebtUtils.sol';
@@ -83,8 +87,10 @@ import {GhoGsmSteward} from 'src/contracts/misc/GhoGsmSteward.sol';
 import {FixedFeeStrategyFactory} from 'src/contracts/facilitators/gsm/feeStrategy/FixedFeeStrategyFactory.sol';
 import {GhoReserve} from 'src/contracts/facilitators/gsm/GhoReserve.sol';
 import {OwnableFacilitator} from 'src/contracts/facilitators/gsm/OwnableFacilitator.sol';
+import {OracleSwapFreezerBase} from 'src/contracts/facilitators/gsm/swapFreezer/OracleSwapFreezerBase.sol';
 import {ChainlinkOracleSwapFreezer} from 'src/contracts/facilitators/gsm/swapFreezer/ChainlinkOracleSwapFreezer.sol';
 import {GelatoOracleSwapFreezer} from 'src/contracts/facilitators/gsm/swapFreezer/GelatoOracleSwapFreezer.sol';
+import {IGelatoOracleSwapFreezer} from 'src/contracts/facilitators/gsm/swapFreezer/interfaces/IGelatoOracleSwapFreezer.sol';
 
 // CCIP contracts
 import {MockUpgradeableLockReleaseTokenPool} from '../mocks/MockUpgradeableLockReleaseTokenPool.sol';
diff --git a/tests/unit/TestOracleSwapFreezerBase.t.sol b/tests/unit/TestOracleSwapFreezerBase.t.sol
