@arbitrum/nitro-contracts 1.1.0-alpha.7 → 1.1.0-beta.1

package/src/rollup/RollupCreator.sol

@@ -7,12 +7,16 @@ pragma solidity ^0.8.0;
 import "./RollupProxy.sol";
 import "./IRollupAdmin.sol";
 import "./BridgeCreator.sol";
-import "./ERC20BridgeCreator.sol";
+import "@offchainlabs/upgrade-executor/src/IUpgradeExecutor.sol";
 import "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
 import "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
 import "@openzeppelin/contracts/access/Ownable.sol";
+import {DeployHelper} from "./DeployHelper.sol";
+import {SafeERC20, IERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
 contract RollupCreator is Ownable {
+    using SafeERC20 for IERC20;
+
     event RollupCreated(
         address indexed rollupAddress,
         address indexed nativeToken,
@@ -23,106 +27,117 @@ contract RollupCreator is Ownable {
         address adminProxy,
         address sequencerInbox,
         address bridge,
+        address upgradeExecutor,
         address validatorUtils,
         address validatorWalletCreator
     );
     event TemplatesUpdated();
 
-    BridgeCreator public ethBridgeCreator;
-    ERC20BridgeCreator public erc20BridgeCreator;
+    struct RollupDeploymentParams {
+        Config config;
+        address batchPoster;
+        address[] validators;
+        uint256 maxDataSize;
+        address nativeToken;
+        bool deployFactoriesToL2;
+        uint256 maxFeePerGasForRetryables;
+    }
+
+    BridgeCreator public bridgeCreator;
     IOneStepProofEntry public osp;
     IChallengeManager public challengeManagerTemplate;
     IRollupAdmin public rollupAdminLogic;
     IRollupUser public rollupUserLogic;
+    IUpgradeExecutor public upgradeExecutorLogic;
 
     address public validatorUtils;
     address public validatorWalletCreator;
 
-    struct BridgeContracts {
-        IBridge bridge;
-        ISequencerInbox sequencerInbox;
-        IInboxBase inbox;
-        IRollupEventInbox rollupEventInbox;
-        IOutbox outbox;
-    }
+    DeployHelper public l2FactoriesDeployer;
 
     constructor() Ownable() {}
 
+    // creator receives back excess fees (for deploying L2 factories) so it can refund the caller
+    receive() external payable {}
+
     function setTemplates(
-        BridgeCreator _ethBridgeCreator,
-        ERC20BridgeCreator _erc20BridgeCreator,
+        BridgeCreator _bridgeCreator,
         IOneStepProofEntry _osp,
         IChallengeManager _challengeManagerLogic,
         IRollupAdmin _rollupAdminLogic,
         IRollupUser _rollupUserLogic,
+        IUpgradeExecutor _upgradeExecutorLogic,
         address _validatorUtils,
-        address _validatorWalletCreator
+        address _validatorWalletCreator,
+        DeployHelper _l2FactoriesDeployer
     ) external onlyOwner {
-        ethBridgeCreator = _ethBridgeCreator;
-        erc20BridgeCreator = _erc20BridgeCreator;
+        bridgeCreator = _bridgeCreator;
         osp = _osp;
         challengeManagerTemplate = _challengeManagerLogic;
         rollupAdminLogic = _rollupAdminLogic;
         rollupUserLogic = _rollupUserLogic;
+        upgradeExecutorLogic = _upgradeExecutorLogic;
         validatorUtils = _validatorUtils;
         validatorWalletCreator = _validatorWalletCreator;
+        l2FactoriesDeployer = _l2FactoriesDeployer;
         emit TemplatesUpdated();
     }
 
     /**
      * @notice Create a new rollup
      * @dev After this setup:
-     * @dev - Rollup should be the owner of bridge
-     * @dev - RollupOwner should be the owner of Rollup's ProxyAdmin
-     * @dev - RollupOwner should be the owner of Rollup
+     * @dev - UpgradeExecutor should be the owner of rollup
+     * @dev - UpgradeExecutor should be the owner of proxyAdmin which manages bridge contracts
+     * @dev - config.rollupOwner should have executor role on upgradeExecutor
      * @dev - Bridge should have a single inbox and outbox
      * @dev - Validators and batch poster should be set if provided
-     * @param config       The configuration for the rollup
-     * @param _batchPoster The address of the batch poster, not used when set to zero address
-     * @param _validators  The list of validator addresses, not used when set to empty list
-     * @param _nativeToken Address of the custom fee token used by rollup. If rollup is ETH-based address(0) should be provided
+     * @param deployParams The parameters for the rollup deployment. It consists of:
+     *          - config        The configuration for the rollup
+     *          - batchPoster   The address of the batch poster, not used when set to zero address
+     *          - validators    The list of validator addresses, not used when set to empty list
+     *          - nativeToken   Address of the custom fee token used by rollup. If rollup is ETH-based address(0) should be provided
+     *          - deployFactoriesToL2 Whether to deploy L2 factories using retryable tickets. If true, retryables need to be paid for in native currency.
+     *                          Deploying factories via retryable tickets at rollup creation time is the most reliable method to do it since it
+     *                          doesn't require paying the L1 gas. If deployment is not done as part of rollup creation TX, there is a risk that
+     *                          anyone can try to deploy factories and potentially burn the nonce 0 (ie. due to gas price spike when doing direct
+     *                          L2 TX). That would mean we permanently lost capability to deploy deterministic factory at expected address.
+     *          - maxFeePerGasForRetryables price bid for L2 execution.
      * @return The address of the newly created rollup
      */
-    function createRollup(
-        Config memory config,
-        address _batchPoster,
-        address[] calldata _validators,
-        address _nativeToken
-    ) external returns (address) {
+    function createRollup(RollupDeploymentParams memory deployParams)
+        public
+        payable
+        returns (address)
+    {
+        // Make sure the immutable maxDataSize is as expected
+        (, ISequencerInbox ethSequencerInbox, IInboxBase ethInbox, , ) = bridgeCreator
+            .ethBasedTemplates();
+        require(
+            deployParams.maxDataSize == ethSequencerInbox.maxDataSize(),
+            "SI_MAX_DATA_SIZE_MISMATCH"
+        );
+        require(deployParams.maxDataSize == ethInbox.maxDataSize(), "I_MAX_DATA_SIZE_MISMATCH");
+
+        (, ISequencerInbox erc20SequencerInbox, IInboxBase erc20Inbox, , ) = bridgeCreator
+            .erc20BasedTemplates();
+        require(
+            deployParams.maxDataSize == erc20SequencerInbox.maxDataSize(),
+            "SI_MAX_DATA_SIZE_MISMATCH"
+        );
+        require(deployParams.maxDataSize == erc20Inbox.maxDataSize(), "I_MAX_DATA_SIZE_MISMATCH");
+
+        // create proxy admin which will manage bridge contracts
         ProxyAdmin proxyAdmin = new ProxyAdmin();
 
         // Create the rollup proxy to figure out the address and initialize it later
-        RollupProxy rollup = new RollupProxy{salt: keccak256(abi.encode(config))}();
+        RollupProxy rollup = new RollupProxy{salt: keccak256(abi.encode(deployParams))}();
 
-        BridgeContracts memory bridgeContracts;
-        if (_nativeToken == address(0)) {
-            // create ETH-based rollup if address zero is provided for native token
-            (
-                bridgeContracts.bridge,
-                bridgeContracts.sequencerInbox,
-                bridgeContracts.inbox,
-                bridgeContracts.rollupEventInbox,
-                bridgeContracts.outbox
-            ) = ethBridgeCreator.createBridge(
-                address(proxyAdmin),
-                address(rollup),
-                config.sequencerInboxMaxTimeVariation
-            );
-        } else {
-            // otherwise create ERC20-based rollup with custom fee token
-            (
-                bridgeContracts.bridge,
-                bridgeContracts.sequencerInbox,
-                bridgeContracts.inbox,
-                bridgeContracts.rollupEventInbox,
-                bridgeContracts.outbox
-            ) = erc20BridgeCreator.createBridge(
-                address(proxyAdmin),
-                address(rollup),
-                _nativeToken,
-                config.sequencerInboxMaxTimeVariation
-            );
-        }
+        BridgeCreator.BridgeContracts memory bridgeContracts = bridgeCreator.createBridge(
+            address(proxyAdmin),
+            address(rollup),
+            deployParams.nativeToken,
+            deployParams.config.sequencerInboxMaxTimeVariation
+        );
 
         IChallengeManager challengeManager = IChallengeManager(
             address(
@@ -140,14 +155,17 @@ contract RollupCreator is Ownable {
             osp
         );
 
-        proxyAdmin.transferOwnership(config.owner);
+        // deploy and init upgrade executor
+        address upgradeExecutor = _deployUpgradeExecutor(deployParams.config.owner, proxyAdmin);
+
+        // upgradeExecutor shall be proxyAdmin's owner
+        proxyAdmin.transferOwnership(address(upgradeExecutor));
 
         // initialize the rollup with this contract as owner to set batch poster and validators
-        // it will transfer the ownership back to the actual owner later
-        address actualOwner = config.owner;
-        config.owner = address(this);
+        // it will transfer the ownership to the upgrade executor later
+        deployParams.config.owner = address(this);
         rollup.initializeProxy(
-            config,
+            deployParams.config,
             ContractDependencies({
                 bridge: bridgeContracts.bridge,
                 sequencerInbox: bridgeContracts.sequencerInbox,
@@ -163,24 +181,32 @@ contract RollupCreator is Ownable {
         );
 
         // setting batch poster, if the address provided is not zero address
-        if (_batchPoster != address(0)) {
-            bridgeContracts.sequencerInbox.setIsBatchPoster(_batchPoster, true);
+        if (deployParams.batchPoster != address(0)) {
+            bridgeContracts.sequencerInbox.setIsBatchPoster(deployParams.batchPoster, true);
         }
 
         // Call setValidator on the newly created rollup contract just if validator set is not empty
-        if (_validators.length != 0) {
-            bool[] memory _vals = new bool[](_validators.length);
-            for (uint256 i = 0; i < _validators.length; i++) {
+        if (deployParams.validators.length != 0) {
+            bool[] memory _vals = new bool[](deployParams.validators.length);
+            for (uint256 i = 0; i < deployParams.validators.length; i++) {
                 _vals[i] = true;
             }
-            IRollupAdmin(address(rollup)).setValidator(_validators, _vals);
+            IRollupAdmin(address(rollup)).setValidator(deployParams.validators, _vals);
         }
 
-        IRollupAdmin(address(rollup)).setOwner(actualOwner);
+        IRollupAdmin(address(rollup)).setOwner(address(upgradeExecutor));
+
+        if (deployParams.deployFactoriesToL2) {
+            _deployFactories(
+                address(bridgeContracts.inbox),
+                deployParams.nativeToken,
+                deployParams.maxFeePerGasForRetryables
+            );
+        }
 
         emit RollupCreated(
             address(rollup),
-            _nativeToken,
+            deployParams.nativeToken,
             address(bridgeContracts.inbox),
             address(bridgeContracts.outbox),
             address(bridgeContracts.rollupEventInbox),
@@ -188,9 +214,61 @@ contract RollupCreator is Ownable {
             address(proxyAdmin),
             address(bridgeContracts.sequencerInbox),
             address(bridgeContracts.bridge),
+            address(upgradeExecutor),
             address(validatorUtils),
             address(validatorWalletCreator)
         );
         return address(rollup);
     }
+
+    function _deployUpgradeExecutor(address rollupOwner, ProxyAdmin proxyAdmin)
+        internal
+        returns (address)
+    {
+        IUpgradeExecutor upgradeExecutor = IUpgradeExecutor(
+            address(
+                new TransparentUpgradeableProxy(
+                    address(upgradeExecutorLogic),
+                    address(proxyAdmin),
+                    bytes("")
+                )
+            )
+        );
+        address[] memory executors = new address[](1);
+        executors[0] = rollupOwner;
+        upgradeExecutor.initialize(address(upgradeExecutor), executors);
+
+        return address(upgradeExecutor);
+    }
+
+    function _deployFactories(
+        address _inbox,
+        address _nativeToken,
+        uint256 _maxFeePerGas
+    ) internal {
+        if (_nativeToken == address(0)) {
+            // we need to fund 4 retryable tickets
+            uint256 cost = l2FactoriesDeployer.getDeploymentTotalCost(
+                IInboxBase(_inbox),
+                _maxFeePerGas
+            );
+
+            // do it
+            l2FactoriesDeployer.perform{value: cost}(_inbox, _nativeToken, _maxFeePerGas);
+
+            // refund the caller
+            (bool sent, ) = msg.sender.call{value: address(this).balance}("");
+            require(sent, "Refund failed");
+        } else {
+            // Transfer fee token amount needed to pay for retryable fees to the inbox.
+            uint256 totalFee = l2FactoriesDeployer.getDeploymentTotalCost(
+                IInboxBase(_inbox),
+                _maxFeePerGas
+            );
+            IERC20(_nativeToken).safeTransferFrom(msg.sender, _inbox, totalFee);
+
+            // do it
+            l2FactoriesDeployer.perform(_inbox, _nativeToken, _maxFeePerGas);
+        }
+    }
 }

package/src/test-helpers/TestToken.sol

@@ -0,0 +1,16 @@
+// Copyright 2021-2022, Offchain Labs, Inc.
+// For license information, see https://github.com/nitro/blob/master/LICENSE
+// SPDX-License-Identifier: BUSL-1.1
+
+pragma solidity ^0.8.0;
+
+import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+
+/**
+ * Basic ERC20 token
+ */
+contract TestToken is ERC20 {
+    constructor(uint256 initialSupply) ERC20("TestToken", "TT") {
+        _mint(msg.sender, initialSupply);
+    }
+}

package/build/contracts/@openzeppelin/contracts/token/ERC20/extensions/ERC20Burnable.sol/ERC20Burnable.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../../build-info/028b7f7957bbed4b884988233864d528.json"
-}

package/build/contracts/@openzeppelin/contracts/token/ERC20/extensions/ERC20Burnable.sol/ERC20Burnable.json

@@ -1,312 +0,0 @@
-{
-  "_format": "hh-sol-artifact-1",
-  "contractName": "ERC20Burnable",
-  "sourceName": "@openzeppelin/contracts/token/ERC20/extensions/ERC20Burnable.sol",
-  "abi": [
-    {
-      "anonymous": false,
-      "inputs": [
-        {
-          "indexed": true,
-          "internalType": "address",
-          "name": "owner",
-          "type": "address"
-        },
-        {
-          "indexed": true,
-          "internalType": "address",
-          "name": "spender",
-          "type": "address"
-        },
-        {
-          "indexed": false,
-          "internalType": "uint256",
-          "name": "value",
-          "type": "uint256"
-        }
-      ],
-      "name": "Approval",
-      "type": "event"
-    },
-    {
-      "anonymous": false,
-      "inputs": [
-        {
-          "indexed": true,
-          "internalType": "address",
-          "name": "from",
-          "type": "address"
-        },
-        {
-          "indexed": true,
-          "internalType": "address",
-          "name": "to",
-          "type": "address"
-        },
-        {
-          "indexed": false,
-          "internalType": "uint256",
-          "name": "value",
-          "type": "uint256"
-        }
-      ],
-      "name": "Transfer",
-      "type": "event"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "owner",
-          "type": "address"
-        },
-        {
-          "internalType": "address",
-          "name": "spender",
-          "type": "address"
-        }
-      ],
-      "name": "allowance",
-      "outputs": [
-        {
-          "internalType": "uint256",
-          "name": "",
-          "type": "uint256"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "spender",
-          "type": "address"
-        },
-        {
-          "internalType": "uint256",
-          "name": "amount",
-          "type": "uint256"
-        }
-      ],
-      "name": "approve",
-      "outputs": [
-        {
-          "internalType": "bool",
-          "name": "",
-          "type": "bool"
-        }
-      ],
-      "stateMutability": "nonpayable",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "account",
-          "type": "address"
-        }
-      ],
-      "name": "balanceOf",
-      "outputs": [
-        {
-          "internalType": "uint256",
-          "name": "",
-          "type": "uint256"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "uint256",
-          "name": "amount",
-          "type": "uint256"
-        }
-      ],
-      "name": "burn",
-      "outputs": [],
-      "stateMutability": "nonpayable",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "account",
-          "type": "address"
-        },
-        {
-          "internalType": "uint256",
-          "name": "amount",
-          "type": "uint256"
-        }
-      ],
-      "name": "burnFrom",
-      "outputs": [],
-      "stateMutability": "nonpayable",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "decimals",
-      "outputs": [
-        {
-          "internalType": "uint8",
-          "name": "",
-          "type": "uint8"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "spender",
-          "type": "address"
-        },
-        {
-          "internalType": "uint256",
-          "name": "subtractedValue",
-          "type": "uint256"
-        }
-      ],
-      "name": "decreaseAllowance",
-      "outputs": [
-        {
-          "internalType": "bool",
-          "name": "",
-          "type": "bool"
-        }
-      ],
-      "stateMutability": "nonpayable",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "spender",
-          "type": "address"
-        },
-        {
-          "internalType": "uint256",
-          "name": "addedValue",
-          "type": "uint256"
-        }
-      ],
-      "name": "increaseAllowance",
-      "outputs": [
-        {
-          "internalType": "bool",
-          "name": "",
-          "type": "bool"
-        }
-      ],
-      "stateMutability": "nonpayable",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "name",
-      "outputs": [
-        {
-          "internalType": "string",
-          "name": "",
-          "type": "string"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "symbol",
-      "outputs": [
-        {
-          "internalType": "string",
-          "name": "",
-          "type": "string"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [],
-      "name": "totalSupply",
-      "outputs": [
-        {
-          "internalType": "uint256",
-          "name": "",
-          "type": "uint256"
-        }
-      ],
-      "stateMutability": "view",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "to",
-          "type": "address"
-        },
-        {
-          "internalType": "uint256",
-          "name": "amount",
-          "type": "uint256"
-        }
-      ],
-      "name": "transfer",
-      "outputs": [
-        {
-          "internalType": "bool",
-          "name": "",
-          "type": "bool"
-        }
-      ],
-      "stateMutability": "nonpayable",
-      "type": "function"
-    },
-    {
-      "inputs": [
-        {
-          "internalType": "address",
-          "name": "from",
-          "type": "address"
-        },
-        {
-          "internalType": "address",
-          "name": "to",
-          "type": "address"
-        },
-        {
-          "internalType": "uint256",
-          "name": "amount",
-          "type": "uint256"
-        }
-      ],
-      "name": "transferFrom",
-      "outputs": [
-        {
-          "internalType": "bool",
-          "name": "",
-          "type": "bool"
-        }
-      ],
-      "stateMutability": "nonpayable",
-      "type": "function"
-    }
-  ],
-  "bytecode": "0x",
-  "deployedBytecode": "0x",
-  "linkReferences": {},
-  "deployedLinkReferences": {}
-}

package/build/contracts/@openzeppelin/contracts/token/ERC20/presets/ERC20PresetFixedSupply.sol/ERC20PresetFixedSupply.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../../build-info/028b7f7957bbed4b884988233864d528.json"
-}