Покрокове керівництво для стандартного мостового контракту Optimism

/**
 * @title IL1ERC20Bridge
 */
interface IL1ERC20Bridge {
    /**********
     * Події *
     **********/

    event ERC20DepositInitiated(

    /********************
     * Публічні функції *
     ********************/

    /**
     * @dev отримати адресу відповідного контракту мосту L2.
     * @return Адреса відповідного контракту мосту L2.
     */
    function l2TokenBridge() external returns (address);

    /**
     * @dev внести суму ERC20 на баланс викликаючого на L2.
     * @param _l1Token Адреса L1 ERC20, який ми вносимо
     * @param _l2Token Адреса відповідного L2 ERC20 на L1
     * @param _amount Сума ERC20 для внесення
     * @param _l2Gas Ліміт газу, необхідний для завершення внесення на L2.
     * @param _data Необов’язкові дані для пересилання на L2. Ці дані надаються
     *        виключно для зручності зовнішніх контрактів. Крім встановлення максимальної
     *        довжини, ці контракти не дають жодних гарантій щодо їхнього вмісту.
     */
    function depositERC20(
        address _l1Token,
        address _l2Token,
        uint256 _amount,
        uint32 _l2Gas,
        bytes calldata _data
    ) external;

    /**
     * @dev внести суму ERC20 на баланс одержувача на L2.
     * @param _l1Token Адреса L1 ERC20, який ми вносимо
     * @param _l2Token Адреса відповідного L2 ERC20 на L1
     * @param _to Адреса L2, на яку буде зараховано виведення коштів.
     * @param _amount Сума ERC20 для внесення.
     * @param _l2Gas Ліміт газу, необхідний для завершення внесення на L2.
     * @param _data Необов’язкові дані для пересилання на L2. Ці дані надаються
     *        виключно для зручності зовнішніх контрактів. Крім встановлення максимальної
     *        довжини, ці контракти не дають жодних гарантій щодо їхнього вмісту.
     */
    function depositERC20To(
        address _l1Token,
        address _l2Token,
        address _to,
        uint256 _amount,
        uint32 _l2Gas,
        bytes calldata _data
    ) external;

    /*************************
     * Міжмережеві функції *
     *************************/

    /**
     * @dev Завершити виведення з L2 на L1 і зарахувати кошти на баланс одержувача
     * токена L1 ERC20.
     * Цей виклик не вдасться, якщо ініційоване виведення з L2 не було фіналізовано.
     *
     * @param _l1Token Адреса токена L1, для якого виконується finalizeWithdrawal.
     * @param _l2Token Адреса токена L2, де було ініційовано виведення.
     * @param _from Адреса L2, що ініціює переказ.
     * @param _to Адреса L1, на яку буде зараховано виведення коштів.
     * @param _amount Сума ERC20 для внесення.
     * @param _data Дані, надані відправником на L2. Ці дані надаються
     *   виключно для зручності зовнішніх контрактів. Крім встановлення максимальної
     *   довжини, ці контракти не дають жодних гарантій щодо їхнього вмісту.
     */
    function finalizeERC20Withdrawal(
        address _l1Token,
        address _l2Token,
        address _from,
        address _to,
        uint256 _amount,
        bytes calldata _data
    ) external;
}

// SPDX-License-Identifier: MIT
pragma solidity >0.5.0 <0.9.0;

import "./IL1ERC20Bridge.sol";

/**
 * @title IL1StandardBridge
 */
interface IL1StandardBridge is IL1ERC20Bridge {
    /**********
     * Події *
     **********/
    event ETHDepositInitiated(
        address indexed _from,
        address indexed _to,
        uint256 _amount,
        bytes _data
    );

    event ETHWithdrawalFinalized(
        .
        .
        .
    );

    /********************
     * Публічні функції *
     ********************/

    /**
     * @dev Внести суму ETH на баланс викликаючого на L2.
            .
            .
            .
     */
    function depositETH(uint32 _l2Gas, bytes calldata _data) external payable;

    /**
     * @dev Внести суму ETH на баланс одержувача на L2.
            .
            .
            .
     */
    function depositETHTo(
        address _to,
        uint32 _l2Gas,
        bytes calldata _data
    ) external payable;

    /*************************
     * Міжмережеві функції *
     *************************/

    /**
     * @dev Завершити виведення з L2 на L1 і зарахувати кошти на баланс одержувача
     * токена L1 ETH. Оскільки тільки xDomainMessenger може викликати цю функцію, вона ніколи не буде викликана
     * до фіналізації виведення.
                .
                .
                .
     */
    function finalizeETHWithdrawal(
        address _from,
        address _to,
        uint256 _amount,
        bytes calldata _data
    ) external;
}

/**
 * @title CrossDomainEnabled
 * @dev Допоміжний контракт для контрактів, що виконують міждоменні комунікації
 *
 * Використаний компілятор: визначається контрактом, що успадковує
 */
contract CrossDomainEnabled {
    /*************
     * Змінні *
     *************/

    // Контракт месенджера, що використовується для надсилання та отримання повідомлень з іншого домену.
    address public messenger;

    /***************
     * Конструктор *
     ***************/

    /**
     * @param _messenger Адреса CrossDomainMessenger на поточному рівні.
     */
    constructor(address _messenger) {
        messenger = _messenger;
    }

    /**********************
     * Модифікатори функцій *
     **********************/

    /**
     * Застосовує обмеження, щоб змінена функція могла викликатися лише з певного міждоменного облікового запису.
     * @param _sourceDomainAccount Єдиний обліковий запис у вихідному домені, який
     *  автентифікований для виклику цієї функції.
     */
    modifier onlyFromCrossDomainAccount(address _sourceDomainAccount) {

        _;
    }

    /**********************
     * Внутрішні функції *
     **********************/

    /**
     * Отримує месенджер, зазвичай зі сховища. Ця функція є відкритою на випадок, якщо дочірньому контракту
     * знадобиться її перевизначити.
     * @return Адреса контракту міждоменного месенджера, який слід використовувати.
     */
    function getCrossDomainMessenger() internal virtual returns (ICrossDomainMessenger) {
        return ICrossDomainMessenger(messenger);
    }

    /**
     * Надсилає повідомлення на обліковий запис в іншому домені
     * @param _crossDomainTarget Запланований одержувач у цільовому домені
     * @param _message Дані для надсилання цілі (зазвичай calldata для функції з
     *  `onlyFromCrossDomainAccount()`)
     * @param _gasLimit gasLimit для отримання повідомлення в цільовому домені.
     */
    function sendCrossDomainMessage(
        address _crossDomainTarget,
        uint32 _gasLimit,
        bytes memory _message

/**
 * @title L1StandardBridge
 * @dev Міст L1 для ETH та ERC20 — це контракт, який зберігає внесені кошти L1 та стандартні
 * токени, що використовуються на L2. Він синхронізує відповідний міст L2, інформуючи його про депозити
 * та очікуючи від нього повідомлень про нові фіналізовані виведення коштів.
 *
 */
contract L1StandardBridge is IL1StandardBridge, CrossDomainEnabled {
    using SafeERC20 for IERC20;

    /******************
     * Ініціалізація *
     ******************/

    /**
     * @param _l1messenger Адреса L1 Messenger, що використовується для міжмережевих комунікацій.
     * @param _l2TokenBridge Адреса стандартного мосту L2.
     */
    // slither-disable-next-line external-function

    /**************
     * Внесення *
     **************/

    /** @dev Модифікатор, що вимагає, щоб відправник був EOA.  Цю перевірку може
     *  обійти зловмисний контракт через initcode, але вона запобігає помилці користувача, якої ми хочемо уникнути.
     */
    modifier onlyEOA() {
        // Використовується для зупинки депозитів з контрактів (щоб уникнути випадкової втрати токенів)
        require(!Address.isContract(msg.sender), "Обліковий запис не є EOA");
        _;
    }

    /**
     * @dev Цю функцію можна викликати без даних
     * для внесення суми ETH на баланс викликаючого на L2.
     * Оскільки функція receive не приймає дані, консервативна
     * стандартна сума пересилається на L2.
     */
    receive() external payable onlyEOA {
        _initiateETHDeposit(msg.sender, msg.sender, 200_000, bytes(""));
    }

    /**
     * @inheritdoc IL1StandardBridge
     */
    function depositETH(uint32 _l2Gas, bytes calldata _data) external payable onlyEOA {
        _initiateETHDeposit(msg.sender, msg.sender, _l2Gas, _data);
    }

    /**
     * @inheritdoc IL1StandardBridge
     */
    function depositETHTo(
        address _to,
        uint32 _l2Gas,
        bytes calldata _data
    ) external payable {
        _initiateETHDeposit(msg.sender, _to, _l2Gas, _data);
    }

    /**
     * @dev Виконує логіку для депозитів, зберігаючи ETH та інформуючи шлюз L2 ETH про
     * депозит.
     * @param _from Обліковий запис, з якого буде взято депозит на L1.
     * @param _to Обліковий запис, на який буде зараховано депозит на L2.
     * @param _l2Gas Ліміт газу, необхідний для завершення депозиту на L2.
     * @param _data Необов’язкові дані для пересилання на L2. Ці дані надаються
     *        виключно для зручності зовнішніх контрактів. Крім встановлення максимальної
     *        довжини, ці контракти не дають жодних гарантій щодо їхнього вмісту.
     */
    function _initiateETHDeposit(
        address _from,
        address _to,
        uint32 _l2Gas,
        bytes memory _data
    ) internal {
        // Сконструювати calldata для виклику finalizeDeposit
        bytes memory message = abi.encodeWithSelector(

    /**
     * @inheritdoc IL1ERC20Bridge
     */
    function depositERC20(
		.
		.
		.
    ) external virtual onlyEOA {
        _initiateERC20Deposit(_l1Token, _l2Token, msg.sender, msg.sender, _amount, _l2Gas, _data);
    }

    /**
     * @inheritdoc IL1ERC20Bridge
     */
    function depositERC20To(
		.
		.
		.
    ) external virtual {
        _initiateERC20Deposit(_l1Token, _l2Token, msg.sender, _to, _amount, _l2Gas, _data);
    }

    /**
     * @dev Виконує логіку для депозитів, інформуючи токен L2 Deposited Token
     * про депозит і викликаючи обробник для блокування коштів L1. (наприклад, transferFrom)
     *
     * @param _l1Token Адреса L1 ERC20, який ми вносимо
     * @param _l2Token Адреса відповідного L2 ERC20 на L1
     * @param _from Обліковий запис, з якого буде взято депозит на L1
     * @param _to Обліковий запис, на який буде зараховано депозит на L2
     * @param _amount Сума ERC20 для внесення.
     * @param _l2Gas Ліміт газу, необхідний для завершення депозиту на L2.
     * @param _data Необов’язкові дані для пересилання на L2. Ці дані надаються
     *        виключно для зручності зовнішніх контрактів. Крім встановлення максимальної
     *        довжини, ці контракти не дають жодних гарантій щодо їхнього вмісту.
     */
    function _initiateERC20Deposit(
        address _l1Token,
        address _l2Token,
        address _from,
        address _to,
        uint256 _amount,
        uint32 _l2Gas,
        bytes calldata _data
    ) internal {

        // Сконструювати calldata для _l2Token.finalizeDeposit(_to, _amount)
        bytes memory message = abi.encodeWithSelector(
            IL2ERC20Bridge.finalizeDeposit.selector,
            _l1Token,
            _l2Token,
            _from,
            _to,
            _amount,
            _data
        );

        // Надіслати calldata на L2
        // slither-disable-next-line reentrancy-events, reentrancy-benign
        sendCrossDomainMessage(l2TokenBridge, _l2Gas, message);

        // slither-disable-next-line reentrancy-benign
        deposits[_l1Token][_l2Token] = deposits[_l1Token][_l2Token] + _amount;

        // slither-disable-next-line reentrancy-events
        emit ERC20DepositInitiated(_l1Token, _l2Token, _from, _to, _amount, _data);
    }

    /*************************
     * Міжмережеві функції *
     *************************/

    /**
     * @inheritdoc IL1StandardBridge
     */
    function finalizeETHWithdrawal(
        address _from,
        address _to,
        uint256 _amount,
        bytes calldata _data

    }

    /**
     * @inheritdoc IL1ERC20Bridge
     */
    function finalizeERC20Withdrawal(
        address _l1Token,
        address _l2Token,
        address _from,
        address _to,
        uint256 _amount,
        bytes calldata _data
    ) external onlyFromCrossDomainAccount(l2TokenBridge) {

        // Коли виведення фіналізується на L1, міст L1 переказує кошти тому, хто виводить
        // slither-disable-next-line reentrancy-events
        IERC20(_l1Token).safeTransfer(_to, _amount);

        // slither-disable-next-line reentrancy-events
        emit ERC20WithdrawalFinalized(_l1Token, _l2Token, _from, _to, _amount, _data);
    }


    /*****************************
     * Тимчасово - міграція ETH *
     *****************************/

    /**
     * @dev Додає баланс ETH до облікового запису. Це призначено для того, щоб дозволити міграцію ETH
     * зі старого шлюзу на новий.
     * ПРИМІТКА: Це залишено лише для одного оновлення, щоб ми могли отримати мігрований ETH зі
     * старого контракту
     */
    function donateETH() external payable {}
}

    /**
     * @param _l2Bridge Адреса стандартного мосту L2.
     * @param _l1Token Адреса відповідного токена L1.
     * @param _name Назва ERC20.
     * @param _symbol Символ ERC20.
     */
    constructor(
        address _l2Bridge,
        address _l1Token,
        string memory _name,
        string memory _symbol
    ) ERC20(_name, _symbol) {
        l1Token = _l1Token;
        l2Bridge = _l2Bridge;
    }

    modifier onlyL2Bridge() {
        require(msg.sender == l2Bridge, "Тільки міст L2 може карбувати та спалювати");
        _;
    }


    // slither-disable-next-line external-function
    function supportsInterface(bytes4 _interfaceId) public pure returns (bool) {
        bytes4 firstSupportedInterface = bytes4(keccak256("supportsInterface(bytes4)")); // ERC165
        bytes4 secondSupportedInterface = IL2StandardERC20.l1Token.selector ^
            IL2StandardERC20.mint.selector ^
            IL2StandardERC20.burn.selector;
        return _interfaceId == firstSupportedInterface || _interfaceId == secondSupportedInterface;
    }

    // slither-disable-next-line external-function
    function mint(address _to, uint256 _amount) public virtual onlyL2Bridge {
        _mint(_to, _amount);

        emit Mint(_to, _amount);
    }

    // slither-disable-next-line external-function
    function burn(address _from, uint256 _amount) public virtual onlyL2Bridge {
        _burn(_from, _amount);

        emit Burn(_from, _amount);
    }
}

/* Імпорт бібліотек */
import { ERC165Checker } from "@openzeppelin/contracts/utils/introspection/ERC165Checker.sol";
import { CrossDomainEnabled } from "../../libraries/bridge/CrossDomainEnabled.sol";
import { Lib_PredeployAddresses } from "../../libraries/constants/Lib_PredeployAddresses.sol";

/* Імпорт контрактів */
import { IL2StandardERC20 } from "../../standards/IL2StandardERC20.sol";

/**
 * @title L2StandardBridge
 * @dev Стандартний міст L2 — це контракт, який працює разом зі стандартним мостом L1, щоб
 * забезпечити перекази ETH та ERC20 між L1 та L2.
 * Цей контракт діє як мінтер для нових токенів, коли він отримує інформацію про депозити в стандартний міст
 * L1.
 * Цей контракт також діє як спалювач токенів, призначених для виведення, інформуючи міст L1
 * про необхідність вивільнення коштів L1.
 */
contract L2StandardBridge is IL2ERC20Bridge, CrossDomainEnabled {
    /********************************
     * Посилання на зовнішні контракти *
     ********************************/

    address public l1TokenBridge;

    /***************
     * Конструктор *
     ***************/

    /**
     * @param _l2CrossDomainMessenger Міждоменний месенджер, що використовується цим контрактом.
     * @param _l1TokenBridge Адреса мосту L1, розгорнутого в основній мережі.
     */
    constructor(address _l2CrossDomainMessenger, address _l1TokenBridge)
        CrossDomainEnabled(_l2CrossDomainMessenger)
    {
        l1TokenBridge = _l1TokenBridge;
    }

    /***************
     * Виведення *
     ***************/

    /**
     * @inheritdoc IL2ERC20Bridge
     */
    function withdraw(
        address _l2Token,
        uint256 _amount,
        uint32 _l1Gas,
        bytes calldata _data
    ) external virtual {
        _initiateWithdrawal(_l2Token, msg.sender, msg.sender, _amount, _l1Gas, _data);
    }

    /**
     * @inheritdoc IL2ERC20Bridge
     */
    function withdrawTo(
        address _l2Token,
        address _to,
        uint256 _amount,
        uint32 _l1Gas,
        bytes calldata _data
    ) external virtual {
        _initiateWithdrawal(_l2Token, msg.sender, _to, _amount, _l1Gas, _data);
    }

    /**
     * @dev Виконує логіку для виведення, спалюючи токен та інформуючи
     *      шлюз токенів L1 про виведення.
     * @param _l2Token Адреса токена L2, де ініційовано виведення.
     * @param _from Обліковий запис, з якого буде взято виведення на L2.
     * @param _to Обліковий запис, на який буде зараховано виведення на L1.
     * @param _amount Кількість токена для виведення.
     * @param _l1Gas Не використовується, але включено для можливих міркувань щодо майбутньої сумісності.
     * @param _data Необов’язкові дані для пересилання на L1. Ці дані надаються
     *        виключно для зручності зовнішніх контрактів. Крім встановлення максимальної
     *        довжини, ці контракти не дають жодних гарантій щодо їхнього вмісту.
     */
    function _initiateWithdrawal(
        address _l2Token,
        address _from,
        address _to,
        uint256 _amount,
        uint32 _l1Gas,
        bytes calldata _data
    ) internal {
        // Коли виведення ініціюється, ми спалюємо кошти того, хто виводить, щоб запобігти подальшому використанню на L2
        // slither-disable-next-line reentrancy-events
        IL2StandardERC20(_l2Token).burn(msg.sender, _amount);

            message = abi.encodeWithSelector(
                IL1StandardBridge.finalizeETHWithdrawal.selector,
                _from,
                _to,
                _amount,
                _data
            );
        } else {
            message = abi.encodeWithSelector(
                IL1ERC20Bridge.finalizeERC20Withdrawal.selector,
                l1Token,
                _l2Token,
                _from,
                _to,
                _amount,
                _data
            );
        }

        // Надіслати повідомлення на міст L1
        // slither-disable-next-line reentrancy-events
        sendCrossDomainMessage(l1TokenBridge, _l1Gas, message);

        // slither-disable-next-line reentrancy-events
        emit WithdrawalInitiated(l1Token, _l2Token, msg.sender, _to, _amount, _data);
    }

    /************************************
     * Міжмережева функція: внесення *
     ************************************/

    /**
     * @inheritdoc IL2ERC20Bridge
     */
    function finalizeDeposit(
        address _l1Token,
        address _l2Token,
        address _from,
        address _to,
        uint256 _amount,
        bytes calldata _data

        } else {
            // Або токен L2, на який вноситься депозит, не погоджується з правильною адресою
            // свого токена L1, або не підтримує правильний інтерфейс.
            // Це має відбуватися лише у випадку зловмисного токена L2, або якщо користувач якимось чином
            // вказав неправильну адресу токена L2 для депозиту.
            // У будь-якому випадку, ми зупиняємо процес тут і створюємо повідомлення про
            // виведення, щоб користувачі могли в деяких випадках повернути свої кошти.
            // Немає способу повністю запобігти зловмисним контрактам токенів, але це обмежує
            // помилки користувачів і пом'якшує деякі форми зловмисної поведінки контрактів.

            bytes memory message = abi.encodeWithSelector(
                IL1ERC20Bridge.finalizeERC20Withdrawal.selector,
                _l1Token,
                _l2Token,
                _to, // тут поміняли _to та _from, щоб повернути депозит відправнику
                _from,
                _amount,
                _data
            );

            // Надіслати повідомлення на міст L1
            // slither-disable-next-line reentrancy-events
            sendCrossDomainMessage(l1TokenBridge, 0, message);
            // slither-disable-next-line reentrancy-events
            emit DepositFailed(_l1Token, _l2Token, _from, _to, _amount, _data);
        }
    }
}