Mocks + DoubleProvider (#30)

* simplify test-e2e.bash

* add v5 to v6 conversion functions and add a note

* return both versions of wallets and providers

* mocks

* move util to scripts/template

* ...

* getEnv fix

* Revert "getEnv fix"

This reverts commit f985a44684a070be3cc2b197ead5cfdde63a259c.

* double provider (#33)

* double provider

* inheritance

* better types

* ...

* update readme

Author: godzillaba

README.md

@@ -44,7 +44,7 @@ To add the fork test setup to an existing hardhat+foundry project:
 - Copy `test/fork/` directory
 - Copy `test:fork` package script
 
-## E2E Tests and the Arbitrum SDK
+## E2E Tests, the Arbitrum SDK, and `DoubleWallet` / `DoubleProvider`
 End to end tests are located in `test/e2e/`, and ran by `yarn test:e2e`.
 
 The GitHub workflow defined in `.github/workflows/test-e2e.yml` will run test files against an L1+L2 nitro testnode setup by default. There are commented out jobs that add an L3 with ETH or custom fees.
@@ -57,6 +57,16 @@ A separate ethers v5 dev dependency is included and can be imported for use with
 import { ethers as ethersv5 } from 'ethers-v5'
 ```
 
+Instead of using providers and wallets directly, use `DoubleProvider` and `DoubleWallet` defined in `scripts/template/util.ts`. Using these classes / types makes dealing with the two ethers version much easier.
+
+## Using Mock Contracts
+Mock contracts like test tokens should live in `test/mocks`. Hardhat does not generate artifacts or types for contracts in `test/`, so to deploy and use them you should use foundry artifacts. For example:
+
+```typescript
+import ArbSysMockArtifact from 'out/ArbSysMock.sol/ArbSysMock.json'
+new ContractFactory(ArbSysMockArtifact.abi, ArbSysMockArtifact.bytecode, signer).deploy()
+```
+
 ### Disabling / Removing
 To disable the end to end testing CI jobs, remove `on: pull_request:` from `.github/workflows/test-e2e.yml`
 

scripts/template/delete-samples.bash

@@ -14,5 +14,8 @@ rm test/fork/Sample.t.sol test/fork/Sample.test.ts
 # remove sample e2e tests
 rm test/e2e/Counter.test.ts
 
+# remove sample mock
+rm test/mocks/SampleMock.sol
+
 # delete this script as it is no longer needed
 rm scripts/template/delete-samples.bash

scripts/template/util.ts

@@ -0,0 +1,38 @@
+import { JsonRpcProvider, Provider, Wallet } from 'ethers'
+import { ethers as ethersv5 } from 'ethers-v5'
+
+export type Unwrap<T> = T extends Promise<infer U> ? U : T
+
+export function getEnv(name: string): string {
+  const value = process.env[name] || ''
+  if (value === '') {
+    throw new Error(`Environment variable ${name} is not defined`)
+  }
+  return value
+}
+
+export class DoubleProvider extends JsonRpcProvider {
+  public readonly v5: ethersv5.providers.JsonRpcProvider
+  constructor(public readonly url: string) {
+    super(url)
+    this.v5 = new ethersv5.providers.JsonRpcProvider(url)
+  }
+}
+
+export class DoubleWallet extends Wallet {
+  public readonly provider!: Provider
+  public readonly v5: ethersv5.Wallet & {
+    provider: ethersv5.providers.JsonRpcProvider
+  }
+
+  constructor(
+    privateKey: string,
+    public readonly doubleProvider: DoubleProvider
+  ) {
+    super(privateKey, doubleProvider)
+    this.v5 = new ethersv5.Wallet(
+      privateKey,
+      doubleProvider.v5
+    ) as ethersv5.Wallet & { provider: ethersv5.providers.JsonRpcProvider }
+  }
+}

test/e2e/Counter.test.ts

@@ -7,6 +7,8 @@ This repository uses ethers v6, but the arbitrum sdk uses ethers v5.
 
 Using the sdk might be a bit tricky, but you can import v5 like this:
 import { ethers as ethersv5 } from 'ethers-v5'
+
+testSetup will return both v5 and v6 versions of signers and providers.
 */
 
 describe('E2E Sample', () => {

test/e2e/test-e2e.bash

@@ -12,20 +12,11 @@ else
     export ORBIT_TEST=1
 fi
 
-cd lib/arbitrum-sdk && yarn gen:network && cd -
-
-# if the above command fails, exit
-if [ $? -ne 0 ]; then
-    echo "Failed to generate network"
-    exit 1
-fi
+set -e
 
-yarn hardhat compile
+cd lib/arbitrum-sdk && yarn gen:network && cd -
 
-if [ $? -ne 0 ]; then
-    echo "Failed to compile"
-    exit 1
-fi
+yarn build
 
 yarn mocha test/e2e/ --timeout 30000000 --bail
 

test/e2e/testSetup.ts

@@ -1,24 +1,27 @@
-import { JsonRpcProvider, Wallet } from 'ethers'
 import { testSetup as sdkTestSetup } from '../../lib/arbitrum-sdk/scripts/testSetup'
 import { L1Network, L2Network, getL1Network } from '../../lib/arbitrum-sdk/src'
-import { getEnv } from '../util/util'
+import {
+  DoubleProvider,
+  DoubleWallet,
+  getEnv,
+} from '../../scripts/template/util'
 
 export const isTestingOrbit = process.env.ORBIT_TEST === '1'
 
 type BaseTestSetup = {
   l1Network: L1Network
   l2Network: L2Network
-  l1Signer: Wallet
-  l2Signer: Wallet
-  l1Provider: JsonRpcProvider
-  l2Provider: JsonRpcProvider
+  l1Signer: DoubleWallet
+  l2Signer: DoubleWallet
+  l1Provider: DoubleProvider
+  l2Provider: DoubleProvider
 }
 
 export type OrbitTestSetup = BaseTestSetup & {
   isTestingOrbit: true
   l3Network: L2Network
-  l3Provider: JsonRpcProvider
-  l3Signer: Wallet
+  l3Provider: DoubleProvider
+  l3Signer: DoubleWallet
 }
 
 export type NonOrbitTestSetup = BaseTestSetup & {
@@ -28,16 +31,16 @@ export type NonOrbitTestSetup = BaseTestSetup & {
 export type TestSetup = OrbitTestSetup | NonOrbitTestSetup
 
 export async function testSetup(): Promise<TestSetup> {
-  const l1Provider = new JsonRpcProvider(getEnv('LOCAL_L1_URL'))
-  const l2Provider = new JsonRpcProvider(getEnv('LOCAL_L2_URL'))
-  const l1Signer = new Wallet(getEnv('LOCAL_L1_KEY'), l1Provider)
-  const l2Signer = new Wallet(getEnv('LOCAL_L2_KEY'), l2Provider)
+  const l1Provider = new DoubleProvider(getEnv('LOCAL_L1_URL'))
+  const l2Provider = new DoubleProvider(getEnv('LOCAL_L2_URL'))
+  const l1Signer = new DoubleWallet(getEnv('LOCAL_L1_KEY'), l1Provider)
+  const l2Signer = new DoubleWallet(getEnv('LOCAL_L2_KEY'), l2Provider)
 
   const setup = await sdkTestSetup()
 
   if (isTestingOrbit) {
-    const l3Provider = new JsonRpcProvider(getEnv('LOCAL_L3_URL'))
-    const l3Signer = new Wallet(getEnv('LOCAL_L3_KEY'), l3Provider)
+    const l3Provider = new DoubleProvider(getEnv('LOCAL_L3_URL'))
+    const l3Signer = new DoubleWallet(getEnv('LOCAL_L3_KEY'), l3Provider)
 
     const l1Network = await getL1Network(
       (setup.l1Network as L2Network).partnerChainID

test/mocks/SampleMock.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.16;
+
+contract SampleMock {
+    function arbOSVersion() external pure returns (uint256) {
+        return 1;
+    }
+}