@arbitrum/nitro-contracts 1.0.0 → 1.0.2-beta.0

package/README.md

@@ -5,8 +5,8 @@ It includes the rollup and fraud proof smart contracts, as well as interfaces fo
 
 For more information see https://developer.arbitrum.io/docs/public_nitro_devnet
 
-
 Compile the contracts locally by running
+
 ```bash
 git clone https://github.com/offchainlabs/nitro
 cd nitro/contracts

package/package.json

@@ -1,27 +1,25 @@
 {
   "name": "@arbitrum/nitro-contracts",
-  "version": "1.0.0",
+  "version": "1.0.2-beta.0",
   "description": "Layer 2 precompiles and rollup for Arbitrum Nitro",
   "author": "Offchain Labs, Inc.",
   "license": "BUSL-1.1",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/offchainlabs/nitro.git",
-    "directory": "contracts"
+    "url": "git+https://github.com/offchainlabs/nitro-contracts.git"
   },
   "files": [
-    "src/",
-    "scripts/build.bash",
-    "hardhat.prod-config.js"
+    "src/"
   ],
   "bugs": {
-    "url": "https://github.com/offchainlabs/nitro/issues"
+    "url": "https://github.com/offchainlabs/nitro-contracts/issues"
   },
   "scripts": {
-    "build": "./scripts/build.bash",
+    "build": "hardhat compile",
+    "lint:test": "eslint ./test",
     "solhint": "solhint -f table src/**/*.sol",
     "prettier:solidity": "prettier --write src/**/*.sol",
-    "hardhat:prod": "hardhat --config hardhat.prod-config.js",
+    "format": "prettier './**/*.{js,json,md,ts,yml,sol}' --write && yarn run lint:test --fix",
     "build:0.6": "INTERFACE_TESTER_SOLC_VERSION=0.6.9 yarn run build",
     "build:0.7": "INTERFACE_TESTER_SOLC_VERSION=0.7.0 yarn run build",
     "test:compatibility": "yarn run build:0.6 && yarn run build:0.7",
@@ -31,7 +29,7 @@
   "dependencies": {
     "@openzeppelin/contracts": "4.5.0",
     "@openzeppelin/contracts-upgradeable": "4.5.2",
-    "hardhat": "^2.6.6"
+    "patch-package": "^6.4.7"
   },
   "private": false,
   "devDependencies": {
@@ -43,12 +41,19 @@
     "@types/chai": "^4.3.0",
     "@types/mocha": "^9.0.0",
     "@types/node": "^17.0.5",
+    "@typescript-eslint/eslint-plugin": "^5.14.0",
+    "@typescript-eslint/eslint-plugin-tslint": "^5.27.1",
+    "@typescript-eslint/parser": "^5.14.0",
     "chai": "^4.3.4",
+    "eslint": "^8.23.1",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-mocha": "^9.0.0",
+    "eslint-plugin-prettier": "^4.0.0",
     "ethereum-waffle": "^3.4.0",
     "ethers": "^5.5.2",
+    "hardhat": "^2.6.6",
     "hardhat-deploy": "^0.11.4",
     "hardhat-gas-reporter": "^1.0.8",
-    "patch-package": "^6.4.7",
     "postinstall-postinstall": "^2.1.0",
     "prettier": "^2.5.1",
     "prettier-plugin-solidity": "^1.0.0-beta.19",
@@ -56,10 +61,11 @@
     "solhint-plugin-prettier": "^0.0.5",
     "solidity-coverage": "^0.7.20",
     "ts-node": "^10.4.0",
+    "tslint": "^6.1.3",
     "typechain": "^8.0.0",
     "typescript": "^4.5.4"
   },
-  "optionalDependencies":{
+  "optionalDependencies": {
     "sol2uml": "2.2.0"
   }
 }

package/src/bridge/Inbox.sol

@@ -35,7 +35,7 @@ import {
     L2MessageType_unsignedEOATx,
     L2MessageType_unsignedContractTx
 } from "../libraries/MessageTypes.sol";
-import {MAX_DATA_SIZE} from "../libraries/Constants.sol";
+import {MAX_DATA_SIZE, UNISWAP_L1_TIMELOCK, UNISWAP_L2_FACTORY} from "../libraries/Constants.sol";
 import "../precompiles/ArbSys.sol";
 
 import "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol";
@@ -527,6 +527,84 @@ contract Inbox is DelegateCallAware, PausableUpgradeable, IInbox {
             );
     }
 
+    /// @notice This is an one-time-exception to resolve a misconfiguration of Uniswap Arbitrum deployment
+    ///         Only the Uniswap L1 Timelock may call this function and it is allowed to create a crosschain
+    ///         retryable ticket without address aliasing. More info here:
+    ///         https://gov.uniswap.org/t/consensus-check-fix-the-cross-chain-messaging-bridge-on-arbitrum/18547
+    /// @dev    This function will be removed in future releases
+    function uniswapCreateRetryableTicket(
+        address to,
+        uint256 l2CallValue,
+        uint256 maxSubmissionCost,
+        address excessFeeRefundAddress,
+        address callValueRefundAddress,
+        uint256 gasLimit,
+        uint256 maxFeePerGas,
+        bytes calldata data
+    ) external payable whenNotPaused onlyAllowed returns (uint256) {
+        // this can only be called by UNISWAP_L1_TIMELOCK
+        require(msg.sender == UNISWAP_L1_TIMELOCK, "NOT_UNISWAP_L1_TIMELOCK");
+        // the retryable can only call UNISWAP_L2_FACTORY
+        require(to == UNISWAP_L2_FACTORY, "NOT_TO_UNISWAP_L2_FACTORY");
+
+        // ensure the user's deposit alone will make submission succeed
+        if (msg.value < (maxSubmissionCost + l2CallValue + gasLimit * maxFeePerGas)) {
+            revert InsufficientValue(
+                maxSubmissionCost + l2CallValue + gasLimit * maxFeePerGas,
+                msg.value
+            );
+        }
+
+        // if a refund address is a contract, we apply the alias to it
+        // so that it can access its funds on the L2
+        // since the beneficiary and other refund addresses don't get rewritten by arb-os
+        if (AddressUpgradeable.isContract(excessFeeRefundAddress)) {
+            excessFeeRefundAddress = AddressAliasHelper.applyL1ToL2Alias(excessFeeRefundAddress);
+        }
+        if (AddressUpgradeable.isContract(callValueRefundAddress)) {
+            // this is the beneficiary. be careful since this is the address that can cancel the retryable in the L2
+            callValueRefundAddress = AddressAliasHelper.applyL1ToL2Alias(callValueRefundAddress);
+        }
+
+        // gas price and limit of 1 should never be a valid input, so instead they are used as
+        // magic values to trigger a revert in eth calls that surface data without requiring a tx trace
+        if (gasLimit == 1 || maxFeePerGas == 1)
+            revert RetryableData(
+                msg.sender,
+                to,
+                l2CallValue,
+                msg.value,
+                maxSubmissionCost,
+                excessFeeRefundAddress,
+                callValueRefundAddress,
+                gasLimit,
+                maxFeePerGas,
+                data
+            );
+
+        uint256 submissionFee = calculateRetryableSubmissionFee(data.length, block.basefee);
+        if (maxSubmissionCost < submissionFee)
+            revert InsufficientSubmissionCost(submissionFee, maxSubmissionCost);
+
+        return
+            _deliverMessage(
+                L1MessageType_submitRetryableTx,
+                AddressAliasHelper.undoL1ToL2Alias(msg.sender),
+                abi.encodePacked(
+                    uint256(uint160(to)),
+                    l2CallValue,
+                    msg.value,
+                    maxSubmissionCost,
+                    uint256(uint160(excessFeeRefundAddress)),
+                    uint256(uint160(callValueRefundAddress)),
+                    gasLimit,
+                    maxFeePerGas,
+                    data.length,
+                    data
+                )
+            );
+    }
+
     function _deliverMessage(
         uint8 _kind,
         address _sender,

package/src/challenge/ChallengeManager.sol

@@ -285,7 +285,7 @@ contract ChallengeManager is DelegateCallAware, IChallengeManager {
         return challenges[challengeIndex].current.addr;
     }
 
-    function isTimedOut(uint64 challengeIndex) public view override returns (bool) {
+    function isTimedOut(uint64 challengeIndex) public view virtual override returns (bool) {
         return challenges[challengeIndex].isTimedOut();
     }
 

package/src/libraries/Constants.sol

@@ -11,3 +11,6 @@ uint64 constant NO_CHAL_INDEX = 0;
 
 // Expected seconds per block in Ethereum PoS
 uint256 constant ETH_POS_BLOCK_TIME = 12;
+
+address constant UNISWAP_L1_TIMELOCK = 0x1a9C8182C09F50C8318d769245beA52c32BE35BC;
+address constant UNISWAP_L2_FACTORY = 0x1F98431c8aD98523631AE4a59f267346ea31F984;

package/src/mocks/InboxStub.sol

@@ -151,7 +151,7 @@ contract InboxStub is IInbox {
         address,
         uint256,
         bytes calldata
-    ) external returns (uint256) {
+    ) external pure returns (uint256) {
         revert("NOT_IMPLEMENTED");
     }
 
@@ -161,7 +161,7 @@ contract InboxStub is IInbox {
         uint256,
         uint256,
         address
-    ) external returns (uint256) {
+    ) external pure returns (uint256) {
         revert("NOT_IMPLEMENTED");
     }
 

package/src/mocks/ProxyAdminForBinding.sol

@@ -0,0 +1,9 @@
+// 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 "@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol";
+
+contract ProxyAdminForBinding is ProxyAdmin {}

package/src/mocks/Simple.sol

@@ -13,11 +13,17 @@ contract Simple {
     event CounterEvent(uint64 count);
     event RedeemedEvent(address caller, address redeemer);
     event NullEvent();
+    event LogAndIncrementCalled(uint256 expected, uint256 have);
 
     function increment() external {
         counter++;
     }
 
+    function logAndIncrement(uint256 expected) external {
+        emit LogAndIncrementCalled(expected, counter);
+        counter++;
+    }
+
     function incrementEmit() external {
         counter++;
         emit CounterEvent(counter);
@@ -104,4 +110,12 @@ contract Simple {
         (success, ) = address(this).call(data);
         require(success, "CALL_FAILED");
     }
+
+    function checkGasUsed(address to, bytes calldata input) external view returns (uint256) {
+        uint256 before = gasleft();
+        // The inner call may revert, but we still want to return the amount of gas used,
+        // so we ignore the result of this call.
+        (to.staticcall{gas: before - 10000}(input));
+        return before - gasleft();
+    }
 }

package/src/mocks/TimedOutChallengeManager.sol

@@ -0,0 +1,13 @@
+// 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 "../challenge/ChallengeManager.sol";
+
+contract TimedOutChallengeManager is ChallengeManager {
+    function isTimedOut(uint64) public pure override returns (bool) {
+        return true;
+    }
+}

package/src/precompiles/ArbDebug.sol

@@ -1,5 +1,5 @@
-// Copyright 2021-2022, Offchain Labs, Inc.
-// For license information, see https://github.com/nitro/blob/master/LICENSE
+// Copyright 2021-2023, Offchain Labs, Inc.
+// For license information, see https://github.com/OffchainLabs/nitro/blob/master/LICENSE
 // SPDX-License-Identifier: BUSL-1.1
 
 pragma solidity >=0.4.21 <0.9.0;
@@ -15,6 +15,9 @@ interface ArbDebug {
     /// @notice Emit events with values based on the args provided
     function events(bool flag, bytes32 value) external payable returns (address, uint256);
 
+    /// @notice Tries (and fails) to emit logs in a view context
+    function eventsView() external view;
+
     // Events that exist for testing log creation and pricing
     event Basic(bool flag, bytes32 indexed value);
     event Mixed(
@@ -34,6 +37,8 @@ interface ArbDebug {
 
     function customRevert(uint64 number) external pure;
 
+    function legacyError() external pure;
+
     error Custom(uint64, string, bool);
     error Unused();
 }

package/src/precompiles/ArbSys.sol

@@ -147,4 +147,6 @@ interface ArbSys {
         bytes32 indexed hash,
         uint256 indexed position
     );
+
+    error InvalidBlockNumber(uint256 requested, uint256 current);
 }

package/hardhat.prod-config.js

@@ -1,18 +0,0 @@
-/**
- * @type import('hardhat/config').HardhatUserConfig
- */
-module.exports = {
-  solidity: {
-    version: "0.8.9",
-    settings: {
-      optimizer: {
-        enabled: true,
-        runs: 100,
-      },
-    },
-  },
-  paths: {
-    sources: "./src",
-    artifacts: "build/contracts",
-  },
-};

package/scripts/build.bash

@@ -1,5 +0,0 @@
-#!/bin/bash
-if [[ $PWD == */contracts ]];
-    then $npm_execpath run hardhat compile;
-    else $npm_execpath run hardhat:prod compile;
-fi