Merge pull request #252 from OffchainLabs/custom-fee-rollup

Support for rollup mode when using fee token

Author: gzeoneth

.github/workflows/contract-tests.yml

@@ -154,101 +154,104 @@ jobs:
 
       - name: Test 4844
         run: yarn test:4844
-  # test-e2e:
-  #   name: Test e2e
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - uses: actions/checkout@v3
-  #       with:
-  #         submodules: recursive
 
-  #     - uses: OffchainLabs/actions/run-nitro-test-node@main
-  #       with:
-  #         l3-node: true
-  #         no-token-bridge: true
-  #         no-l3-token-bridge: true
-  #         nitro-contracts-branch: '${{ github.event.pull_request.head.sha || github.sha }}'
-  #         nitro-testnode-ref: node-18
+  test-e2e:
+    name: Test e2e
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
 
-  #     - name: Setup node/yarn
-  #       uses: actions/setup-node@v3
-  #       with:
-  #         node-version: 18
-  #         cache: 'yarn'
-  #         cache-dependency-path: '**/yarn.lock'
+      - uses: OffchainLabs/actions/run-nitro-test-node@main
+        with:
+          l3-node: true
+          no-token-bridge: true
+          no-l3-token-bridge: true
+          nitro-contracts-branch: '${{ github.event.pull_request.head.sha || github.sha }}'
+          nitro-testnode-ref: v3-support
 
-  #     - name: Install packages
-  #       run: yarn
+      - name: Setup node/yarn
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: 'yarn'
+          cache-dependency-path: '**/yarn.lock'
 
-  #     - name: Compile contracts
-  #       run: yarn build
+      - name: Install packages
+        run: yarn
 
-  #     - name: Run e2e tests
-  #       run: yarn test:e2e
-  # test-e2e-custom-fee-token:
-  #   name: Test e2e custom fee token
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - uses: actions/checkout@v3
-  #       with:
-  #         submodules: recursive
+      - name: Compile contracts
+        run: yarn build
 
-  #     - uses: OffchainLabs/actions/run-nitro-test-node@main
-  #       with:
-  #         l3-node: true
-  #         args: --l3-fee-token
-  #         no-token-bridge: true
-  #         no-l3-token-bridge: true
-  #         nitro-contracts-branch: '${{ github.event.pull_request.head.sha || github.sha }}'
-  #         nitro-testnode-ref: node-18
+      - name: Run e2e tests
+        run: yarn test:e2e
 
-  #     - name: Setup node/yarn
-  #       uses: actions/setup-node@v3
-  #       with:
-  #         node-version: 18
-  #         cache: 'yarn'
-  #         cache-dependency-path: '**/yarn.lock'
+  test-e2e-custom-fee-token:
+    name: Test e2e custom fee token
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
 
-  #     - name: Install packages
-  #       run: yarn
+      - uses: OffchainLabs/actions/run-nitro-test-node@main
+        with:
+          l3-node: true
+          args: --l3-fee-token
+          no-token-bridge: true
+          no-l3-token-bridge: true
+          nitro-contracts-branch: '${{ github.event.pull_request.head.sha || github.sha }}'
+          nitro-testnode-ref: v3-support
 
-  #     - name: Compile contracts
-  #       run: yarn build
+      - name: Setup node/yarn
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: 'yarn'
+          cache-dependency-path: '**/yarn.lock'
 
-  #     - name: Run e2e tests
-  #       run: yarn test:e2e
-  # 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
+      - name: Install packages
+        run: yarn
 
-  #     - uses: OffchainLabs/actions/run-nitro-test-node@main
-  #       with:
-  #         l3-node: true
-  #         args: --l3-fee-token --l3-fee-token-decimals 6
-  #         no-token-bridge: true
-  #         no-l3-token-bridge: true
-  #         nitro-contracts-branch: '${{ github.event.pull_request.head.sha || github.sha }}'
-  #         nitro-testnode-ref: 'non18-decimal-token-node-18'
+      - name: Compile contracts
+        run: yarn build
 
-  #     - name: Setup node/yarn
-  #       uses: actions/setup-node@v3
-  #       with:
-  #         node-version: 18
-  #         cache: 'yarn'
-  #         cache-dependency-path: '**/yarn.lock'
+      - name: Run e2e tests
+        run: yarn test:e2e
 
-  #     - name: Install packages
-  #       run: yarn
+  test-e2e-fee-token-6-decimals:
+    name: Test e2e fee token with 6 decimals and pricer
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
 
-  #     - name: Compile contracts
-  #       run: yarn build
+      - 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: v3-support
+          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
+      - name: Run e2e tests
+        run: yarn test:e2e
 
   # bold-upgrade:
   #   name: BOLD upgrade test

foundry.toml

@@ -2,7 +2,8 @@
 src = 'src'
 out = 'out'
 libs = ['node_modules', 'lib']
-cache_path  = 'forge-cache/sol'
+test = 'test/foundry'
+cache_path = 'forge-cache/sol'
 optimizer = true
 optimizer_runs = 2000
 via_ir = false
@@ -11,14 +12,16 @@ remappings = ['ds-test/=lib/forge-std/lib/ds-test/src/',
               'forge-std/=lib/forge-std/src/',
               '@openzeppelin/contracts-upgradeable/=node_modules/@openzeppelin/contracts-upgradeable/', 
               '@openzeppelin/contracts/=node_modules/@openzeppelin/contracts/', 
-              '@offchainlabs/upgrade-executor/=node_modules/@offchainlabs/upgrade-executor/']
+              '@offchainlabs/upgrade-executor/=node_modules/@offchainlabs/upgrade-executor/',
+              '@uniswap/v2-core/=node_modules/@uniswap/v2-core/contracts',
+              '@uniswap/lib/=node_modules/@uniswap/lib/contracts']
 fs_permissions = [{ access = "read", path = "./"}]
 
 [profile.yul]
 src = 'yul'
 out = 'out/yul'
 libs = ['node_modules', 'lib']
-cache_path  = 'forge-cache/yul'
+cache_path = 'forge-cache/yul'
 remappings = []
 auto_detect_remappings = false
 
@@ -38,4 +41,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

@@ -1,6 +1,6 @@
 {
   "name": "@arbitrum/nitro-contracts",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "description": "Layer 2 precompiles and rollup for Arbitrum Nitro",
   "author": "Offchain Labs, Inc.",
   "license": "BUSL-1.1",
@@ -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:e2e:stylus": "hardhat test test/e2e/stylusDeployer.ts",
     "test:upgrade": "./scripts/testUpgrade.bash",
@@ -51,6 +53,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",
@@ -78,6 +81,8 @@
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/eslint-plugin-tslint": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
+    "@uniswap/lib": "^4.0.1-alpha",
+    "@uniswap/v2-core": "^1.0.1",
     "audit-ci": "^6.6.1",
     "chai": "^4.5.0",
     "dotenv": "^16.4.7",

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
@@ -88,6 +92,7 @@ async function main() {
     true,
     contracts.rollupCreator.address,
     feeToken,
+    feeTokenPricer,
     stakeToken
   )
 

scripts/rollupCreation.ts

@@ -3,7 +3,7 @@ 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 { BigNumber, Event, Signer } from 'ethers'
 import { ERC20, ERC20__factory, IERC20__factory } from '../build/types'
 import { sleep } from './testSetup'
 import { promises as fs } from 'fs'
@@ -66,6 +66,7 @@ export async function createRollup(
   isDevDeployment: boolean,
   rollupCreatorAddress: string,
   feeToken: string,
+  feeTokenPricer: string,
   stakeToken: string
 ): Promise<{
   rollupCreationResult: RollupCreationResult
@@ -81,7 +82,7 @@ export async function createRollup(
     rollupCreatorAddress,
     rollupCreatorAbi,
     signer
-  )
+  ) as RollupCreator
   const validatorWalletCreator = await rollupCreator.validatorWalletCreator()
 
   try {
@@ -106,7 +107,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,
@@ -116,6 +122,7 @@ export async function createRollup(
           maxFeePerGasForRetryables: MAX_FER_PER_GAS,
           batchPosters: config.batchPosters,
           batchPosterManager: config.batchPosterManager,
+          feeTokenPricer: feeTokenPricer,
         }
 
     const createRollupTx = await rollupCreator.createRollup(deployParams, {
@@ -124,7 +131,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()
     )
@@ -225,6 +232,7 @@ export async function createRollup(
 
 async function _getDevRollupConfig(
   feeToken: string,
+  feeTokenPricer: string,
   validatorWalletCreator: string,
   stakeToken: string
 ): Promise<RollupCreator.RollupDeploymentParamsStruct> {
@@ -347,6 +355,7 @@ async function _getDevRollupConfig(
     maxFeePerGasForRetryables: MAX_FER_PER_GAS,
     batchPosters: batchPosters,
     batchPosterManager: batchPosterManager,
+    feeTokenPricer: feeTokenPricer,
   }
 
   function _createValidatorAddress(