Merge pull request #751 from graphprotocol/l2-public-testnet

L2 public testnet deployment and related fixes

Author: pcarranzav

.github/workflows/e2e.yml

@@ -3,6 +3,14 @@ name: Run E2E tests
 on:
   push:
     branches: [dev]
+    paths:
+      - contracts/**
+      - config/**
+      - e2e/**
+      - cli/**
+      - tasks/**
+      - scripts/**
+      - hardhat.config.ts
   pull_request: {}
 
 jobs:
@@ -25,9 +33,7 @@ jobs:
         run: |
           git clone https://github.com/edgeandnode/nitro
           pushd nitro
-          git checkout ci
           git submodule update --init --recursive
           ./test-node.bash --init --no-blockscout --detach
           popd
-          NETWORK=localnitrol1 ADDRESS_BOOK=addresses.json GRAPH_CONFIG=config/graph.localhost.yml yarn test:e2e
-          NETWORK=localnitrol2 ADDRESS_BOOK=addresses.json GRAPH_CONFIG=config/graph.arbitrum-localhost.yml yarn test:e2e
+          L1_NETWORK=localnitrol1 L2_NETWORK=localnitrol2 yarn test:e2e

.github/workflows/gre.yml

@@ -3,6 +3,8 @@ name: Run GRE tests
 on:
   push:
     branches: [dev]
+    paths:
+      - gre/**
   pull_request: {}
 
 jobs:

.gitignore

@@ -19,3 +19,12 @@ bin/
 # Coverage and other reports
 /reports
 coverage.json
+
+# Local test files
+addresses-local.json
+localNetwork.json
+arbitrum-addresses-local.json
+tx-*.log
+
+# Keys
+.keystore

DEPLOYMENT.md

@@ -40,7 +40,7 @@ To deploy to a different network execute:
 yarn deploy -- --network {networkName}
 
 # Example
-yarn deploy -- --network kovan
+yarn deploy -- --network goerli
 ```
 
 The network must be configured in the `hardhat.config.ts` as explained in https://hardhat.org/config.
@@ -100,7 +100,7 @@ Some contracts require the address from previously deployed contracts. For that
 ### Deploying a new testnet
 
 1. Make sure contracts are up to date as you please.
-2. `yarn deploy-rinkeby` to deploy to Rinkeby. This will create new contracts with new addresses in `addresses.json`.
+2. `yarn deploy-goerli` to deploy to Goerli. This will create new contracts with new addresses in `addresses.json`.
 3. Update the `package.json` and `package-lock.json` files with the new package version and publish a new npm package with `npm publish`. You can dry-run the files to be uploaded by running `npm publish --dry-run`.
 4. Merge this update into master, branch off and save for whatever version of the testnet is going on, and then tag this on the github repo, pointing to your branch (ex. at `testnet-phase-1` branch). This way we can always get the contract code for testnet, while continuing to do work on mainnet.
 5. Pull the updated package into the subgraph, and other apps that depend on the package.json.

README.md

@@ -63,7 +63,7 @@ yarn add @graphprotocol/contracts
 
 # Contract Addresses
 
-The testnet runs on Rinkeby, while mainnet is on Ethereum Mainnet. The addresses for both of these can be found in `./addresses.json`.
+The testnet runs on Goerli, while mainnet is on Ethereum Mainnet. The addresses for both of these can be found in `./addresses.json`.
 
 # Local Setup
 
@@ -92,7 +92,7 @@ The most straightforward way to interact with the contracts is through the hardh
 
 ```
 # A console to interact with testnet contracts
-npx hardhat console --network rinkeby
+npx hardhat console --network goerli
 ```
 
 ### Hardhat Tasks

TESTING.md

@@ -33,37 +33,52 @@ There are several types of e2e tests which can be run separately:
   - Read and write interactions with the blockchain. _Requires an account with sufficient balance!_
   - Example: a test validating that a user can add signal to a subgraph.
 
-### Hardhat local node
+### Hardhat local node (L1)
 
-To run all e2e tests against a hardhat local node run:
+It can be useful to run E2E tests against a fresh protocol deployment on L1, this can be done with the following:
 
 ```bash
-yarn test:e2e
+L1_NETWORK=localhost yarn test:e2e
 ```
 
-The command will perform the following actions:
+The command will:
+- start a hardhat local node
+- deploy the L1 protocol
+- configure the new L1 deployment
+- Run all L1 e2e tests
 
-- Start a hardhat node (localhost)
-- Run `migrate:accounts` hardhat task to create keys for all protocol roles (deployer, governor, arbiter, etc). This currently doesn't support multisig accounts.
-- Run `migrate` hardhat task to deploy the protocol
-- Run `migrate:ownership` hardhat task to transfer ownership of governed contracts to the governor
-- Run `migrate:unpause` to unpause the protocol
-- Run `e2e` hardhat task to run all deployment tests (config and init)
-- Run `e2e:scenario` hardhat task to run a scenario
+### Arbitrum Nitro testnodes (L1/L2)
+
+If you want to test the protocol on an L1/L2 setup, you can run:
+
+```bash
+L1_NETWORK=localnitrol1 L2_NETWORK=localnitrol2 yarn test:e2e
+```
+
+In this case the command will:
+- deploy the L1 protocol
+- configure the new L1 deployment
+- deploy the L2 protocol
+- configure the new L2 deployment
+- configure the L1/L2 bridge
+- Run all L1 e2e tests
+- Run all L2 e2e tests
+
+Note that you'll need to setup the testnodes before running the tests. See [Quick Setup](https://github.com/edgeandnode/nitro#quick-setup) for details on how to do this.
 
 ### Other networks
 
 To run tests against a live testnet or even mainnet run:
 
 ```bash
 # All e2e tests
-npx hardhat e2e --network <network> --graph-config config/graph.<network>.yml
+ARBITRUM_ADDRESS_BOOK=<arbitrum-address-book> npx hardhat e2e --network <network> --l1-graph-config config/graph.<l1-network>.yml --l2-graph-config config/graph.<l2-network>.yml
 
 # Only deployment config tests
-npx hardhat e2e:config --network <network> --graph-config config/graph.<network>.yml
+ARBITRUM_ADDRESS_BOOK=<arbitrum-address-book> npx hardhat e2e:config --network <network> --l1-graph-config config/graph.<l1-network>.yml --l2-graph-config config/graph.<l2-network>.yml
 
 # Only deployment init tests
-npx hardhat e2e:init --network <network> --graph-config config/graph.<network>.yml
+ARBITRUM_ADDRESS_BOOK=<arbitrum-address-book> npx hardhat e2e:init --network <network> --l1-graph-config config/graph.<l1-network>.yml --l2-graph-config config/graph.<l2-network>.yml
 
 # Only a specific scenario
 npx hardhat e2e:scenario <scenario> --network <network> --graph-config config/graph.<network>.yml
@@ -82,26 +97,4 @@ Scenarios are defined by an optional script and a test file:
    - They run before the test file.
 - Test file
    - Should be named e2e/scenarios/{scenario-name}.test.ts.
-   - Standard chai/mocha/hardhat/ethers test file.
-
-## Setting up Arbitrum's testnodes
-
-Arbitrum provides a quick way of setting up L1 and L2 testnodes for local development and testing. The following steps will guide you through the process of setting them up. Note that a local installation of Docker and Docker Compose is required.
-
-```bash
-git clone https://github.com/offchainlabs/nitro
-cd nitro
-git submodule update --init --recursive
-
-# Apply any changes you might want, see below for more info, and then start the testnodes
-./test-node.bash --init
-```
-
-**Useful information**
-- L1 RPC: [http://localhost:8545](http://localhost:8545/)
-- L2 RPC: [http://localhost:8547](http://localhost:8547/)
-- Blockscout explorer (L2 only): [http://localhost:4000/](http://localhost:4000/)
-- Prefunded genesis key (L1 and L2): `e887f7d17d07cc7b8004053fb8826f6657084e88904bb61590e498ca04704cf2`
-
-**Enable automine on L1**
-In `docker-compose.yml` file edit the `geth` service command by removing the `--dev.period 1` flag.
+   - Standard chai/mocha/hardhat/ethers test file.