Support for rollup mode when using fee token

.github/workflows/contract-tests.yml

@@ -278,3 +278,74 @@ jobs:
 
       - name: Test upgrade
         run: L1_RPC=${{ secrets.L1_RPC || 'https://rpc.ankr.com/eth' }} yarn test:upgrade
+
+  test-e2e-custom-fee-token:
+    name: Test e2e custom fee token
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - uses: OffchainLabs/actions/run-nitro-test-node@main
+        with:
+          l3-node: true
+          args: --l3-fee-token --l3-fee-token-pricer
+          no-token-bridge: true
+          no-l3-token-bridge: true
+          nitro-testnode-ref: fee-token-pricer
+          nitro-contracts-branch: '${{ github.event.pull_request.head.sha || github.sha }}'
+
+      - name: Setup node/yarn
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: 'yarn'
+          cache-dependency-path: '**/yarn.lock'
+
+      - name: Install packages
+        run: yarn
+
+      - name: Compile contracts
+        run: yarn build
+
+      - name: Run e2e orbit tests
+        run: yarn test:e2e:orbit
+
+      - name: Run e2e orbit custom fee token rollup tests
+        run: yarn test:e2e:orbit-fee-token-rollup
+  test-e2e-fee-token-6-decimals:
+    name: Test e2e fee token with 6 decimals
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - uses: OffchainLabs/actions/run-nitro-test-node@main
+        with:
+          l3-node: true
+          args: --l3-fee-token --l3-fee-token-pricer --l3-fee-token-decimals 6
+          no-token-bridge: true
+          no-l3-token-bridge: true
+          nitro-testnode-ref: fee-token-pricer
+          nitro-contracts-branch: '${{ github.event.pull_request.head.sha || github.sha }}'
+
+      - name: Setup node/yarn
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: 'yarn'
+          cache-dependency-path: '**/yarn.lock'
+
+      - name: Install packages
+        run: yarn
+
+      - name: Compile contracts
+        run: yarn build
+
+      - name: Run e2e tests
+        run: yarn test:e2e:orbit
+
+      - name: Run e2e orbit custom fee token rollup tests
+        run: yarn test:e2e:orbit-fee-token-rollup

foundry.toml

@@ -38,4 +38,7 @@ ignore = []
 contract_new_lines = false
 sort_imports = false
 
-# See more config options https://github.com/foundry-rs/foundry/tree/master/config
+[fuzz]
+runs = 1000
+
+# See more config options https://github.com/foundry-rs/foundry/tree/master/config

package.json

@@ -39,6 +39,8 @@
     "test:compatibility": "yarn run build:0.6 && yarn run build:0.7",
     "test:storage": "./test/storage/test.bash",
     "test:signatures": "./test/signatures/test-sigs.bash",
+    "test:e2e:orbit": "hardhat test test/e2e/orbitChain.ts",
+    "test:e2e:orbit-fee-token-rollup": "hardhat test test/e2e/customFeeRollup.ts",
     "test:e2e": "hardhat test test/e2e/*.ts",
     "test:upgrade": "./scripts/testUpgrade.bash",
     "test:foundry": "forge test --gas-limit 10000000000",
@@ -50,6 +52,7 @@
     "deploy-eth-rollup": "hardhat run scripts/createEthRollup.ts",
     "deploy-erc20-rollup": "hardhat run scripts/createERC20Rollup.ts",
     "create-rollup-testnode": "hardhat run scripts/local-deployment/deployCreatorAndCreateRollup.ts",
+    "slither-triage": "slither . --skip-assembly --triage-mode",
     "script:bold-prepare": "hardhat run ./scripts/prepareBoldUpgrade.ts",
     "script:bold-populate-lookup": "hardhat run ./scripts/populateLookup.ts",
     "script:bold-local-execute": "hardhat run ./scripts/executeBoldUpgrade.ts",

scripts/createERC20Rollup.ts

@@ -38,12 +38,24 @@ async function main() {
     throw new Error('STAKE_TOKEN_ADDRESS not set')
   }
 
-  console.log('Creating new rollup with', customFeeTokenAddress, 'as fee token')
+  let feeTokenPricer = process.env.FEE_TOKEN_PRICER_ADDRESS
+  if (!feeTokenPricer) {
+    feeTokenPricer = ethers.constants.AddressZero
+  }
+
+  console.log(
+    'Creating new rollup with',
+    customFeeTokenAddress,
+    'as fee token and',
+    feeTokenPricer,
+    'as fee token pricer'
+  )
   await createRollup(
     deployer,
     false,
     rollupCreatorAddress,
     customFeeTokenAddress,
+    feeTokenPricer,
     stakeTokenAddress
   )
 }

scripts/createEthRollup.ts

@@ -4,6 +4,7 @@ import { createRollup } from './rollupCreation'
 
 async function main() {
   const feeToken = ethers.constants.AddressZero
+  const feeTokenPricer = ethers.constants.AddressZero
   const rollupCreatorAddress = process.env.ROLLUP_CREATOR_ADDRESS
   if (!rollupCreatorAddress) {
     throw new Error('ROLLUP_CREATOR_ADDRESS not set')
@@ -21,6 +22,7 @@ async function main() {
     false,
     rollupCreatorAddress,
     feeToken,
+    feeTokenPricer,
     stakeTokenAddress
   )
 }

scripts/local-deployment/deployCreatorAndCreateRollup.ts

@@ -41,6 +41,10 @@ async function main() {
   if (!feeToken) {
     feeToken = ethers.constants.AddressZero
   }
+  let feeTokenPricer = process.env.FEE_TOKEN_PRICER_ADDRESS as string
+  if (!feeTokenPricer) {
+    feeTokenPricer = ethers.constants.AddressZero
+  }
 
   /// get stake token address, if undefined deploy WETH and set it as stake token
   let stakeToken = process.env.STAKE_TOKEN_ADDRESS as string
@@ -84,6 +88,7 @@ async function main() {
     true,
     contracts.rollupCreator.address,
     feeToken,
+    feeTokenPricer,
     stakeToken
   )
 

scripts/rollupCreation.ts

@@ -3,8 +3,13 @@ import '@nomiclabs/hardhat-ethers'
 import { run } from 'hardhat'
 import { abi as rollupCreatorAbi } from '../build/contracts/src/rollup/RollupCreator.sol/RollupCreator.json'
 import { config, maxDataSize } from './config'
-import { BigNumber, Signer } from 'ethers'
-import { ERC20, ERC20__factory, IERC20__factory } from '../build/types'
+import { BigNumber, Event, Signer } from 'ethers'
+import {
+  ERC20,
+  ERC20__factory,
+  IERC20__factory,
+  RollupCreator,
+} from '../build/types'
 import { sleep } from './testSetup'
 import { promises as fs } from 'fs'
 import { _isRunningOnArbitrum, verifyContract } from './deploymentUtils'
@@ -60,6 +65,7 @@ export async function createRollup(
   isDevDeployment: boolean,
   rollupCreatorAddress: string,
   feeToken: string,
+  feeTokenPricer: string,
   stakeToken: string
 ): Promise<{
   rollupCreationResult: RollupCreationResult
@@ -75,7 +81,7 @@ export async function createRollup(
     rollupCreatorAddress,
     rollupCreatorAbi,
     signer
-  )
+  ) as RollupCreator
   const validatorWalletCreator = await rollupCreator.validatorWalletCreator()
 
   try {
@@ -100,7 +106,12 @@ export async function createRollup(
     // Call the createRollup function
     console.log('Calling createRollup to generate a new rollup ...')
     const deployParams = isDevDeployment
-      ? await _getDevRollupConfig(feeToken, validatorWalletCreator, stakeToken)
+      ? await _getDevRollupConfig(
+          feeToken,
+          feeTokenPricer,
+          validatorWalletCreator,
+          stakeToken
+        )
       : {
           config: config.rollupConfig,
           validators: config.validators,
@@ -110,6 +121,7 @@ export async function createRollup(
           maxFeePerGasForRetryables: MAX_FER_PER_GAS,
           batchPosters: config.batchPosters,
           batchPosterManager: config.batchPosterManager,
+          feeTokenPricer: feeTokenPricer,
         }
 
     const createRollupTx = await rollupCreator.createRollup(deployParams, {
@@ -118,7 +130,7 @@ export async function createRollup(
     const createRollupReceipt = await createRollupTx.wait()
 
     const rollupCreatedEvent = createRollupReceipt.events?.find(
-      (event: RollupCreatedEvent) =>
+      (event: Event): event is Event =>
         event.event === 'RollupCreated' &&
         event.address.toLowerCase() === rollupCreatorAddress.toLowerCase()
     )
@@ -218,6 +230,7 @@ export async function createRollup(
 
 async function _getDevRollupConfig(
   feeToken: string,
+  feeTokenPricer: string,
   validatorWalletCreator: string,
   stakeToken: string
 ) {
@@ -330,6 +343,7 @@ async function _getDevRollupConfig(
     maxFeePerGasForRetryables: MAX_FER_PER_GAS,
     batchPosters: batchPosters,
     batchPosterManager: batchPosterManager,
+    feeTokenPricer: feeTokenPricer,
   }
 
   function _createValidatorAddress(

src/bridge/ISequencerInbox.sol

@@ -132,6 +132,15 @@ interface ISequencerInbox is IDelayedMessageProvider {
     ///         This enables the batch poster to do key rotation
     function batchPosterManager() external view returns (address);
 
+    /// @notice The fee token pricer is used to get the exchange rate between the child chain's fee token
+    ///         and parent chain's fee token. This is needed when the child chain uses a custom fee
+    ///         token which is different from the parent chain's fee token. The exchange rate is
+    ///         used to correctly report converted gas price in the batch spending reports, so
+    ///         the batch poster can get properly reimbursed on the child chain. If the chain uses
+    ///         a custom fee token, but the pricer is not set, then the batch poster reports won't be reported
+    ///         and the batch poster won't get reimbursed.
+    function feeTokenPricer() external view returns (IFeeTokenPricer);
+
     struct DasKeySetInfo {
         bool isValidKeyset;
         uint64 creationBlock;
@@ -321,6 +330,15 @@ interface ISequencerInbox is IDelayedMessageProvider {
         address newBatchPosterManager
     ) external;
 
+    /**
+     * @notice Updates the fee token pricer, the contract which is used to get the exchange rate between child
+     *         chain's fee token and parent chain's fee token in rollups that use a custom fee token.
+     * @param newFeeTokenPricer The new fee token pricer to be set
+     */
+    function setFeeTokenPricer(
+        IFeeTokenPricer newFeeTokenPricer
+    ) external;
+
     /// @notice Allows the rollup owner to sync the rollup address
     function updateRollupAddress() external;
 
@@ -329,6 +347,17 @@ interface ISequencerInbox is IDelayedMessageProvider {
     function initialize(
         IBridge bridge_,
         MaxTimeVariation calldata maxTimeVariation_,
-        BufferConfig calldata bufferConfig_
+        BufferConfig calldata bufferConfig_,
+        IFeeTokenPricer feeTokenPricer_
     ) external;
 }
+
+interface IFeeTokenPricer {
+    /**
+     * @notice Get the number of child chain fee tokens per 1 parent chain fee token. Exchange rate must be
+     *         denominated in 18 decimals. Function is mutable so it allows the pricer to keep internal state.
+     * @dev    For example, parent chain's native token is ETH, fee token is DAI. If price of 1ETH = 2000DAI, then function should return 2000*1e18.
+     *         If fee token is USDC instead and price of 1ETH = 2000USDC, function should still return 2000*1e18, despite USDC using 6 decimals.
+     */
+    function getExchangeRate() external returns (uint256);
+}