UNPKG

@tokamak-network/thanos-contracts

Version:
17 lines 1.27 MB
{ "language": "Solidity", "sources": { "contracts/L1/L1CrossDomainMessenger.sol": { "content": "// SPDX-License-Identifier: MIT\npragma solidity 0.8.15;\n\nimport { Predeploys } from \"../libraries/Predeploys.sol\";\nimport { OptimismPortal } from \"./OptimismPortal.sol\";\nimport { CrossDomainMessenger } from \"../universal/CrossDomainMessenger.sol\";\nimport { Semver } from \"../universal/Semver.sol\";\n\n/**\n * @custom:proxied\n * @title L1CrossDomainMessenger\n * @notice The L1CrossDomainMessenger is a message passing interface between L1 and L2 responsible\n * for sending and receiving data on the L1 side. Users are encouraged to use this\n * interface instead of interacting with lower-level contracts directly.\n */\ncontract L1CrossDomainMessenger is CrossDomainMessenger, Semver {\n /**\n * @notice Address of the OptimismPortal.\n */\n OptimismPortal public immutable PORTAL;\n\n /**\n * @custom:semver 1.1.0\n *\n * @param _portal Address of the OptimismPortal contract on this network.\n */\n constructor(OptimismPortal _portal)\n Semver(1, 1, 0)\n CrossDomainMessenger(Predeploys.L2_CROSS_DOMAIN_MESSENGER)\n {\n PORTAL = _portal;\n initialize();\n }\n\n /**\n * @notice Initializer.\n */\n function initialize() public initializer {\n __CrossDomainMessenger_init();\n }\n\n /**\n * @inheritdoc CrossDomainMessenger\n */\n function _sendMessage(\n address _to,\n uint64 _gasLimit,\n uint256 _value,\n bytes memory _data\n ) internal override {\n PORTAL.depositTransaction{ value: _value }(_to, _value, _gasLimit, false, _data);\n }\n\n /**\n * @inheritdoc CrossDomainMessenger\n */\n function _isOtherMessenger() internal view override returns (bool) {\n return msg.sender == address(PORTAL) && PORTAL.l2Sender() == OTHER_MESSENGER;\n }\n\n /**\n * @inheritdoc CrossDomainMessenger\n */\n function _isUnsafeTarget(address _target) internal view override returns (bool) {\n return _target == address(this) || _target == address(PORTAL);\n }\n}\n" }, "contracts/L1/L1ERC721Bridge.sol": { "content": "// SPDX-License-Identifier: MIT\npragma solidity 0.8.15;\n\nimport { ERC721Bridge } from \"../universal/ERC721Bridge.sol\";\nimport { IERC721 } from \"@openzeppelin/contracts/token/ERC721/IERC721.sol\";\nimport { L2ERC721Bridge } from \"../L2/L2ERC721Bridge.sol\";\nimport { Semver } from \"../universal/Semver.sol\";\n\n/**\n * @title L1ERC721Bridge\n * @notice The L1 ERC721 bridge is a contract which works together with the L2 ERC721 bridge to\n * make it possible to transfer ERC721 tokens from Ethereum to Optimism. This contract\n * acts as an escrow for ERC721 tokens deposited into L2.\n */\ncontract L1ERC721Bridge is ERC721Bridge, Semver {\n /**\n * @notice Mapping of L1 token to L2 token to ID to boolean, indicating if the given L1 token\n * by ID was deposited for a given L2 token.\n */\n mapping(address => mapping(address => mapping(uint256 => bool))) public deposits;\n\n /**\n * @custom:semver 1.0.0\n *\n * @param _messenger Address of the CrossDomainMessenger on this network.\n * @param _otherBridge Address of the ERC721 bridge on the other network.\n */\n constructor(address _messenger, address _otherBridge)\n Semver(1, 1, 0)\n ERC721Bridge(_messenger, _otherBridge)\n {}\n\n /**\n * @notice Completes an ERC721 bridge from the other domain and sends the ERC721 token to the\n * recipient on this domain.\n *\n * @param _localToken Address of the ERC721 token on this domain.\n * @param _remoteToken Address of the ERC721 token on the other domain.\n * @param _from Address that triggered the bridge on the other domain.\n * @param _to Address to receive the token on this domain.\n * @param _tokenId ID of the token being deposited.\n * @param _extraData Optional data to forward to L2. Data supplied here will not be used to\n * execute any code on L2 and is only emitted as extra data for the\n * convenience of off-chain tooling.\n */\n function finalizeBridgeERC721(\n address _localToken,\n address _remoteToken,\n address _from,\n address _to,\n uint256 _tokenId,\n bytes calldata _extraData\n ) external onlyOtherBridge {\n require(_localToken != address(this), \"L1ERC721Bridge: local token cannot be self\");\n\n // Checks that the L1/L2 NFT pair has a token ID that is escrowed in the L1 Bridge.\n require(\n deposits[_localToken][_remoteToken][_tokenId] == true,\n \"L1ERC721Bridge: Token ID is not escrowed in the L1 Bridge\"\n );\n\n // Mark that the token ID for this L1/L2 token pair is no longer escrowed in the L1\n // Bridge.\n deposits[_localToken][_remoteToken][_tokenId] = false;\n\n // When a withdrawal is finalized on L1, the L1 Bridge transfers the NFT to the\n // withdrawer.\n IERC721(_localToken).safeTransferFrom(address(this), _to, _tokenId);\n\n // slither-disable-next-line reentrancy-events\n emit ERC721BridgeFinalized(_localToken, _remoteToken, _from, _to, _tokenId, _extraData);\n }\n\n /**\n * @inheritdoc ERC721Bridge\n */\n function _initiateBridgeERC721(\n address _localToken,\n address _remoteToken,\n address _from,\n address _to,\n uint256 _tokenId,\n uint32 _minGasLimit,\n bytes calldata _extraData\n ) internal override {\n require(_remoteToken != address(0), \"L1ERC721Bridge: remote token cannot be address(0)\");\n\n // Construct calldata for _l2Token.finalizeBridgeERC721(_to, _tokenId)\n bytes memory message = abi.encodeWithSelector(\n L2ERC721Bridge.finalizeBridgeERC721.selector,\n _remoteToken,\n _localToken,\n _from,\n _to,\n _tokenId,\n _extraData\n );\n\n // Lock token into bridge\n deposits[_localToken][_remoteToken][_tokenId] = true;\n IERC721(_localToken).transferFrom(_from, address(this), _tokenId);\n\n // Send calldata into L2\n MESSENGER.sendMessage(OTHER_BRIDGE, message, _minGasLimit);\n emit ERC721BridgeInitiated(_localToken, _remoteToken, _from, _to, _tokenId, _extraData);\n }\n}\n" }, "contracts/L1/L1StandardBridge.sol": { "content": "// SPDX-License-Identifier: MIT\npragma solidity 0.8.15;\n\nimport { Predeploys } from \"../libraries/Predeploys.sol\";\nimport { StandardBridge } from \"../universal/StandardBridge.sol\";\nimport { Semver } from \"../universal/Semver.sol\";\n\n/**\n * @custom:proxied\n * @title L1StandardBridge\n * @notice The L1StandardBridge is responsible for transfering ETH and ERC20 tokens between L1 and\n * L2. In the case that an ERC20 token is native to L1, it will be escrowed within this\n * contract. If the ERC20 token is native to L2, it will be burnt. Before Bedrock, ETH was\n * stored within this contract. After Bedrock, ETH is instead stored inside the\n * OptimismPortal contract.\n * NOTE: this contract is not intended to support all variations of ERC20 tokens. Examples\n * of some token types that may not be properly supported by this contract include, but are\n * not limited to: tokens with transfer fees, rebasing tokens, and tokens with blocklists.\n */\ncontract L1StandardBridge is StandardBridge, Semver {\n /**\n * @custom:legacy\n * @notice Emitted whenever a deposit of ETH from L1 into L2 is initiated.\n *\n * @param from Address of the depositor.\n * @param to Address of the recipient on L2.\n * @param amount Amount of ETH deposited.\n * @param extraData Extra data attached to the deposit.\n */\n event ETHDepositInitiated(\n address indexed from,\n address indexed to,\n uint256 amount,\n bytes extraData\n );\n\n /**\n * @custom:legacy\n * @notice Emitted whenever a withdrawal of ETH from L2 to L1 is finalized.\n *\n * @param from Address of the withdrawer.\n * @param to Address of the recipient on L1.\n * @param amount Amount of ETH withdrawn.\n * @param extraData Extra data attached to the withdrawal.\n */\n event ETHWithdrawalFinalized(\n address indexed from,\n address indexed to,\n uint256 amount,\n bytes extraData\n );\n\n /**\n * @custom:legacy\n * @notice Emitted whenever an ERC20 deposit is initiated.\n *\n * @param l1Token Address of the token on L1.\n * @param l2Token Address of the corresponding token on L2.\n * @param from Address of the depositor.\n * @param to Address of the recipient on L2.\n * @param amount Amount of the ERC20 deposited.\n * @param extraData Extra data attached to the deposit.\n */\n event ERC20DepositInitiated(\n address indexed l1Token,\n address indexed l2Token,\n address indexed from,\n address to,\n uint256 amount,\n bytes extraData\n );\n\n /**\n * @custom:legacy\n * @notice Emitted whenever an ERC20 withdrawal is finalized.\n *\n * @param l1Token Address of the token on L1.\n * @param l2Token Address of the corresponding token on L2.\n * @param from Address of the withdrawer.\n * @param to Address of the recipient on L1.\n * @param amount Amount of the ERC20 withdrawn.\n * @param extraData Extra data attached to the withdrawal.\n */\n event ERC20WithdrawalFinalized(\n address indexed l1Token,\n address indexed l2Token,\n address indexed from,\n address to,\n uint256 amount,\n bytes extraData\n );\n\n /**\n * @custom:semver 1.1.0\n *\n * @param _messenger Address of the L1CrossDomainMessenger.\n */\n constructor(address payable _messenger)\n Semver(1, 1, 0)\n StandardBridge(_messenger, payable(Predeploys.L2_STANDARD_BRIDGE))\n {}\n\n /**\n * @notice Allows EOAs to bridge ETH by sending directly to the bridge.\n */\n receive() external payable override onlyEOA {\n _initiateETHDeposit(msg.sender, msg.sender, RECEIVE_DEFAULT_GAS_LIMIT, bytes(\"\"));\n }\n\n /**\n * @custom:legacy\n * @notice Deposits some amount of ETH into the sender's account on L2.\n *\n * @param _minGasLimit Minimum gas limit for the deposit message on L2.\n * @param _extraData Optional data to forward to L2. Data supplied here will not be used to\n * execute any code on L2 and is only emitted as extra data for the\n * convenience of off-chain tooling.\n */\n function depositETH(uint32 _minGasLimit, bytes calldata _extraData) external payable onlyEOA {\n _initiateETHDeposit(msg.sender, msg.sender, _minGasLimit, _extraData);\n }\n\n /**\n * @custom:legacy\n * @notice Deposits some amount of ETH into a target account on L2.\n * Note that if ETH is sent to a contract on L2 and the call fails, then that ETH will\n * be locked in the L2StandardBridge. ETH may be recoverable if the call can be\n * successfully replayed by increasing the amount of gas supplied to the call. If the\n * call will fail for any amount of gas, then the ETH will be locked permanently.\n *\n * @param _to Address of the recipient on L2.\n * @param _minGasLimit Minimum gas limit for the deposit message on L2.\n * @param _extraData Optional data to forward to L2. Data supplied here will not be used to\n * execute any code on L2 and is only emitted as extra data for the\n * convenience of off-chain tooling.\n */\n function depositETHTo(\n address _to,\n uint32 _minGasLimit,\n bytes calldata _extraData\n ) external payable {\n _initiateETHDeposit(msg.sender, _to, _minGasLimit, _extraData);\n }\n\n /**\n * @custom:legacy\n * @notice Deposits some amount of ERC20 tokens into the sender's account on L2.\n *\n * @param _l1Token Address of the L1 token being deposited.\n * @param _l2Token Address of the corresponding token on L2.\n * @param _amount Amount of the ERC20 to deposit.\n * @param _minGasLimit Minimum gas limit for the deposit message on L2.\n * @param _extraData Optional data to forward to L2. Data supplied here will not be used to\n * execute any code on L2 and is only emitted as extra data for the\n * convenience of off-chain tooling.\n */\n function depositERC20(\n address _l1Token,\n address _l2Token,\n uint256 _amount,\n uint32 _minGasLimit,\n bytes calldata _extraData\n ) external virtual onlyEOA {\n _initiateERC20Deposit(\n _l1Token,\n _l2Token,\n msg.sender,\n msg.sender,\n _amount,\n _minGasLimit,\n _extraData\n );\n }\n\n /**\n * @custom:legacy\n * @notice Deposits some amount of ERC20 tokens into a target account on L2.\n *\n * @param _l1Token Address of the L1 token being deposited.\n * @param _l2Token Address of the corresponding token on L2.\n * @param _to Address of the recipient on L2.\n * @param _amount Amount of the ERC20 to deposit.\n * @param _minGasLimit Minimum gas limit for the deposit message on L2.\n * @param _extraData Optional data to forward to L2. Data supplied here will not be used to\n * execute any code on L2 and is only emitted as extra data for the\n * convenience of off-chain tooling.\n */\n function depositERC20To(\n address _l1Token,\n address _l2Token,\n address _to,\n uint256 _amount,\n uint32 _minGasLimit,\n bytes calldata _extraData\n ) external virtual {\n _initiateERC20Deposit(\n _l1Token,\n _l2Token,\n msg.sender,\n _to,\n _amount,\n _minGasLimit,\n _extraData\n );\n }\n\n /**\n * @custom:legacy\n * @notice Finalizes a withdrawal of ETH from L2.\n *\n * @param _from Address of the withdrawer on L2.\n * @param _to Address of the recipient on L1.\n * @param _amount Amount of ETH to withdraw.\n * @param _extraData Optional data forwarded from L2.\n */\n function finalizeETHWithdrawal(\n address _from,\n address _to,\n uint256 _amount,\n bytes calldata _extraData\n ) external payable {\n finalizeBridgeETH(_from, _to, _amount, _extraData);\n }\n\n /**\n * @custom:legacy\n * @notice Finalizes a withdrawal of ERC20 tokens from L2.\n *\n * @param _l1Token Address of the token on L1.\n * @param _l2Token Address of the corresponding token on L2.\n * @param _from Address of the withdrawer on L2.\n * @param _to Address of the recipient on L1.\n * @param _amount Amount of the ERC20 to withdraw.\n * @param _extraData Optional data forwarded from L2.\n */\n function finalizeERC20Withdrawal(\n address _l1Token,\n address _l2Token,\n address _from,\n address _to,\n uint256 _amount,\n bytes calldata _extraData\n ) external {\n finalizeBridgeERC20(_l1Token, _l2Token, _from, _to, _amount, _extraData);\n }\n\n /**\n * @custom:legacy\n * @notice Retrieves the access of the corresponding L2 bridge contract.\n *\n * @return Address of the corresponding L2 bridge contract.\n */\n function l2TokenBridge() external view returns (address) {\n return address(OTHER_BRIDGE);\n }\n\n /**\n * @notice Internal function for initiating an ETH deposit.\n *\n * @param _from Address of the sender on L1.\n * @param _to Address of the recipient on L2.\n * @param _minGasLimit Minimum gas limit for the deposit message on L2.\n * @param _extraData Optional data to forward to L2.\n */\n function _initiateETHDeposit(\n address _from,\n address _to,\n uint32 _minGasLimit,\n bytes memory _extraData\n ) internal {\n _initiateBridgeETH(_from, _to, msg.value, _minGasLimit, _extraData);\n }\n\n /**\n * @notice Internal function for initiating an ERC20 deposit.\n *\n * @param _l1Token Address of the L1 token being deposited.\n * @param _l2Token Address of the corresponding token on L2.\n * @param _from Address of the sender on L1.\n * @param _to Address of the recipient on L2.\n * @param _amount Amount of the ERC20 to deposit.\n * @param _minGasLimit Minimum gas limit for the deposit message on L2.\n * @param _extraData Optional data to forward to L2.\n */\n function _initiateERC20Deposit(\n address _l1Token,\n address _l2Token,\n address _from,\n address _to,\n uint256 _amount,\n uint32 _minGasLimit,\n bytes memory _extraData\n ) internal {\n _initiateBridgeERC20(_l1Token, _l2Token, _from, _to, _amount, _minGasLimit, _extraData);\n }\n\n /**\n * @notice Emits the legacy ETHDepositInitiated event followed by the ETHBridgeInitiated event.\n * This is necessary for backwards compatibility with the legacy bridge.\n *\n * @inheritdoc StandardBridge\n */\n function _emitETHBridgeInitiated(\n address _from,\n address _to,\n uint256 _amount,\n bytes memory _extraData\n ) internal override {\n emit ETHDepositInitiated(_from, _to, _amount, _extraData);\n super._emitETHBridgeInitiated(_from, _to, _amount, _extraData);\n }\n\n /**\n * @notice Emits the legacy ETHWithdrawalFinalized event followed by the ETHBridgeFinalized\n * event. This is necessary for backwards compatibility with the legacy bridge.\n *\n * @inheritdoc StandardBridge\n */\n function _emitETHBridgeFinalized(\n address _from,\n address _to,\n uint256 _amount,\n bytes memory _extraData\n ) internal override {\n emit ETHWithdrawalFinalized(_from, _to, _amount, _extraData);\n super._emitETHBridgeFinalized(_from, _to, _amount, _extraData);\n }\n\n /**\n * @notice Emits the legacy ERC20DepositInitiated event followed by the ERC20BridgeInitiated\n * event. This is necessary for backwards compatibility with the legacy bridge.\n *\n * @inheritdoc StandardBridge\n */\n function _emitERC20BridgeInitiated(\n address _localToken,\n address _remoteToken,\n address _from,\n address _to,\n uint256 _amount,\n bytes memory _extraData\n ) internal override {\n emit ERC20DepositInitiated(_localToken, _remoteToken, _from, _to, _amount, _extraData);\n super._emitERC20BridgeInitiated(_localToken, _remoteToken, _from, _to, _amount, _extraData);\n }\n\n /**\n * @notice Emits the legacy ERC20WithdrawalFinalized event followed by the ERC20BridgeFinalized\n * event. This is necessary for backwards compatibility with the legacy bridge.\n *\n * @inheritdoc StandardBridge\n */\n function _emitERC20BridgeFinalized(\n address _localToken,\n address _remoteToken,\n address _from,\n address _to,\n uint256 _amount,\n bytes memory _extraData\n ) internal override {\n emit ERC20WithdrawalFinalized(_localToken, _remoteToken, _from, _to, _amount, _extraData);\n super._emitERC20BridgeFinalized(_localToken, _remoteToken, _from, _to, _amount, _extraData);\n }\n}\n" }, "contracts/L1/L2OutputOracle.sol": { "content": "// SPDX-License-Identifier: MIT\npragma solidity 0.8.15;\n\nimport { Initializable } from \"@openzeppelin/contracts/proxy/utils/Initializable.sol\";\nimport { Semver } from \"../universal/Semver.sol\";\nimport { Types } from \"../libraries/Types.sol\";\n\n/**\n * @custom:proxied\n * @title L2OutputOracle\n * @notice The L2OutputOracle contains an array of L2 state outputs, where each output is a\n * commitment to the state of the L2 chain. Other contracts like the OptimismPortal use\n * these outputs to verify information about the state of L2.\n */\ncontract L2OutputOracle is Initializable, Semver {\n /**\n * @notice The interval in L2 blocks at which checkpoints must be submitted. Although this is\n * immutable, it can safely be modified by upgrading the implementation contract.\n */\n uint256 public immutable SUBMISSION_INTERVAL;\n\n /**\n * @notice The time between L2 blocks in seconds. Once set, this value MUST NOT be modified.\n */\n uint256 public immutable L2_BLOCK_TIME;\n\n /**\n * @notice The address of the challenger. Can be updated via upgrade.\n */\n address public immutable CHALLENGER;\n\n /**\n * @notice The address of the proposer. Can be updated via upgrade.\n */\n address public immutable PROPOSER;\n\n /**\n * @notice Minimum time (in seconds) that must elapse before a withdrawal can be finalized.\n */\n uint256 public immutable FINALIZATION_PERIOD_SECONDS;\n\n /**\n * @notice The number of the first L2 block recorded in this contract.\n */\n uint256 public startingBlockNumber;\n\n /**\n * @notice The timestamp of the first L2 block recorded in this contract.\n */\n uint256 public startingTimestamp;\n\n /**\n * @notice Array of L2 output proposals.\n */\n Types.OutputProposal[] internal l2Outputs;\n\n /**\n * @notice Emitted when an output is proposed.\n *\n * @param outputRoot The output root.\n * @param l2OutputIndex The index of the output in the l2Outputs array.\n * @param l2BlockNumber The L2 block number of the output root.\n * @param l1Timestamp The L1 timestamp when proposed.\n */\n event OutputProposed(\n bytes32 indexed outputRoot,\n uint256 indexed l2OutputIndex,\n uint256 indexed l2BlockNumber,\n uint256 l1Timestamp\n );\n\n /**\n * @notice Emitted when outputs are deleted.\n *\n * @param prevNextOutputIndex Next L2 output index before the deletion.\n * @param newNextOutputIndex Next L2 output index after the deletion.\n */\n event OutputsDeleted(uint256 indexed prevNextOutputIndex, uint256 indexed newNextOutputIndex);\n\n /**\n * @custom:semver 1.2.0\n *\n * @param _submissionInterval Interval in blocks at which checkpoints must be submitted.\n * @param _l2BlockTime The time per L2 block, in seconds.\n * @param _startingBlockNumber The number of the first L2 block.\n * @param _startingTimestamp The timestamp of the first L2 block.\n * @param _proposer The address of the proposer.\n * @param _challenger The address of the challenger.\n */\n constructor(\n uint256 _submissionInterval,\n uint256 _l2BlockTime,\n uint256 _startingBlockNumber,\n uint256 _startingTimestamp,\n address _proposer,\n address _challenger,\n uint256 _finalizationPeriodSeconds\n ) Semver(1, 2, 0) {\n require(_l2BlockTime > 0, \"L2OutputOracle: L2 block time must be greater than 0\");\n require(\n _submissionInterval > _l2BlockTime,\n \"L2OutputOracle: submission interval must be greater than L2 block time\"\n );\n\n SUBMISSION_INTERVAL = _submissionInterval;\n L2_BLOCK_TIME = _l2BlockTime;\n PROPOSER = _proposer;\n CHALLENGER = _challenger;\n FINALIZATION_PERIOD_SECONDS = _finalizationPeriodSeconds;\n\n initialize(_startingBlockNumber, _startingTimestamp);\n }\n\n /**\n * @notice Initializer.\n *\n * @param _startingBlockNumber Block number for the first recoded L2 block.\n * @param _startingTimestamp Timestamp for the first recoded L2 block.\n */\n function initialize(uint256 _startingBlockNumber, uint256 _startingTimestamp)\n public\n initializer\n {\n require(\n _startingTimestamp <= block.timestamp,\n \"L2OutputOracle: starting L2 timestamp must be less than current time\"\n );\n\n startingTimestamp = _startingTimestamp;\n startingBlockNumber = _startingBlockNumber;\n }\n\n /**\n * @notice Deletes all output proposals after and including the proposal that corresponds to\n * the given output index. Only the challenger address can delete outputs.\n *\n * @param _l2OutputIndex Index of the first L2 output to be deleted. All outputs after this\n * output will also be deleted.\n */\n // solhint-disable-next-line ordering\n function deleteL2Outputs(uint256 _l2OutputIndex) external {\n require(\n msg.sender == CHALLENGER,\n \"L2OutputOracle: only the challenger address can delete outputs\"\n );\n\n // Make sure we're not *increasing* the length of the array.\n require(\n _l2OutputIndex < l2Outputs.length,\n \"L2OutputOracle: cannot delete outputs after the latest output index\"\n );\n\n // Do not allow deleting any outputs that have already been finalized.\n require(\n block.timestamp - l2Outputs[_l2OutputIndex].timestamp < FINALIZATION_PERIOD_SECONDS,\n \"L2OutputOracle: cannot delete outputs that have already been finalized\"\n );\n\n uint256 prevNextL2OutputIndex = nextOutputIndex();\n\n // Use assembly to delete the array elements because Solidity doesn't allow it.\n assembly {\n sstore(l2Outputs.slot, _l2OutputIndex)\n }\n\n emit OutputsDeleted(prevNextL2OutputIndex, _l2OutputIndex);\n }\n\n /**\n * @notice Accepts an outputRoot and the timestamp of the corresponding L2 block. The timestamp\n * must be equal to the current value returned by `nextTimestamp()` in order to be\n * accepted. This function may only be called by the Proposer.\n *\n * @param _outputRoot The L2 output of the checkpoint block.\n * @param _l2BlockNumber The L2 block number that resulted in _outputRoot.\n * @param _l1BlockHash A block hash which must be included in the current chain.\n * @param _l1BlockNumber The block number with the specified block hash.\n */\n function proposeL2Output(\n bytes32 _outputRoot,\n uint256 _l2BlockNumber,\n bytes32 _l1BlockHash,\n uint256 _l1BlockNumber\n ) external payable {\n require(\n msg.sender == PROPOSER,\n \"L2OutputOracle: only the proposer address can propose new outputs\"\n );\n\n require(\n _l2BlockNumber == nextBlockNumber(),\n \"L2OutputOracle: block number must be equal to next expected block number\"\n );\n\n require(\n computeL2Timestamp(_l2BlockNumber) < block.timestamp,\n \"L2OutputOracle: cannot propose L2 output in the future\"\n );\n\n require(\n _outputRoot != bytes32(0),\n \"L2OutputOracle: L2 output proposal cannot be the zero hash\"\n );\n\n if (_l1BlockHash != bytes32(0)) {\n // This check allows the proposer to propose an output based on a given L1 block,\n // without fear that it will be reorged out.\n // It will also revert if the blockheight provided is more than 256 blocks behind the\n // chain tip (as the hash will return as zero). This does open the door to a griefing\n // attack in which the proposer's submission is censored until the block is no longer\n // retrievable, if the proposer is experiencing this attack it can simply leave out the\n // blockhash value, and delay submission until it is confident that the L1 block is\n // finalized.\n require(\n blockhash(_l1BlockNumber) == _l1BlockHash,\n \"L2OutputOracle: block hash does not match the hash at the expected height\"\n );\n }\n\n emit OutputProposed(_outputRoot, nextOutputIndex(), _l2BlockNumber, block.timestamp);\n\n l2Outputs.push(\n Types.OutputProposal({\n outputRoot: _outputRoot,\n timestamp: uint128(block.timestamp),\n l2BlockNumber: uint128(_l2BlockNumber)\n })\n );\n }\n\n /**\n * @notice Returns an output by index. Exists because Solidity's array access will return a\n * tuple instead of a struct.\n *\n * @param _l2OutputIndex Index of the output to return.\n *\n * @return The output at the given index.\n */\n function getL2Output(uint256 _l2OutputIndex)\n external\n view\n returns (Types.OutputProposal memory)\n {\n return l2Outputs[_l2OutputIndex];\n }\n\n /**\n * @notice Returns the index of the L2 output that checkpoints a given L2 block number. Uses a\n * binary search to find the first output greater than or equal to the given block.\n *\n * @param _l2BlockNumber L2 block number to find a checkpoint for.\n *\n * @return Index of the first checkpoint that commits to the given L2 block number.\n */\n function getL2OutputIndexAfter(uint256 _l2BlockNumber) public view returns (uint256) {\n // Make sure an output for this block number has actually been proposed.\n require(\n _l2BlockNumber <= latestBlockNumber(),\n \"L2OutputOracle: cannot get output for a block that has not been proposed\"\n );\n\n // Make sure there's at least one output proposed.\n require(\n l2Outputs.length > 0,\n \"L2OutputOracle: cannot get output as no outputs have been proposed yet\"\n );\n\n // Find the output via binary search, guaranteed to exist.\n uint256 lo = 0;\n uint256 hi = l2Outputs.length;\n while (lo < hi) {\n uint256 mid = (lo + hi) / 2;\n if (l2Outputs[mid].l2BlockNumber < _l2BlockNumber) {\n lo = mid + 1;\n } else {\n hi = mid;\n }\n }\n\n return lo;\n }\n\n /**\n * @notice Returns the L2 output proposal that checkpoints a given L2 block number. Uses a\n * binary search to find the first output greater than or equal to the given block.\n *\n * @param _l2BlockNumber L2 block number to find a checkpoint for.\n *\n * @return First checkpoint that commits to the given L2 block number.\n */\n function getL2OutputAfter(uint256 _l2BlockNumber)\n external\n view\n returns (Types.OutputProposal memory)\n {\n return l2Outputs[getL2OutputIndexAfter(_l2BlockNumber)];\n }\n\n /**\n * @notice Returns the number of outputs that have been proposed. Will revert if no outputs\n * have been proposed yet.\n *\n * @return The number of outputs that have been proposed.\n */\n function latestOutputIndex() external view returns (uint256) {\n return l2Outputs.length - 1;\n }\n\n /**\n * @notice Returns the index of the next output to be proposed.\n *\n * @return The index of the next output to be proposed.\n */\n function nextOutputIndex() public view returns (uint256) {\n return l2Outputs.length;\n }\n\n /**\n * @notice Returns the block number of the latest submitted L2 output proposal. If no proposals\n * been submitted yet then this function will return the starting block number.\n *\n * @return Latest submitted L2 block number.\n */\n function latestBlockNumber() public view returns (uint256) {\n return\n l2Outputs.length == 0\n ? startingBlockNumber\n : l2Outputs[l2Outputs.length - 1].l2BlockNumber;\n }\n\n /**\n * @notice Computes the block number of the next L2 block that needs to be checkpointed.\n *\n * @return Next L2 block number.\n */\n function nextBlockNumber() public view returns (uint256) {\n return latestBlockNumber() + SUBMISSION_INTERVAL;\n }\n\n /**\n * @notice Returns the L2 timestamp corresponding to a given L2 block number.\n *\n * @param _l2BlockNumber The L2 block number of the target block.\n *\n * @return L2 timestamp of the given block.\n */\n function computeL2Timestamp(uint256 _l2BlockNumber) public view returns (uint256) {\n return startingTimestamp + ((_l2BlockNumber - startingBlockNumber) * L2_BLOCK_TIME);\n }\n}\n" }, "contracts/L1/OptimismPortal.sol": { "content": "// SPDX-License-Identifier: MIT\npragma solidity 0.8.15;\n\nimport { Initializable } from \"@openzeppelin/contracts/proxy/utils/Initializable.sol\";\nimport { SafeCall } from \"../libraries/SafeCall.sol\";\nimport { L2OutputOracle } from \"./L2OutputOracle.sol\";\nimport { SystemConfig } from \"./SystemConfig.sol\";\nimport { Constants } from \"../libraries/Constants.sol\";\nimport { Types } from \"../libraries/Types.sol\";\nimport { Hashing } from \"../libraries/Hashing.sol\";\nimport { SecureMerkleTrie } from \"../libraries/trie/SecureMerkleTrie.sol\";\nimport { AddressAliasHelper } from \"../vendor/AddressAliasHelper.sol\";\nimport { ResourceMetering } from \"./ResourceMetering.sol\";\nimport { Semver } from \"../universal/Semver.sol\";\n\n/**\n * @custom:proxied\n * @title OptimismPortal\n * @notice The OptimismPortal is a low-level contract responsible for passing messages between L1\n * and L2. Messages sent directly to the OptimismPortal have no form of replayability.\n * Users are encouraged to use the L1CrossDomainMessenger for a higher-level interface.\n */\ncontract OptimismPortal is Initializable, ResourceMetering, Semver {\n /**\n * @notice Represents a proven withdrawal.\n *\n * @custom:field outputRoot Root of the L2 output this was proven against.\n * @custom:field timestamp Timestamp at whcih the withdrawal was proven.\n * @custom:field l2OutputIndex Index of the output this was proven against.\n */\n struct ProvenWithdrawal {\n bytes32 outputRoot;\n uint128 timestamp;\n uint128 l2OutputIndex;\n }\n\n /**\n * @notice Version of the deposit event.\n */\n uint256 internal constant DEPOSIT_VERSION = 0;\n\n /**\n * @notice The L2 gas limit set when eth is deposited using the receive() function.\n */\n uint64 internal constant RECEIVE_DEFAULT_GAS_LIMIT = 100_000;\n\n /**\n * @notice Address of the L2OutputOracle contract.\n */\n L2OutputOracle public immutable L2_ORACLE;\n\n /**\n * @notice Address of the SystemConfig contract.\n */\n SystemConfig public immutable SYSTEM_CONFIG;\n\n /**\n * @notice Address that has the ability to pause and unpause withdrawals.\n */\n address public immutable GUARDIAN;\n\n /**\n * @notice Address of the L2 account which initiated a withdrawal in this transaction. If the\n * of this variable is the default L2 sender address, then we are NOT inside of a call\n * to finalizeWithdrawalTransaction.\n */\n address public l2Sender;\n\n /**\n * @notice A list of withdrawal hashes which have been successfully finalized.\n */\n mapping(bytes32 => bool) public finalizedWithdrawals;\n\n /**\n * @notice A mapping of withdrawal hashes to `ProvenWithdrawal` data.\n */\n mapping(bytes32 => ProvenWithdrawal) public provenWithdrawals;\n\n /**\n * @notice Determines if cross domain messaging is paused. When set to true,\n * deposits and withdrawals are paused. This may be removed in the\n * future.\n */\n bool public paused;\n\n /**\n * @notice Emitted when a transaction is deposited from L1 to L2. The parameters of this event\n * are read by the rollup node and used to derive deposit transactions on L2.\n *\n * @param from Address that triggered the deposit transaction.\n * @param to Address that the deposit transaction is directed to.\n * @param version Version of this deposit transaction event.\n * @param opaqueData ABI encoded deposit data to be parsed off-chain.\n */\n event TransactionDeposited(\n address indexed from,\n address indexed to,\n uint256 indexed version,\n bytes opaqueData\n );\n\n /**\n * @notice Emitted when a withdrawal transaction is proven.\n *\n * @param withdrawalHash Hash of the withdrawal transaction.\n */\n event WithdrawalProven(\n bytes32 indexed withdrawalHash,\n address indexed from,\n address indexed to\n );\n\n /**\n * @notice Emitted when a withdrawal transaction is finalized.\n *\n * @param withdrawalHash Hash of the withdrawal transaction.\n * @param success Whether the withdrawal transaction was successful.\n */\n event WithdrawalFinalized(bytes32 indexed withdrawalHash, bool success);\n\n /**\n * @notice Emitted when the pause is triggered.\n *\n * @param account Address of the account triggering the pause.\n */\n event Paused(address account);\n\n /**\n * @notice Emitted when the pause is lifted.\n *\n * @param account Address of the account triggering the unpause.\n */\n event Unpaused(address account);\n\n /**\n * @notice Reverts when paused.\n */\n modifier whenNotPaused() {\n require(paused == false, \"OptimismPortal: paused\");\n _;\n }\n\n /**\n * @custom:semver 1.3.0\n *\n * @param _l2Oracle Address of the L2OutputOracle contract.\n * @param _guardian Address that can pause deposits and withdrawals.\n * @param _paused Sets the contract's pausability state.\n * @param _config Address of the SystemConfig contract.\n */\n constructor(\n L2OutputOracle _l2Oracle,\n address _guardian,\n bool _paused,\n SystemConfig _config\n ) Semver(1, 3, 0) {\n L2_ORACLE = _l2Oracle;\n GUARDIAN = _guardian;\n SYSTEM_CONFIG = _config;\n initialize(_paused);\n }\n\n /**\n * @notice Initializer.\n */\n function initialize(bool _paused) public initializer {\n l2Sender = Constants.DEFAULT_L2_SENDER;\n paused = _paused;\n __ResourceMetering_init();\n }\n\n /**\n * @notice Pause deposits and withdrawals.\n */\n function pause() external {\n require(msg.sender == GUARDIAN, \"OptimismPortal: only guardian can pause\");\n paused = true;\n emit Paused(msg.sender);\n }\n\n /**\n * @notice Unpause deposits and withdrawals.\n */\n function unpause() external {\n require(msg.sender == GUARDIAN, \"OptimismPortal: only guardian can unpause\");\n paused = false;\n emit Unpaused(msg.sender);\n }\n\n /**\n * @notice Accepts value so that users can send ETH directly to this contract and have the\n * funds be deposited to their address on L2. This is intended as a convenience\n * function for EOAs. Contracts should call the depositTransaction() function directly\n * otherwise any deposited funds will be lost due to address aliasing.\n */\n // solhint-disable-next-line ordering\n receive() external payable {\n depositTransaction(msg.sender, msg.value, RECEIVE_DEFAULT_GAS_LIMIT, false, bytes(\"\"));\n }\n\n /**\n * @notice Accepts ETH value without triggering a deposit to L2. This function mainly exists\n * for the sake of the migration between the legacy Optimism system and Bedrock.\n */\n function donateETH() external payable {\n // Intentionally empty.\n }\n\n /**\n * @notice Getter for the resource config. Used internally by the ResourceMetering\n * contract. The SystemConfig is the source of truth for the resource config.\n *\n * @return ResourceMetering.ResourceConfig\n */\n function _resourceConfig()\n internal\n view\n override\n returns (ResourceMetering.ResourceConfig memory)\n {\n return SYSTEM_CONFIG.resourceConfig();\n }\n\n /**\n * @notice Proves a withdrawal transaction.\n *\n * @param _tx Withdrawal transaction to finalize.\n * @param _l2OutputIndex L2 output index to prove against.\n * @param _outputRootProof Inclusion proof of the L2ToL1MessagePasser contract's storage root.\n * @param _withdrawalProof Inclusion proof of the withdrawal in L2ToL1MessagePasser contract.\n */\n function proveWithdrawalTransaction(\n Types.WithdrawalTransaction memory _tx,\n uint256 _l2OutputIndex,\n Types.OutputRootProof calldata _outputRootProof,\n bytes[] calldata _withdrawalProof\n ) external whenNotPaused {\n // Prevent users from creating a deposit transaction where this address is the message\n // sender on L2. Because this is checked here, we do not need to check again in\n // `finalizeWithdrawalTransaction`.\n require(\n _tx.target != address(this),\n \"OptimismPortal: you cannot send messages to the portal contract\"\n );\n\n // Get the output root and load onto the stack to prevent multiple mloads. This will\n // revert if there is no output root for the given block number.\n bytes32 outputRoot = L2_ORACLE.getL2Output(_l2OutputIndex).outputRoot;\n\n // Verify that the output root can be generated with the elements in the proof.\n require(\n outputRoot == Hashing.hashOutputRootProof(_outputRootProof),\n \"OptimismPortal: invalid output root proof\"\n );\n\n // Load the ProvenWithdrawal into memory, using the withdrawal hash as a unique identifier.\n bytes32 withdrawalHash = Hashing.hashWithdrawal(_tx);\n ProvenWithdrawal memory provenWithdrawal = provenWithdrawals[withdrawalHash];\n\n // We generally want to prevent users from proving the same withdrawal multiple times\n // because each successive proof will update the timestamp. A malicious user can take\n // advantage of this to prevent other users from finalizing their withdrawal. However,\n // since withdrawals are proven before an output root is finalized, we need to allow users\n // to re-prove their withdrawal only in the case that the output root for their specified\n // output index has been updated.\n require(\n provenWithdrawal.timestamp == 0 ||\n L2_ORACLE.getL2Output(provenWithdrawal.l2OutputIndex).outputRoot !=\n provenWithdrawal.outputRoot,\n \"OptimismPortal: withdrawal hash has already been proven\"\n );\n\n // Compute the storage slot of the withdrawal hash in the L2ToL1MessagePasser contract.\n // Refer to the Solidity documentation for more information on how storage layouts are\n // computed for mappings.\n bytes32 storageKey = keccak256(\n abi.encode(\n withdrawalHash,\n uint256(0) // The withdrawals mapping is at the first slot in the layout.\n )\n );\n\n // Verify that the hash of this withdrawal was stored in the L2toL1MessagePasser contract\n // on L2. If this is true, under the assumption that the SecureMerkleTrie does not have\n // bugs, then we know that this withdrawal was actually triggered on L2 and can therefore\n // be relayed on L1.\n require(\n SecureMerkleTrie.verifyInclusionProof(\n abi.encode(storageKey),\n hex\"01\",\n _withdrawalProof,\n _outputRootProof.messagePasserStorageRoot\n ),\n \"OptimismPortal: invalid withdrawal inclusion proof\"\n );\n\n // Designate the withdrawalHash as proven by storing the `outputRoot`, `timestamp`, and\n // `l2BlockNumber` in the `provenWithdrawals` mapping. A `withdrawalHash` can only be\n // proven once unless it is submitted again with a different outputRoot.\n provenWithdrawals[withdrawalHash] = ProvenWithdrawal({\n outputRoot: outputRoot,\n timestamp: uint128(block.timestamp),\n l2OutputIndex: uint128(_l2OutputIndex)\n });\n\n // Emit a `WithdrawalProven` event.\n emit WithdrawalProven(withdrawalHash, _tx.sender, _tx.target);\n }\n\n /**\n * @notice Finalizes a withdrawal transaction.\n *\n * @param _tx Withdrawal transaction to finalize.\n */\n function finalizeWithdrawalTransaction(Types.WithdrawalTransaction memory _tx)\n external\n whenNotPaused\n {\n // Make sure that the l2Sender has not yet been set. The l2Sender is set to a value other\n // than the default value when a withdrawal transaction is being finalized. This check is\n // a defacto reentrancy guard.\n require(\n l2Sender == Constants.DEFAULT_L2_SENDER,\n \"OptimismPortal: can only trigger one withdrawal per transaction\"\n );\n\n // Grab the proven withdrawal from the `provenWithdrawals` map.\n bytes32 withdrawalHash = Hashing.hashWithdrawal(_tx);\n ProvenWithdrawal memory provenWithdrawal = provenWithdrawals[withdrawalHash];\n\n // A withdrawal can only be finalized if it has been proven. We know that a withdrawal has\n // been proven at least once when its timestamp is non-zero. Unproven withdrawals will have\n // a timestamp of zero.\n require(\n provenWithdrawal.timestamp != 0,\n \"OptimismPortal: withdrawal has not been proven yet\"\n );\n\n // As a sanity check, we make sure that the proven withdrawal's timestamp is greater than\n // starting timestamp inside the L2OutputOracle. Not strictly necessary but extra layer of\n // safety against weird bugs in the proving step.\n require(\n provenWithdrawal.timestamp >= L2_ORACLE.startingTimestamp(),\n \"OptimismPortal: withdrawal timestamp less than L2 Oracle starting timestamp\"\n );\n\n // A proven withdrawal must wait at least the finalization period before it can be\n // finalized. This waiting period can elapse in parallel with the waiting period for the\n // output the withdrawal was proven against. In effect, this means that the minimum\n // withdrawal time is proposal submission time + finalization period.\n require(\n _isFinalizationPeriodElapsed(provenWithdrawal.timestamp),\n \"OptimismPortal: proven withdrawal finalization period has not elapsed\"\n );\n\n // Grab the OutputProposal from the L2OutputOracle, will revert if the output that\n // corresponds to the given index has not been proposed yet.\n Types.OutputProposal memory proposal = L2_ORACLE.getL2Output(\n provenWithdrawal.l2OutputIndex\n );\n\n // Check that the output root that was used to prove the withdrawal is the same as the\n // current output root for the given output index. An output root may change if it is\n // deleted by the challenger address and then re-proposed.\n require(\n proposal.outputRoot == provenWithdrawal.outputRoot,\n \"OptimismPortal: output root proven is not the same as current output root\"\n );\n\n // Check that the output proposal has also been finalized.\n require(\n _isFinalizationPeriodElapsed(proposal.timestamp),\n \"OptimismPortal: output proposal finalization period has not elapsed\"\n );\n\n // Check that this withdrawal has not already been finalized, this is replay protection.\n require(\n finalizedWithdrawals[withdrawalHash] == false,\n \"OptimismPortal: withdrawal has already been finalized\"\n );\n\n // Mark the withdrawal as finalized so it can't be replayed.\n finalizedWithdrawals[withdrawalHash] = true;\n\n // Set the l2Sender so contracts know who triggered this withdrawal on L2.\n l2Sender = _tx.sender;\n\n // Trigger the call to the target contract. We use a custom low level method\n // SafeCall.callWithMinGas to ensure two key properties\n // 1. Target contracts cannot force this call to run out of gas by returning a very large\n // amount of data (and this is OK because we don't care about the returndata here).\n // 2. The amount of gas provided to the call to the target contract is at least the gas\n // limit specified by the us