Merge pull request #107 from bgd-labs/feat/soneium

feat: Add soneium network

Author: sendra

lib/solidity-utils

@@ -0,0 +1,46 @@
+// SPDX-License-Identifier: BUSL-1.1
+pragma solidity ^0.8.0;
+
+import {SoneiumAdapter, IBaseAdapter, SoneiumAdapterArgs as SoneiumAdapterArgsType} from '../../src/contracts/adapters/soneium/soneiumAdapter.sol';
+import './BaseAdapterScript.sol';
+
+library SoneiumAdapterDeploymentHelper {
+  struct SoneiumAdapterArgs {
+    BaseAdapterArgs baseArgs;
+    address ovm;
+  }
+
+  function getAdapterCode(
+    SoneiumAdapterArgs memory soneiumArgs
+  ) internal pure returns (bytes memory) {
+    bytes memory creationCode = type(SoneiumAdapter).creationCode;
+
+    return
+      abi.encodePacked(
+        creationCode,
+        abi.encode(
+          SoneiumAdapterArgsType({
+            crossChainController: soneiumArgs.baseArgs.crossChainController,
+            ovmCrossDomainMessenger: soneiumArgs.ovm,
+            providerGasLimit: soneiumArgs.baseArgs.providerGasLimit,
+            trustedRemotes: soneiumArgs.baseArgs.trustedRemotes
+          })
+        )
+      );
+  }
+}
+
+abstract contract BaseSoneiumAdapter is BaseAdapterScript {
+  function OVM() internal view virtual returns (address);
+
+  function _getAdapterByteCode(
+    BaseAdapterArgs memory baseArgs
+  ) internal view override returns (bytes memory) {
+    require(OVM() != address(0), 'Invalid OVM address');
+
+    return
+      SoneiumAdapterDeploymentHelper.getAdapterCode(
+        SoneiumAdapterDeploymentHelper.SoneiumAdapterArgs({baseArgs: baseArgs, ovm: OVM()})
+      );
+  }
+}

scripts/Adapters/DeploySoneiumAdapter.sol

@@ -0,0 +1,58 @@
+// SPDX-License-Identifier: BUSL-1.1
+pragma solidity ^0.8.0;
+
+import {BaseAdapter, IBaseAdapter} from '../BaseAdapter.sol';
+import {Errors} from '../../libs/Errors.sol';
+import {ChainIds} from 'solidity-utils/contracts/utils/ChainHelpers.sol';
+import {OpAdapter, IOpAdapter} from '../optimism/OpAdapter.sol';
+
+/**
+ * @param crossChainController address of the cross chain controller that will use this bridge adapter
+ * @param ovmCrossDomainMessenger ink entry point address
+ * @param providerGasLimit base gas limit used by the bridge adapter
+ * @param trustedRemotes list of remote configurations to set as trusted
+ */
+struct SoneiumAdapterArgs {
+  address crossChainController;
+  address ovmCrossDomainMessenger;
+  uint256 providerGasLimit;
+  IBaseAdapter.TrustedRemotesConfig[] trustedRemotes;
+}
+
+/**
+ * @title SoneiumAdapter
+ * @author BGD Labs
+ * @notice Soneium bridge adapter. Used to send and receive messages cross chain between Ethereum and Soneium
+ * @dev it uses the eth balance of CrossChainController contract to pay for message bridging as the method to bridge
+        is called via delegate call
+ * @dev note that this adapter can only be used for the communication path ETHEREUM -> SONEIUM
+ * @dev note that this adapter inherits from Optimism adapter and overrides only supported chain
+ */
+contract SoneiumAdapter is OpAdapter {
+  /**
+   * @param args SoneiumAdapterArgs necessary to initialize the adapter
+   */
+  constructor(
+    SoneiumAdapterArgs memory args
+  )
+    OpAdapter(
+      args.crossChainController,
+      args.ovmCrossDomainMessenger,
+      args.providerGasLimit,
+      'Soneium native adapter',
+      args.trustedRemotes
+    )
+  {}
+
+  /// @inheritdoc IOpAdapter
+  function isDestinationChainIdSupported(
+    uint256 chainId
+  ) public view virtual override returns (bool) {
+    return chainId == ChainIds.SONEIUM;
+  }
+
+  /// @inheritdoc IOpAdapter
+  function getOriginChainId() public pure virtual override returns (uint256) {
+    return ChainIds.ETHEREUM;
+  }
+}