Adds ViemSigner compatibility layer

.env-sample

@@ -13,5 +13,5 @@ GOERLI_RPC="https://goerli.infura.io/v3/2323"
 GOERLI_ROLLUP_TESTNET_RPC="https://goerli-rollup.arbitrum.io/rpc"
 
 NOVA_RPC="soontm"
-
+# Swaps integration tests to use Viem signer instead of Ethers
 SHOULD_USE_VIEM_SIGNER='0'

.github/workflows/build-test.yml

@@ -15,10 +15,6 @@ jobs:
       matrix:
         node-version: [16, 18, 20]
     steps:
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-
       - name: Checkout
         uses: actions/checkout@v3
 
@@ -128,22 +124,20 @@ jobs:
         run: CI=true yarn test:unit
 
   test-integration:
-    name: Test (Integration)
+    name: Test (Integration) - ${{ matrix.description }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
         node-version: [16, 18, 20]
+        include:
+          - viem_signer: '0'
+            description: 'Ethers v5'
+          - viem_signer: '1'
+            description: 'Viem'
     needs: install
-    strategy:
-      matrix:
-        viem_signer: ['0', '1']
     env:
       SHOULD_USE_VIEM_SIGNER: ${{ matrix.viem_signer }}
     steps:
-      - uses: actions/setup-node@v3
-        with:
-          node-version: 16
-
       - name: Checkout
         uses: actions/checkout@v3
 

package.json

@@ -32,7 +32,6 @@
     "test:coverage": "nyc mocha",
     "test:fork": "SHOULD_FORK=1 hardhat test tests/fork/*.test.ts",
     "test:integration": "mocha tests/integration/ --timeout 30000000 --bail",
-    "test:universal": "mocha tests/integration/universal --timeout 30000000 --watch",
     "test:unit": "mocha --parallel tests/unit/ --timeout 30000 --bail",
     "test:ci": "nyc --reporter=lcovonly mocha --reporter xunit",
     "lint": "eslint .",
@@ -63,9 +62,9 @@
     "@types/node-fetch": "^2.6.4",
     "@types/prompts": "^2.0.14",
     "@types/yargs": "^17.0.9",
-    "@typescript-eslint/eslint-plugin": "^5.14.0",
-    "@typescript-eslint/eslint-plugin-tslint": "^5.27.1",
-    "@typescript-eslint/parser": "^5.14.0",
+    "@typescript-eslint/eslint-plugin": "^6.14.0",
+    "@typescript-eslint/eslint-plugin-tslint": "^6.14.0",
+    "@typescript-eslint/parser": "^6.14.0",
     "arb-bridge-peripherals": "1.0.10",
     "audit-ci": "^6.3.0",
     "axios": "^0.21.3",
@@ -77,7 +76,7 @@
     "eslint-plugin-mocha": "^9.0.0",
     "eslint-plugin-prettier": "^4.0.0",
     "ethers-v6": "npm:ethers@^6.5.1",
-    "hardhat": "^2.8.3",
+    "hardhat": "^2.18.3",
     "mocha": "^9.2.1",
     "nyc": "^15.1.0",
     "prettier": "^2.3.2",
@@ -90,7 +89,7 @@
     "typedoc": "^0.24.6",
     "typedoc-plugin-markdown": "^3.15.3",
     "typescript": "^5.3.2",
-    "viem": "^1.0.5",
+    "viem": "^1.19.13",
     "web3": "^4.0.1",
     "yargs": "^17.3.1"
   },

scripts/deployBridge.ts

@@ -36,8 +36,7 @@ const deployBehindProxy = async <
   await proxy.deployed()
   console.log(factory['contractName'], proxy.address)
 
-  //@ts-ignore
-  return instance.attach(proxy.address)
+  return instance.attach(proxy.address) as ReturnType<T['deploy']>
 }
 
 export const deployErc20L1 = async (deployer: Signer) => {

scripts/testSetup.ts

@@ -1,31 +1,47 @@
-;('use strict')
+/*
+ * Copyright 2021, Offchain Labs, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/* eslint-env node */
+'use strict'
 
+import 'isomorphic-unfetch'
 import { JsonRpcProvider } from '@ethersproject/providers'
 import { Wallet } from '@ethersproject/wallet'
 
-import { execSync } from 'child_process'
 import dotenv from 'dotenv'
-import { Signer } from 'ethers'
-import * as fs from 'fs'
-import * as path from 'path'
-import { Erc20Bridger, EthBridger, InboxTools } from '../src'
-import { Bridge__factory } from '../src/lib/abi/factories/Bridge__factory'
-import { RollupAdminLogic__factory } from '../src/lib/abi/factories/RollupAdminLogic__factory'
-import { AdminErc20Bridger } from '../src/lib/assetBridger/erc20Bridger'
-import { ArbSdkError } from '../src/lib/dataEntities/errors'
+import { EthBridger, InboxTools, Erc20Bridger } from '../src'
 import {
   L1Network,
   L2Network,
-  addCustomNetwork,
   getL1Network,
   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'
+import { RollupAdminLogic__factory } from '../src/lib/abi/factories/RollupAdminLogic__factory'
 import { deployErc20AndInit } from './deployBridge'
+import * as path from 'path'
+import * as fs from 'fs'
+import { ArbSdkError } from '../src/lib/dataEntities/errors'
 import { createWalletClient, http } from 'viem'
-import { privateKeyToAccount } from 'viem/accounts'
 import { mainnet } from 'viem/chains'
-import { walletClientToSigner } from '../src/lib/utils/universal/signerTransforms'
-import 'isomorphic-unfetch'
+import { privateKeyToAccount } from 'viem/accounts'
+import { createViemSigner } from '../src/lib/utils/universal/signerTransforms'
 
 dotenv.config()
 
@@ -199,21 +215,20 @@ export const ethLocal = {
   id: 1337,
   rpcUrls: {
     default: {
-      http: ['http://127.0.0.1:8545'],
+      http: [config.ethUrl],
     },
     public: {
-      http: ['http://127.0.0.1:8545'],
+      http: [config.ethUrl],
     },
   },
 }
-const ethRpcUrl = config.ethUrl
 
 export const testSetup = async (): Promise<{
   seed: Wallet
   pk: any
   l1Network: L1Network
   l2Network: L2Network
-  l1Signer: any
+  l1Signer: Signer
   ethersL1Signer: Signer
   l2Signer: Signer
   erc20Bridger: Erc20Bridger
@@ -236,11 +251,22 @@ export const testSetup = async (): Promise<{
   const pk = ethersL1Signer._signingKey().privateKey as `0x${string}`
   const ethWalletClient = createWalletClient({
     account: privateKeyToAccount(pk),
-    transport: http(ethRpcUrl),
-    chain: ethLocal,
+    transport: http(config.ethUrl),
+    chain: {
+      ...mainnet,
+      id: 1337,
+      rpcUrls: {
+        default: {
+          http: [config.ethUrl],
+        },
+        public: {
+          http: [config.ethUrl],
+        },
+      },
+    },
   })
   const l1Signer = config.shouldUseViemSigner
-    ? walletClientToSigner(ethWalletClient)
+    ? createViemSigner(ethWalletClient)
     : ethersL1Signer
 
   let setL1Network: L1Network, setL2Network: L2Network

src/index.ts

@@ -62,4 +62,9 @@ export {
   RetryableDataTools,
 } from './lib/dataEntities/retryableData'
 
+export {
+  createViemSigner,
+  type ViemSigner,
+} from './lib/utils/universal/signerTransforms'
+
 export { Address } from './lib/dataEntities/address'

src/lib/assetBridger/erc20Bridger.ts

@@ -49,7 +49,7 @@ import { L2Network, getL2Network } from '../dataEntities/networks'
 import { ArbSdkError, MissingProviderArbSdkError } from '../dataEntities/errors'
 import { DISABLED_GATEWAY } from '../dataEntities/constants'
 import { EventFetcher } from '../utils/eventFetcher'
-import { EthDepositParams, EthWithdrawParams, Signerish } from './ethBridger'
+import { EthDepositParams, EthWithdrawParams } from './ethBridger'
 import { AssetBridger } from './assetBridger'
 import {
   L1ContractCallTransaction,
@@ -71,7 +71,6 @@ import { OmitTyped, RequiredPick } from '../utils/types'
 import { RetryableDataTools } from '../dataEntities/retryableData'
 import { EventArgs } from '../dataEntities/event'
 import { L1ToL2MessageGasParams } from '../message/L1ToL2MessageCreator'
-import { transformUniversalSignerToEthersV5Signer } from '../utils/universal/signerTransforms'
 
 export interface TokenApproveParams {
   /**
@@ -610,10 +609,7 @@ export class Erc20Bridger extends AssetBridger<
   public async deposit(
     params: Erc20DepositParams | L1ToL2TxReqAndSignerProvider
   ): Promise<L1ContractCallTransaction> {
-    const signer = await transformUniversalSignerToEthersV5Signer(
-      params.l1Signer
-    )
-    await this.checkL1Network(signer)
+    await this.checkL1Network(params.l1Signer)
 
     // Although the types prevent should alert callers that value is not
     // a valid override, it is possible that they pass it in anyway as it's a common override
@@ -624,16 +620,16 @@ export class Erc20Bridger extends AssetBridger<
       )
     }
 
-    const l1Provider = SignerProviderUtils.getProviderOrThrow(signer)
+    const l1Provider = SignerProviderUtils.getProviderOrThrow(params.l1Signer)
     const tokenDeposit = isL1ToL2TransactionRequest(params)
       ? params
       : await this.getDepositRequest({
           ...params,
           l1Provider,
-          from: await signer.getAddress(),
+          from: await params.l1Signer.getAddress(),
         })
 
-    const tx = await signer.sendTransaction({
+    const tx = await params.l1Signer.sendTransaction({
       ...tokenDeposit.txRequest,
       ...params.overrides,
     })
@@ -754,16 +750,15 @@ export class AdminErc20Bridger extends Erc20Bridger {
     l1Signer: Signer,
     l2Provider: Provider
   ): Promise<L1ContractTransaction> {
-    const signer = await transformUniversalSignerToEthersV5Signer(l1Signer)
-    if (!SignerProviderUtils.signerHasProvider(signer)) {
+    if (!SignerProviderUtils.signerHasProvider(l1Signer)) {
       throw new MissingProviderArbSdkError('l1Signer')
     }
-    await this.checkL1Network(signer)
+    await this.checkL1Network(l1Signer)
     await this.checkL2Network(l2Provider)
 
-    const l1SenderAddress = await signer.getAddress()
+    const l1SenderAddress = await l1Signer.getAddress()
 
-    const l1Token = ICustomToken__factory.connect(l1TokenAddress, signer)
+    const l1Token = ICustomToken__factory.connect(l1TokenAddress, l1Signer)
     const l2Token = IArbToken__factory.connect(l2TokenAddress, l2Provider)
 
     // sanity checks
@@ -781,7 +776,7 @@ export class AdminErc20Bridger extends Erc20Bridger {
       maxSubmissionCost: BigNumber
       gasLimit: BigNumber
     }
-    const from = await signer.getAddress()
+    const from = await l1Signer.getAddress()
     const encodeFuncData = (
       setTokenGas: GasParams,
       setGatewayGas: GasParams,
@@ -822,7 +817,7 @@ export class AdminErc20Bridger extends Erc20Bridger {
       }
     }
 
-    const l1Provider = signer.provider!
+    const l1Provider = l1Signer.provider!
     const gEstimator = new L1ToL2MessageGasEstimator(l2Provider)
     const setTokenEstimates2 = await gEstimator.populateFunctionParams(
       (params: OmitTyped<L1ToL2MessageGasParams, 'deposit'>) =>
@@ -856,7 +851,7 @@ export class AdminErc20Bridger extends Erc20Bridger {
       l1Provider
     )
 
-    const registerTx = await signer.sendTransaction({
+    const registerTx = await l1Signer.sendTransaction({
       to: l1Token.address,
       data: setGatewayEstimates2.data,
       value: setGatewayEstimates2.value,