-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat and chore: Optimism L1 to L2 message passing and deployment script
- Loading branch information
Showing
17 changed files
with
712 additions
and
19 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| [{"inputs":[],"stateMutability":"nonpayable","type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"msgHash","type":"bytes32"}],"name":"FailedRelayedMessage","type":"event"},{"anonymous":false,"inputs":[{"indexed":false,"internalType":"uint8","name":"version","type":"uint8"}],"name":"Initialized","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"bytes32","name":"msgHash","type":"bytes32"}],"name":"RelayedMessage","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"target","type":"address"},{"indexed":false,"internalType":"address","name":"sender","type":"address"},{"indexed":false,"internalType":"bytes","name":"message","type":"bytes"},{"indexed":false,"internalType":"uint256","name":"messageNonce","type":"uint256"},{"indexed":false,"internalType":"uint256","name":"gasLimit","type":"uint256"}],"name":"SentMessage","type":"event"},{"anonymous":false,"inputs":[{"indexed":true,"internalType":"address","name":"sender","type":"address"},{"indexed":false,"internalType":"uint256","name":"value","type":"uint256"}],"name":"SentMessageExtension1","type":"event"},{"inputs":[],"name":"MESSAGE_VERSION","outputs":[{"internalType":"uint16","name":"","type":"uint16"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MIN_GAS_CALLDATA_OVERHEAD","outputs":[{"internalType":"uint64","name":"","type":"uint64"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MIN_GAS_DYNAMIC_OVERHEAD_DENOMINATOR","outputs":[{"internalType":"uint64","name":"","type":"uint64"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"MIN_GAS_DYNAMIC_OVERHEAD_NUMERATOR","outputs":[{"internalType":"uint64","name":"","type":"uint64"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"OTHER_MESSENGER","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"PORTAL","outputs":[{"internalType":"contract OptimismPortal","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"RELAY_CALL_OVERHEAD","outputs":[{"internalType":"uint64","name":"","type":"uint64"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"RELAY_CONSTANT_OVERHEAD","outputs":[{"internalType":"uint64","name":"","type":"uint64"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"RELAY_GAS_CHECK_BUFFER","outputs":[{"internalType":"uint64","name":"","type":"uint64"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"RELAY_RESERVED_GAS","outputs":[{"internalType":"uint64","name":"","type":"uint64"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"bytes","name":"_message","type":"bytes"},{"internalType":"uint32","name":"_minGasLimit","type":"uint32"}],"name":"baseGas","outputs":[{"internalType":"uint64","name":"","type":"uint64"}],"stateMutability":"pure","type":"function"},{"inputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"name":"failedMessages","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"contract OptimismPortal","name":"_portal","type":"address"}],"name":"initialize","outputs":[],"stateMutability":"nonpayable","type":"function"},{"inputs":[],"name":"messageNonce","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"portal","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"},{"inputs":[{"internalType":"uint256","name":"_nonce","type":"uint256"},{"internalType":"address","name":"_sender","type":"address"},{"internalType":"address","name":"_target","type":"address"},{"internalType":"uint256","name":"_value","type":"uint256"},{"internalType":"uint256","name":"_minGasLimit","type":"uint256"},{"internalType":"bytes","name":"_message","type":"bytes"}],"name":"relayMessage","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"address","name":"_target","type":"address"},{"internalType":"bytes","name":"_message","type":"bytes"},{"internalType":"uint32","name":"_minGasLimit","type":"uint32"}],"name":"sendMessage","outputs":[],"stateMutability":"payable","type":"function"},{"inputs":[{"internalType":"bytes32","name":"","type":"bytes32"}],"name":"successfulMessages","outputs":[{"internalType":"bool","name":"","type":"bool"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"version","outputs":[{"internalType":"string","name":"","type":"string"}],"stateMutability":"view","type":"function"},{"inputs":[],"name":"xDomainMessageSender","outputs":[{"internalType":"address","name":"","type":"address"}],"stateMutability":"view","type":"function"}] |
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,171 @@ | ||
| // SPDX-License-Identifier: MIT | ||
| pragma solidity ^0.8.23; | ||
|
|
||
| /// @dev Interface to the CrossDomainMessenger (CDM) Contract Proxy. | ||
| interface ICrossDomainMessenger { | ||
| function xDomainMessageSender() external returns (address); | ||
| } | ||
|
|
||
| /// @dev Provided zero address. | ||
| error ZeroAddress(); | ||
|
|
||
| /// @dev Only self contract is allowed to call the function. | ||
| /// @param sender Sender address. | ||
| /// @param instance Required contract instance address. | ||
| error SelfCallOnly(address sender, address instance); | ||
|
|
||
| /// @dev Only `CDMContractProxyHome` is allowed to call the function. | ||
| /// @param sender Sender address. | ||
| /// @param CDMContractProxyHome Required CDM Contract Proxy (Home) address. | ||
| error CDMContractProxyHomeOnly(address sender, address CDMContractProxyHome); | ||
|
|
||
| /// @dev Only on behalf of `foreignGovernor` the function is allowed to process the data. | ||
| /// @param sender Sender address. | ||
| /// @param foreignGovernor Required Foreign Governor address. | ||
| error ForeignGovernorOnly(address sender, address foreignGovernor); | ||
|
|
||
| /// @dev Provided incorrect data length. | ||
| /// @param expected Expected minimum data length. | ||
| /// @param provided Provided data length. | ||
| error IncorrectDataLength(uint256 expected, uint256 provided); | ||
|
|
||
| /// @dev Provided value is bigger than the actual balance. | ||
| /// @param value Provided value. | ||
| /// @param balance Actual balance. | ||
| error InsufficientBalance(uint256 value, uint256 balance); | ||
|
|
||
| /// @dev Target execution failed. | ||
| /// @param target Target address. | ||
| /// @param value Provided value. | ||
| /// @param payload Provided payload. | ||
| error TargetExecFailed(address target, uint256 value, bytes payload); | ||
|
|
||
| /// @title OptimismMessenger - Smart contract for the governor home (Optimism) bridge implementation | ||
| /// @author Aleksandr Kuperman - <[email protected]> | ||
| /// @author Andrey Lebedev - <[email protected]> | ||
| /// @author Mariapia Moscatiello - <[email protected]> | ||
| contract OptimismMessenger { | ||
| event FundsReceived(address indexed sender, uint256 value); | ||
| event ForeignGovernorUpdated(address indexed foreignMessageSender); | ||
| event MessageReceived(address indexed foreignMessageSender, bytes data); | ||
|
|
||
| // Default payload data length includes the number of bytes of at least one address (20 bytes or 160 bits), | ||
| // value (12 bytes or 96 bits) and the payload size (4 bytes or 32 bits) | ||
| uint256 public constant DEFAULT_DATA_LENGTH = 36; | ||
| // CDM Contract Proxy (Home) address on L2 that receives the message across the bridge from the foreign L1 network | ||
| address public immutable CDMContractProxyHome; | ||
| // Foreign governor address on L1 that is authorized to propagate the transaction execution across the bridge | ||
| address public foreignGovernor; | ||
|
|
||
| /// @dev HomeMediator constructor. | ||
| /// @param _CDMContractProxyHome CDM Contract Proxy (Home) address (Optimism). | ||
| /// @param _foreignGovernor Foreign Governor address (ETH). | ||
| constructor(address _CDMContractProxyHome, address _foreignGovernor) { | ||
| // Check fo zero addresses | ||
| if (_CDMContractProxyHome == address(0) || _foreignGovernor == address(0)) { | ||
| revert ZeroAddress(); | ||
| } | ||
|
|
||
| CDMContractProxyHome = _CDMContractProxyHome; | ||
| foreignGovernor = _foreignGovernor; | ||
| } | ||
|
|
||
| /// @dev Receives native network token. | ||
| receive() external payable { | ||
| emit FundsReceived(msg.sender, msg.value); | ||
| } | ||
|
|
||
| /// @dev Changes the Foreign Governor address (original Timelock). | ||
| /// @notice The only way to change the Foreign Governor address is by the Timelock on L1 to request that change. | ||
| /// This triggers a self-contract transaction of HomeMediator that changes the Foreign Governor address. | ||
| /// @param newForeignGovernor New Foreign Governor address. | ||
| function changeForeignGovernor(address newForeignGovernor) external { | ||
| // Check if the change is authorized by the previous governor itself | ||
| // This is possible only if all the checks in the message process function pass and the contract calls itself | ||
| if (msg.sender != address(this)) { | ||
| revert SelfCallOnly(msg.sender, address(this)); | ||
| } | ||
|
|
||
| // Check for the zero address | ||
| if (newForeignGovernor == address(0)) { | ||
| revert ZeroAddress(); | ||
| } | ||
|
|
||
| foreignGovernor = newForeignGovernor; | ||
| emit ForeignGovernorUpdated(newForeignGovernor); | ||
| } | ||
|
|
||
| /// @dev Processes a message received from the CDM Contract Proxy (Home) contract. | ||
| /// @notice The sender must be the Foreign Governor address (Timelock). | ||
| /// @param data Bytes message sent from the CDM Contract Proxy (Home) contract. The data must be encoded as a set of | ||
| /// continuous transactions packed into a single buffer, where each transaction is composed as follows: | ||
| /// - target address of 20 bytes (160 bits); | ||
| /// - value of 12 bytes (96 bits), as a limit for all of Autonolas ecosystem contracts; | ||
| /// - payload length of 4 bytes (32 bits), as 2^32 - 1 characters is more than enough to fill a whole block; | ||
| /// - payload as bytes, with the length equal to the specified payload length. | ||
| function processMessageFromForeign(bytes memory data) external payable { | ||
| // Check for the CDM Contract Proxy (Home) address | ||
| if (msg.sender != CDMContractProxyHome) { | ||
| revert CDMContractProxyHomeOnly(msg.sender, CDMContractProxyHome); | ||
| } | ||
|
|
||
| // Check for the Foreign Governor address | ||
| address governor = foreignGovernor; | ||
| address bridgeGovernor = ICrossDomainMessenger(CDMContractProxyHome).xDomainMessageSender(); | ||
| if (bridgeGovernor != governor) { | ||
| revert ForeignGovernorOnly(bridgeGovernor, governor); | ||
| } | ||
|
|
||
| // Check for the correct data length | ||
| uint256 dataLength = data.length; | ||
| if (dataLength < DEFAULT_DATA_LENGTH) { | ||
| revert IncorrectDataLength(DEFAULT_DATA_LENGTH, data.length); | ||
| } | ||
|
|
||
| // Unpack and process the data | ||
| for (uint256 i = 0; i < dataLength;) { | ||
| address target; | ||
| uint96 value; | ||
| uint32 payloadLength; | ||
| // solhint-disable-next-line no-inline-assembly | ||
| assembly { | ||
| // First 20 bytes is the address (160 bits) | ||
| i := add(i, 20) | ||
| target := mload(add(data, i)) | ||
| // Offset the data by 12 bytes of value (96 bits) | ||
| i := add(i, 12) | ||
| value := mload(add(data, i)) | ||
| // Offset the data by 4 bytes of payload length (32 bits) | ||
| i := add(i, 4) | ||
| payloadLength := mload(add(data, i)) | ||
| } | ||
|
|
||
| // Check for the zero address | ||
| if (target == address(0)) { | ||
| revert ZeroAddress(); | ||
| } | ||
|
|
||
| // Check for the value compared to the contract's balance | ||
| if (value > address(this).balance) { | ||
| revert InsufficientBalance(value, address(this).balance); | ||
| } | ||
|
|
||
| // Get the payload | ||
| bytes memory payload = new bytes(payloadLength); | ||
| for (uint256 j = 0; j < payloadLength; ++j) { | ||
| payload[j] = data[i + j]; | ||
| } | ||
| // Offset the data by the payload number of bytes | ||
| i += payloadLength; | ||
|
|
||
| // Call the target with the provided payload | ||
| (bool success, ) = target.call{value: value}(payload); | ||
| if (!success) { | ||
| revert TargetExecFailed(target, value, payload); | ||
| } | ||
| } | ||
|
|
||
| // Emit received message | ||
| emit MessageReceived(governor, data); | ||
| } | ||
| } |
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
Oops, something went wrong.