feat: add support for custom gas token

hardhat.nitro-contracts-abigen.ts

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

hardhat.token-bridge-contracts-abigen.ts

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

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arbitrum/sdk",
-  "version": "3.1.12",
+  "version": "3.1.12-orbit-custom-fee-token.1",
   "description": "Typescript library client-side interactions with Arbitrum",
   "author": "Offchain Labs, Inc.",
   "license": "Apache-2.0",
@@ -31,7 +31,8 @@
     "test": "mocha",
     "test:coverage": "nyc mocha",
     "test:fork": "SHOULD_FORK=1 hardhat test tests/fork/*.test.ts",
-    "test:integration": "mocha tests/integration/ --timeout 30000000 --bail",
+    "test:integration": "mocha tests/integration/ --ignore tests/integration/custom-fee-token/ --timeout 30000000 --bail",
+    "test:integration:custom-fee-token": "mocha tests/integration/custom-fee-token/ --timeout 30000000 --bail",
     "test:unit": "mocha --parallel tests/unit/ --timeout 30000 --bail",
     "test:ci": "nyc --reporter=lcovonly mocha --reporter xunit",
     "lint": "eslint .",
@@ -43,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",
@@ -53,7 +55,8 @@
     "ethers": "^5.1.0"
   },
   "devDependencies": {
-    "@arbitrum/nitro-contracts": "1.0.1",
+    "@arbitrum/nitro-contracts": "1.1.0-alpha.7",
+    "@arbitrum/token-bridge-contracts": "1.1.0-alpha.1",
     "@nomiclabs/hardhat-ethers": "^2.0.4",
     "@typechain/ethers-v5": "9.0.0",
     "@types/chai": "^4.2.11",
@@ -63,7 +66,6 @@
     "@typescript-eslint/eslint-plugin": "^5.14.0",
     "@typescript-eslint/eslint-plugin-tslint": "^5.27.1",
     "@typescript-eslint/parser": "^5.14.0",
-    "arb-bridge-peripherals": "1.0.10",
     "audit-ci": "^6.3.0",
     "axios": "^0.21.3",
     "chai": "^4.2.0",

scripts/fundCustomFeeToken.ts

@@ -0,0 +1,7 @@
+import { fundL1CustomFeeToken } from '../tests/integration/custom-fee-token/customFeeTokenTestHelpers'
+
+async function main() {
+  await fundL1CustomFeeToken('0x3f1Eae7D46d88F08fc2F8ed27FCb2AB183EB2d0E')
+}
+
+main()

scripts/genAbi.js

@@ -11,7 +11,7 @@ async function main() {
   const cwd = process.cwd()
 
   const nitroPath = getPackagePath('@arbitrum/nitro-contracts')
-  const peripheralsPath = getPackagePath('arb-bridge-peripherals')
+  const tokenBridgePath = getPackagePath('@arbitrum/token-bridge-contracts')
 
   console.log('Compiling paths.')
 
@@ -27,20 +27,29 @@ 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 hardhat:prod compile`, {
+  // copy the hardhat config to nitro-contracts
+  execSync(
+    `cp ${cwd}/hardhat.nitro-contracts-abigen.ts ${nitroPath}/hardhat-abigen.ts`
+  )
+  // copy the hardhat config to token-bridge-contracts
+  execSync(
+    `cp ${cwd}/hardhat.token-bridge-contracts-abigen.ts ${tokenBridgePath}/hardhat-abigen.ts`
+  )
+
+  console.log('building @arbitrum/nitro-contracts')
+  execSync(`${npmExec} run build --config hardhat-abigen.ts`, {
     cwd: nitroPath,
   })
 
-  console.log('building peripherals')
-  execSync(`${npmExec} run hardhat:prod compile`, {
-    cwd: peripheralsPath,
+  console.log('building @arbitrum/token-bridge-contracts')
+  execSync(`${npmExec} run build --config hardhat-abigen.ts`, {
+    cwd: tokenBridgePath,
   })
 
   console.log('Done compiling')
 
   const nitroFiles = glob(cwd, [
-    `${peripheralsPath}/build/contracts/!(build-info)/**/+([a-zA-Z0-9_]).json`,
+    `${tokenBridgePath}/build/contracts/!(build-info)/**/+([a-zA-Z0-9_]).json`,
     `${nitroPath}/build/contracts/!(build-info)/**/+([a-zA-Z0-9_]).json`,
   ])
 

scripts/testSetup.ts

@@ -18,8 +18,10 @@
 
 import { JsonRpcProvider } from '@ethersproject/providers'
 import { Wallet } from '@ethersproject/wallet'
-
+import { Signer } from 'ethers'
+import { Provider } from '@ethersproject/abstract-provider'
 import dotenv from 'dotenv'
+
 import { EthBridger, InboxTools, Erc20Bridger } from '../src'
 import {
   L1Network,
@@ -28,7 +30,6 @@ import {
   getL2Network,
   addCustomNetwork,
 } from '../src/lib/dataEntities/networks'
-import { Signer } from 'ethers'
 import { AdminErc20Bridger } from '../src/lib/assetBridger/erc20Bridger'
 import { execSync } from 'child_process'
 import { Bridge__factory } from '../src/lib/abi/factories/Bridge__factory'
@@ -208,6 +209,8 @@ export const testSetup = async (): Promise<{
   l2Network: L2Network
   l1Signer: Signer
   l2Signer: Signer
+  l1Provider: Provider
+  l2Provider: Provider
   erc20Bridger: Erc20Bridger
   ethBridger: EthBridger
   adminErc20Bridger: AdminErc20Bridger
@@ -270,6 +273,8 @@ export const testSetup = async (): Promise<{
   return {
     l1Signer,
     l2Signer,
+    l1Provider: ethProvider,
+    l2Provider: arbProvider,
     l1Network: setL1Network,
     l2Network: setL2Network,
     erc20Bridger,

src/index.ts

@@ -47,9 +47,14 @@ export {
   L2Networks,
   L1Network,
   L2Network,
+  Chain,
+  ParentChain,
   getL1Network,
   getL2Network,
+  getChain,
+  getParentChain,
   addCustomNetwork,
+  addCustomChain,
   addDefaultLocalNetwork,
 } from './lib/dataEntities/networks'
 export { InboxTools } from './lib/inbox/inbox'

src/lib/assetBridger/assetBridger.ts

@@ -20,7 +20,14 @@ import { ArbSdkError } from '../dataEntities/errors'
 import { L1ContractTransaction } from '../message/L1Transaction'
 import { L2ContractTransaction } from '../message/L2Transaction'
 
-import { l1Networks, L1Network, L2Network } from '../dataEntities/networks'
+import {
+  l1Networks,
+  L1Network,
+  L2Network,
+  Chain,
+  ParentChain,
+  parentChains,
+} from '../dataEntities/networks'
 import {
   SignerOrProvider,
   SignerProviderUtils,
@@ -31,22 +38,30 @@ import {
  */
 export abstract class AssetBridger<DepositParams, WithdrawParams> {
   public readonly l1Network: L1Network
+  public readonly parentChain: ParentChain
+  private readonly l1NetworkOrParentChain: L1Network | ParentChain
 
-  public constructor(public readonly l2Network: L2Network) {
+  public constructor(public readonly l2Network: L2Network | Chain) {
     this.l1Network = l1Networks[l2Network.partnerChainID]
-    if (!this.l1Network) {
+    this.parentChain = parentChains[l2Network.partnerChainID]
+    this.l1NetworkOrParentChain = this.l1Network || this.parentChain
+
+    if (!this.l1NetworkOrParentChain) {
       throw new ArbSdkError(
-        `Unknown l1 network chain id: ${l2Network.partnerChainID}`
+        `Unknown parent network chain id: ${l2Network.partnerChainID}`
       )
     }
   }
 
   /**
-   * Check the signer/provider matches the l1Network, throws if not
+   * Check the signer/provider matches the L1 network or the Parent Chain, throws if not
    * @param sop
    */
   protected async checkL1Network(sop: SignerOrProvider): Promise<void> {
-    await SignerProviderUtils.checkNetworkMatches(sop, this.l1Network.chainID)
+    await SignerProviderUtils.checkNetworkMatches(
+      sop,
+      this.l1NetworkOrParentChain.chainID
+    )
   }
 
   /**