-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5074e7f
commit 3e8620d
Showing
10 changed files
with
212 additions
and
83 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| // SPDX-License-Identifier: MIT | ||
|
|
||
| pragma solidity ^0.8.0; | ||
|
|
||
| /** | ||
| * @dev Interface for ERC-7786 source gateways. | ||
| * | ||
| * See ERC-7786 for more details | ||
| */ | ||
| interface IERC7786GatewaySource { | ||
| /** | ||
| * @dev Event emitted when a message is created. If `outboxId` is zero, no further processing is necessary. If | ||
| * `outboxId` is not zero, then further (gateway specific, and non-standardized) action is required. | ||
| */ | ||
| event MessagePosted( | ||
| bytes32 indexed outboxId, | ||
| string sender, // CAIP-10 account identifier (chain identifier + ":" + account address) | ||
| string receiver, // CAIP-10 account identifier (chain identifier + ":" + account address) | ||
| bytes payload, | ||
| bytes[] attributes | ||
| ); | ||
|
|
||
| /// @dev This error is thrown when a message creation fails because of an unsupported attribute being specified. | ||
| error UnsupportedAttribute(bytes4 selector); | ||
|
|
||
| /// @dev Getter to check whether an attribute is supported or not. | ||
| function supportsAttribute(bytes4 selector) external view returns (bool); | ||
|
|
||
| /** | ||
| * @dev Endpoint for creating a new message. If the message requires further (gateway specific) processing before | ||
| * it can be sent to the destination chain, then a non-zero `outboxId` must be returned. Otherwise, the | ||
| * message MUST be sent and this function must return 0. | ||
| * @param destinationChain {CAIP2} chain identifier | ||
| * @param receiver {CAIP10} account address (does not include the chain identifier) | ||
| * | ||
| * * MUST emit a {MessagePosted} event. | ||
| * | ||
| * If any of the `attributes` is not supported, this function SHOULD revert with an {UnsupportedAttribute} error. | ||
| * Other errors SHOULD revert with errors not specified in ERC-7786. | ||
| */ | ||
| function sendMessage( | ||
| string calldata destinationChain, | ||
| string calldata receiver, | ||
| bytes calldata payload, | ||
| bytes[] calldata attributes | ||
| ) external payable returns (bytes32 outboxId); | ||
| } | ||
|
|
||
| /** | ||
| * @dev Interface for the ERC-7786 client contract (receiver). | ||
| * | ||
| * See ERC-7786 for more details | ||
| */ | ||
| interface IERC7786Receiver { | ||
| /** | ||
| * @dev Endpoint for receiving cross-chain message. | ||
| * @param sourceChain {CAIP2} chain identifier | ||
| * @param sender {CAIP10} account address (does not include the chain identifier) | ||
| * | ||
| * This function may be called directly by the gateway. | ||
| */ | ||
| function executeMessage( | ||
| string calldata sourceChain, // CAIP-2 chain identifier | ||
| string calldata sender, // CAIP-10 account address (does not include the chain identifier) | ||
| bytes calldata payload, | ||
| bytes[] calldata attributes | ||
| ) external payable returns (bytes4); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
contracts/mocks/docs/crosschain/MyCustomAxelarGatewayDestination.sol
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| // contracts/MyCustomAxelarGatewayDestination.sol | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity ^0.8.20; | ||
|
|
||
| import {AxelarGatewayDestination, AxelarExecutable} from "../../../crosschain/axelar/AxelarGatewayDestination.sol"; | ||
| import {IAxelarGateway} from "@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IAxelarGateway.sol"; | ||
|
|
||
| abstract contract MyCustomAxelarGatewayDestination is AxelarGatewayDestination { | ||
| /// @dev Initializes the contract with the Axelar gateway and the initial owner. | ||
| constructor(IAxelarGateway gateway, address initialOwner) AxelarExecutable(address(gateway)) {} | ||
| } |
11 changes: 11 additions & 0 deletions
11
contracts/mocks/docs/crosschain/MyCustomAxelarGatewayDuplex.sol
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| // contracts/MyCustomAxelarGatewayDuplex.sol | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity ^0.8.20; | ||
|
|
||
| import {AxelarGatewayDuplex, AxelarExecutable} from "../../../crosschain/axelar/AxelarGatewayDuplex.sol"; | ||
| import {IAxelarGateway} from "@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IAxelarGateway.sol"; | ||
|
|
||
| abstract contract MyCustomAxelarGatewayDuplex is AxelarGatewayDuplex { | ||
| /// @dev Initializes the contract with the Axelar gateway and the initial owner. | ||
| constructor(IAxelarGateway gateway, address initialOwner) AxelarGatewayDuplex(gateway, initialOwner) {} | ||
| } |
13 changes: 13 additions & 0 deletions
13
contracts/mocks/docs/crosschain/MyCustomAxelarGatewaySource.sol
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| // contracts/MyERC7786ReceiverContract.sol | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity ^0.8.20; | ||
|
|
||
| import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol"; | ||
| import {AxelarGatewaySource} from "../../../crosschain/axelar/AxelarGatewaySource.sol"; | ||
| import {AxelarGatewayBase} from "../../../crosschain/axelar/AxelarGatewayBase.sol"; | ||
| import {IAxelarGateway} from "@axelar-network/axelar-gmp-sdk-solidity/contracts/interfaces/IAxelarGateway.sol"; | ||
|
|
||
| abstract contract MyCustomAxelarGatewaySource is AxelarGatewaySource { | ||
| /// @dev Initializes the contract with the Axelar gateway and the initial owner. | ||
| constructor(IAxelarGateway gateway, address initialOwner) Ownable(initialOwner) AxelarGatewayBase(gateway) {} | ||
| } |
47 changes: 47 additions & 0 deletions
47
contracts/mocks/docs/crosschain/MyERC7786GatewaySource.sol
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| // contracts/MyERC7786GatewaySource.sol | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity ^0.8.20; | ||
|
|
||
| import {CAIP2} from "@openzeppelin/contracts/utils/CAIP2.sol"; | ||
| import {CAIP10} from "@openzeppelin/contracts/utils/CAIP10.sol"; | ||
| import {Strings} from "@openzeppelin/contracts/utils/Strings.sol"; | ||
| import {IERC7786GatewaySource} from "../../../interfaces/IERC7786.sol"; | ||
|
|
||
| abstract contract MyERC7786GatewaySource is IERC7786GatewaySource { | ||
| using Strings for address; | ||
|
|
||
| error UnsupportedNativeTransfer(); | ||
|
|
||
| /// @inheritdoc IERC7786GatewaySource | ||
| function supportsAttribute(bytes4 /*selector*/) public pure returns (bool) { | ||
| return false; | ||
| } | ||
|
|
||
| /// @inheritdoc IERC7786GatewaySource | ||
| function sendMessage( | ||
| string calldata destinationChain, // CAIP-2 chain identifier | ||
| string calldata receiver, // CAIP-10 account address (does not include the chain identifier) | ||
| bytes calldata payload, | ||
| bytes[] calldata attributes | ||
| ) external payable returns (bytes32 outboxId) { | ||
| require(msg.value == 0, UnsupportedNativeTransfer()); | ||
| // Use of `if () revert` syntax to avoid accessing attributes[0] if it's empty | ||
| if (attributes.length > 0) | ||
| revert UnsupportedAttribute(attributes[0].length < 0x04 ? bytes4(0) : bytes4(attributes[0][0:4])); | ||
|
|
||
| // Emit event | ||
| outboxId = bytes32(0); // Explicitly set to 0. Can be used for post-processing | ||
| emit MessagePosted( | ||
| outboxId, | ||
| CAIP10.format(CAIP2.local(), msg.sender.toChecksumHexString()), | ||
| CAIP10.format(destinationChain, receiver), | ||
| payload, | ||
| attributes | ||
| ); | ||
|
|
||
| // Optionally: If this is an adapter, send the message to a protocol gateway for processing | ||
| // This may require the logic for tracking destination gateway addresses and chain identifiers | ||
|
|
||
| return outboxId; | ||
| } | ||
| } |
29 changes: 29 additions & 0 deletions
29
contracts/mocks/docs/crosschain/MyERC7786ReceiverContract.sol
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| // contracts/MyERC7786ReceiverContract.sol | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity ^0.8.22; | ||
|
|
||
| import {AccessManaged} from "@openzeppelin/contracts/access/manager/AccessManaged.sol"; | ||
| import {ERC7786Receiver} from "../../../crosschain/utils/ERC7786Receiver.sol"; | ||
|
|
||
| contract MyERC7786ReceiverContract is ERC7786Receiver, AccessManaged { | ||
| constructor(address initialAuthority) AccessManaged(initialAuthority) {} | ||
|
|
||
| /// @dev Check if the given instance is a known gateway. | ||
| function _isKnownGateway(address /* instance */) internal virtual override restricted returns (bool) { | ||
| // The restricted modifier ensures that this function is only called by a known authority. | ||
| return true; | ||
| } | ||
|
|
||
| /// @dev Internal endpoint for receiving cross-chain message. | ||
| /// @param sourceChain {CAIP2} chain identifier | ||
| /// @param sender {CAIP10} account address (does not include the chain identifier) | ||
| function _processMessage( | ||
| address gateway, | ||
| string calldata sourceChain, | ||
| string calldata sender, | ||
| bytes calldata payload, | ||
| bytes[] calldata attributes | ||
| ) internal virtual override restricted { | ||
| // Process the message here | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters