move IBCChannelUpgradableModule into apps/commons

Signed-off-by: Jun Kimura <[email protected]>
hyperledger-labs · Jul 30, 2024 · e70f0d5 · e70f0d5
1 parent 9b5036a
commit e70f0d5
Show file tree

Hide file tree

Showing 5 changed files with 101 additions and 98 deletions.
diff --git a/...rc/helpers/IBCChannelUpgradableModule.sol → ...ps/commons/IBCChannelUpgradableModule.sol b/...rc/helpers/IBCChannelUpgradableModule.sol → ...ps/commons/IBCChannelUpgradableModule.sol
@@ -1,91 +1,11 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Channel, UpgradeFields, Timeout} from "../../../../contracts/proto/Channel.sol";
-import {IIBCHandler} from "../../../../contracts/core/25-handler/IIBCHandler.sol";
-import {IIBCModuleUpgrade} from "../../../../contracts/core/26-router/IIBCModuleUpgrade.sol";
-import {AppBase} from "../../../../contracts/apps/commons/IBCAppBase.sol";
-
-interface IIBCChannelUpgradableModuleErrors {
-    // ------------------- Errors ------------------- //
-
-    error IBCChannelUpgradableModuleUnauthorizedUpgrader();
-    error IBCChannelUpgradableModuleInvalidTimeout();
-    error IBCChannelUpgradableModuleInvalidConnectionHops();
-    error IBCChannelUpgradableModuleUpgradeAlreadyExists();
-    error IBCChannelUpgradableModuleUpgradeNotFound();
-    error IBCChannelUpgradableModuleInvalidUpgrade();
-
-    error IBCChannelUpgradableModuleCannotRemoveInProgressUpgrade();
-    /// @param state The current state of the channel
-    error IBCChannelUpgradableModuleChannelNotFlushingState(Channel.State state);
-    /// @param actual The actual upgrade sequence
-    error IBCChannelUpgradableModuleSequenceMismatch(uint64 actual);
-
-    error IBCChannelUpgradableModuleChannelNotFound();
-    error IBCChannelUpgradableModuleCannotOverwriteUpgrade();
-}
-
-interface IIBCChannelUpgradableModule {
-    // ------------------- Data Structures ------------------- //
-
-    /**
-     * @dev Proposed upgrade fields
-     * @param fields Upgrade fields
-     * @param timeout Absolute timeout for the upgrade
-     */
-    struct UpgradeProposal {
-        UpgradeFields.Data fields;
-        Timeout.Data timeout;
-    }
-
-    /**
-     * @dev Allowed transition for the channel upgrade
-     * @param flushComplete Whether the upgrade is allowed to transition to the flush complete state
-     */
-    struct AllowedTransition {
-        bool flushComplete;
-    }
-
-    // ------------------- Functions ------------------- //
-
-    /**
-     * @dev Returns the proposed upgrade for the given port, channel, and sequence
-     */
-    function getUpgradeProposal(string calldata portId, string calldata channelId)
-        external
-        view
-        returns (UpgradeProposal memory);
-
-    /**
-     * @dev Propose an upgrade for the given port, channel, and sequence
-     * @notice This function is only callable by an authorized upgrader
-     * The upgrader must call this function before calling `channelUpgradeInit` or `channelUpgradeTry` of the IBC handler
-     */
-    function proposeUpgrade(
-        string calldata portId,
-        string calldata channelId,
-        UpgradeFields.Data calldata upgradeFields,
-        Timeout.Data calldata timeout
-    ) external;
-
-    /**
-     * @dev Removes the proposed upgrade for the given port and channel
-     * @notice This function is only callable by an authorized upgrader
-     * @param portId Port identifier
-     * @param channelId Channel identifier
-     */
-    function removeUpgradeProposal(string calldata portId, string calldata channelId) external;
-
-    /**
-     * @dev Allow the upgrade to transition to the flush complete state
-     * @notice This function is only callable by an authorized upgrader
-     * WARNING: Before calling this function, the upgrader must ensure that all inflight packets have been received on the receiving chain,
-     * and all acknowledgements written have been acknowledged on the sending chain
-     */
-    function allowTransitionToFlushComplete(string calldata portId, string calldata channelId, uint64 upgradeSequence)
-        external;
-}
+import {Channel, UpgradeFields, Timeout} from "../../proto/Channel.sol";
+import {IIBCHandler} from "../../core/25-handler/IIBCHandler.sol";
+import {IIBCModuleUpgrade} from "../../core/26-router/IIBCModuleUpgrade.sol";
+import {AppBase} from "./IBCAppBase.sol";
+import {IIBCChannelUpgradableModule, IIBCChannelUpgradableModuleErrors} from "./IIBCChannelUpgradableModule.sol";
 
 abstract contract IBCChannelUpgradableModuleBase is
     AppBase,
@@ -312,10 +232,8 @@ abstract contract IBCChannelUpgradableModuleBase is
      * @dev See {IERC165-supportsInterface}
      */
     function supportsInterface(bytes4 interfaceId) public view virtual override returns (bool) {
-        return
-            super.supportsInterface(interfaceId) ||
-            interfaceId == type(IIBCModuleUpgrade).interfaceId ||
-            interfaceId == type(IIBCChannelUpgradableModule).interfaceId;
+        return super.supportsInterface(interfaceId) || interfaceId == type(IIBCModuleUpgrade).interfaceId
+            || interfaceId == type(IIBCChannelUpgradableModule).interfaceId;
     }
 
     // ------------------- Internal Functions ------------------- //

diff --git a/contracts/apps/commons/IIBCChannelUpgradableModule.sol b/contracts/apps/commons/IIBCChannelUpgradableModule.sol
@@ -0,0 +1,85 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {Channel, UpgradeFields, Timeout} from "../../proto/Channel.sol";
+
+interface IIBCChannelUpgradableModuleErrors {
+    // ------------------- Errors ------------------- //
+
+    error IBCChannelUpgradableModuleUnauthorizedUpgrader();
+    error IBCChannelUpgradableModuleInvalidTimeout();
+    error IBCChannelUpgradableModuleInvalidConnectionHops();
+    error IBCChannelUpgradableModuleUpgradeAlreadyExists();
+    error IBCChannelUpgradableModuleUpgradeNotFound();
+    error IBCChannelUpgradableModuleInvalidUpgrade();
+
+    error IBCChannelUpgradableModuleCannotRemoveInProgressUpgrade();
+    /// @param state The current state of the channel
+    error IBCChannelUpgradableModuleChannelNotFlushingState(Channel.State state);
+    /// @param actual The actual upgrade sequence
+    error IBCChannelUpgradableModuleSequenceMismatch(uint64 actual);
+
+    error IBCChannelUpgradableModuleChannelNotFound();
+    error IBCChannelUpgradableModuleCannotOverwriteUpgrade();
+}
+
+interface IIBCChannelUpgradableModule {
+    // ------------------- Data Structures ------------------- //
+
+    /**
+     * @dev Proposed upgrade fields
+     * @param fields Upgrade fields
+     * @param timeout Absolute timeout for the upgrade
+     */
+    struct UpgradeProposal {
+        UpgradeFields.Data fields;
+        Timeout.Data timeout;
+    }
+
+    /**
+     * @dev Allowed transition for the channel upgrade
+     * @param flushComplete Whether the upgrade is allowed to transition to the flush complete state
+     */
+    struct AllowedTransition {
+        bool flushComplete;
+    }
+
+    // ------------------- Functions ------------------- //
+
+    /**
+     * @dev Returns the proposed upgrade for the given port, channel, and sequence
+     */
+    function getUpgradeProposal(string calldata portId, string calldata channelId)
+        external
+        view
+        returns (UpgradeProposal memory);
+
+    /**
+     * @dev Propose an upgrade for the given port, channel, and sequence
+     * @notice This function is only callable by an authorized upgrader
+     * The upgrader must call this function before calling `channelUpgradeInit` or `channelUpgradeTry` of the IBC handler
+     */
+    function proposeUpgrade(
+        string calldata portId,
+        string calldata channelId,
+        UpgradeFields.Data calldata upgradeFields,
+        Timeout.Data calldata timeout
+    ) external;
+
+    /**
+     * @dev Removes the proposed upgrade for the given port and channel
+     * @notice This function is only callable by an authorized upgrader
+     * @param portId Port identifier
+     * @param channelId Channel identifier
+     */
+    function removeUpgradeProposal(string calldata portId, string calldata channelId) external;
+
+    /**
+     * @dev Allow the upgrade to transition to the flush complete state
+     * @notice This function is only callable by an authorized upgrader
+     * WARNING: Before calling this function, the upgrader must ensure that all inflight packets have been received on the receiving chain,
+     * and all acknowledgements written have been acknowledged on the sending chain
+     */
+    function allowTransitionToFlushComplete(string calldata portId, string calldata channelId, uint64 upgradeSequence)
+        external;
+}
diff --git a/tests/foundry/src/ICS04Upgrade.t.sol b/tests/foundry/src/ICS04Upgrade.t.sol
@@ -14,7 +14,9 @@ import {TestIBCChannelUpgradableMockApp} from "./helpers/TestIBCChannelUpgradabl
 import {TestIBCChannelUpgradableMockAppInconsistentVersions} from "./helpers/TestIBCChannelUpgradableMockAppInconsistentVersions.t.sol";
 import {ICS04UpgradeTestHelper} from "./helpers/ICS04UpgradeTestHelper.t.sol";
 import {ICS04PacketEventTestHelper} from "./helpers/ICS04PacketTestHelper.t.sol";
-import {IIBCChannelUpgradableModule} from "./helpers/IBCChannelUpgradableModule.sol";
+import {
+    IIBCChannelUpgradableModule
+} from "../../../contracts/apps/commons/IBCChannelUpgradableModule.sol";
 import {IBCMockLib} from "../../../contracts/apps/mock/IBCMockLib.sol";
 import {IBCMockApp} from "../../../contracts/apps/mock/IBCMockApp.sol";
 

diff --git a/tests/foundry/src/ICS04UpgradeApp.t.sol b/tests/foundry/src/ICS04UpgradeApp.t.sol
@@ -3,14 +3,12 @@ pragma solidity ^0.8.20;
 
 import "./helpers/IBCTestHelper.t.sol";
 import {Vm} from "forge-std/Test.sol";
-import {Upgrade, UpgradeFields, Timeout} from "../../../contracts/proto/Channel.sol";
-import {LocalhostClientLib} from "../../../contracts/clients/09-localhost/LocalhostClient.sol";
+import {UpgradeFields, Timeout} from "../../../contracts/proto/Channel.sol";
 import {LocalhostHelper} from "../../../contracts/clients/09-localhost/LocalhostHelper.sol";
-import {IIBCChannelUpgrade} from "../../../contracts/core/04-channel/IIBCChannelUpgrade.sol";
-import {TestIBCChannelUpgradableMockApp} from "./helpers/TestIBCChannelUpgradableMockApp.t.sol";
 import {
     IIBCChannelUpgradableModule, IIBCChannelUpgradableModuleErrors
-} from "./helpers/IBCChannelUpgradableModule.sol";
+} from "../../../contracts/apps/commons/IBCChannelUpgradableModule.sol";
+import {TestIBCChannelUpgradableMockApp} from "./helpers/TestIBCChannelUpgradableMockApp.t.sol";
 import {ICS04UpgradeTestHelper} from "./helpers/ICS04UpgradeTestHelper.t.sol";
 
 contract TestICS04UpgradeApp is ICS04UpgradeTestHelper {

diff --git a/tests/foundry/src/helpers/TestIBCChannelUpgradableMockApp.t.sol b/tests/foundry/src/helpers/TestIBCChannelUpgradableMockApp.t.sol
@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {Upgrade, UpgradeFields, Timeout} from "../../../../contracts/proto/Channel.sol";
+import {UpgradeFields, Timeout} from "../../../../contracts/proto/Channel.sol";
 import {
-    IIBCChannelUpgrade, IIBCChannelUpgradeBase
+    IIBCChannelUpgradeBase
 } from "../../../../contracts/core/04-channel/IIBCChannelUpgrade.sol";
 import {IIBCHandler} from "../../../../contracts/core/25-handler/IIBCHandler.sol";
 import {IBCMockApp} from "../../../../contracts/apps/mock/IBCMockApp.sol";
-import {IBCChannelUpgradableModuleBase} from "./IBCChannelUpgradableModule.sol";
+import {IBCChannelUpgradableModuleBase} from "../../../../contracts/apps/commons/IBCChannelUpgradableModule.sol";
 import {IBCAppBase} from "../../../../contracts/apps/commons/IBCAppBase.sol";
 
 contract TestIBCChannelUpgradableMockApp is IBCMockApp, IBCChannelUpgradableModuleBase {