@across-protocol/contracts 3.0.20 → 3.0.23

package/contracts/Cher_SpokePool.sol

@@ -0,0 +1,72 @@
+// SPDX-License-Identifier: BUSL-1.1
+pragma solidity ^0.8.0;
+import "@eth-optimism/contracts/libraries/constants/Lib_PredeployAddresses.sol";
+
+import "./Ovm_SpokePool.sol";
+import "./external/interfaces/CCTPInterfaces.sol";
+import { IOpUSDCBridgeAdapter } from "./external/interfaces/IOpUSDCBridgeAdapter.sol";
+
+/**
+ * @notice Cher SpokePool.
+ * @custom:security-contact bugs@across.to
+ */
+contract Cher_SpokePool is Ovm_SpokePool {
+    using SafeERC20 for IERC20;
+
+    // Address of the custom L2 USDC bridge.
+    address private constant USDC_BRIDGE = 0x8be79275FCfD08A931087ECf70Ba8a99aee3AC59;
+
+    /// @custom:oz-upgrades-unsafe-allow constructor
+    constructor(
+        address _wrappedNativeTokenAddress,
+        uint32 _depositQuoteTimeBuffer,
+        uint32 _fillDeadlineBuffer,
+        IERC20 _l2Usdc,
+        ITokenMessenger _cctpTokenMessenger
+    )
+        Ovm_SpokePool(
+            _wrappedNativeTokenAddress,
+            _depositQuoteTimeBuffer,
+            _fillDeadlineBuffer,
+            _l2Usdc,
+            _cctpTokenMessenger
+        )
+    {} // solhint-disable-line no-empty-blocks
+
+    /**
+     * @notice Construct the OVM Cher SpokePool.
+     * @param _initialDepositId Starting deposit ID. Set to 0 unless this is a re-deployment in order to mitigate
+     * relay hash collisions.
+     * @param _crossDomainAdmin Cross domain admin to set. Can be changed by admin.
+     * @param _withdrawalRecipient Address which receives token withdrawals. Can be changed by admin. For Spoke Pools on L2, this will
+     */
+    function initialize(
+        uint32 _initialDepositId,
+        address _crossDomainAdmin,
+        address _withdrawalRecipient
+    ) public initializer {
+        __OvmSpokePool_init(_initialDepositId, _crossDomainAdmin, _withdrawalRecipient, Lib_PredeployAddresses.OVM_ETH);
+    }
+
+    /**
+     * @notice Cher-specific logic to bridge tokens back to the hub pool contract on L1.
+     * @param amountToReturn Amount of the token to bridge back.
+     * @param l2TokenAddress Address of the l2 Token to bridge back. This token will either be bridged back to the token defined in the mapping `remoteL1Tokens`,
+     * or via the canonical mapping defined in the bridge contract retrieved from `tokenBridges`.
+     * @dev This implementation deviates slightly from `_bridgeTokensToHubPool` in the `Ovm_SpokePool` contract since
+     * this chain uses Circle's bridged (upgradable to native) USDC standard, which uses a custom interface.
+     */
+    function _bridgeTokensToHubPool(uint256 amountToReturn, address l2TokenAddress) internal virtual override {
+        // Handle custom USDC bridge which doesn't conform to the standard bridge interface. In the future, CCTP may be used to bridge USDC to mainnet, in which
+        // case bridging logic is handled by the Ovm_SpokePool code. In the meantime, if CCTP is not enabled, then use the USDC bridge. Once CCTP is activated on
+        // Cher, this block of code will be unused.
+        if (l2TokenAddress == address(usdcToken) && !_isCCTPEnabled()) {
+            usdcToken.safeIncreaseAllowance(USDC_BRIDGE, amountToReturn);
+            IOpUSDCBridgeAdapter(USDC_BRIDGE).sendMessage(
+                withdrawalRecipient, // _to. Withdraw, over the bridge, to the l1 hub pool contract.
+                amountToReturn, // _amount.
+                l1Gas // _minGasLimit. Same value used in other OpStack bridges.
+            );
+        } else super._bridgeTokensToHubPool(amountToReturn, l2TokenAddress);
+    }
+}

package/dist/deploy/consts.js

@@ -86,6 +86,11 @@ exports.OP_STACK_ADDRESS_MAP = {
             L1StandardBridge: "0x88ff1e5b602916615391f55854588efcbb7663f0",
             L1OpUSDCBridgeAdapter: common_1.ZERO_ADDRESS,
         },
+        [utils_1.CHAIN_IDs.CHER]: {
+            L1CrossDomainMessenger: "0x9cf951e3f74b644e621b36ca9cea147a78d4c39f",
+            L1StandardBridge: "0xeb9bf100225c214efc3e7c651ebbadcf85177607",
+            L1OpUSDCBridgeAdapter: "0xC67A8c5f22b40274Ca7C4A56Db89569Ee2AD3FAb",
+        },
         [utils_1.CHAIN_IDs.LISK]: {
             L1CrossDomainMessenger: "0x31B72D76FB666844C41EdF08dF0254875Dbb7edB",
             L1StandardBridge: "0x2658723Bf70c7667De6B25F99fcce13A16D25d08",

package/dist/deployments/deployments.json

@@ -29,7 +29,8 @@
         "Zora_Adapter": { "address": "0x024f2fc31cbdd8de17194b1892c834f98ef5169b", "blockNumber": 20512287 },
         "WorldChain_Adapter": { "address": "0xA8399e221a583A57F54Abb5bA22f31b5D6C09f32", "blockNumber": 20963234 },
         "AlephZero_Adapter": { "address": "0x6F4083304C2cA99B077ACE06a5DcF670615915Af", "blockNumber": 21131132 },
-        "Ink_Adapter": { "address": "0x7e90a40c7519b041a7df6498fbf5662e8cfc61d2", "blockNumber": 21438590 }
+        "Ink_Adapter": { "address": "0x7e90a40c7519b041a7df6498fbf5662e8cfc61d2", "blockNumber": 21438590 },
+        "Cher_Adapter": { "address": "0x0c9d064523177dBB55CFE52b9D0c485FBFc35FD2", "blockNumber": 21597341 }
     },
     "10": {
         "SpokePool": { "address": "0x6f26Bf09B1C792e3228e5467807a900A503c0281", "blockNumber": 93903076 },
@@ -168,5 +169,9 @@
         "SpokePool": { "address": "0xeF684C38F94F48775959ECf2012D7E864ffb9dd4", "blockNumber": 1139240 },
         "SpokePoolVerifier": { "address": "0xB4A8d45647445EA9FC3E1058096142390683dBC2", "blockNumber": 1152853 },
         "MulticallHandler": { "address": "0x924a9f036260DdD5808007E1AA95f08eD08aA569", "blockNumber": 1145284 }
+    },
+    "1868": {
+        "SpokePool": { "address": "0x3baD7AD0728f9917d1Bf08af5782dCbD516cDd96", "blockNumber": 1709997 },
+        "MulticallHandler": { "address": "0x924a9f036260DdD5808007E1AA95f08eD08aA569", "blockNumber": 1711482 }
     }
 }

package/dist/hardhat.config.js

@@ -102,6 +102,7 @@ const config = {
             "contracts/Optimism_SpokePool.sol": LARGE_CONTRACT_COMPILER_SETTINGS,
             "contracts/WorldChain_SpokePool.sol": LARGE_CONTRACT_COMPILER_SETTINGS,
             "contracts/Ink_SpokePool.sol": LARGE_CONTRACT_COMPILER_SETTINGS,
+            "contracts/Cher_SpokePool.sol": LARGE_CONTRACT_COMPILER_SETTINGS,
         },
     },
     zksolc: {
@@ -326,6 +327,13 @@ const config = {
             accounts: { mnemonic },
             companionNetworks: { l1: "mainnet" },
         },
+        cher: {
+            chainId: constants_1.CHAIN_IDs.CHER,
+            url: (0, common_1.getNodeUrl)("cher", true, constants_1.CHAIN_IDs.CHER),
+            saveDeployments: true,
+            accounts: { mnemonic },
+            companionNetworks: { l1: "mainnet" },
+        },
     },
     gasReporter: { enabled: process.env.REPORT_GAS !== undefined, currency: "USD" },
     etherscan: {
@@ -356,6 +364,7 @@ const config = {
             worldchain: "blockscout",
             alephzero: "blockscout",
             ink: "blockscout",
+            cher: "blockscout",
         },
         customChains: [
             {
@@ -390,6 +399,14 @@ const config = {
                     browserURL: "https://explorer.inkonchain.com",
                 },
             },
+            {
+                network: "cher",
+                chainId: constants_1.CHAIN_IDs.CHER,
+                urls: {
+                    apiURL: "https://blockscout.com/api",
+                    browserURL: "https://blockscout.com",
+                },
+            },
             {
                 network: "linea",
                 chainId: constants_1.CHAIN_IDs.LINEA,

package/dist/src/svm/helpers.js

@@ -7,7 +7,7 @@ const ethers_1 = require("ethers");
  * Returns the chainId for a given solana cluster.
  */
 const getSolanaChainId = (cluster) => {
-    return bignumber_1.BigNumber.from(BigInt(ethers_1.ethers.utils.keccak256(ethers_1.ethers.utils.toUtf8Bytes(`solana-${cluster}`))) & BigInt("0xFFFFFFFFFFFFFFFF"));
+    return bignumber_1.BigNumber.from(BigInt(ethers_1.ethers.utils.keccak256(ethers_1.ethers.utils.toUtf8Bytes(`solana-${cluster}`))) & BigInt("0xFFFFFFFFFFFF"));
 };
 exports.getSolanaChainId = getSolanaChainId;
 /**