feat: non-18 decimal custom gas token support

src/lib/assetBridger/erc20Bridger.ts

@@ -685,8 +685,8 @@ export class Erc20Bridger extends AssetBridger<
     }
 
     const decimals = await getNativeTokenDecimals({
-      l1Provider: parentProvider,
-      l2Network: this.childNetwork,
+      parentProvider,
+      childNetwork: this.childNetwork,
     })
 
     const depositFunc = (
@@ -1096,8 +1096,8 @@ export class AdminErc20Bridger extends Erc20Bridger {
     }
 
     const nativeTokenDecimals = await getNativeTokenDecimals({
-      l1Provider: parentProvider,
-      l2Network: this.childNetwork,
+      parentProvider,
+      childNetwork: this.childNetwork,
     })
 
     type GasParams = {

src/lib/assetBridger/ethBridger.ts

@@ -317,8 +317,8 @@ export class EthBridger extends AssetBridger<
     params: EthDepositToRequestParams
   ): Promise<ParentToChildTransactionRequest> {
     const decimals = await getNativeTokenDecimals({
-      l1Provider: params.parentProvider,
-      l2Network: this.childNetwork,
+      parentProvider: params.parentProvider,
+      childNetwork: this.childNetwork,
     })
 
     const amountToBeMintedOnChildChain = nativeTokenDecimalsTo18Decimals({

src/lib/message/ParentToChildMessageGasEstimator.ts

@@ -231,10 +231,10 @@ export class ParentToChildMessageGasEstimator {
     const { data } = retryableEstimateData
     const gasLimitDefaults = this.applyGasLimitDefaults(options?.gasLimit)
 
-    const l2Network = await getArbitrumNetwork(this.childProvider)
+    const childNetwork = await getArbitrumNetwork(this.childProvider)
     const decimals = await getNativeTokenDecimals({
-      l1Provider: parentProvider,
-      l2Network,
+      parentProvider,
+      childNetwork,
     })
 
     // estimate the child gas price

src/lib/utils/lib.ts

@@ -198,21 +198,21 @@ export const getBlockRangesForL1Block = async (
 }
 
 export async function getNativeTokenDecimals({
-  l1Provider,
-  l2Network,
+  parentProvider,
+  childNetwork,
 }: {
-  l1Provider: Provider
-  l2Network: ArbitrumNetwork
+  parentProvider: Provider
+  childNetwork: ArbitrumNetwork
 }) {
-  const nativeTokenAddress = l2Network.nativeToken
+  const nativeTokenAddress = childNetwork.nativeToken
 
   if (!nativeTokenAddress || nativeTokenAddress === constants.AddressZero) {
     return 18
   }
 
   const nativeTokenContract = ERC20__factory.connect(
     nativeTokenAddress,
-    l1Provider
+    parentProvider
   )
 
   try {

tests/integration/custom-fee-token/customFeeTokenEthBridger.test.ts

@@ -59,8 +59,8 @@ describeOnlyWhenCustomGasToken(
         childChain,
       } = await testSetup()
       const decimals = await getNativeTokenDecimals({
-        l1Provider: parentProvider,
-        l2Network: childChain,
+        parentProvider,
+        childNetwork: childChain,
       })
       const amount = ethers.utils.parseUnits('1', decimals)
 
@@ -179,8 +179,8 @@ describeOnlyWhenCustomGasToken(
         nativeTokenContract,
       } = await testSetup()
       const decimals = await getNativeTokenDecimals({
-        l1Provider: parentProvider,
-        l2Network: childChain,
+        parentProvider,
+        childNetwork: childChain,
       })
 
       const bridge = ethBridger.childNetwork.ethBridge.bridge

tests/integration/custom-fee-token/customFeeTokenTestHelpers.ts

@@ -99,8 +99,8 @@ export async function fundChildCustomFeeToken(childSigner: Signer) {
   const deployerWallet = new Wallet(config.arbKey, arbProvider())
 
   const decimals = await getNativeTokenDecimals({
-    l1Provider: ethProvider(),
-    l2Network: localNetworks().l2Network,
+    parentProvider: ethProvider(),
+    childNetwork: localNetworks().l2Network,
   })
 
   const tx = await deployerWallet.sendTransaction({

tests/integration/customerc20.test.ts

@@ -46,10 +46,7 @@ import {
 import { AdminErc20Bridger } from '../../src/lib/assetBridger/erc20Bridger'
 import { testSetup } from '../../scripts/testSetup'
 import { ERC20__factory } from '../../src/lib/abi/factories/ERC20__factory'
-import {
-  fundParentCustomFeeToken,
-  isArbitrumNetworkWithCustomFeeToken,
-} from './custom-fee-token/customFeeTokenTestHelpers'
+import { isArbitrumNetworkWithCustomFeeToken } from './custom-fee-token/customFeeTokenTestHelpers'
 
 const depositAmount = BigNumber.from(100)
 const withdrawalAmount = BigNumber.from(10)
@@ -75,10 +72,6 @@ describe('Custom ERC20', () => {
     }
     await fundParentSigner(testState.parentSigner)
     await fundChildSigner(testState.childSigner)
-
-    if (isArbitrumNetworkWithCustomFeeToken()) {
-      await fundParentCustomFeeToken(testState.parentSigner)
-    }
   })
 
   it('register custom token', async () => {

tests/integration/eth.test.ts

@@ -111,8 +111,8 @@ describe('Ether', async () => {
       childSigner,
     } = await testSetup()
     const decimals = await getNativeTokenDecimals({
-      l1Provider: parentProvider,
-      l2Network: childChain,
+      parentProvider,
+      childNetwork: childChain,
     })
 
     await fundParentSigner(parentSigner)
@@ -181,8 +181,8 @@ describe('Ether', async () => {
       childSigner,
     } = await testSetup()
     const decimals = await getNativeTokenDecimals({
-      l1Provider: parentProvider,
-      l2Network: childChain,
+      parentProvider,
+      childNetwork: childChain,
     })
 
     await fundParentSigner(parentSigner)
@@ -271,8 +271,8 @@ describe('Ether', async () => {
       childSigner,
     } = await testSetup()
     const decimals = await getNativeTokenDecimals({
-      l1Provider: parentProvider,
-      l2Network: childChain,
+      parentProvider,
+      childNetwork: childChain,
     })
 
     await fundParentSigner(parentSigner)
@@ -447,8 +447,8 @@ describe('Ether', async () => {
     ).to.eq(ChildToParentMessageStatus.EXECUTED)
 
     const decimals = await getNativeTokenDecimals({
-      l1Provider: parentProvider,
-      l2Network: childChain,
+      parentProvider,
+      childNetwork: childChain,
     })
 
     const finalRandomBalance = isArbitrumNetworkWithCustomFeeToken()

tests/integration/l1l3Bridger.test.ts

@@ -383,8 +383,8 @@ describe('L1 to L3 Bridging', () => {
       'should properly get l2 and l1 fee token addresses',
       async function () {
         const decimals = await getNativeTokenDecimals({
-          l1Provider: l1Signer.provider!,
-          l2Network: l3Network,
+          parentProvider: l1Signer.provider!,
+          childNetwork: l3Network,
         })
 
         if (decimals !== 18) {
@@ -413,8 +413,8 @@ describe('L1 to L3 Bridging', () => {
       'should throw getting l1 gas token address when it is unavailable',
       async function () {
         const decimals = await getNativeTokenDecimals({
-          l1Provider: l1Signer.provider!,
-          l2Network: l3Network,
+          parentProvider: l1Signer.provider!,
+          childNetwork: l3Network,
         })
 
         if (decimals !== 18) {
@@ -441,8 +441,8 @@ describe('L1 to L3 Bridging', () => {
       'should throw when the fee token does not use 18 decimals on L1 or L2',
       async function () {
         const decimals = await getNativeTokenDecimals({
-          l1Provider: l1Signer.provider!,
-          l2Network: l3Network,
+          parentProvider: l1Signer.provider!,
+          childNetwork: l3Network,
         })
 
         if (decimals !== 18) {
@@ -938,8 +938,8 @@ describe('L1 to L3 Bridging', () => {
 
     it('happy path non fee token or standard', async function () {
       const decimals = await getNativeTokenDecimals({
-        l1Provider: l1Signer.provider!,
-        l2Network: l3Network,
+        parentProvider: l1Signer.provider!,
+        childNetwork: l3Network,
       })
 
       if (decimals !== 18) {
@@ -961,8 +961,8 @@ describe('L1 to L3 Bridging', () => {
 
     it('happy path weth', async function () {
       const decimals = await getNativeTokenDecimals({
-        l1Provider: l1Signer.provider!,
-        l2Network: l3Network,
+        parentProvider: l1Signer.provider!,
+        childNetwork: l3Network,
       })
 
       if (decimals !== 18) {
@@ -1000,8 +1000,8 @@ describe('L1 to L3 Bridging', () => {
 
     itOnlyWhenCustomGasToken('happy path OnlyCustomFee', async function () {
       const decimals = await getNativeTokenDecimals({
-        l1Provider: l1Signer.provider!,
-        l2Network: l3Network,
+        parentProvider: l1Signer.provider!,
+        childNetwork: l3Network,
       })
 
       if (decimals !== 18) {

tests/integration/retryableData.test.ts

@@ -46,8 +46,8 @@ describe('RevertData', () => {
 
     const { parentProvider, childChain } = await testSetup()
     const decimals = await getNativeTokenDecimals({
-      l1Provider: parentProvider,
-      l2Network: childChain,
+      parentProvider,
+      childNetwork: childChain,
     })
 
     return {