add support for HyperEVM in the FactoryBurnMintERC20 (#1132)

* add support for HyperEVM in the FactoryBurnMintERC20

* comments and an additional test

* comment fixes

* typo fix

* comment fix

* typo fix

---------

Co-authored-by: Suryansh <39276431+0xsuryansh@users.noreply.github.com>

Author: jhweintraub

chains/evm/.gas-snapshot

@@ -88,16 +88,17 @@ FactoryBurnMintERC20_approve:test_Approve() (gas: 56417)
 FactoryBurnMintERC20_burn:test_BasicBurn() (gas: 174145)
 FactoryBurnMintERC20_burnFrom:test_BurnFrom() (gas: 59013)
 FactoryBurnMintERC20_burnFromAlias:test_BurnFrom() (gas: 59128)
-FactoryBurnMintERC20_constructor:test_Constructor() (gas: 1267258)
-FactoryBurnMintERC20_decreaseApproval:test_DecreaseApproval() (gas: 32589)
+FactoryBurnMintERC20_constructor:test_Constructor() (gas: 1310174)
+FactoryBurnMintERC20_decreaseApproval:test_DecreaseApproval() (gas: 32624)
 FactoryBurnMintERC20_getCCIPAdmin:test_getCCIPAdmin() (gas: 13111)
 FactoryBurnMintERC20_getCCIPAdmin:test_setCCIPAdmin() (gas: 24707)
 FactoryBurnMintERC20_grantMintAndBurnRoles:test_GrantMintAndBurnRoles() (gas: 123542)
 FactoryBurnMintERC20_grantRole:test_GrantBurnAccess() (gas: 54587)
-FactoryBurnMintERC20_grantRole:test_GrantMany() (gas: 956926)
-FactoryBurnMintERC20_grantRole:test_GrantMintAccess() (gas: 96829)
-FactoryBurnMintERC20_increaseApproval:test_IncreaseApproval() (gas: 46250)
+FactoryBurnMintERC20_grantRole:test_GrantMany() (gas: 956970)
+FactoryBurnMintERC20_grantRole:test_GrantMintAccess() (gas: 96864)
+FactoryBurnMintERC20_increaseApproval:test_IncreaseApproval() (gas: 46316)
 FactoryBurnMintERC20_mint:test_BasicMint() (gas: 151569)
+FactoryBurnMintERC20_setHyperEVMLinker:test_setHyperEVMLinker_Success() (gas: 40631)
 FactoryBurnMintERC20_supportsInterface:test_SupportsInterface() (gas: 11447)
 FactoryBurnMintERC20_transfer:test_Transfer() (gas: 43439)
 FastTransferTokenPool_ccipReceive_Test:test_ccipReceive_FastFill_Settlement() (gas: 125441)
@@ -469,13 +470,13 @@ TokenAdminRegistry_removeRegistryModule:test_removeRegistryModule() (gas: 55248)
 TokenAdminRegistry_setPool:test_setPool() (gas: 36816)
 TokenAdminRegistry_setPool:test_setPool_ZeroAddressRemovesPool() (gas: 31891)
 TokenAdminRegistry_transferAdminRole:test_transferAdminRole() (gas: 50690)
-TokenPoolFactory_createTokenPool:test_createTokenPoolLockRelease_ExistingToken_predict() (gas: 12075903)
-TokenPoolFactory_createTokenPool:test_createTokenPool_BurnFromMintTokenPool() (gas: 6316345)
-TokenPoolFactory_createTokenPool:test_createTokenPool_ExistingRemoteToken_AndPredictPool() (gas: 12926671)
-TokenPoolFactory_createTokenPool:test_createTokenPool_RemoteTokenHasDifferentDecimals() (gas: 12934321)
-TokenPoolFactory_createTokenPool:test_createTokenPool_WithNoExistingRemoteContracts_predict() (gas: 13308515)
-TokenPoolFactory_createTokenPool:test_createTokenPool_WithNoExistingTokenOnRemoteChain() (gas: 6101173)
-TokenPoolFactory_createTokenPool:test_createTokenPool_WithRemoteTokenAndRemotePool() (gas: 6313167)
+TokenPoolFactory_createTokenPool:test_createTokenPoolLockRelease_ExistingToken_predict() (gas: 12177441)
+TokenPoolFactory_createTokenPool:test_createTokenPool_BurnFromMintTokenPool() (gas: 6374730)
+TokenPoolFactory_createTokenPool:test_createTokenPool_ExistingRemoteToken_AndPredictPool() (gas: 13029733)
+TokenPoolFactory_createTokenPool:test_createTokenPool_RemoteTokenHasDifferentDecimals() (gas: 13037383)
+TokenPoolFactory_createTokenPool:test_createTokenPool_WithNoExistingRemoteContracts_predict() (gas: 13414301)
+TokenPoolFactory_createTokenPool:test_createTokenPool_WithNoExistingTokenOnRemoteChain() (gas: 6160778)
+TokenPoolFactory_createTokenPool:test_createTokenPool_WithRemoteTokenAndRemotePool() (gas: 6371549)
 TokenPoolWithAllowList_applyAllowListUpdates:test_SetAllowList() (gas: 180617)
 TokenPoolWithAllowList_applyAllowListUpdates:test_SetAllowListSkipsZero() (gas: 24415)
 TokenPoolWithAllowList_getAllowList:test_GetAllowList() (gas: 24486)

chains/evm/contracts/test/tokenAdminRegistry/FactoryBurnMintERC20/FactoryBurnMintERC20.setHyperEVMLinker.t.sol

@@ -0,0 +1,40 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.24;
+
+import {FactoryBurnMintERC20} from "../../../tokenAdminRegistry/TokenPoolFactory/FactoryBurnMintERC20.sol";
+
+import {HyperEVMLinker} from "../../../tokenAdminRegistry/TokenPoolFactory/HyperEVMLinker.sol";
+import {BurnMintERC20Setup} from "./BurnMintERC20Setup.t.sol";
+
+contract FactoryBurnMintERC20_setHyperEVMLinker is BurnMintERC20Setup {
+  bytes32 public constant HYPER_EVM_LINKER_SLOT = 0x8c306a6a12fff1951878e8621be6674add1102cd359dd968efbbe797629ef84f;
+
+  FactoryBurnMintERC20 public s_factoryBurnMintERC20;
+
+  function setUp() public override {
+    super.setUp();
+
+    s_factoryBurnMintERC20 = new FactoryBurnMintERC20("MOCK TOKEN", "MOCK", 18, 1e27, 0, OWNER);
+  }
+
+  function test_setHyperEVMLinker_Success() public {
+    address testHyperEVMLinker = makeAddr("testHyperEVMLinker");
+
+    vm.expectEmit();
+    emit HyperEVMLinker.HyperEVMLinkerSet(testHyperEVMLinker);
+    s_factoryBurnMintERC20.setHyperEVMLinker(testHyperEVMLinker);
+
+    assertEq(s_factoryBurnMintERC20.getHyperEVMLinker(), testHyperEVMLinker);
+
+    // Manually inspect the storage at the HYPER_EVM_LINKER_SLOT to ensure the address is stored correctly
+    bytes32 storedValue = vm.load(address(s_factoryBurnMintERC20), HYPER_EVM_LINKER_SLOT);
+    assertEq(address(uint160(uint256(storedValue))), testHyperEVMLinker);
+  }
+
+  // Reverts
+
+  function test_setHyperEVMLinker_RevertWhen_ZeroAddress() public {
+    vm.expectRevert(abi.encodeWithSelector(HyperEVMLinker.LinkerAddressCannotBeZero.selector));
+    s_factoryBurnMintERC20.setHyperEVMLinker(address(0));
+  }
+}

chains/evm/contracts/tokenAdminRegistry/TokenPoolFactory/FactoryBurnMintERC20.sol

@@ -5,6 +5,7 @@ import {IGetCCIPAdmin} from "../../interfaces/IGetCCIPAdmin.sol";
 import {IOwnable} from "@chainlink/contracts/src/v0.8/shared/interfaces/IOwnable.sol";
 import {IBurnMintERC20} from "@chainlink/contracts/src/v0.8/shared/token/ERC20/IBurnMintERC20.sol";
 
+import {HyperEVMLinker} from "./HyperEVMLinker.sol";
 import {Ownable2StepMsgSender} from "@chainlink/contracts/src/v0.8/shared/access/Ownable2StepMsgSender.sol";
 
 import {ERC20} from "@chainlink/contracts/src/v0.8/vendor/openzeppelin-solidity/v4.8.3/contracts/token/ERC20/ERC20.sol";
@@ -20,7 +21,14 @@ import {EnumerableSet} from
 /// @notice A basic ERC20 compatible token contract with burn and minting roles.
 /// @dev The constructor has been modified to support the deployment pattern used by a factory contract.
 /// @dev The total supply can be limited during deployment.
-contract FactoryBurnMintERC20 is IBurnMintERC20, IGetCCIPAdmin, IERC165, ERC20Burnable, Ownable2StepMsgSender {
+contract FactoryBurnMintERC20 is
+  IBurnMintERC20,
+  IGetCCIPAdmin,
+  IERC165,
+  ERC20Burnable,
+  Ownable2StepMsgSender,
+  HyperEVMLinker
+{
   using EnumerableSet for EnumerableSet.AddressSet;
 
   error SenderNotMinter(address sender);

chains/evm/contracts/tokenAdminRegistry/TokenPoolFactory/HyperEVMLinker.sol

@@ -0,0 +1,44 @@
+pragma solidity ^0.8.25;
+
+import {Ownable2StepMsgSender} from "@chainlink/contracts/src/v0.8/shared/access/Ownable2StepMsgSender.sol";
+
+/// @title HyperEVMLinker
+/// @notice This contract is used to facilitate linking of an ERC20 from HyperEVM to HyperCore by storing the linker
+/// address in the required slot.
+/// @dev This contract is built in accordance with the Hyperliquid standard at the following URL:
+/// https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/hyperevm/hypercore-less-than-greater-than-hyperevm-transfers#linking-core-and-evm-spot-assets
+abstract contract HyperEVMLinker is Ownable2StepMsgSender {
+  // In order to bridge to HyperCore, factory-deployed contracts must store the address of a finalizer linker at
+  // storage slot keccak256("HyperCore deployer")
+  bytes32 internal constant HYPER_EVM_LINKER_SLOT = 0x8c306a6a12fff1951878e8621be6674add1102cd359dd968efbbe797629ef84f;
+
+  error LinkerAddressCannotBeZero();
+
+  event HyperEVMLinkerSet(address indexed hyperEVMLinker);
+
+  /// @notice Sets the hyperEVMLinker address.
+  /// @param newLinker The address of the hyperEVMLinker.
+  function setHyperEVMLinker(
+    address newLinker
+  ) external onlyOwner {
+    if (newLinker == address(0)) {
+      revert LinkerAddressCannotBeZero();
+    }
+
+    assembly {
+      sstore(HYPER_EVM_LINKER_SLOT, newLinker)
+    }
+
+    emit HyperEVMLinkerSet(newLinker);
+  }
+
+  /// @notice Gets the hyperEVMLinker address.
+  /// @return hyperEVMLinker The address of the hyperEVMLinker.
+  function getHyperEVMLinker() public view returns (address) {
+    address hyperEVMLinker;
+    assembly {
+      hyperEVMLinker := sload(HYPER_EVM_LINKER_SLOT)
+    }
+    return hyperEVMLinker;
+  }
+}

chains/evm/gobindings/generated/latest/factory_burn_mint_erc20/factory_burn_mint_erc20.go

@@ -11,7 +11,7 @@ cctp_message_transmitter_proxy: ../solc/ccip/CCTPMessageTransmitterProxy/CCTPMes
 don_id_claimer: ../solc/ccip/DonIDClaimer/DonIDClaimer.sol/DonIDClaimer.abi.json ../solc/ccip/DonIDClaimer/DonIDClaimer.sol/DonIDClaimer.bin 2ef6cba2f8e258c9d6f2dd55f8d2fc59ae5f686af609ed7d298e8ae9c3923448
 erc20_lock_box: ../solc/ccip/ERC20LockBox/ERC20LockBox.sol/ERC20LockBox.abi.json ../solc/ccip/ERC20LockBox/ERC20LockBox.sol/ERC20LockBox.bin 1fbb6f36d1c346337a862950ef9620bdb6296d026febb3a5a6541c88c27e3c1f
 ether_sender_receiver: ../solc/ccip/EtherSenderReceiver/EtherSenderReceiver.sol/EtherSenderReceiver.abi.json ../solc/ccip/EtherSenderReceiver/EtherSenderReceiver.sol/EtherSenderReceiver.bin c862bb4e4aec2f889fae514872f1f287cc2bcdc2870e9134ffa3bdfd806ffb67
-factory_burn_mint_erc20: ../solc/ccip/FactoryBurnMintERC20/FactoryBurnMintERC20.sol/FactoryBurnMintERC20.abi.json ../solc/ccip/FactoryBurnMintERC20/FactoryBurnMintERC20.sol/FactoryBurnMintERC20.bin 5c4d7396a6fb8fd5087d28e15c64785426609670beb681547e7f924fb32c5f14
+factory_burn_mint_erc20: ../solc/ccip/FactoryBurnMintERC20/FactoryBurnMintERC20.sol/FactoryBurnMintERC20.abi.json ../solc/ccip/FactoryBurnMintERC20/FactoryBurnMintERC20.sol/FactoryBurnMintERC20.bin 9116aae17ec2850111336f5fadb1eae9a76760bebe47f6fd0588fe0ce58020be
 fast_transfer_token_pool: ../solc/ccip/BurnMintFastTransferTokenPool/BurnMintFastTransferTokenPool.sol/BurnMintFastTransferTokenPool.abi.json ../solc/ccip/BurnMintFastTransferTokenPool/BurnMintFastTransferTokenPool.sol/BurnMintFastTransferTokenPool.bin c375296327f6f310785b499206e983c8848967465dc336eed5d1dcdffb02f7e8
 fee_quoter: ../solc/ccip/FeeQuoter/FeeQuoter.sol/FeeQuoter.abi.json ../solc/ccip/FeeQuoter/FeeQuoter.sol/FeeQuoter.bin 9c5997da2f7d38a98b2acba22146fa73f964139b29fae4996be708f34a4e9878
 hybrid_lock_release_usdc_token_pool: ../solc/ccip/HybridLockReleaseUSDCTokenPool/HybridLockReleaseUSDCTokenPool.sol/HybridLockReleaseUSDCTokenPool.abi.json ../solc/ccip/HybridLockReleaseUSDCTokenPool/HybridLockReleaseUSDCTokenPool.sol/HybridLockReleaseUSDCTokenPool.bin 914ea0b94e07a336e993f16422f5039f76db7c1949832f3fb29c4b69aabbd1ba