feat: X Layer path activation payload (#60)

Author: sendra

diffs/adi_add_xlayer_path_to_adiethereum_before_adi_add_xlayer_path_to_adiethereum_after.md

@@ -0,0 +1,14 @@
+## Raw diff
+
+```json
+{
+  "forwarderAdaptersByChain": {
+    "196": {
+      "from": "",
+      "to": {
+        "0x9fD570da8fFe3384F1093833D44072ea79ABdEB0": "0xEbc2c80073E4752e9A1D2e9A9bC98e8F4EeE9Be9"
+      }
+    }
+  }
+}
+```

scripts/payloads/adapters/ethereum/Ethereum_Activate_XLayer_Bridge_Adapter_Payload.s.sol

@@ -0,0 +1,34 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import '../../../BaseDeployerScript.sol';
+import '../../../../src/templates/SimpleAddForwarderAdapter.sol';
+
+abstract contract Ethereum_Activate_XLayer_Bridge_Adapter_Payload is BaseDeployerScript {
+  function _getPayloadByteCode() internal virtual returns (bytes memory);
+
+  function PAYLOAD_SALT() internal pure virtual returns (string memory) {
+    return 'Add XLayer path to a.DI';
+  }
+
+  function DESTINATION_CHAIN_ID() internal pure virtual returns (uint256);
+
+  function _deployPayload(AddForwarderAdapterArgs memory args) internal returns (address) {
+    bytes memory payloadCode = abi.encodePacked(_getPayloadByteCode(), abi.encode(args));
+
+    return _deployByteCode(payloadCode, PAYLOAD_SALT());
+  }
+
+  function _execute(Addresses memory addresses) internal virtual override {
+    Addresses memory destinationAddresses = _getAddresses(DESTINATION_CHAIN_ID());
+
+    _deployPayload(
+      AddForwarderAdapterArgs({
+        crossChainController: addresses.crossChainController,
+        currentChainBridgeAdapter: addresses.xlayerAdapter,
+        destinationChainBridgeAdapter: destinationAddresses.xlayerAdapter,
+        destinationChainId: DESTINATION_CHAIN_ID()
+      })
+    );
+  }
+}

scripts/payloads/adapters/ethereum/Network_Deployments.s.sol

@@ -14,8 +14,23 @@ import {Ethereum_Sonic_Path_Payload} from '../../../../src/adapter_payloads/Ethe
 import {SimpleAddForwarderAdapter} from '../../../../src/templates/SimpleAddForwarderAdapter.sol';
 import {Ethereum_Plasma_Path_Payload} from '../../../../src/adapter_payloads/Ethereum_Plasma_Path_Payload.sol';
 import {Ethereum_Activate_Bob_Bridge_Adapter_Payload} from './Ethereum_Activate_Bob_Bridge_Adapter_Payload.s.sol';
+import {Ethereum_Activate_XLayer_Bridge_Adapter_Payload} from './Ethereum_Activate_XLayer_Bridge_Adapter_Payload.s.sol';
 
-contract Ethereum is Ethereum_Activate_Bob_Bridge_Adapter_Payload {
+contract Ethereum is Ethereum_Activate_XLayer_Bridge_Adapter_Payload {
+  function TRANSACTION_NETWORK() internal pure override returns (uint256) {
+    return ChainIds.ETHEREUM;
+  }
+
+  function _getPayloadByteCode() internal pure override returns (bytes memory) {
+    return type(SimpleAddForwarderAdapter).creationCode;
+  }
+
+  function DESTINATION_CHAIN_ID() internal pure override returns (uint256) {
+    return ChainIds.XLAYER;
+  }
+}
+
+contract Ethereum_Bob is Ethereum_Activate_Bob_Bridge_Adapter_Payload {
   function TRANSACTION_NETWORK() internal pure override returns (uint256) {
     return ChainIds.ETHEREUM;
   }

tests/adi/ADITestBase.sol

@@ -23,6 +23,11 @@ import {GovernanceV3Scroll} from 'aave-address-book/GovernanceV3Scroll.sol';
 import {GovernanceV3Linea} from 'aave-address-book/GovernanceV3Linea.sol';
 import {GovernanceV3Sonic} from 'aave-address-book/GovernanceV3Sonic.sol';
 import {GovernanceV3Celo} from 'aave-address-book/GovernanceV3Celo.sol';
+import {GovernanceV3Bob} from 'aave-address-book/GovernanceV3Bob.sol';
+import {GovernanceV3Soneium} from 'aave-address-book/GovernanceV3Soneium.sol';
+import {GovernanceV3Plasma} from 'aave-address-book/GovernanceV3Plasma.sol';
+import {GovernanceV3Mantle} from 'aave-address-book/GovernanceV3Mantle.sol';
+import {GovernanceV3Ink} from 'aave-address-book/GovernanceV3Ink.sol';
 import {IBaseAdapter} from 'aave-address-book/common/IBaseAdapter.sol';
 
 contract ADITestBase is Test {
@@ -630,7 +635,7 @@ contract ADITestBase is Test {
     uint256 chainId
   ) internal pure returns (uint256[] memory) {
     if (chainId == ChainIds.MAINNET) {
-      uint256[] memory chainIds = new uint256[](18);
+      uint256[] memory chainIds = new uint256[](19);
       chainIds[0] = ChainIds.MAINNET;
       chainIds[1] = ChainIds.POLYGON;
       chainIds[2] = ChainIds.AVALANCHE;
@@ -649,6 +654,7 @@ contract ADITestBase is Test {
       chainIds[15] = ChainIds.SONEIUM;
       chainIds[16] = ChainIds.BOB;
       chainIds[17] = ChainIds.PLASMA;
+      chainIds[18] = ChainIds.XLAYER;
 
       return chainIds;
     } else if (chainId == ChainIds.POLYGON) {
@@ -731,15 +737,17 @@ contract ADITestBase is Test {
     } else if (chainId == ChainIds.SONIC) {
       return GovernanceV3Sonic.CROSS_CHAIN_CONTROLLER;
     } else if (chainId == ChainIds.MANTLE) {
-      return 0x1283C5015B1Fb5616FA3aCb0C18e6879a02869cB;
+      return GovernanceV3Mantle.CROSS_CHAIN_CONTROLLER;
     } else if (chainId == ChainIds.INK) {
-      return 0x990B75fD1a2345D905a385dBC6e17BEe0Cb2f505;
+      return GovernanceV3Ink.CROSS_CHAIN_CONTROLLER;
     } else if (chainId == ChainIds.SONEIUM) {
-      return 0xD92b37a5114b33F668D274Fb48f23b726a854d6E;
+      return GovernanceV3Soneium.CROSS_CHAIN_CONTROLLER;
     } else if (chainId == ChainIds.BOB) {
-      return 0xBd28fb717A779e9a5E4CB8023D46C5d0d708d91f;
+      return GovernanceV3Bob.CROSS_CHAIN_CONTROLLER;
     } else if (chainId == ChainIds.PLASMA) {
-      return 0x643441742f73e270e565619be6DE5f4D55E08cd6;
+      return GovernanceV3Plasma.CROSS_CHAIN_CONTROLLER;
+    } else if (chainId == ChainIds.XLAYER) {
+      return 0xFdd46155fD3DA5B907AD3B9f9395366290f58097;
     }
     revert();
   }

tests/payloads/ethereum/AddBobPathTest.t.sol

@@ -3,7 +3,7 @@ pragma solidity ^0.8.0;
 
 import 'forge-std/console.sol';
 import {ADITestBase} from '../../adi/ADITestBase.sol';
-import {Addresses, Ethereum as PayloadEthereumScript} from '../../../scripts/payloads/adapters/ethereum/Network_Deployments.s.sol';
+import {Addresses, Ethereum_Bob as PayloadEthereumScript} from '../../../scripts/payloads/adapters/ethereum/Network_Deployments.s.sol';
 import {SimpleAddForwarderAdapter, AddForwarderAdapterArgs} from '../../../src/templates/SimpleAddForwarderAdapter.sol';
 
 abstract contract BaseAddBobPathPayloadTest is ADITestBase {

tests/payloads/ethereum/AddXLayerPathTest.t.sol

@@ -0,0 +1,92 @@
+// SPDX-License-Identifier: BUSL-1.1
+pragma solidity ^0.8.0;
+
+import 'forge-std/console.sol';
+import {ADITestBase} from '../../adi/ADITestBase.sol';
+import {Addresses, Ethereum as Ethereum} from '../../../scripts/payloads/adapters/ethereum/Network_Deployments.s.sol';
+import {SimpleAddForwarderAdapter, AddForwarderAdapterArgs} from '../../../src/templates/SimpleAddForwarderAdapter.sol';
+
+abstract contract BaseAddXLayerPathPayloadTest is ADITestBase {
+  address internal _payload;
+  address internal _crossChainController;
+
+  string internal NETWORK;
+  uint256 internal immutable BLOCK_NUMBER;
+
+  constructor(string memory network, uint256 blockNumber) {
+    NETWORK = network;
+    BLOCK_NUMBER = blockNumber;
+  }
+
+  function _getDeployedPayload() internal virtual returns (address);
+
+  function _getPayload() internal virtual returns (address);
+
+  function _getCurrentNetworkAddresses() internal virtual returns (Addresses memory);
+
+  function setUp() public {
+    vm.createSelectFork(vm.rpcUrl(NETWORK), BLOCK_NUMBER);
+
+    Addresses memory addresses = _getCurrentNetworkAddresses();
+    _crossChainController = addresses.crossChainController;
+
+    _payload = _getPayload();
+  }
+
+  function test_defaultTest() public {
+    defaultTest(
+      string.concat('add_xlayer_path_to_adi', NETWORK),
+      _crossChainController,
+      address(_payload),
+      false,
+      vm
+    );
+  }
+
+  function test_samePayloadAddress(
+    address currentChainAdapter,
+    address destinationChainAdapter,
+    address crossChainController,
+    uint256 destinationChainId
+  ) public {
+    SimpleAddForwarderAdapter deployedPayload = SimpleAddForwarderAdapter(_getDeployedPayload());
+    SimpleAddForwarderAdapter predictedPayload = SimpleAddForwarderAdapter(_getPayload());
+
+    assertEq(predictedPayload.DESTINATION_CHAIN_ID(), deployedPayload.DESTINATION_CHAIN_ID());
+    assertEq(predictedPayload.CROSS_CHAIN_CONTROLLER(), deployedPayload.CROSS_CHAIN_CONTROLLER());
+    assertEq(
+      predictedPayload.CURRENT_CHAIN_BRIDGE_ADAPTER(),
+      deployedPayload.CURRENT_CHAIN_BRIDGE_ADAPTER()
+    );
+    assertEq(
+      predictedPayload.DESTINATION_CHAIN_BRIDGE_ADAPTER(),
+      deployedPayload.DESTINATION_CHAIN_BRIDGE_ADAPTER()
+    );
+  }
+}
+
+contract EthereumAddXLayerPathPayloadTest is
+  Ethereum,
+  BaseAddXLayerPathPayloadTest('ethereum', 23726764)
+{
+  function _getDeployedPayload() internal pure override returns (address) {
+    return 0x90345B3f6d25684EB921c056Fad6CCf6360ceA5B;
+  }
+
+  function _getCurrentNetworkAddresses() internal view override returns (Addresses memory) {
+    return _getAddresses(TRANSACTION_NETWORK());
+  }
+
+  function _getPayload() internal override returns (address) {
+    Addresses memory currentAddresses = _getCurrentNetworkAddresses();
+    Addresses memory destinationAddresses = _getAddresses(DESTINATION_CHAIN_ID());
+
+    AddForwarderAdapterArgs memory args = AddForwarderAdapterArgs({
+      crossChainController: currentAddresses.crossChainController,
+      currentChainBridgeAdapter: currentAddresses.xlayerAdapter, // ethereum -> xlayer bridge adapter
+      destinationChainBridgeAdapter: destinationAddresses.xlayerAdapter, // xlayer bridge adapter
+      destinationChainId: DESTINATION_CHAIN_ID()
+    });
+    return _deployPayload(args);
+  }
+}