custom errors

Author: Amxx

contracts/crosschain/axelar/AxelarGatewayBase.sol

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: MIT
 
-pragma solidity ^0.8.0;
+pragma solidity ^0.8.27;
 
 import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
 import {IAxelarGateway} from "@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IAxelarGateway.sol";
@@ -22,6 +22,9 @@ abstract contract AxelarGatewayBase is Ownable {
     /// @dev Error emitted when an unsupported chain is queried.
     error UnsupportedChain(string caip2);
 
+    error ChainEquivalenceAlreadyRegistered(string caip2);
+    error RemoteGatewayAlreadyRegistered(string caip2);
+
     /// @dev Axelar's official gateway for the current chain.
     IAxelarGateway public immutable localGateway;
 
@@ -36,26 +39,26 @@ abstract contract AxelarGatewayBase is Ownable {
     /// @dev Returns the equivalent chain given an id that can be either CAIP-2 or an Axelar network identifier.
     function getEquivalentChain(string memory input) public view virtual returns (string memory output) {
         output = _chainEquivalence[input];
-        if (bytes(output).length == 0) revert UnsupportedChain(input);
+        require(bytes(output).length > 0, UnsupportedChain(input));
     }
 
     /// @dev Returns the CAIP-10 account address of the remote gateway for a given CAIP-2 chain identifier.
     function getRemoteGateway(string memory caip2) public view virtual returns (string memory remoteGateway) {
         remoteGateway = _remoteGateways[caip2];
-        if (bytes(remoteGateway).length == 0) revert UnsupportedChain(caip2);
+        require(bytes(remoteGateway).length > 0, UnsupportedChain(caip2));
     }
 
     /// @dev Registers a chain equivalence between a CAIP-2 chain identifier and an Axelar network identifier.
     function registerChainEquivalence(string calldata caip2, string calldata axelarSupported) public virtual onlyOwner {
-        require(bytes(_chainEquivalence[caip2]).length == 0, "Chain equivalence already registered");
+        require(bytes(_chainEquivalence[caip2]).length == 0, ChainEquivalenceAlreadyRegistered(caip2));
         _chainEquivalence[caip2] = axelarSupported;
         _chainEquivalence[axelarSupported] = caip2;
         emit RegisteredChainEquivalence(caip2, axelarSupported);
     }
 
     /// @dev Registers the CAIP-10 account address of the remote gateway for a given CAIP-2 chain identifier.
     function registerRemoteGateway(string calldata caip2, string calldata remoteGateway) public virtual onlyOwner {
-        require(bytes(_remoteGateways[caip2]).length == 0, "Remote gateway already registered");
+        require(bytes(_remoteGateways[caip2]).length == 0, RemoteGatewayAlreadyRegistered(caip2));
         _remoteGateways[caip2] = remoteGateway;
         emit RegisteredRemoteGateway(caip2, remoteGateway);
     }

contracts/crosschain/axelar/AxelarGatewayDestination.sol

@@ -18,6 +18,9 @@ abstract contract AxelarGatewayDestination is IERC7786GatewayDestinationPassive,
     using Strings for address;
     using Strings for string;
 
+    error InvalidOriginGateway(string sourceChain, string axelarSourceAddress);
+    error ReceiverExecutionFailed();
+
     /// @dev Sets a message as executed so it can't be executed again. Should be called by the receiver contract.
     function setMessageExecuted(
         bytes calldata messageKey,
@@ -76,7 +79,10 @@ abstract contract AxelarGatewayDestination is IERC7786GatewayDestinationPassive,
 
         // check message validity
         // - `axelarSourceAddress` is the remote gateway on the origin chain.
-        require(getRemoteGateway(sourceChain).equal(axelarSourceAddress), "Invalid origin gateway");
+        require(
+            getRemoteGateway(sourceChain).equal(axelarSourceAddress),
+            InvalidOriginGateway(sourceChain, axelarSourceAddress)
+        );
 
         // Active mode
         bytes4 result = IERC7786Receiver(receiver.parseAddress()).executeMessage(
@@ -87,6 +93,6 @@ abstract contract AxelarGatewayDestination is IERC7786GatewayDestinationPassive,
             payload,
             attributes
         );
-        require(result == IERC7786Receiver.executeMessage.selector, "Receiver execution failed");
+        require(result == IERC7786Receiver.executeMessage.selector, ReceiverExecutionFailed());
     }
 }

contracts/crosschain/utils/draft-ERC7786Receiver.sol

@@ -1,6 +1,6 @@
 // SPDX-License-Identifier: MIT
 
-pragma solidity ^0.8.0;
+pragma solidity ^0.8.27;
 
 import {IERC7786GatewayDestinationPassive, IERC7786Receiver} from "../interfaces/draft-IERC7786.sol";
 
@@ -34,7 +34,7 @@ abstract contract ERC7786Receiver is IERC7786Receiver {
             // no extra check
         } else if (_isKnownGateway(gateway)) {
             // Passive mode
-            if (msg.value != 0) revert ERC7786ReceivePassiveModeValue();
+            require(msg.value == 0, ERC7786ReceivePassiveModeValue());
             IERC7786GatewayDestinationPassive(gateway).setMessageExecuted(
                 gatewayMessageKey,
                 source,

test/crosschain/axelar/AxelarGateway.test.js

@@ -67,7 +67,7 @@ describe('AxelarGateway', function () {
         ethers.randomBytes(128),
         [],
       ))
-        .to.be.revertedWith('Receiver execution failed');
+        .to.be.revertedWithCustomError(this.dstGateway, 'ReceiverExecutionFailed');
     });
 
     it('invalid receiver - EOA', async function () {