Add CCIP from core-modules to protocol/synthetix

protocol/synthetix/cannonfile.test.toml

@@ -22,9 +22,6 @@ artifact = "contracts/generated/test/TestableCollateralConfigurationStorage.sol:
 [contract.TestableCollateralLockStorage]
 artifact = "contracts/generated/test/TestableCollateralLockStorage.sol:TestableCollateralLockStorage"
 
-[contract.TestableCrossChainStorage]
-artifact = "contracts/generated/test/TestableCrossChainStorage.sol:TestableCrossChainStorage"
-
 [contract.TestableDistributionStorage]
 artifact = "contracts/generated/test/TestableDistributionStorage.sol:TestableDistributionStorage"
 
@@ -72,6 +69,7 @@ contracts = [
     "CcipReceiverModule",
     "CollateralModule",
     "CollateralConfigurationModule",
+    "CrossChainModule",
     "CrossChainUSDModule",
     "IssueUSDModule",
     "LiquidationModule",
@@ -87,7 +85,6 @@ contracts = [
     "TestableCollateralStorage",
     "TestableCollateralConfigurationStorage",
     "TestableCollateralLockStorage",
-    "TestableCrossChainStorage",
     "TestableDistributionStorage",
     "TestableDistributionActorStorage",
     "TestableMarketStorage",

protocol/synthetix/cannonfile.toml

@@ -49,6 +49,9 @@ artifact = "contracts/modules/core/CollateralModule.sol:CollateralModule"
 [contract.CollateralConfigurationModule]
 artifact = "contracts/modules/core/CollateralConfigurationModule.sol:CollateralConfigurationModule"
 
+[contract.CrossChainModule]
+artifact = "contracts/modules/core/CrossChainModule.sol:CrossChainModule"
+
 [contract.CrossChainUSDModule]
 artifact = "contracts/modules/core/CrossChainUSDModule.sol:CrossChainUSDModule"
 
@@ -96,6 +99,7 @@ contracts = [
     "CcipReceiverModule",
     "CollateralModule",
     "CollateralConfigurationModule",
+    "CrossChainModule",
     "CrossChainUSDModule",
     "IssueUSDModule",
     "LiquidationModule",

protocol/synthetix/contracts/interfaces/IUtilsModule.sol

@@ -7,31 +7,6 @@ import {IERC165} from "@synthetixio/core-contracts/contracts/interfaces/IERC165.
  * @title Module with assorted utility functions.
  */
 interface IUtilsModule is IERC165 {
-    /**
-     * @notice Emitted when a new cross chain network becomes supported by the protocol
-     */
-    event NewSupportedCrossChainNetwork(uint64 newChainId);
-
-    /**
-     * @notice Configure CCIP addresses on the stablecoin.
-     * @param ccipRouter The address on this chain to which CCIP messages will be sent or received.
-     * @param ccipTokenPool The address where CCIP fees will be sent to when sending and receiving cross chain messages.
-     */
-    function configureChainlinkCrossChain(address ccipRouter, address ccipTokenPool) external;
-
-    /**
-     * @notice Used to add new cross chain networks to the protocol
-     * Ignores a network if it matches the current chain id
-     * Ignores a network if it has already been added
-     * @param supportedNetworks array of all networks that are supported by the protocol
-     * @param ccipSelectors the ccip "selector" which maps to the chain id on the same index. must be same length as `supportedNetworks`
-     * @return numRegistered the number of networks that were actually registered
-     */
-    function setSupportedCrossChainNetworks(
-        uint64[] memory supportedNetworks,
-        uint64[] memory ccipSelectors
-    ) external returns (uint256 numRegistered);
-
     /**
      * @notice Configure the system's single oracle manager address.
      * @param oracleManagerAddress The address of the oracle manager.
@@ -66,6 +41,13 @@ interface IUtilsModule is IERC165 {
      */
     function getConfigAddress(bytes32 k) external view returns (address v);
 
+    /**
+     * @notice Configure CCIP addresses on the stablecoin.
+     * @param ccipRouter The address on this chain to which CCIP messages will be sent or received.
+     * @param ccipTokenPool The address where CCIP fees will be sent to when sending and receiving cross chain messages.
+     */
+    function configureUsdTokenChainlink(address ccipRouter, address ccipTokenPool) external;
+
     /**
      * @notice Checks if the address is the trusted forwarder
      * @param forwarder The address to check

protocol/synthetix/contracts/mocks/CcipRouterMock.sol

@@ -1,7 +1,6 @@
 //SPDX-License-Identifier: MIT
 pragma solidity >=0.8.4;
-
-import "../interfaces/external/ICcipRouterClient.sol";
+import "@synthetixio/core-modules/contracts/interfaces/external/ICcipRouterClient.sol";
 
 contract CcipRouterMock {
     // solhint-disable no-empty-blocks

protocol/synthetix/contracts/modules/core/CcipReceiverModule.sol

@@ -1,22 +1,12 @@
 //SPDX-License-Identifier: MIT
 pragma solidity >=0.8.11 <0.9.0;
 
-import "@synthetixio/core-modules/contracts/interfaces/IAssociatedSystemsModule.sol";
-import "@synthetixio/core-modules/contracts/storage/AssociatedSystem.sol";
-import "@synthetixio/core-contracts/contracts/ownership/OwnableStorage.sol";
-
-import "../../interfaces/external/IAny2EVMMessageReceiver.sol";
-
-import "../../storage/OracleManager.sol";
-import "../../storage/Config.sol";
-import "../../storage/CrossChain.sol";
+import {CcipReceiverModule as BaseCcipReceiverModule} from "@synthetixio/core-modules/contracts/modules/CcipReceiverModule.sol";
 
 /**
- * @title Module with assorted utility functions.
- * @dev See IUtilsModule.
+ * @title Module that handles receiving ccip messages.
  */
-contract CcipReceiverModule is IAny2EVMMessageReceiver {
-    function ccipReceive(CcipClient.Any2EVMMessage memory message) external {
-        CrossChain.processCcipReceive(CrossChain.load(), message);
-    }
+// solhint-disable-next-line no-empty-blocks
+contract CcipReceiverModule is BaseCcipReceiverModule {
+
 }

protocol/synthetix/contracts/modules/core/CrossChainModule.sol

@@ -0,0 +1,12 @@
+//SPDX-License-Identifier: MIT
+pragma solidity >=0.8.11 <0.9.0;
+
+import {CrossChainModule as BaseCrossChainModule} from "@synthetixio/core-modules/contracts/modules/CrossChainModule.sol";
+
+/**
+ * @title Module that handles anything related to cross-chain.
+ */
+// solhint-disable-next-line no-empty-blocks
+contract CrossChainModule is BaseCrossChainModule {
+
+}

protocol/synthetix/contracts/modules/core/CrossChainUSDModule.sol

@@ -5,10 +5,9 @@ import "../../interfaces/ICrossChainUSDModule.sol";
 import "@synthetixio/core-modules/contracts/interfaces/ITokenModule.sol";
 import "@synthetixio/core-contracts/contracts/utils/ERC2771Context.sol";
 
-import "../../storage/CrossChain.sol";
-
 import "@synthetixio/core-modules/contracts/storage/AssociatedSystem.sol";
 import "@synthetixio/core-modules/contracts/storage/FeatureFlag.sol";
+import "@synthetixio/core-modules/contracts/storage/CrossChain.sol";
 
 /**
  * @title Module for the cross-chain transfers of stablecoins.

protocol/synthetix/contracts/modules/core/UtilsModule.sol

@@ -4,86 +4,25 @@ pragma solidity >=0.8.11 <0.9.0;
 import "@synthetixio/core-modules/contracts/interfaces/IAssociatedSystemsModule.sol";
 import "@synthetixio/core-modules/contracts/storage/AssociatedSystem.sol";
 import "@synthetixio/core-contracts/contracts/ownership/OwnableStorage.sol";
-import "@synthetixio/core-contracts/contracts/errors/ParameterError.sol";
-import "@synthetixio/core-contracts/contracts/utils/SafeCast.sol";
 import "@synthetixio/core-contracts/contracts/utils/ERC2771Context.sol";
 
 import "../../interfaces/IUtilsModule.sol";
 
-import "../../storage/CrossChain.sol";
 import "../../storage/OracleManager.sol";
 import "../../storage/Config.sol";
 
-import "../../interfaces/external/IAny2EVMMessageReceiver.sol";
-
 /**
  * @title Module with assorted utility functions.
  * @dev See IUtilsModule.
  */
 contract UtilsModule is IUtilsModule {
     using AssociatedSystem for AssociatedSystem.Data;
-    using SetUtil for SetUtil.UintSet;
-    using SafeCastU256 for uint256;
 
     bytes32 private constant _USD_TOKEN = "USDToken";
     bytes32 private constant _CCIP_CHAINLINK_SEND = "ccipChainlinkSend";
     bytes32 private constant _CCIP_CHAINLINK_RECV = "ccipChainlinkRecv";
     bytes32 private constant _CCIP_CHAINLINK_TOKEN_POOL = "ccipChainlinkTokenPool";
 
-    /**
-     * @inheritdoc IUtilsModule
-     */
-    function configureChainlinkCrossChain(
-        address ccipRouter,
-        address ccipTokenPool
-    ) external override {
-        OwnableStorage.onlyOwner();
-
-        CrossChain.Data storage cc = CrossChain.load();
-
-        cc.ccipRouter = ICcipRouterClient(ccipRouter);
-
-        IAssociatedSystemsModule usdToken = IAssociatedSystemsModule(
-            AssociatedSystem.load(_USD_TOKEN).proxy
-        );
-
-        usdToken.registerUnmanagedSystem(_CCIP_CHAINLINK_SEND, ccipRouter);
-        usdToken.registerUnmanagedSystem(_CCIP_CHAINLINK_RECV, ccipRouter);
-        usdToken.registerUnmanagedSystem(_CCIP_CHAINLINK_TOKEN_POOL, ccipTokenPool);
-    }
-
-    /**
-     * @inheritdoc IUtilsModule
-     */
-    function setSupportedCrossChainNetworks(
-        uint64[] memory supportedNetworks,
-        uint64[] memory ccipSelectors
-    ) external returns (uint256 numRegistered) {
-        OwnableStorage.onlyOwner();
-
-        uint64 myChainId = block.chainid.to64();
-
-        if (ccipSelectors.length != supportedNetworks.length) {
-            revert ParameterError.InvalidParameter("ccipSelectors", "must match length");
-        }
-
-        CrossChain.Data storage cc = CrossChain.load();
-        for (uint i = 0; i < supportedNetworks.length; i++) {
-            if (supportedNetworks[i] == myChainId) continue;
-            if (
-                supportedNetworks[i] != myChainId &&
-                !cc.supportedNetworks.contains(supportedNetworks[i])
-            ) {
-                numRegistered++;
-                cc.supportedNetworks.add(supportedNetworks[i]);
-                emit NewSupportedCrossChainNetwork(supportedNetworks[i]);
-            }
-
-            cc.ccipChainIdToSelector[supportedNetworks[i]] = ccipSelectors[i];
-            cc.ccipSelectorToChainId[ccipSelectors[i]] = supportedNetworks[i];
-        }
-    }
-
     /**
      * @inheritdoc IUtilsModule
      */
@@ -128,8 +67,21 @@ contract UtilsModule is IUtilsModule {
     function supportsInterface(
         bytes4 interfaceId
     ) public view virtual override(IERC165) returns (bool) {
-        return
-            interfaceId == type(IAny2EVMMessageReceiver).interfaceId ||
-            interfaceId == this.supportsInterface.selector;
+        return interfaceId == this.supportsInterface.selector;
+    }
+
+    function configureUsdTokenChainlink(
+        address ccipRouter,
+        address ccipTokenPool
+    ) external override {
+        OwnableStorage.onlyOwner();
+
+        IAssociatedSystemsModule usdToken = IAssociatedSystemsModule(
+            AssociatedSystem.load(_USD_TOKEN).getAddress()
+        );
+
+        usdToken.registerUnmanagedSystem(_CCIP_CHAINLINK_SEND, ccipRouter);
+        usdToken.registerUnmanagedSystem(_CCIP_CHAINLINK_RECV, ccipRouter);
+        usdToken.registerUnmanagedSystem(_CCIP_CHAINLINK_TOKEN_POOL, ccipTokenPool);
     }
 }

protocol/synthetix/contracts/modules/usd/USDTokenModule.sol

@@ -2,10 +2,10 @@
 pragma solidity ^0.8.7;
 
 import "../../interfaces/IUSDTokenModule.sol";
-import "../../storage/CrossChain.sol";
 
 import "@synthetixio/core-contracts/contracts/utils/ERC2771Context.sol";
 import "@synthetixio/core-modules/contracts/storage/AssociatedSystem.sol";
+import "@synthetixio/core-modules/contracts/storage/CrossChain.sol";
 import "@synthetixio/core-contracts/contracts/token/ERC20.sol";
 import "@synthetixio/core-modules/contracts/storage/FeatureFlag.sol";
 import "@synthetixio/core-contracts/contracts/initializable/InitializableMixin.sol";