Skip to content

Commit 0d84e79

Browse files
committed
document remoteGateway format
1 parent b3d5990 commit 0d84e79

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

contracts/crosschain/axelar/AxelarGatewayBase.sol

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ abstract contract AxelarGatewayBase is Ownable {
3939
require(bytes(output).length > 0, UnsupportedChain(input));
4040
}
4141

42-
/// @dev Returns the remote gateway address for a given chain.
42+
/// @dev Returns the CAIP-10 account address of the remote gateway for a given CAIP-2 chain identifier.
4343
function getRemoteGateway(string memory caip2) public view virtual returns (string memory remoteGateway) {
4444
remoteGateway = _remoteGateways[caip2];
4545
require(bytes(remoteGateway).length > 0, UnsupportedChain(caip2));
@@ -53,7 +53,7 @@ abstract contract AxelarGatewayBase is Ownable {
5353
emit RegisteredChainEquivalence(caip2, axelarSupported);
5454
}
5555

56-
/// @dev Registers a remote gateway address for a given CAIP-2 chain identifier.
56+
/// @dev Registers the CAIP-10 account address of the remote gateway for a given CAIP-2 chain identifier.
5757
function registerRemoteGateway(string calldata caip2, string calldata remoteGateway) public virtual onlyOwner {
5858
require(bytes(_remoteGateways[caip2]).length == 0, "Remote gateway already registered");
5959
_remoteGateways[caip2] = remoteGateway;

contracts/crosschain/axelar/AxelarGatewayDestination.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import {AxelarGatewayBase} from "./AxelarGatewayBase.sol";
1111
* @dev Implementation of an ERC-7786 gateway destination adapter for the Axelar Network in dual mode.
1212
*
1313
* The contract implements implements AxelarExecutable's {_execute} function to execute the message,
14-
* converting Axelar's native workflow into the standard ERC7786 active mode.
14+
* converting Axelar's native workflow into the standard ERC-7786 active mode.
1515
* Alternatively, it provides a way to set a message as executed by calling the {setMessageExecuted}
1616
* function (passive mode).
1717
*/

contracts/crosschain/axelar/AxelarGatewaySource.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import {AxelarGatewayBase} from "./AxelarGatewayBase.sol";
99
import {IERC7786GatewaySource} from "../interfaces/draft-IERC7786.sol";
1010

1111
/**
12-
* @dev Implementation of an ERC7786 gateway source adapter for the Axelar Network.
12+
* @dev Implementation of an ERC-7786 gateway source adapter for the Axelar Network.
1313
*
1414
* The contract provides a way to send messages to a remote chain using the Axelar Network
1515
* using the {sendMessage} function.

0 commit comments

Comments
 (0)