feat(e2e): run L1 and L2 together in e2e tests

Signed-off-by: Tomás Migone <[email protected]>

Author: tmigone

.gitignore

@@ -19,3 +19,7 @@ bin/
 # Coverage and other reports
 /reports
 coverage.json
+
+# Local test files
+addresses-local.json
+arbitrum-addresses-local.json

cli/commands/bridge/to-l2.ts

@@ -45,7 +45,8 @@ export const sendToL2 = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<v
 
   // parse provider
   const l1Provider = cli.wallet.provider
-  const l2Provider = getProvider(cliArgs.l2ProviderUrl)
+  // TODO: fix this hack for usage with hardhat
+  const l2Provider = cliArgs.l2Provider ? cliArgs.l2Provider : getProvider(cliArgs.l2ProviderUrl)
   const l1ChainId = cli.chainId
   const l2ChainId = (await l2Provider.getNetwork()).chainId
   if (chainIdIsL2(l1ChainId) || !chainIdIsL2(l2ChainId)) {
@@ -100,6 +101,7 @@ export const sendToL2 = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<v
   const txReceipt = await sendTransaction(cli.wallet, l1Gateway, 'outboundTransfer', txParams, {
     value: ethValue,
   })
+
   // get l2 ticket status
   if (txReceipt.status == 1) {
     logger.info('Waiting for message to propagate to L2...')

config/graph.arbitrum-localhost.yml

@@ -1,10 +1,10 @@
 general:
-  arbitrator: &arbitrator "0xFFcf8FDEE72ac11b5c542428B35EEF5769C409f0" # Arbitration Council
-  governor: &governor "0x22d491Bde2303f2f43325b2108D26f1eAbA1e32b" # Graph Council
-  authority: &authority "0xE11BA2b4D45Eaed5996Cd0823791E0C93114882d" # Authority that signs payment vouchers
-  availabilityOracle: &availabilityOracle "0xd03ea8624C8C5987235048901fB614fDcA89b117" # Subgraph Availability Oracle
-  pauseGuardian: &pauseGuardian "0x95cED938F7991cd0dFcb48F0a06a40FA1aF46EBC" # Protocol pause guardian
-  allocationExchangeOwner: &allocationExchangeOwner "0x3E5e9111Ae8eB78Fe1CC3bb8915d5D461F3Ef9A9" # Allocation Exchange owner
+  arbitrator: &arbitrator "0x4237154FE0510FdE3575656B60c68a01B9dCDdF8" # Arbitration Council
+  governor: &governor "0x1257227a2ECA34834940110f7B5e341A5143A2c4" # Graph Council
+  authority: &authority "0x12B8D08b116E1E3cc29eE9Cf42bB0AA8129C3215" # Authority that signs payment vouchers
+  availabilityOracle: &availabilityOracle "0x7694a48065f063a767a962610C6717c59F36b445" # Subgraph Availability Oracle
+  pauseGuardian: &pauseGuardian "0x601060e0DC5349AA55EC73df5A58cB0FC1cD2e3C" # Protocol pause guardian
+  allocationExchangeOwner: &allocationExchangeOwner "0xbD38F7b67a591A5cc7D642e1026E5095B819d952" # Allocation Exchange owner
 
 contracts:
   Controller:

e2e/deployment/config/l1/l1GraphTokenGateway.test.ts

@@ -77,7 +77,7 @@ describe('[L1] L1GraphTokenGateway configuration', function () {
         '0x00',
       )
 
-      await expect(tx).revertedWith('INBOX_NOT_SET')
+      await expect(tx).revertedWith('NOT_FROM_BRIDGE')
     })
   })
 })

e2e/scenarios/fixtures/bridge.ts

@@ -0,0 +1,29 @@
+import { SignerWithAddress } from '@nomiclabs/hardhat-ethers/signers'
+import { BigNumber } from 'ethers'
+import { toGRT } from '../../../cli/network'
+
+export interface BridgeFixture {
+  deploymentFile: string
+  funder: SignerWithAddress
+  accountsToFund: {
+    signer: SignerWithAddress
+    amount: BigNumber
+  }[]
+}
+
+// Signers
+// 0: l1Deployer
+// 1: l2Deployer
+
+export const getBridgeFixture = (signers: SignerWithAddress[]): BridgeFixture => {
+  return {
+    deploymentFile: '../arbitrum-sdk/localNetwork.json',
+    funder: signers[0],
+    accountsToFund: [
+      {
+        signer: signers[1],
+        amount: toGRT(10_000_000),
+      },
+    ],
+  }
+}

e2e/scenarios/lib/helpers.ts

@@ -1,14 +1,18 @@
 export function getGraphOptsFromArgv(): {
-  graphConfig: string | undefined
   addressBook: string | undefined
+  graphConfig: string | undefined
+  l1GraphConfig: string | undefined
+  l2GraphConfig: string | undefined
 } {
   const argv = process.argv.slice(2)
 
   const getArgv = (index: number) =>
     argv[index] && argv[index] !== 'undefined' ? argv[index] : undefined
 
   return {
-    graphConfig: getArgv(0),
-    addressBook: getArgv(1),
+    addressBook: getArgv(0),
+    graphConfig: getArgv(1),
+    l1GraphConfig: getArgv(2),
+    l2GraphConfig: getArgv(3),
   }
 }

e2e/scenarios/lib/staking.ts

@@ -42,7 +42,7 @@ export const allocateFrom = async (
     'allocateFrom',
     [indexer.address, subgraphDeploymentID, amount, allocationId, metadata, proof],
     {
-      gasLimit: 2000000,
+      gasLimit: 4_000_000,
     },
   )
 }
@@ -56,6 +56,6 @@ export const closeAllocation = async (
 
   console.log(`\nClosing ${allocationId}...`)
   await sendTransaction(indexer, contracts.Staking, 'closeAllocation', [allocationId, poi], {
-    gasLimit: 2000000,
+    gasLimit: 4_000_000,
   })
 }

e2e/scenarios/send-grt-to-l2.test.ts

@@ -0,0 +1,23 @@
+import { expect } from 'chai'
+import hre from 'hardhat'
+import { getBridgeFixture, BridgeFixture } from './fixtures/bridge'
+
+describe('Bridge GRT to L2', () => {
+  const graph = hre.graph()
+  let bridgeFixture: BridgeFixture
+
+  before(async () => {
+    const l1Deployer = await graph.l1.getDeployer()
+    const l2Deployer = await graph.l2.getDeployer()
+    bridgeFixture = getBridgeFixture([l1Deployer, l2Deployer])
+  })
+
+  describe('GRT balances', () => {
+    it(`L2 balances should match bridged amount`, async function () {
+      for (const account of bridgeFixture.accountsToFund) {
+        const l2GrtBalance = await graph.l2.contracts.GraphToken.balanceOf(account.signer.address)
+        expect(l2GrtBalance).eq(account.amount)
+      }
+    })
+  })
+})

e2e/scenarios/send-grt-to-l2.ts

@@ -0,0 +1,40 @@
+// ### Scenario description ###
+// Bridge action > Bridge GRT tokens from L1 to L2
+// This scenario will bridge GRT tokens from L1 to L2. See fixtures for details.
+// Run with:
+//    npx hardhat e2e:scenario send-grt-to-l2 --network <network> --graph-config config/graph.<network>.yml
+
+import hre from 'hardhat'
+import { TASK_BRIDGE_TO_L2 } from '../../tasks/bridge/to-l2'
+import { getGraphOptsFromArgv } from './lib/helpers'
+import { getBridgeFixture } from './fixtures/bridge'
+
+async function main() {
+  const graphOpts = getGraphOptsFromArgv()
+  const graph = hre.graph(graphOpts)
+
+  const l1Deployer = await graph.l1.getDeployer()
+  const l2Deployer = await graph.l2.getDeployer()
+
+  const bridgeFixture = getBridgeFixture([l1Deployer, l2Deployer])
+
+  // == Send GRT to L2 accounts
+  for (const account of bridgeFixture.accountsToFund) {
+    await hre.run(TASK_BRIDGE_TO_L2, {
+      ...graphOpts,
+      amount: account.amount.toString(),
+      sender: bridgeFixture.funder.address,
+      recipient: account.signer.address,
+      deploymentFile: bridgeFixture.deploymentFile,
+    })
+  }
+}
+
+// We recommend this pattern to be able to use async/await everywhere
+// and properly handle errors.
+main()
+  .then(() => process.exit(0))
+  .catch((error) => {
+    console.error(error)
+    process.exitCode = 1
+  })

hardhat.config.ts

@@ -29,7 +29,7 @@ const SKIP_LOAD = process.env.SKIP_LOAD === 'true'
 
 function loadTasks() {
   require('./gre/gre')
-  ;['contracts', 'misc', 'deployment', 'actions', 'verify', 'e2e'].forEach((folder) => {
+  ;['contracts', 'bridge', 'misc', 'deployment', 'actions', 'verify', 'e2e'].forEach((folder) => {
     const tasksPath = path.join(__dirname, 'tasks', folder)
     fs.readdirSync(tasksPath)
       .filter((pth) => pth.includes('.ts'))
@@ -101,6 +101,9 @@ function setupNetworkProviders(hardhatConfig) {
 const DEFAULT_TEST_MNEMONIC =
   'myth like bonus scare over problem client lizard pioneer submit female collect'
 
+const DEFAULT_L2_TEST_MNEMONIC =
+  'urge never interest human any economy gentle canvas anxiety pave unlock find'
+
 const config: HardhatUserConfig = {
   paths: {
     sources: './contracts',
@@ -160,7 +163,7 @@ const config: HardhatUserConfig = {
     localnitrol2: {
       chainId: 412346,
       url: 'http://localhost:8547',
-      accounts: { mnemonic: DEFAULT_TEST_MNEMONIC },
+      accounts: { mnemonic: DEFAULT_L2_TEST_MNEMONIC },
     },
   },
   graph: {