Add messageId in IERC7786Receiver.executeMessage (#88)

Amxx · frangio · web-flow · commit 18db32c3db40 · 2025-03-11T14:16:20.000+01:00
Co-authored-by: Francisco Giordano &lt;fg@frang.io&gt;
diff --git a/contracts/crosschain/ERC7786Aggregator.sol b/contracts/crosschain/ERC7786Aggregator.sol
@@ -180,6 +180,7 @@ contract ERC7786Aggregator is IERC7786GatewaySource, IERC7786Receiver, Ownable,
      * not revert. Any value accrued that way can be recovered by the admin using the {sweep} function.
      */
     function executeMessage(
+        string calldata /*messageId*/, // gateway specific, empty or unique
         string calldata sourceChain, // CAIP-2 chain identifier
         string calldata sender, // CAIP-10 account address (does not include the chain identifier)
         bytes calldata payload,
@@ -218,7 +219,7 @@ contract ERC7786Aggregator is IERC7786GatewaySource, IERC7786Receiver, Ownable,
 
             bytes memory call = abi.encodeCall(
                 IERC7786Receiver.executeMessage,
-                (sourceChain, originalSender, unwrappedPayload, attributes)
+                (uint256(id).toHexString(32), sourceChain, originalSender, unwrappedPayload, attributes)
             );
             // slither-disable-next-line reentrancy-no-eth
             (bool success, bytes memory returndata) = receiver.parseAddress().call(call);
diff --git a/contracts/crosschain/axelar/AxelarGatewayBase.sol b/contracts/crosschain/axelar/AxelarGatewayBase.sol
@@ -26,14 +26,14 @@ abstract contract AxelarGatewayBase is Ownable {
     error RemoteGatewayAlreadyRegistered(string caip2);
 
     /// @dev Axelar's official gateway for the current chain.
-    IAxelarGateway public immutable localGateway;
+    IAxelarGateway internal immutable _axelarGateway;
 
     mapping(string caip2 => string remoteGateway) private _remoteGateways;
     mapping(string caip2OrAxelar => string axelarOrCaip2) private _chainEquivalence;
 
     /// @dev Sets the local gateway address (i.e. Axelar's official gateway for the current chain).
     constructor(IAxelarGateway _gateway) {
-        localGateway = _gateway;
+        _axelarGateway = _gateway;
     }
 
     /// @dev Returns the equivalent chain given an id that can be either CAIP-2 or an Axelar network identifier.
diff --git a/contracts/crosschain/axelar/AxelarGatewayDestination.sol b/contracts/crosschain/axelar/AxelarGatewayDestination.sol
@@ -14,8 +14,7 @@ import {AxelarGatewayBase} from "./AxelarGatewayBase.sol";
  * workflow into the standard ERC-7786.
  */
 abstract contract AxelarGatewayDestination is AxelarGatewayBase, AxelarExecutable {
-    using Strings for address;
-    using Strings for string;
+    using Strings for *;
 
     error InvalidOriginGateway(string sourceChain, string axelarSourceAddress);
     error ReceiverExecutionFailed();
@@ -33,10 +32,13 @@ abstract contract AxelarGatewayDestination is AxelarGatewayBase, AxelarExecutabl
      * the message)
      */
     function _execute(
+        bytes32 commandId,
         string calldata axelarSourceChain, // chain of the remote gateway - axelar format
         string calldata axelarSourceAddress, // address of the remote gateway
         bytes calldata adapterPayload
     ) internal override {
+        string memory messageId = uint256(commandId).toHexString(32);
+
         // Parse the package
         (string memory sender, string memory receiver, bytes memory payload, bytes[] memory attributes) = abi.decode(
             adapterPayload,
@@ -53,6 +55,7 @@ abstract contract AxelarGatewayDestination is AxelarGatewayBase, AxelarExecutabl
         );
 
         bytes4 result = IERC7786Receiver(receiver.parseAddress()).executeMessage(
+            messageId,
             sourceChain,
             sender,
             payload,
diff --git a/contracts/crosschain/axelar/AxelarGatewaySource.sol b/contracts/crosschain/axelar/AxelarGatewaySource.sol
@@ -53,7 +53,7 @@ abstract contract AxelarGatewaySource is IERC7786GatewaySource, AxelarGatewayBas
         // Send the message
         string memory axelarDestination = getEquivalentChain(destinationChain);
         string memory remoteGateway = getRemoteGateway(destinationChain);
-        localGateway.callContract(axelarDestination, remoteGateway, adapterPayload);
+        _axelarGateway.callContract(axelarDestination, remoteGateway, adapterPayload);
 
         return outboxId;
     }
diff --git a/contracts/crosschain/utils/ERC7786Receiver.sol b/contracts/crosschain/utils/ERC7786Receiver.sol
@@ -22,13 +22,14 @@ abstract contract ERC7786Receiver is IERC7786Receiver {
 
     /// @inheritdoc IERC7786Receiver
     function executeMessage(
+        string calldata messageId,
         string calldata source,
         string calldata sender,
         bytes calldata payload,
         bytes[] calldata attributes
     ) public payable virtual returns (bytes4) {
         require(_isKnownGateway(msg.sender), ERC7786ReceiverInvalidGateway(msg.sender));
-        _processMessage(msg.sender, source, sender, payload, attributes);
+        _processMessage(msg.sender, messageId, source, sender, payload, attributes);
         return IERC7786Receiver.executeMessage.selector;
     }
 
@@ -38,6 +39,7 @@ abstract contract ERC7786Receiver is IERC7786Receiver {
     /// @dev Virtual function that should contain the logic to execute when a cross-chain message is received.
     function _processMessage(
         address gateway,
+        string calldata messageId,
         string calldata sourceChain,
         string calldata sender,
         bytes calldata payload,
diff --git a/contracts/interfaces/IERC7786.sol b/contracts/interfaces/IERC7786.sol
@@ -60,6 +60,7 @@ interface IERC7786Receiver {
      * This function may be called directly by the gateway.
      */
     function executeMessage(
+        string calldata messageId, // gateway specific, empty or unique
         string calldata sourceChain, // CAIP-2 chain identifier
         string calldata sender, // CAIP-10 account address (does not include the chain identifier)
         bytes calldata payload,
diff --git a/contracts/mocks/crosschain/ERC7786GatewayMock.sol b/contracts/mocks/crosschain/ERC7786GatewayMock.sol
@@ -32,7 +32,7 @@ contract ERC7786GatewayMock is IERC7786GatewaySource {
 
         address target = Strings.parseAddress(receiver);
         require(
-            IERC7786Receiver(target).executeMessage(source, sender, payload, attributes) ==
+            IERC7786Receiver(target).executeMessage("", source, sender, payload, attributes) ==
                 IERC7786Receiver.executeMessage.selector,
             "Receiver error"
         );
diff --git a/contracts/mocks/crosschain/ERC7786ReceiverInvalidMock.sol b/contracts/mocks/crosschain/ERC7786ReceiverInvalidMock.sol
@@ -6,6 +6,7 @@ import {IERC7786Receiver} from "../../interfaces/IERC7786.sol";
 
 contract ERC7786ReceiverInvalidMock is IERC7786Receiver {
     function executeMessage(
+        string calldata,
         string calldata,
         string calldata,
         bytes calldata,
diff --git a/contracts/mocks/crosschain/ERC7786ReceiverMock.sol b/contracts/mocks/crosschain/ERC7786ReceiverMock.sol
@@ -7,7 +7,14 @@ import {ERC7786Receiver} from "../../crosschain/utils/ERC7786Receiver.sol";
 contract ERC7786ReceiverMock is ERC7786Receiver {
     address private immutable _gateway;
 
-    event MessageReceived(address gateway, string source, string sender, bytes payload, bytes[] attributes);
+    event MessageReceived(
+        address gateway,
+        string messageId,
+        string source,
+        string sender,
+        bytes payload,
+        bytes[] attributes
+    );
 
     constructor(address gateway_) {
         _gateway = gateway_;
@@ -19,11 +26,12 @@ contract ERC7786ReceiverMock is ERC7786Receiver {
 
     function _processMessage(
         address gateway,
+        string calldata messageId,
         string calldata source,
         string calldata sender,
         bytes calldata payload,
         bytes[] calldata attributes
     ) internal virtual override {
-        emit MessageReceived(gateway, source, sender, payload, attributes);
+        emit MessageReceived(gateway, messageId, source, sender, payload, attributes);
     }
 }
diff --git a/contracts/mocks/crosschain/ERC7786ReceiverRevertMock.sol b/contracts/mocks/crosschain/ERC7786ReceiverRevertMock.sol
@@ -6,6 +6,7 @@ import {IERC7786Receiver} from "../../interfaces/IERC7786.sol";
 
 contract ERC7786ReceiverRevertMock is IERC7786Receiver {
     function executeMessage(
+        string calldata,
         string calldata,
         string calldata,
         bytes calldata,
diff --git a/contracts/mocks/crosschain/axelar/AxelarGatewayMock.sol b/contracts/mocks/crosschain/axelar/AxelarGatewayMock.sol
@@ -3,6 +3,7 @@
 pragma solidity ^0.8.27;
 
 import {IAxelarGateway} from "@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IAxelarGateway.sol";
+import {IBaseAmplifierGateway} from "@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IBaseAmplifierGateway.sol";
 import {IAxelarExecutable} from "@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IAxelarExecutable.sol";
 import {BitMaps} from "@openzeppelin/contracts/utils/structs/BitMaps.sol";
 import {Strings} from "@openzeppelin/contracts/utils/Strings.sol";
@@ -64,7 +65,7 @@ contract AxelarGatewayMock {
         if (_pendingCommandIds.get(uint256(commandId))) {
             _pendingCommandIds.unset(uint256(commandId));
 
-            emit IAxelarGateway.ContractCallExecuted(commandId);
+            emit IBaseAmplifierGateway.MessageExecuted(commandId);
 
             return
                 commandId ==
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -43,7 +43,7 @@
     "zeppelin"
   ],
   "dependencies": {
-    "@axelar-network/axelar-gmp-sdk-solidity": "^5.10.0"
+    "@axelar-network/axelar-gmp-sdk-solidity": "^6.0.6"
   },
   "devDependencies": {
     "@openzeppelin/contracts": "file:lib/@openzeppelin-contracts",
diff --git a/test/crosschain/ERC7786Aggregator.test.js b/test/crosschain/ERC7786Aggregator.test.js
@@ -149,7 +149,7 @@ describe('ERC7786Aggregator', function () {
           if (this.outcome) {
             await expect(txPromise)
               .to.emit(this.destination, 'MessageReceived')
-              .withArgs(this.aggregatorB, this.CAIP2, getAddress(this.sender), this.payload, this.attributes)
+              .withArgs(this.aggregatorB, anyValue, this.CAIP2, getAddress(this.sender), this.payload, this.attributes)
               .to.emit(this.aggregatorB, 'ExecutionSuccess')
               .withArgs(resultId)
               .to.not.emit(this.aggregatorB, 'ExecutionFailed');
diff --git a/test/crosschain/ERC7786Receiver.test.js b/test/crosschain/ERC7786Receiver.test.js
@@ -33,6 +33,6 @@ describe('ERC7786Receiver', function () {
       .to.emit(this.gateway, 'MessagePosted')
       .withArgs(ethers.ZeroHash, this.toCaip10(this.sender), this.toCaip10(this.receiver), payload, attributes)
       .to.emit(this.receiver, 'MessageReceived')
-      .withArgs(this.gateway, this.caip2, getAddress(this.sender), payload, attributes);
+      .withArgs(this.gateway, '', this.caip2, getAddress(this.sender), payload, attributes); // ERC7786GatewayMock uses empty messageId
   });
 });
diff --git a/test/crosschain/axelar/AxelarGateway.test.js b/test/crosschain/axelar/AxelarGateway.test.js
@@ -26,11 +26,11 @@ describe('AxelarGateway', function () {
   });
 
   it('initial setup', async function () {
-    await expect(this.gatewayA.localGateway()).to.eventually.equal(this.axelar);
+    await expect(this.gatewayA.gateway()).to.eventually.equal(this.axelar);
     await expect(this.gatewayA.getEquivalentChain(this.CAIP2)).to.eventually.equal('local');
     await expect(this.gatewayA.getRemoteGateway(this.CAIP2)).to.eventually.equal(getAddress(this.gatewayB));
 
-    await expect(this.gatewayB.localGateway()).to.eventually.equal(this.axelar);
+    await expect(this.gatewayB.gateway()).to.eventually.equal(this.axelar);
     await expect(this.gatewayB.getEquivalentChain(this.CAIP2)).to.eventually.equal('local');
     await expect(this.gatewayB.getRemoteGateway(this.CAIP2)).to.eventually.equal(getAddress(this.gatewayA));
   });
@@ -52,10 +52,10 @@ describe('AxelarGateway', function () {
       .withArgs(ethers.ZeroHash, srcCAIP10, dstCAIP10, payload, attributes)
       .to.emit(this.axelar, 'ContractCall')
       .withArgs(this.gatewayA, 'local', getAddress(this.gatewayB), ethers.keccak256(encoded), encoded)
-      .to.emit(this.axelar, 'ContractCallExecuted')
+      .to.emit(this.axelar, 'MessageExecuted')
       .withArgs(anyValue)
       .to.emit(this.receiver, 'MessageReceived')
-      .withArgs(this.gatewayB, this.CAIP2, getAddress(this.sender), payload, attributes);
+      .withArgs(this.gatewayB, anyValue, this.CAIP2, getAddress(this.sender), payload, attributes);
   });
 
   it('invalid receiver - bad return value', async function () {

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ abstract contract AxelarGatewaySource is IERC7786GatewaySource, AxelarGatewayBas`
`53`	`53`	`// Send the message`
`54`	`54`	`string memory axelarDestination = getEquivalentChain(destinationChain);`
`55`	`55`	`string memory remoteGateway = getRemoteGateway(destinationChain);`
`56`		`- localGateway.callContract(axelarDestination, remoteGateway, adapterPayload);`
	`56`	`+ _axelarGateway.callContract(axelarDestination, remoteGateway, adapterPayload);`
`57`	`57`
`58`	`58`	`return outboxId;`
`59`	`59`	`}`