Rebranding ERC7786Aggregator as ERC7786OpenBridge (#180)

Amxx · ernestognw · web-flow · commit a1ff8e991846 · 2025-06-23T16:16:29.000+02:00
Co-authored-by: ernestognw &lt;ernestognw@gmail.com&gt;
diff --git a/contracts/crosschain/ERC7786OpenBridge.sol b/contracts/crosschain/ERC7786OpenBridge.sol
@@ -11,9 +11,9 @@ import {InteroperableAddress} from "@openzeppelin/contracts/utils/draft-Interope
 
 /**
  * @dev N of M gateway: Sends your message through M independent gateways. It will be delivered to the receiver by an
- * equivalent aggregator on the destination chain if N of the M gateways agree.
+ * equivalent bridge on the destination chain if N of the M gateways agree.
  */
-contract ERC7786Aggregator is IERC7786GatewaySource, IERC7786Receiver, Ownable, Pausable {
+contract ERC7786OpenBridge is IERC7786GatewaySource, IERC7786Receiver, Ownable, Pausable {
     using EnumerableSet for EnumerableSet.AddressSet;
     using InteroperableAddress for bytes;
 
@@ -37,19 +37,19 @@ contract ERC7786Aggregator is IERC7786GatewaySource, IERC7786Receiver, Ownable,
     event ThresholdUpdated(uint8 threshold);
 
     error UnsupportedNativeTransfer();
-    error ERC7786AggregatorInvalidCrosschainSender();
-    error ERC7786AggregatorAlreadyExecuted();
-    error ERC7786AggregatorRemoteNotRegistered(bytes2 chainType, bytes chainReference);
-    error ERC7786AggregatorGatewayAlreadyRegistered(address gateway);
-    error ERC7786AggregatorGatewayNotRegistered(address gateway);
-    error ERC7786AggregatorThresholdViolation();
-    error ERC7786AggregatorInvalidExecutionReturnValue();
+    error ERC7786OpenBridgeInvalidCrosschainSender();
+    error ERC7786OpenBridgeAlreadyExecuted();
+    error ERC7786OpenBridgeRemoteNotRegistered(bytes2 chainType, bytes chainReference);
+    error ERC7786OpenBridgeGatewayAlreadyRegistered(address gateway);
+    error ERC7786OpenBridgeGatewayNotRegistered(address gateway);
+    error ERC7786OpenBridgeThresholdViolation();
+    error ERC7786OpenBridgeInvalidExecutionReturnValue();
 
     /****************************************************************************************************************
      *                                        S T A T E   V A R I A B L E S                                         *
      ****************************************************************************************************************/
 
-    /// @dev address of the matching aggregator for a given CAIP2 chain
+    /// @dev address of the matching bridge for a given CAIP2 chain
     mapping(bytes2 chainType => mapping(bytes chainReference => bytes addr)) private _remotes;
 
     /// @dev Tracking of the received message pending final delivery
@@ -99,8 +99,8 @@ contract ERC7786Aggregator is IERC7786GatewaySource, IERC7786Receiver, Ownable,
         if (attributes.length > 0)
             revert UnsupportedAttribute(attributes[0].length < 0x04 ? bytes4(0) : bytes4(attributes[0][0:4]));
 
-        // address of the remote aggregator, revert if not registered
-        bytes memory aggregator = getRemoteAggregator(recipient);
+        // address of the remote bridge, revert if not registered
+        bytes memory bridge = getRemoteBridge(recipient);
         bytes memory sender = InteroperableAddress.formatEvmV1(block.chainid, msg.sender);
 
         // wrapping the payload
@@ -112,7 +112,7 @@ contract ERC7786Aggregator is IERC7786GatewaySource, IERC7786Receiver, Ownable,
         for (uint256 i = 0; i < outbox.length; ++i) {
             address gateway = _gateways.at(i);
             // send message
-            bytes32 id = IERC7786GatewaySource(gateway).sendMessage(aggregator, wrappedPayload, attributes);
+            bytes32 id = IERC7786GatewaySource(gateway).sendMessage(bridge, wrappedPayload, attributes);
             // if ID, track it
             if (id != bytes32(0)) {
                 outbox[i] = Outbox(gateway, id);
@@ -135,7 +135,7 @@ contract ERC7786Aggregator is IERC7786GatewaySource, IERC7786Receiver, Ownable,
      *
      * @dev This function serves a dual purpose:
      *
-     * It will be called by ERC-7786 gateways with message coming from the the corresponding aggregator on the source
+     * It will be called by ERC-7786 gateways with message coming from the the corresponding bridge on the source
      * chain. These "signals" are tracked until the threshold is reached. At that point the message is sent to the
      * destination.
      *
@@ -148,7 +148,7 @@ contract ERC7786Aggregator is IERC7786GatewaySource, IERC7786Receiver, Ownable,
      *
      * This function revert if:
      *
-     * * the message is not properly formatted or does not originate from the registered aggregator on the source
+     * * the message is not properly formatted or does not originate from the registered bridge on the source
      *   chain.
      * * someone tries re-execute a message that was already successfully delivered. This includes gateways that call
      *   this function a second time with a message that was already executed.
@@ -179,11 +179,8 @@ contract ERC7786Aggregator is IERC7786GatewaySource, IERC7786Receiver, Ownable,
         bytes calldata payload,
         bytes[] calldata attributes
     ) public payable virtual whenNotPaused returns (bytes4) {
-        // Check sender is a trusted aggregator
-        require(
-            keccak256(getRemoteAggregator(sender)) == keccak256(sender),
-            ERC7786AggregatorInvalidCrosschainSender()
-        );
+        // Check sender is a trusted bridge
+        require(keccak256(getRemoteBridge(sender)) == keccak256(sender), ERC7786OpenBridgeInvalidCrosschainSender());
 
         // Message reception tracker
         bytes32 id = keccak256(abi.encode(sender, payload, attributes));
@@ -199,7 +196,7 @@ contract ERC7786Aggregator is IERC7786GatewaySource, IERC7786Receiver, Ownable,
             // if already executed, leave gracefully
             if (tracker.executed) return IERC7786Receiver.executeMessage.selector;
         } else if (tracker.executed) {
-            revert ERC7786AggregatorAlreadyExecuted();
+            revert ERC7786OpenBridgeAlreadyExecuted();
         }
 
         // Parse payload
@@ -230,7 +227,7 @@ contract ERC7786Aggregator is IERC7786GatewaySource, IERC7786Receiver, Ownable,
                 emit ExecutionSuccess(id);
             } else {
                 // call successful but invalid value returned, we need to revert the subcall
-                revert ERC7786AggregatorInvalidExecutionReturnValue();
+                revert ERC7786OpenBridgeInvalidExecutionReturnValue();
             }
         }
 
@@ -247,17 +244,14 @@ contract ERC7786Aggregator is IERC7786GatewaySource, IERC7786Receiver, Ownable,
         return _threshold;
     }
 
-    function getRemoteAggregator(bytes memory chain) public view virtual returns (bytes memory) {
+    function getRemoteBridge(bytes memory chain) public view virtual returns (bytes memory) {
         (bytes2 chainType, bytes memory chainReference, ) = chain.parseV1();
-        return getRemoteAggregator(chainType, chainReference);
+        return getRemoteBridge(chainType, chainReference);
     }
 
-    function getRemoteAggregator(
-        bytes2 chainType,
-        bytes memory chainReference
-    ) public view virtual returns (bytes memory) {
+    function getRemoteBridge(bytes2 chainType, bytes memory chainReference) public view virtual returns (bytes memory) {
         bytes memory addr = _remotes[chainType][chainReference];
-        require(bytes(addr).length != 0, ERC7786AggregatorRemoteNotRegistered(chainType, chainReference));
+        require(bytes(addr).length != 0, ERC7786OpenBridgeRemoteNotRegistered(chainType, chainReference));
         return InteroperableAddress.formatV1(chainType, chainReference, addr);
     }
 
@@ -275,8 +269,8 @@ contract ERC7786Aggregator is IERC7786GatewaySource, IERC7786Receiver, Ownable,
         _setThreshold(newThreshold);
     }
 
-    function registerRemoteAggregator(bytes calldata aggregator) public virtual onlyOwner {
-        _registerRemoteAggregator(aggregator);
+    function registerRemoteBridge(bytes calldata bridge) public virtual onlyOwner {
+        _registerRemoteBridge(bridge);
     }
 
     function pause() public virtual onlyOwner {
@@ -295,25 +289,25 @@ contract ERC7786Aggregator is IERC7786GatewaySource, IERC7786Receiver, Ownable,
     // ================================================== Internal ===================================================
 
     function _addGateway(address gateway) internal virtual {
-        require(_gateways.add(gateway), ERC7786AggregatorGatewayAlreadyRegistered(gateway));
+        require(_gateways.add(gateway), ERC7786OpenBridgeGatewayAlreadyRegistered(gateway));
         emit GatewayAdded(gateway);
     }
 
     function _removeGateway(address gateway) internal virtual {
-        require(_gateways.remove(gateway), ERC7786AggregatorGatewayNotRegistered(gateway));
-        require(_threshold <= _gateways.length(), ERC7786AggregatorThresholdViolation());
+        require(_gateways.remove(gateway), ERC7786OpenBridgeGatewayNotRegistered(gateway));
+        require(_threshold <= _gateways.length(), ERC7786OpenBridgeThresholdViolation());
         emit GatewayRemoved(gateway);
     }
 
     function _setThreshold(uint8 newThreshold) internal virtual {
-        require(newThreshold > 0 && newThreshold <= _gateways.length(), ERC7786AggregatorThresholdViolation());
+        require(newThreshold > 0 && newThreshold <= _gateways.length(), ERC7786OpenBridgeThresholdViolation());
         _threshold = newThreshold;
         emit ThresholdUpdated(newThreshold);
     }
 
-    function _registerRemoteAggregator(bytes calldata aggregator) internal virtual {
-        (bytes2 chainType, bytes calldata chainReference, bytes calldata addr) = aggregator.parseV1Calldata();
+    function _registerRemoteBridge(bytes calldata bridge) internal virtual {
+        (bytes2 chainType, bytes calldata chainReference, bytes calldata addr) = bridge.parseV1Calldata();
         _remotes[chainType][chainReference] = addr;
-        emit RemoteRegistered(aggregator);
+        emit RemoteRegistered(bridge);
     }
 }
diff --git a/contracts/crosschain/README.adoc b/contracts/crosschain/README.adoc
@@ -6,7 +6,7 @@ NOTE: This document is better viewed at https://docs.openzeppelin.com/community-
 Gateways are contracts that enable cross-chain communication. These can either be a message source or a destination according to ERC-7786.
 
  * {ERC7786Receiver}: ERC-7786 cross-chain message receiver.
- * {ERC7786Aggregator}: ERC-7786 "N out of M" gateway. Sends a message through M gateways and executes on the destination if N received it.
+ * {ERC7786OpenBridge}: ERC-7786 "N out of M" gateway. Sends a message through M gateways and executes on the destination if N received it.
 
 Developers can access interoperability protocols through gateway adapters. The library includes the following gateway adapters:
 
@@ -17,7 +17,7 @@ Developers can access interoperability protocols through gateway adapters. The l
 
 == Gateways
 
-{{ERC7786Aggregator}}
+{{ERC7786OpenBridge}}
 
 == Clients
 
diff --git a/docs/modules/ROOT/pages/crosschain.adoc b/docs/modules/ROOT/pages/crosschain.adoc
@@ -84,13 +84,13 @@ For a destination gateway, the library provides an adapter of the `AxelarExecuta
 include::api:example$crosschain/MyCustomAxelarGatewayDestination.sol[]
 ----
 
-=== Multi Bridge Aggregator
+=== Open Bridge
 
-The xref:api:crosschain.adoc#ERC7786Aggregator[ERC7786Aggregator] is a special gateway that implements both xref:api:crosschain.adoc#IERC7786GatewaySource[IERC7786GatewaySource] and xref:api:crosschain.adoc#IERC7786Receiver[IERC7786Receiver] interfaces. It provides a way to send messages across multiple bridges simultaneously and ensures message delivery through a threshold-based confirmation system.
+The xref:api:crosschain.adoc#ERC7786OpenBridge[ERC7786OpenBridge] is a special gateway that implements both xref:api:crosschain.adoc#IERC7786GatewaySource[IERC7786GatewaySource] and xref:api:crosschain.adoc#IERC7786Receiver[IERC7786Receiver] interfaces. It provides a way to send messages across multiple bridges simultaneously and ensures message delivery through a threshold-based confirmation system.
 
-The aggregator maintains a list of known  gateways and a confirmation threshold. When sending a message, it broadcasts to all registered gateways, and when receiving, it requires a minimum number of confirmations before executing the message. This approach increases reliability by ensuring messages are properly delivered and validated across multiple bridges.
+The bridge maintains a list of known  gateways and a confirmation threshold. When sending a message, it broadcasts to all registered gateways, and when receiving, it requires a minimum number of confirmations before executing the message. This approach increases reliability by ensuring messages are properly delivered and validated across multiple bridges.
 
-When sending a message, the aggregator tracks the message IDs from each gateway to maintain a record of the message's journey across different bridges:
+When sending a message, the bridge tracks the message IDs from each gateway to maintain a record of the message's journey across different bridges:
 
 ```solidity
 function sendMessage(
@@ -110,7 +110,7 @@ function sendMessage(
         // send message
         bytes32 id = IERC7786GatewaySource(gateway).sendMessage(
             destinationChain,
-            aggregator,
+            bridge,
             wrappedPayload,
             attributes
         );
@@ -125,7 +125,7 @@ function sendMessage(
 }
 ```
 
-On the receiving end, the aggregator implements a threshold-based confirmation system. Messages are only executed after receiving enough confirmations from the gateways, ensuring message validity and preventing double execution. The xref:api:crosschain.adoc#ERC7786Aggregator-executeMessage-string-string-string-bytes-bytes---[`executeMessage`] function handles this process:
+On the receiving end, the bridge implements a threshold-based confirmation system. Messages are only executed after receiving enough confirmations from the gateways, ensuring message validity and preventing double execution. The xref:api:crosschain.adoc#ERC7786OpenBridge-executeMessage-string-string-string-bytes-bytes---[`executeMessage`] function handles this process:
 
 ```solidity
 function executeMessage(
@@ -148,7 +148,7 @@ function executeMessage(
         // if already executed, leave gracefully
         if (tracker.executed) return IERC7786Receiver.executeMessage.selector;
     } else if (tracker.executed) {
-        revert ERC7786AggregatorAlreadyExecuted();
+        revert ERC7786OpenBridgeAlreadyExecuted();
     }
     
     // ... Validate sender and prepare payload for execution ...
@@ -173,4 +173,4 @@ function executeMessage(
 }
 ```
 
-The aggregator is designed to be configurable. As an `Ownable` contract, it allows the owner to manage the list of trusted gateways and adjust the confirmation threshold. The `_gateways` list and threshold are initially set during contract deployment using the xref:api:crosschain.adoc#ERC7786Aggregator-_addGateway-address-[`++_addGateway++`] and xref:api:crosschain.adoc#ERC7786Aggregator-_setThreshold-uint8-[`++_setThreshold++`] functions. The owner can update these settings as needed to adapt to changing requirements or add new gateways.
+The bridge is designed to be configurable. As an `Ownable` contract, it allows the owner to manage the list of trusted gateways and adjust the confirmation threshold. The `_gateways` list and threshold are initially set during contract deployment using the xref:api:crosschain.adoc#ERC7786OpenBridge-_addGateway-address-[`++_addGateway++`] and xref:api:crosschain.adoc#ERC7786OpenBridge-_setThreshold-uint8-[`++_setThreshold++`] functions. The owner can update these settings as needed to adapt to changing requirements or add new gateways.
diff --git a/test/crosschain/ERC7786OpenBridge.test.js b/test/crosschain/ERC7786OpenBridge.test.js
