@arbitrum/nitro-contracts 1.2.1 → 2.0.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arbitrum/nitro-contracts",
-  "version": "1.2.1",
+  "version": "2.0.0-beta.1",
   "description": "Layer 2 precompiles and rollup for Arbitrum Nitro",
   "author": "Offchain Labs, Inc.",
   "license": "BUSL-1.1",
@@ -18,12 +18,15 @@
     "url": "https://github.com/offchainlabs/nitro-contracts/issues"
   },
   "scripts": {
+    "audit:ci": "audit-ci --config ./audit-ci.jsonc",
+    "audit:fix": "yarn-audit-fix",
     "prepublishOnly": "hardhat clean && forge clean && hardhat compile && yarn build:forge:yul",
     "build:all": "yarn build && yarn build:forge",
     "build": "hardhat compile",
     "build:forge:sol": "forge build --skip *.yul",
     "build:forge:yul": "FOUNDRY_PROFILE=yul forge build --skip *.sol",
     "build:forge": "yarn build:forge:sol && yarn build:forge:yul",
+    "contract:size": "STRICT=true hardhat size-contracts",
     "lint:test": "eslint ./test",
     "solhint": "solhint -f table src/**/*.sol",
     "prettier:solidity": "prettier --write src/**/*.sol",
@@ -39,17 +42,20 @@
     "postinstall": "patch-package",
     "deploy-factory": "hardhat run scripts/deployment.ts",
     "deploy-eth-rollup": "hardhat run scripts/createEthRollup.ts",
-    "deploy-erc20-rollup": "hardhat run scripts/createERC20Rollup.ts"
+    "deploy-erc20-rollup": "hardhat run scripts/createERC20Rollup.ts",
+    "create-rollup-testnode": "hardhat run scripts/local-deployment/deployCreatorAndCreateRollup.ts",
+    "deploy-cachemanager-testnode": "hardhat run scripts/local-deployment/deployCacheManager.ts"
   },
   "dependencies": {
     "@offchainlabs/upgrade-executor": "1.1.0-beta.0",
     "@openzeppelin/contracts": "4.5.0",
     "@openzeppelin/contracts-upgradeable": "4.5.2",
-    "patch-package": "^6.4.7"
+    "patch-package": "^6.4.7",
+    "solady": "0.0.182"
   },
   "private": false,
   "devDependencies": {
-    "@arbitrum/sdk": "^3.1.3",
+    "@arbitrum/sdk": "^3.4.1",
     "@ethersproject/providers": "^5.7.2",
     "@nomiclabs/hardhat-ethers": "npm:hardhat-deploy-ethers@^0.3.0-beta.13",
     "@nomiclabs/hardhat-etherscan": "^3.1.0",
@@ -63,15 +69,17 @@
     "@typescript-eslint/eslint-plugin": "^5.14.0",
     "@typescript-eslint/eslint-plugin-tslint": "^5.27.1",
     "@typescript-eslint/parser": "^5.14.0",
+    "audit-ci": "^6.6.1",
     "chai": "^4.3.4",
     "dotenv": "^16.3.1",
     "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",
+    "ethereum-waffle": "^4.0.10",
+    "ethers": "^5.5.4",
     "hardhat": "^2.17.2",
+    "hardhat-contract-sizer": "^2.10.0",
     "hardhat-deploy": "^0.11.37",
     "hardhat-gas-reporter": "^1.0.9",
     "hardhat-ignore-warnings": "^0.2.9",
@@ -83,7 +91,8 @@
     "solidity-coverage": "^0.8.4",
     "ts-node": "^10.4.0",
     "tslint": "^6.1.3",
-    "typechain": "^8.0.0",
-    "typescript": "^4.5.4"
+    "typechain": "^8.3.2",
+    "typescript": "^4.5.4",
+    "yarn-audit-fix": "^10.0.7"
   }
 }

package/src/bridge/AbsInbox.sol

@@ -231,11 +231,14 @@ abstract contract AbsInbox is DelegateCallAware, PausableUpgradeable, IInboxBase
         uint256 amount,
         bytes calldata data
     ) internal returns (uint256) {
-        // ensure the user's deposit alone will make submission succeed
-        if (amount < (maxSubmissionCost + l2CallValue + gasLimit * maxFeePerGas)) {
+        // Ensure the user's deposit alone will make submission succeed.
+        // In case of native token having non-18 decimals: 'amount' is denominated in native token's decimals. All other
+        // value params - l2CallValue, maxSubmissionCost and maxFeePerGas are denominated in child chain's native 18 decimals.
+        uint256 amountToBeMintedOnL2 = _fromNativeTo18Decimals(amount);
+        if (amountToBeMintedOnL2 < (maxSubmissionCost + l2CallValue + gasLimit * maxFeePerGas)) {
             revert InsufficientValue(
                 maxSubmissionCost + l2CallValue + gasLimit * maxFeePerGas,
-                amount
+                amountToBeMintedOnL2
             );
         }
 
@@ -308,7 +311,7 @@ abstract contract AbsInbox is DelegateCallAware, PausableUpgradeable, IInboxBase
                 abi.encodePacked(
                     uint256(uint160(to)),
                     l2CallValue,
-                    amount,
+                    _fromNativeTo18Decimals(amount),
                     maxSubmissionCost,
                     uint256(uint160(excessFeeRefundAddress)),
                     uint256(uint160(callValueRefundAddress)),
@@ -347,6 +350,15 @@ abstract contract AbsInbox is DelegateCallAware, PausableUpgradeable, IInboxBase
         virtual
         returns (uint256);
 
+    /// @notice get amount of ETH/token to mint on child chain based on provided value.
+    ///         In case of ETH-based rollup this amount will always equal the provided
+    ///         value. In case of ERC20-based rollup where native token has number of
+    ///         decimals different thatn 18, amount will be re-adjusted to reflect 18
+    ///         decimals used for native currency on child chain.
+    /// @dev    provided value has to be less than 'type(uint256).max/10**(18-decimalsIn)'
+    ///         or otherwise it will overflow.
+    function _fromNativeTo18Decimals(uint256 value) internal view virtual returns (uint256);
+
     /**
      * @dev This empty reserved space is put in place to allow future versions to add new
      * variables without shifting down storage in the inheritance chain.

package/src/bridge/AbsOutbox.sol

@@ -205,6 +205,10 @@ abstract contract AbsOutbox is DelegateCallAware, IOutbox {
     ) internal {
         emit OutBoxTransactionExecuted(to, l2Sender, 0, outputId);
 
+        // get amount to unlock based on provided value. It might differ in case
+        // of native token which uses number of decimals different than 18
+        uint256 amountToUnlock = _getAmountToUnlock(value);
+
         // we temporarily store the previous values so the outbox can naturally
         // unwind itself when there are nested calls to `executeTransaction`
         L2ToL1Context memory prevContext = context;
@@ -215,11 +219,11 @@ abstract contract AbsOutbox is DelegateCallAware, IOutbox {
             l1Block: uint96(l1Block),
             timestamp: uint128(l2Timestamp),
             outputId: bytes32(outputId),
-            withdrawalAmount: _amountToSetInContext(value)
+            withdrawalAmount: _amountToSetInContext(amountToUnlock)
         });
 
         // set and reset vars around execution so they remain valid during call
-        executeBridgeCall(to, value, data);
+        executeBridgeCall(to, amountToUnlock, data);
 
         context = prevContext;
     }
@@ -311,6 +315,11 @@ abstract contract AbsOutbox is DelegateCallAware, IOutbox {
     /// @return default 'amount' in case of ERC20-based rollup is type(uint256).max, or 0 in case of ETH-based rollup
     function _defaultContextAmount() internal pure virtual returns (uint256);
 
+    /// @notice based on provided value, get amount of ETH/token to unlock. In case of ETH-based rollup this amount
+    ///         will always equal the provided value. In case of ERC20-based rollup, amount will be re-adjusted to
+    ///         reflect the number of decimals used by native token, in case it is different than 18.
+    function _getAmountToUnlock(uint256 value) internal view virtual returns (uint256);
+
     /// @notice value to be set for 'amount' field in L2ToL1Context during L2 to L1 transaction execution.
     ///         In case of ERC20-based rollup this is the amount of native token being withdrawn. In case of standard ETH-based
     ///         rollup this amount shall always be 0, because amount of ETH being withdrawn can be read from msg.value.

package/src/bridge/ERC20Bridge.sol

@@ -7,9 +7,18 @@ pragma solidity ^0.8.4;
 import "./AbsBridge.sol";
 import "./IERC20Bridge.sol";
 import "../libraries/AddressAliasHelper.sol";
-import {InvalidTokenSet, CallTargetNotAllowed, CallNotAllowed} from "../libraries/Error.sol";
-import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
-import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+import {
+    InvalidTokenSet,
+    CallTargetNotAllowed,
+    CallNotAllowed,
+    NativeTokenDecimalsTooLarge
+} from "../libraries/Error.sol";
+import {DecimalsConverterHelper} from "../libraries/DecimalsConverterHelper.sol";
+import {MAX_ALLOWED_NATIVE_TOKEN_DECIMALS} from "../libraries/Constants.sol";
+
+import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 
 /**
  * @title Staging ground for incoming and outgoing messages
@@ -20,6 +29,8 @@ import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
  *       - The token must only be transferrable via a call to the token address itself
  *       - The token must only be able to set allowance via a call to the token address itself
  *       - The token must not have a callback on transfer, and more generally a user must not be able to make a transfer to themselves revert
+ *       - The token must have a max of 2^256 - 1 wei total supply unscaled
+ *       - The token must have a max of 2^256 - 1 wei total supply when scaled to 18 decimals
  */
 contract ERC20Bridge is AbsBridge, IERC20Bridge {
     using SafeERC20 for IERC20;
@@ -27,12 +38,28 @@ contract ERC20Bridge is AbsBridge, IERC20Bridge {
     /// @inheritdoc IERC20Bridge
     address public nativeToken;
 
+    /// @inheritdoc IERC20Bridge
+    uint8 public nativeTokenDecimals;
+
     /// @inheritdoc IERC20Bridge
     function initialize(IOwnable rollup_, address nativeToken_) external initializer onlyDelegated {
         if (nativeToken_ == address(0)) revert InvalidTokenSet(nativeToken_);
         nativeToken = nativeToken_;
         _activeOutbox = EMPTY_ACTIVEOUTBOX;
         rollup = rollup_;
+
+        // store number of decimals used by native token
+        try ERC20(nativeToken_).decimals() returns (uint8 decimals) {
+            if (decimals > MAX_ALLOWED_NATIVE_TOKEN_DECIMALS) {
+                revert NativeTokenDecimalsTooLarge(decimals);
+            }
+            nativeTokenDecimals = decimals;
+        } catch {
+            // decimal is not part of the ERC20 spec
+            // assume it have 0 decimals if it does not have decimals() method
+            // we do this to align with the token bridge behavior
+            nativeTokenDecimals = 0;
+        }
     }
 
     /// @inheritdoc IERC20Bridge

package/src/bridge/ERC20Inbox.sol

@@ -9,9 +9,14 @@ import "./IERC20Inbox.sol";
 import "./IERC20Bridge.sol";
 import "../libraries/AddressAliasHelper.sol";
 import {L1MessageType_ethDeposit} from "../libraries/MessageTypes.sol";
-import "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol";
+import {AmountTooLarge} from "../libraries/Error.sol";
+import {MAX_UPSCALE_AMOUNT} from "../libraries/Constants.sol";
+
+import {DecimalsConverterHelper} from "../libraries/DecimalsConverterHelper.sol";
+
+import {AddressUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/AddressUpgradeable.sol";
 import {IERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
-import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
+import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
 /**
  * @title Inbox for user and contract originated messages
@@ -33,7 +38,7 @@ contract ERC20Inbox is AbsInbox, IERC20Inbox {
 
         // inbox holds native token in transit used to pay for retryable tickets, approve bridge to use it
         address nativeToken = IERC20Bridge(address(bridge)).nativeToken();
-        IERC20(nativeToken).approve(address(bridge), type(uint256).max);
+        IERC20(nativeToken).safeApprove(address(bridge), type(uint256).max);
     }
 
     /// @inheritdoc IERC20Inbox
@@ -46,11 +51,12 @@ contract ERC20Inbox is AbsInbox, IERC20Inbox {
             dest = AddressAliasHelper.applyL1ToL2Alias(msg.sender);
         }
 
+        uint256 amountToMintOnL2 = _fromNativeTo18Decimals(amount);
         return
             _deliverMessage(
                 L1MessageType_ethDeposit,
                 msg.sender,
-                abi.encodePacked(dest, amount),
+                abi.encodePacked(dest, amountToMintOnL2),
                 amount
             );
     }
@@ -141,4 +147,22 @@ contract ERC20Inbox is AbsInbox, IERC20Inbox {
                 tokenAmount
             );
     }
+
+    /// @inheritdoc AbsInbox
+    function _fromNativeTo18Decimals(uint256 value) internal view override returns (uint256) {
+        // In order to keep compatibility of child chain's native currency with external 3rd party tooling we
+        // expect 18 decimals to be always used for native currency. If native token uses different number of
+        // decimals then here it will be normalized to 18. Keep in mind, when withdrawing from child chain back
+        // to parent chain then the amount has to match native token's granularity, otherwise it will be rounded
+        // down.
+        uint8 nativeTokenDecimals = IERC20Bridge(address(bridge)).nativeTokenDecimals();
+
+        // Also make sure that inflated amount does not overflow uint256
+        if (nativeTokenDecimals < 18) {
+            if (value > MAX_UPSCALE_AMOUNT) {
+                revert AmountTooLarge(value);
+            }
+        }
+        return DecimalsConverterHelper.adjustDecimals(value, nativeTokenDecimals, 18);
+    }
 }

package/src/bridge/ERC20Outbox.sol

@@ -5,9 +5,11 @@
 pragma solidity ^0.8.4;
 
 import "./AbsOutbox.sol";
+import {IERC20Bridge} from "./IERC20Bridge.sol";
+import {DecimalsConverterHelper} from "../libraries/DecimalsConverterHelper.sol";
 
 contract ERC20Outbox is AbsOutbox {
-    // it is assumed that arb-os never assigns this value to a valid leaf to be redeemed
+    /// @dev it is assumed that arb-os never assigns this value to a valid leaf to be redeemed
     uint256 private constant AMOUNT_DEFAULT_CONTEXT = type(uint256).max;
 
     function l2ToL1WithdrawalAmount() external view returns (uint256) {
@@ -22,6 +24,13 @@ contract ERC20Outbox is AbsOutbox {
         return AMOUNT_DEFAULT_CONTEXT;
     }
 
+    /// @inheritdoc AbsOutbox
+    function _getAmountToUnlock(uint256 value) internal view override returns (uint256) {
+        uint8 nativeTokenDecimals = IERC20Bridge(address(bridge)).nativeTokenDecimals();
+        // this might revert due to overflow, but we assume the token supply is less than 2^256
+        return DecimalsConverterHelper.adjustDecimals(value, 18, nativeTokenDecimals);
+    }
+
     /// @inheritdoc AbsOutbox
     function _amountToSetInContext(uint256 value) internal pure override returns (uint256) {
         // native token withdrawal amount which can be fetched from context

package/src/bridge/IERC20Bridge.sol

@@ -19,6 +19,13 @@ interface IERC20Bridge is IBridge {
      */
     function nativeToken() external view returns (address);
 
+    /**
+     * @dev number of decimals used by the native token
+     *      This is set on bridge initialization using nativeToken.decimals()
+     *      If the token does not have decimals() method, we assume it have 0 decimals
+     */
+    function nativeTokenDecimals() external view returns (uint8);
+
     /**
      * @dev Enqueue a message in the delayed inbox accumulator.
      *      These messages are later sequenced in the SequencerInbox, either

package/src/bridge/IERC20Inbox.sol

@@ -20,11 +20,12 @@ interface IERC20Inbox is IInboxBase {
      * @notice Put a message in the L2 inbox that can be reexecuted for some fixed amount of time if it reverts
      * @dev all tokenTotalFeeAmount will be deposited to callValueRefundAddress on L2
      * @dev Gas limit and maxFeePerGas should not be set to 1 as that is used to trigger the RetryableData error
+     * @dev In case of native token having non-18 decimals: tokenTotalFeeAmount is denominated in native token's decimals. All other value params - l2CallValue, maxSubmissionCost and maxFeePerGas are denominated in child chain's native 18 decimals.
      * @param to destination L2 contract address
      * @param l2CallValue call value for retryable L2 message
      * @param maxSubmissionCost Max gas deducted from user's L2 balance to cover base submission fee
-     * @param excessFeeRefundAddress gasLimit x maxFeePerGas - execution cost gets credited here on L2 balance
-     * @param callValueRefundAddress l2Callvalue gets credited here on L2 if retryable txn times out or gets cancelled
+     * @param excessFeeRefundAddress the address which receives the difference between execution fee paid and the actual execution cost. In case this address is a contract, funds will be received in its alias on L2.
+     * @param callValueRefundAddress l2Callvalue gets credited here on L2 if retryable txn times out or gets cancelled. In case this address is a contract, funds will be received in its alias on L2.
      * @param gasLimit Max gas deducted from user's L2 balance to cover L2 execution. Should not be set to 1 (magic value used to trigger the RetryableData error)
      * @param maxFeePerGas price bid for L2 execution. Should not be set to 1 (magic value used to trigger the RetryableData error)
      * @param tokenTotalFeeAmount amount of fees to be deposited in native token to cover for retryable ticket cost
@@ -53,7 +54,7 @@ interface IERC20Inbox is IInboxBase {
      * @param to destination L2 contract address
      * @param l2CallValue call value for retryable L2 message
      * @param maxSubmissionCost Max gas deducted from user's L2 balance to cover base submission fee
-     * @param excessFeeRefundAddress gasLimit x maxFeePerGas - execution cost gets credited here on L2 balance
+     * @param excessFeeRefundAddress the address which receives the difference between execution fee paid and the actual execution cost
      * @param callValueRefundAddress l2Callvalue gets credited here on L2 if retryable txn times out or gets cancelled
      * @param gasLimit Max gas deducted from user's L2 balance to cover L2 execution. Should not be set to 1 (magic value used to trigger the RetryableData error)
      * @param maxFeePerGas price bid for L2 execution. Should not be set to 1 (magic value used to trigger the RetryableData error)

package/src/bridge/IInbox.sol

@@ -77,8 +77,8 @@ interface IInbox is IInboxBase {
      * @param to destination L2 contract address
      * @param l2CallValue call value for retryable L2 message
      * @param maxSubmissionCost Max gas deducted from user's L2 balance to cover base submission fee
-     * @param excessFeeRefundAddress gasLimit x maxFeePerGas - execution cost gets credited here on L2 balance
-     * @param callValueRefundAddress l2Callvalue gets credited here on L2 if retryable txn times out or gets cancelled
+     * @param excessFeeRefundAddress the address which receives the difference between execution fee paid and the actual execution cost. In case this address is a contract, funds will be received in its alias on L2.
+     * @param callValueRefundAddress l2Callvalue gets credited here on L2 if retryable txn times out or gets cancelled. In case this address is a contract, funds will be received in its alias on L2.
      * @param gasLimit Max gas deducted from user's L2 balance to cover L2 execution. Should not be set to 1 (magic value used to trigger the RetryableData error)
      * @param maxFeePerGas price bid for L2 execution. Should not be set to 1 (magic value used to trigger the RetryableData error)
      * @param data ABI encoded data of L2 message
@@ -105,7 +105,7 @@ interface IInbox is IInboxBase {
      * @param to destination L2 contract address
      * @param l2CallValue call value for retryable L2 message
      * @param maxSubmissionCost Max gas deducted from user's L2 balance to cover base submission fee
-     * @param excessFeeRefundAddress gasLimit x maxFeePerGas - execution cost gets credited here on L2 balance
+     * @param excessFeeRefundAddress the address which receives the difference between execution fee paid and the actual execution cost
      * @param callValueRefundAddress l2Callvalue gets credited here on L2 if retryable txn times out or gets cancelled
      * @param gasLimit Max gas deducted from user's L2 balance to cover L2 execution. Should not be set to 1 (magic value used to trigger the RetryableData error)
      * @param maxFeePerGas price bid for L2 execution. Should not be set to 1 (magic value used to trigger the RetryableData error)

package/src/bridge/Inbox.sol

@@ -238,7 +238,7 @@ contract Inbox is AbsInbox, IInbox {
      * @param to destination L2 contract address
      * @param l2CallValue call value for retryable L2 message
      * @param maxSubmissionCost Max gas deducted from user's L2 balance to cover base submission fee
-     * @param excessFeeRefundAddress gasLimit x maxFeePerGas - execution cost gets credited here on L2 balance
+     * @param excessFeeRefundAddress the address which receives the difference between execution fee paid and the actual execution cost
      * @param callValueRefundAddress l2Callvalue gets credited here on L2 if retryable txn times out or gets cancelled
      * @param gasLimit Max gas deducted from user's L2 balance to cover L2 execution. Should not be set to 1 (magic value used to trigger the RetryableData error)
      * @param maxFeePerGas price bid for L2 execution. Should not be set to 1 (magic value used to trigger the RetryableData error)
@@ -343,4 +343,9 @@ contract Inbox is AbsInbox, IInbox {
                 messageDataHash
             );
     }
+
+    /// @inheritdoc AbsInbox
+    function _fromNativeTo18Decimals(uint256 value) internal pure override returns (uint256) {
+        return value;
+    }
 }

package/src/bridge/Outbox.sol

@@ -14,6 +14,11 @@ contract Outbox is AbsOutbox {
         return 0;
     }
 
+    /// @inheritdoc AbsOutbox
+    function _getAmountToUnlock(uint256 value) internal pure override returns (uint256) {
+        return value;
+    }
+
     /// @inheritdoc AbsOutbox
     function _amountToSetInContext(uint256) internal pure override returns (uint256) {
         // In ETH-based chains withdrawal amount can be read from msg.value. For that reason