feat: stop messaging

src/contracts/BaseOpUSDCBridgeAdapter.sol

@@ -14,13 +14,16 @@ abstract contract BaseOpUSDCBridgeAdapter is Ownable, IOpUSDCBridgeAdapter {
  /// @inheritdoc IOpUSDCBridgeAdapter
  address public linkedAdapter;
 
+ /// @inheritdoc IOpUSDCBridgeAdapter
+ bool public isMessagingDisabled;
+
  /**
  * @notice Construct the OpUSDCBridgeAdapter contract
- * @param _USDC The address of the USDC Contract to be used by the adapter
+ * @param _usdc The address of the USDC Contract to be used by the adapter
  * @param _messenger The address of the messenger contract
  */
- constructor(address _USDC, address _messenger) Ownable(msg.sender) {
- USDC = _USDC;
+ constructor(address _usdc, address _messenger) Ownable(msg.sender) {
+ USDC = _usdc;
  MESSENGER = _messenger;
  }
 
@@ -49,4 +52,23 @@ abstract contract BaseOpUSDCBridgeAdapter is Ownable, IOpUSDCBridgeAdapter {
  * @param _amount The amount of tokens to mint
  */
  function receiveMessage(address _user, uint256 _amount) external virtual;
+
+ /**
+ * @notice Send a message to the linked adapter to call receiveStopMessaging() and stop outgoing messages.
+ * @dev Only callable by the owner of the adapter
+ */
+ function stopMessaging() external onlyOwner {
+ isMessagingDisabled = true;
+ IOpUSDCBridgeAdapter(linkedAdapter).receiveStopMessaging();
+ emit MessagingStopped();
+ }
+
+ /**
+ * @notice Receive the stop messaging message from the linked adapter and stop outgoing messages
+ */
+ function receiveStopMessaging() external {
+ if (msg.sender != linkedAdapter) revert OpUSDCBridgeAdapter_NotLinkedAdapter();
+ isMessagingDisabled = true;
+ emit MessagingStopped();
+ }
 }

src/interfaces/IOpUSDCBridgeAdapter.sol

@@ -12,25 +12,35 @@
  */
  event LinkedAdapterSet(address _linkedAdapter);
 
+ /**
+ * @notice Emitted when messaging is stopped
+ */
+ event MessagingStopped();
+
  /*///////////////////////////////////////////////////////////////
  ERRORS
  //////////////////////////////////////////////////////////////*/
 
+ /**
+ * @notice Error when the stop messaging function is not called by the linked adapter
+ */
+ error OpUSDCBridgeAdapter_NotLinkedAdapter();
+
  /*///////////////////////////////////////////////////////////////
  VARIABLES
  //////////////////////////////////////////////////////////////*/
 
  /**
  * @notice Fetches address of the USDC token
- * @return _USDC Address of the USDC token
+ * @return _usdc Address of the USDC token
  */
- function USDC() external view returns (address _USDC);
+ function USDC() external view returns (address _usdc);
 
  /**
  * @notice Fetches address of the CrossDomainMessenger to send messages to L1 <-> L2
  * @return _messenger Address of the messenger
  */
  function MESSENGER() external view returns (address _messenger);
 
  /**
  * @notice Fetches address of the linked adapter on L2 to send messages to and receive from
@@ -38,6 +48,12 @@
  */
  function linkedAdapter() external view returns (address _linkedAdapter);
 
+ /**
+ * @notice Fetches whether messaging is disabled
+ * @return _isMessagingDisabled Whether messaging is disabled
+ */
+ function isMessagingDisabled() external view returns (bool _isMessagingDisabled);
+
  /*///////////////////////////////////////////////////////////////
  LOGIC
  //////////////////////////////////////////////////////////////*/
@@ -47,7 +63,7 @@
  * @dev Only the owner can call this function
  * @param _linkedAdapter The address of the linked adapter
  */
  function setLinkedAdapter(address _linkedAdapter) external;
 
  /**
  * @notice Send the message to the linked adapter to mint the bridged representation on the linked chain
@@ -64,4 +80,15 @@
  * @param _amount The amount of tokens to mint
  */
  function receiveMessage(address _user, uint256 _amount) external;
+
+ /**
+ * @notice Send a message to the linked adapter to call receiveStopMessaging() and stop outgoing messages.
+ * @dev Only callable by the owner of the adapter.
+ */
+ function stopMessaging() external;
+
+ /**
+ * @notice Receive the stop messaging message from the linked adapter and stop outgoing messages
+ */
+ function receiveStopMessaging() external;
 }

test/unit/BaseOpUSDCBridgeAdapter.t.sol

@@ -2,7 +2,7 @@
 pragma solidity 0.8.25;
 
 import {BaseOpUSDCBridgeAdapter, IOpUSDCBridgeAdapter} from 'contracts/BaseOpUSDCBridgeAdapter.sol';
-import {Test} from 'forge-std/Test.sol';
+import {StdStorage, Test, stdStorage} from 'forge-std/Test.sol';
 
 contract TestOpUSDCBridgeAdapter is BaseOpUSDCBridgeAdapter {
  constructor(address _USDC, address _messenger) BaseOpUSDCBridgeAdapter(_USDC, _messenger) {}
@@ -52,3 +52,34 @@ contract UnitInitialization is Base {
  adapter.setLinkedAdapter(_linkedAdapter);
  }
 }
+
+contract UnitStopMessaging is Base {
+ using stdStorage for StdStorage;
+
+ function testStopMessaging() public {
+ vm.mockCall(adapter.linkedAdapter(), abi.encodeWithSignature('receiveStopMessaging()'), abi.encode(''));
+ vm.prank(_owner);
+ adapter.stopMessaging();
+ assertEq(adapter.isMessagingDisabled(), true, 'Messaging should be disabled');
+ }
+
+ function testReceiveStopMessaging() public {
+ address _linkedAdapter = makeAddr('linkedAdapter');
+
+ stdstore.target(address(adapter)).sig('linkedAdapter()').depth(0).checked_write(_linkedAdapter);
+ vm.prank(_linkedAdapter);
+ adapter.receiveStopMessaging();
+ assertEq(adapter.isMessagingDisabled(), true, 'Messaging should be disabled');
+ }
+
+ function testReceiveStopMessagingWrongSender() public {
+ address _linkedAdapter = makeAddr('linkedAdapter');
+ address _notLinkedAdapter = makeAddr('notLinkedAdapter');
+
+ stdstore.target(address(adapter)).sig('linkedAdapter()').depth(0).checked_write(_linkedAdapter);
+ vm.prank(_notLinkedAdapter);
+ vm.expectRevert(IOpUSDCBridgeAdapter.OpUSDCBridgeAdapter_NotLinkedAdapter.selector);
+ adapter.receiveStopMessaging();
+ assertEq(adapter.isMessagingDisabled(), false, 'Messaging should not be disabled');
+ }
+}