feat: support for running e2e on nitro testnodes

tmigone · tmigone · commit 0e8c64f162eb · 2022-09-23T14:54:32.000-04:00
Signed-off-by: Tomás Migone &lt;tomas@edgeandnode.com&gt;
diff --git a/cli/commands/protocol/configure-bridge.ts b/cli/commands/protocol/configure-bridge.ts
@@ -32,12 +32,16 @@ export const configureL1Bridge = async (cli: CLIEnvironment, cliArgs: CLIArgs):
 
   const l1Inbox = arbAddressBook.getEntry('IInbox')
   const l1Router = arbAddressBook.getEntry('L1GatewayRouter')
-  logger.info(
-    'L1 Inbox address: ' + l1Inbox.address + ' and L1 Router address: ' + l1Router.address,
-  )
+
+  // There is no L1GatewayRouter on L1, use random address instead as setArbitrumAddresses will reject 0x0
+  const l1RouterAddress =
+    cli.chainId.toString() === '1337'
+      ? '0x000000000000000000000000000000000000dead'
+      : l1Router.address
+  logger.info('L1 Inbox address: ' + l1Inbox.address + ' and L1 Router address: ' + l1RouterAddress)
   await sendTransaction(cli.wallet, gateway, 'setArbitrumAddresses', [
     l1Inbox.address,
-    l1Router.address,
+    l1RouterAddress,
   ])
 }
 
@@ -64,9 +68,12 @@ export const configureL2Bridge = async (cli: CLIEnvironment, cliArgs: CLIArgs):
   logger.info('L1 Gateway address: ' + l1Counterpart.address)
   await sendTransaction(cli.wallet, gateway, 'setL1CounterpartAddress', [l1Counterpart.address])
 
-  const l2Router = arbAddressBook.getEntry('L2GatewayRouter')
-  logger.info('L2 Router address: ' + l2Router.address)
-  await sendTransaction(cli.wallet, gateway, 'setL2Router', [l2Router.address])
+  // There is no L2GatewayRouter in localhost
+  if (cli.chainId.toString() !== '412346') {
+    const l2Router = arbAddressBook.getEntry('L2GatewayRouter')
+    logger.info('L2 Router address: ' + l2Router.address)
+    await sendTransaction(cli.wallet, gateway, 'setL2Router', [l2Router.address])
+  }
 
   logger.info('L2 Gateway address: ' + gateway.address)
   await sendTransaction(cli.wallet, token, 'setGateway', [gateway.address])
diff --git a/config/graph.arbitrum-localhost.yml b/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:
diff --git a/e2e/deployment/config/l1/l1GraphTokenGateway.test.ts b/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')
     })
   })
 })
diff --git a/hardhat.config.ts b/hardhat.config.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: {
diff --git a/scripts/e2e b/scripts/e2e
@@ -3,17 +3,134 @@
 set -eo pipefail
 source $(pwd)/scripts/evm
 
+function pre_deploy() {
+  local NETWORK=$1
+  local GRAPH_CONFIG=$2
+
+  # Create named accounts
+  npx hardhat migrate:accounts --network "$NETWORK" --graph-config "$GRAPH_CONFIG"
+
+  # Fund accounts if using nitro test nodes
+  if [[ "$NETWORK" == *"localnitro"* ]]; then
+    npx hardhat migrate:accounts:nitro --network "$NETWORK" --graph-config "$GRAPH_CONFIG"
+  fi
+}
+
+function deploy() {
+  local NETWORK=$1
+  local GRAPH_CONFIG=$2
+  local ADDRESS_BOOK=$3
+
+  # Deploy protocol
+  npx hardhat migrate \
+    --network "$NETWORK" \
+    --skip-confirmation \
+    --auto-mine \
+    --force \
+    --graph-config "$GRAPH_CONFIG" \
+    --address-book "$ADDRESS_BOOK"
+}
+
+function post_deploy () {
+  local NETWORK=$1
+  local GRAPH_CONFIG=$2
+  local ADDRESS_BOOK=$3
+
+  # Governor to accept contracts ownership 
+  npx hardhat migrate:ownership --network "$NETWORK" --graph-config "$GRAPH_CONFIG" --address-book "$ADDRESS_BOOK"
+  
+  # Unpause the protocol
+  npx hardhat migrate:unpause:protocol --network "$NETWORK" --graph-config "$GRAPH_CONFIG" --address-book "$ADDRESS_BOOK"
+}
+
+function configure_bridge () {
+  local L1_NETWORK=$1
+  local L1_GRAPH_CONFIG=$2
+  local L2_NETWORK=$3
+  local L2_GRAPH_CONFIG=$4
+  local ADDRESS_BOOK=$5
+
+  # These settings are only used for CLI bridge commands
+  # so we keep them here to avoid confusion with hardhat based tasks
+  local L1_CHAIN_ID=${L1_CHAIN_ID:-"1337"}
+  local L2_CHAIN_ID=${L2_CHAIN_ID:-"412346"}
+
+  local L1_RPC=${L1_RPC:-"http://localhost:8545"}
+  local L2_RPC=${L2_RPC:-"http://localhost:8547"}
+
+  local L1_MNEMONIC=${L1_MNEMONIC:-"myth like bonus scare over problem client lizard pioneer submit female collect"}
+  local L2_MNEMONIC=${L2_MNEMONIC:-"urge never interest human any economy gentle canvas anxiety pave unlock find"}
+
+  # Set L1Inbox address in arbitrum address book
+  local L1_INBOX=$(docker exec $(docker ps -qf "name=nitro_geth") cat /config/deployment.json | jq -r '.inbox')
+  jq -r '."1337" += { "IInbox" : { "address": "'"$L1_INBOX"'" } }' arbitrum-addresses.json > updated.json
+  mv updated.json arbitrum-addresses.json
+
+  # Configure the bridge
+  ./cli/cli.ts -a "$ADDRESS_BOOK" -p "$L2_RPC" -m "$L2_MNEMONIC" -n 2 protocol configure-l2-bridge "$L1_CHAIN_ID"
+  ./cli/cli.ts -a "$ADDRESS_BOOK" -p "$L1_RPC" -m "$L1_MNEMONIC" -n 2 protocol configure-l1-bridge "$L2_CHAIN_ID"
+
+  # Unpause the bridge
+  npx hardhat migrate:unpause:bridge --network "$L2_NETWORK" --graph-config "$L2_GRAPH_CONFIG" --address-book "$ADDRESS_BOOK"
+  npx hardhat migrate:unpause:bridge --network "$L1_NETWORK" --graph-config "$L1_GRAPH_CONFIG" --address-book "$ADDRESS_BOOK"
+}
+
+function test_e2e () {
+  local NETWORK=$1
+  local GRAPH_CONFIG=$2
+  local ADDRESS_BOOK=$3
+
+  npx hardhat e2e --network "$NETWORK" --graph-config "$GRAPH_CONFIG" --address-book "$ADDRESS_BOOK"
+}
+
+function test_e2e_scenarios () {
+  local NETWORK=$1
+  local GRAPH_CONFIG=$2
+  local ADDRESS_BOOK=$3
+
+  # Skip GRT based scenarios as L2 doesnt have tokens yet...
+  if [[ "$NETWORK" !=  "localnitrol2" ]]; then
+    npx hardhat e2e:scenario create-subgraphs --network "$NETWORK" --graph-config "$GRAPH_CONFIG" --address-book "$ADDRESS_BOOK"
+    npx hardhat e2e:scenario open-allocations --network "$NETWORK" --graph-config "$GRAPH_CONFIG" --address-book "$ADDRESS_BOOK"
+  fi
+
+  # skip close-allocations for arbitrum testnodes as we can't advance epoch
+  if [[ "$NETWORK" !=  *"localnitro"* ]]; then
+    npx hardhat e2e:scenario close-allocations --network "$NETWORK" --graph-config "$GRAPH_CONFIG" --address-book "$ADDRESS_BOOK"
+  fi
+}
+
 # Allow overriding config
-GRAPH_CONFIG=${GRAPH_CONFIG:-"config/graph.localhost.yml"}
+# By default run only L1 tests on localhost network
 ADDRESS_BOOK=${ADDRESS_BOOK:-"addresses.json"}
-NETWORK=${NETWORK:-"localhost"}
+L1_NETWORK=${L1_NETWORK:-"localhost"}
+L2_NETWORK=${L2_NETWORK}
+L1_GRAPH_CONFIG=${L1_GRAPH_CONFIG:-"config/graph.localhost.yml"}
+L2_GRAPH_CONFIG=${L2_GRAPH_CONFIG:-"config/graph.arbitrum-localhost.yml"}
 
 echo "Running e2e tests"
-echo "- Using config: $GRAPH_CONFIG"
 echo "- Using address book: $ADDRESS_BOOK"
-echo "- Using network: $NETWORK"
+echo "- Using L1 network: $L1_NETWORK"
+echo "- Using L1 config: $L1_GRAPH_CONFIG"
+
+if [[ -n "$L2_NETWORK" ]]; then
+  echo "- Using L2 network: $L2_NETWORK"
+  echo "- Using L2 config: $L2_GRAPH_CONFIG"
+else 
+  echo "- Skipping L2 tests"
+fi
+
+### SETUP
+# Check binary dependencies before starting
+dependencies=( jq docker )
+for i in "${dependencies[@]}"
+do
+  if ! command -v "$i" &> /dev/null; then
+    echo "$i not found, please install and re run"
+    exit
+  fi
+done
 
-### Setup
 # Compile contracts
 yarn build
 
@@ -29,38 +146,35 @@ if [[ ! -f "$ADDRESS_BOOK" ]]; then
   echo '{}' > "$ADDRESS_BOOK"
 fi
 
-# Pre-deploy actions
-npx hardhat migrate:accounts --network "$NETWORK" --graph-config "$GRAPH_CONFIG"
-if [[ "$NETWORK" == *"localnitro"* ]]; then
-  npx hardhat migrate:accounts:nitro --network "$NETWORK" --graph-config "$GRAPH_CONFIG"
+### DEPLOY
+# Deploy L1
+echo "Deploying L1 protocol"
+pre_deploy "$L1_NETWORK" "$L1_GRAPH_CONFIG"
+deploy "$L1_NETWORK" "$L1_GRAPH_CONFIG" "$ADDRESS_BOOK"
+post_deploy "$L1_NETWORK" "$L1_GRAPH_CONFIG" "$ADDRESS_BOOK"
+
+# Deploy L2
+if [[ -n "$L2_NETWORK" ]]; then
+  echo "Deploying L2 protocol"
+  pre_deploy "$L2_NETWORK" "$L2_GRAPH_CONFIG"
+  deploy "$L2_NETWORK" "$L2_GRAPH_CONFIG" "$ADDRESS_BOOK"
+  post_deploy "$L2_NETWORK" "$L2_GRAPH_CONFIG" "$ADDRESS_BOOK"
 fi
 
-# Deploy protocol
-npx hardhat migrate \
-  --network "$NETWORK" \
-  --skip-confirmation \
-  --auto-mine \
-  --graph-config "$GRAPH_CONFIG" \
-  --address-book "$ADDRESS_BOOK"
+# Configure bridge
+if [[ -n "$L2_NETWORK" ]]; then
+  configure_bridge "$L1_NETWORK" "$L1_GRAPH_CONFIG" "$L2_NETWORK" "$L2_GRAPH_CONFIG" "$ADDRESS_BOOK"
+fi
 
-# Post deploy actions
-npx hardhat migrate:ownership --network "$NETWORK" --graph-config "$GRAPH_CONFIG" --address-book "$ADDRESS_BOOK"
-npx hardhat migrate:unpause --network "$NETWORK" --graph-config "$GRAPH_CONFIG" --address-book "$ADDRESS_BOOK"
 
-### Test
-# Run tests
-npx hardhat e2e --network "$NETWORK" --graph-config "$GRAPH_CONFIG" --address-book "$ADDRESS_BOOK"
+### TEST
+# Run e2e tests
+test_e2e "$L1_NETWORK" "$L1_GRAPH_CONFIG" "$ADDRESS_BOOK"
+test_e2e "$L2_NETWORK" "$L2_GRAPH_CONFIG" "$ADDRESS_BOOK"
 
 # Skip GRT scenarios in L2 as we don't have bridged GRT yet
-if [[ "$NETWORK" !=  "localnitrol2" ]]; then
-  npx hardhat e2e:scenario create-subgraphs --network "$NETWORK" --graph-config "$GRAPH_CONFIG" --address-book "$ADDRESS_BOOK"
-  npx hardhat e2e:scenario open-allocations --network "$NETWORK" --graph-config "$GRAPH_CONFIG" --address-book "$ADDRESS_BOOK"
-fi
-
-# skip close-allocations for arbitrum testnodes as we can't advance epoch
-if [[ "$NETWORK" !=  *"localnitro"* ]]; then
-  npx hardhat e2e:scenario close-allocations --network "$NETWORK" --graph-config "$GRAPH_CONFIG" --address-book "$ADDRESS_BOOK"
-fi
+test_e2e_scenarios "$L1_NETWORK" "$L1_GRAPH_CONFIG" "$ADDRESS_BOOK"
+test_e2e_scenarios "$L2_NETWORK" "$L2_GRAPH_CONFIG" "$ADDRESS_BOOK"
 
 ### Cleanup
 # Exit error mode so the evm instance always gets killed
diff --git a/tasks/deployment/unpause.ts b/tasks/deployment/unpause.ts
@@ -2,24 +2,35 @@ import { task } from 'hardhat/config'
 import { cliOpts } from '../../cli/defaults'
 import GraphChain from '../../gre/helpers/network'
 
-task('migrate:unpause', 'Unpause protocol and bridge')
+task('migrate:unpause:protocol', 'Unpause protocol')
   .addOptionalParam('addressBook', cliOpts.addressBook.description)
   .addOptionalParam('graphConfig', cliOpts.graphConfig.description)
   .setAction(async (taskArgs, hre) => {
     const graph = hre.graph(taskArgs)
     const { governor } = await graph.getNamedAccounts()
-    const { Controller, L1GraphTokenGateway, L2GraphTokenGateway } = graph.contracts
+    const { Controller } = graph.contracts
 
     console.log('> Unpausing protocol')
     const tx = await Controller.connect(governor).setPaused(false)
     await tx.wait()
 
+    console.log('Done!')
+  })
+
+task('migrate:unpause:bridge', 'Unpause bridge')
+  .addOptionalParam('addressBook', cliOpts.addressBook.description)
+  .addOptionalParam('graphConfig', cliOpts.graphConfig.description)
+  .setAction(async (taskArgs, hre) => {
+    const graph = hre.graph(taskArgs)
+    const { governor } = await graph.getNamedAccounts()
+    const { L1GraphTokenGateway, L2GraphTokenGateway } = graph.contracts
+
     console.log('> Unpausing bridge')
     const GraphTokenGateway = GraphChain.isL2(graph.chainId)
       ? L2GraphTokenGateway
       : L1GraphTokenGateway
-    const tx2 = await GraphTokenGateway.connect(governor).setPaused(false)
-    await tx2.wait()
+    const tx = await GraphTokenGateway.connect(governor).setPaused(false)
+    await tx.wait()
 
     console.log('Done!')
   })

Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ describe('[L1] L1GraphTokenGateway configuration', function () {`
`77`	`77`	`'0x00',`
`78`	`78`	`)`
`79`	`79`
`80`		`- await expect(tx).revertedWith('INBOX_NOT_SET')`
	`80`	`+ await expect(tx).revertedWith('NOT_FROM_BRIDGE')`
`81`	`81`	`})`
`82`	`82`	`})`
`83`	`83`	`})`