feat: add support for custom gas token

.github/workflows/build-test.yml

@@ -9,7 +9,7 @@ env:
 
 jobs:
   install:
-    name: 'Install'
+    name: Install on Node.js v${{ matrix.node-version }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -27,7 +27,7 @@ jobs:
         uses: OffchainLabs/actions/node-modules/install@main
 
   lint:
-    name: Lint
+    name: Lint on Node.js v${{ matrix.node-version }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -76,7 +76,7 @@ jobs:
           verbose: false
 
   audit:
-    name: Audit
+    name: Audit on Node.js v${{ matrix.node-version }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -97,7 +97,7 @@ jobs:
       - run: yarn audit:ci
 
   test-unit:
-    name: Test (Unit)
+    name: Test (Unit) on Node.js v${{ matrix.node-version }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -124,12 +124,25 @@ jobs:
         run: CI=true yarn test:unit
 
   test-integration:
-    name: Test (Integration) - ${{ matrix.orbit-test == '1' && 'Orbit' || 'No Orbit' }} - Node ${{ matrix.node-version }}
+    name: Test (Integration) on Node.js v${{ matrix.node-version }}${{ matrix.orbit-test == '1' && ' with L3' || '' }}${{ matrix.custom-fee == '1' && ' with custom gas token' || '' }}
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false # runs all tests to completion even if one fails
       matrix:
         node-version: [16, 18, 20]
-        orbit-test: ['1', '0']
+        orbit-test: ['0', '1']
+        custom-fee: ['0']
+        include:
+          - orbit-test: '1'
+            custom-fee: '1'
+            node-version: 16
+          - orbit-test: '1'
+            custom-fee: '1'
+            node-version: 18
+          - orbit-test: '1'
+            custom-fee: '1'
+            node-version: 20
+
     needs: install
     env:
       ORBIT_TEST: ${{ matrix.orbit-test }}
@@ -149,8 +162,8 @@ jobs:
         uses: OffchainLabs/actions/run-nitro-test-node@main
         with:
           nitro-testnode-ref: master
-          no-token-bridge: true
           l3-node: ${{ matrix.orbit-test == '1' }}
+          args: ${{ matrix.custom-fee == '1' && '--l3-fee-token' || '' }}
 
       - name: Copy .env
         run: cp ./.env-sample ./.env

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arbitrum/sdk",
-  "version": "3.2.0",
+  "version": "3.3.0-beta.0",
   "description": "Typescript library client-side interactions with Arbitrum",
   "author": "Offchain Labs, Inc.",
   "license": "Apache-2.0",
@@ -44,7 +44,8 @@
     "setStandard": "ts-node scripts/setStandardGateways.ts",
     "setCustom": "ts-node scripts/setArbCustomGateways.ts",
     "cancelRetryable": "ts-node scripts/cancelRetryable.ts",
-    "bridgeStandardToken": "ts-node scripts/deployStandard.ts"
+    "bridgeStandardToken": "ts-node scripts/deployStandard.ts",
+    "fund": "ts-node scripts/fundCustomFeeToken.ts"
   },
   "dependencies": {
     "@ethersproject/address": "^5.0.8",
@@ -54,8 +55,8 @@
     "ethers": "^5.1.0"
   },
   "devDependencies": {
-    "@arbitrum/nitro-contracts": "1.1.0",
-    "@arbitrum/token-bridge-contracts": "1.2.0",
+    "@arbitrum/nitro-contracts": "^1.1.0",
+    "@arbitrum/token-bridge-contracts": "^1.2.0",
     "@nomiclabs/hardhat-ethers": "^2.0.4",
     "@typechain/ethers-v5": "9.0.0",
     "@types/chai": "^4.2.11",

scripts/fundCustomFeeToken.ts

@@ -0,0 +1,19 @@
+import { fundL1CustomFeeToken } from '../tests/integration/custom-fee-token/customFeeTokenTestHelpers'
+import { getLocalNetworksFromFile } from './testSetup'
+
+async function main() {
+  const localNetworks = getLocalNetworksFromFile()
+  if (!localNetworks) {
+    console.error('No local networks found')
+    //TODO: get token address from deployment somehow
+  }
+  const nativeTokenAddress = localNetworks?.l2Network.nativeToken
+  if (!nativeTokenAddress || nativeTokenAddress === undefined) {
+    console.error('No native token found')
+    return
+  }
+
+  await fundL1CustomFeeToken(nativeTokenAddress)
+}
+
+main()

scripts/genAbi.js

@@ -27,15 +27,11 @@ async function main() {
   // https://yarnpkg.com/advanced/rulebook#packages-should-never-write-inside-their-own-folder-outside-of-postinstall
   // instead of writing in postinstall in each of those packages, we should target a local folder in sdk's postinstall
 
-  console.log('building nitro')
-  execSync(`${npmExec} run build`, {
-    cwd: nitroPath,
-  })
+  console.log('building @arbitrum/nitro-contracts')
+  execSync(`${npmExec} run build`, { cwd: nitroPath })
 
-  console.log('building token bridge')
-  execSync(`${npmExec} run build`, {
-    cwd: tokenBridgePath,
-  })
+  console.log('building @arbitrum/token-bridge-contracts')
+  execSync(`${npmExec} run build`, { cwd: tokenBridgePath })
 
   console.log('Done compiling')