Merge pull request #52 from bgd-labs/feat/soneium-path-activation

feat: Soneium path activation payload

Author: sendra

Makefile

@@ -298,6 +298,9 @@ deploy-mantle-path-payload:
 deploy-ink-path-payload:
 	$(call deploy_fn,payloads/adapters/ethereum/Network_Deployments,ethereum)
 
+deploy-soneium-path-payload:
+	$(call deploy_fn,payloads/adapters/ethereum/Network_Deployments,ethereum)
+
 update-owners-and-guardians:
 	$(call deploy_fn,helpers/Update_Ownership,zksync)
 

diffs/adi_add_soneium_path_to_adiethereum_before_adi_add_soneium_path_to_adiethereum_after.md

@@ -0,0 +1,14 @@
+## Raw diff
+
+```json
+{
+  "forwarderAdaptersByChain": {
+    "1868": {
+      "from": "",
+      "to": {
+        "0xe66973c4571F733CafEb1BDE1fa58Ff35416d901": "0x5698e43Ef1be85C68Dec568B5925dD5DB7903e39"
+      }
+    }
+  }
+}
+```

scripts/payloads/adapters/ethereum/Ethereum_Activate_Soneium_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_Soneium_Bridge_Adapter_Payload is BaseDeployerScript {
+  function _getPayloadByteCode() internal virtual returns (bytes memory);
+
+  function PAYLOAD_SALT() internal pure virtual returns (string memory) {
+    return 'Add Soneium 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.soneiumAdapter,
+        destinationChainBridgeAdapter: destinationAddresses.soneiumAdapter,
+        destinationChainId: DESTINATION_CHAIN_ID()
+      })
+    );
+  }
+}

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

@@ -7,11 +7,26 @@ import {Ethereum_Activate_Lina_Bridge_Adapter_Payload} from './Ethereum_Activate
 import {Ethereum_Activate_Sonic_Bridge_Adapter_Payload} from './Ethereum_Activate_Sonic_Bridge_Adapter_Payload.s.sol';
 import {Ethereum_Activate_Mantle_Bridge_Adapter_Payload} from './Ethereum_Activate_Mantle_Bridge_Adapter_Payload.s.sol';
 import {Ethereum_Activate_Ink_Bridge_Adapter_Payload} from './Ethereum_Activate_Ink_Bridge_Adapter_Payload.s.sol';
+import {Ethereum_Activate_Soneium_Bridge_Adapter_Payload} from './Ethereum_Activate_Soneium_Bridge_Adapter_Payload.s.sol';
 import {Ethereum_Celo_Path_Payload} from '../../../../src/adapter_payloads/Ethereum_Celo_Path_Payload.sol';
 import {Ethereum_Sonic_Path_Payload} from '../../../../src/adapter_payloads/Ethereum_Sonic_Path_Payload.sol';
 import {SimpleAddForwarderAdapter} from '../../../../src/templates/SimpleAddForwarderAdapter.sol';
 
-contract Ethereum is Ethereum_Activate_Ink_Bridge_Adapter_Payload {
+contract Ethereum is Ethereum_Activate_Soneium_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.SONEIUM;
+  }
+}
+
+contract Ethereum_Ink is Ethereum_Activate_Ink_Bridge_Adapter_Payload {
   function TRANSACTION_NETWORK() internal pure override returns (uint256) {
     return ChainIds.ETHEREUM;
   }

tests/adi/ADITestBase.sol

@@ -630,7 +630,7 @@ contract ADITestBase is Test {
     uint256 chainId
   ) internal pure returns (uint256[] memory) {
     if (chainId == ChainIds.MAINNET) {
-      uint256[] memory chainIds = new uint256[](15);
+      uint256[] memory chainIds = new uint256[](16);
       chainIds[0] = ChainIds.MAINNET;
       chainIds[1] = ChainIds.POLYGON;
       chainIds[2] = ChainIds.AVALANCHE;
@@ -646,6 +646,7 @@ contract ADITestBase is Test {
       chainIds[12] = ChainIds.SONIC;
       chainIds[13] = ChainIds.MANTLE;
       chainIds[14] = ChainIds.INK;
+      chainIds[15] = ChainIds.SONEIUM;
 
       return chainIds;
     } else if (chainId == ChainIds.POLYGON) {
@@ -731,6 +732,8 @@ contract ADITestBase is Test {
       return 0x1283C5015B1Fb5616FA3aCb0C18e6879a02869cB;
     } else if (chainId == ChainIds.INK) {
       return 0x990B75fD1a2345D905a385dBC6e17BEe0Cb2f505;
+    } else if (chainId == ChainIds.SONEIUM) {
+      return 0xD92b37a5114b33F668D274Fb48f23b726a854d6E;
     }
     revert();
   }

tests/payloads/ethereum/AddInkPathTest.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} from '../../../scripts/payloads/adapters/ethereum/Network_Deployments.s.sol';
+import {Addresses, Ethereum_Ink as Ethereum} from '../../../scripts/payloads/adapters/ethereum/Network_Deployments.s.sol';
 import {SimpleAddForwarderAdapter, AddForwarderAdapterArgs} from '../../../src/templates/SimpleAddForwarderAdapter.sol';
 
 abstract contract BaseAddInkPathPayloadTest is ADITestBase {

tests/payloads/ethereum/AddSoneiumPathTest.t.sol

@@ -0,0 +1,87 @@
+// 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} from '../../../scripts/payloads/adapters/ethereum/Network_Deployments.s.sol';
+import {SimpleAddForwarderAdapter, AddForwarderAdapterArgs} from '../../../src/templates/SimpleAddForwarderAdapter.sol';
+
+abstract contract BaseAddSoneiumPathPayloadTest 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_soneium_path_to_adi', NETWORK),
+      _crossChainController,
+      address(_payload),
+      false,
+      vm
+    );
+  }
+
+  function test_samePayloadAddress() 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 EthereumAddSoneiumPathPayloadTest is
+  Ethereum,
+  BaseAddSoneiumPathPayloadTest('ethereum', 22424684)
+{
+  function _getDeployedPayload() internal pure override returns (address) {
+    return 0xD934A9034C95f9c31e1D6077DFed49B0F4d36FC3;
+  }
+
+  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.soneiumAdapter, // ethereum -> soneium bridge adapter
+      destinationChainBridgeAdapter: destinationAddresses.soneiumAdapter, // soneium bridge adapter
+      destinationChainId: DESTINATION_CHAIN_ID()
+    });
+    return _deployPayload(args);
+  }
+}