feat: e2e protocol deployment testing (#631)

* feat: add deployment e2e tests

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

Author: tmigone

README.md

@@ -83,12 +83,39 @@ Testing is done with the following stack:
 - [Typescript](https://www.typescriptlang.org/)
 - [Ethers](https://docs.ethers.io/v5/)
 
-To test all files, use `yarn test`. To test a single file run:
+## Contracts
+To test all the smart contracts, use `yarn test`. 
+To test a single file run: `npx hardhat test test/<FILE_NAME>.ts`
+
+## E2E Testing
+
+End to end tests are also available and can be run against a local network or a live network. These can be useful to validate a protocol deployment is configured and working as expected.
+
+### Hardhat local node
+To run e2e tests against a hardhat local node run:
+
+```bash
+yarn test:e2e
+```
+
+The command will invoke several hardhat tasks, including:
+
+- 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 tests
+
+### Other networks
+To run tests against a live testnet or even mainnet run:
 
 ```bash
-npx hardhat test test/<FILE_NAME>.ts
+GRAPH_CONFIG=config/graph.<network>.yml ADDRESS_BOOK=addresses.json npx hardhat test e2e/**/*.ts --network <network>
 ```
 
+This command will only run the tests so you need to be sure the protocol is already deployed and the graph config file and address book files are up to date.
+
 # Interacting with the contracts
 
 There are three ways to interact with the contracts through this repo:

addresses.json

@@ -1,5 +1,6 @@
 import fs from 'fs'
 import YAML from 'yaml'
+import { Scalar, YAMLMap } from 'yaml/types'
 
 import { AddressBook } from './address-book'
 import { CLIEnvironment } from './env'
@@ -110,3 +111,44 @@ export function getContractConfig(
     proxy,
   }
 }
+
+// YAML helper functions
+const getNode = (doc: YAML.Document.Parsed, path: string[]): YAMLMap => {
+  try {
+    let node: YAMLMap
+    for (const p of path) {
+      node = node === undefined ? doc.get(p) : node.get(p)
+    }
+    return node
+  } catch (error) {
+    throw new Error(`Could not find node: ${path}.`)
+  }
+}
+
+function getItem(node: YAMLMap, key: string): Scalar {
+  if (!node.has(key)) {
+    throw new Error(`Could not find item: ${key}.`)
+  }
+  return node.get(key, true) as Scalar
+}
+
+function getItemFromPath(doc: YAML.Document.Parsed, path: string) {
+  const splitPath = path.split('/')
+  const itemKey = splitPath.pop()
+
+  const node = getNode(doc, splitPath)
+  const item = getItem(node, itemKey)
+  return item
+}
+
+export const getItemValue = (doc: YAML.Document.Parsed, path: string): any => {
+  const item = getItemFromPath(doc, path)
+  return item.value
+}
+
+export const updateItemValue = (doc: YAML.Document.Parsed, path: string, value: any): boolean => {
+  const item = getItemFromPath(doc, path)
+  const updated = item.value !== value
+  item.value = value
+  return updated
+}

cli/config.ts

@@ -18,6 +18,9 @@ import { BancorFormula } from '../build/types/BancorFormula'
 import { IENS } from '../build/types/IENS'
 import { GraphGovernance } from '../build/types/GraphGovernance'
 import { AllocationExchange } from '../build/types/AllocationExchange'
+import { SubgraphNFT } from '../build/types/SubgraphNFT'
+import { GraphCurationToken } from '../build/types/GraphCurationToken'
+import { SubgraphNFTDescriptor } from '../build/types/SubgraphNFTDescriptor'
 
 export interface NetworkContracts {
   EpochManager: EpochManager
@@ -34,6 +37,9 @@ export interface NetworkContracts {
   IENS: IENS
   GraphGovernance: GraphGovernance
   AllocationExchange: AllocationExchange
+  SubgraphNFT: SubgraphNFT
+  SubgraphNFTDescriptor: SubgraphNFTDescriptor
+  GraphCurationToken: GraphCurationToken
 }
 
 export const loadContracts = (

cli/contracts.ts

@@ -2,6 +2,9 @@ general:
   arbitrator: &arbitrator "0xFD01aa87BeB04D0ac764FC298aCFd05FfC5439cD" # Arbitration Council
   governor: &governor "0xf1135bFF22512FF2A585b8d4489426CE660f204c" # Graph Council
   authority: &authority "0x52e498aE9B8A5eE2A5Cd26805F06A9f29A7F489F" # Authority that signs payment vouchers
+  availabilityOracle: &availabilityOracle "0x14053D40ea2E81D3AB0739728a54ab84F21200F9" # Subgraph Availability Oracle
+  pauseGuardian: &pauseGuardian "0x6855D551CaDe60754D145fb5eDCD90912D860262" # Protocol pause guardian
+  allocationExchangeOwner: &allocationExchangeOwner "0xf1135bFF22512FF2A585b8d4489426CE660f204c" # Allocation Exchange owner
 
 contracts:
   Controller:
@@ -108,7 +111,7 @@ contracts:
     init:
       graphToken: "${{GraphToken.address}}"
       staking: "${{Staking.address}}"
-      governor: *governor
+      governor: *allocationExchangeOwner
       authority: *authority
     calls:
       - fn: "approveAll"

config/graph.goerli.yml

@@ -0,0 +1,133 @@
+general:
+  arbitrator: &arbitrator "0xFFcf8FDEE72ac11b5c542428B35EEF5769C409f0" # Arbitration Council
+  governor: &governor "0x22d491Bde2303f2f43325b2108D26f1eAbA1e32b" # Governor 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
+
+contracts:
+  Controller:
+    calls:
+      - fn: "setContractProxy"
+        id: "0xe6876326c1291dfcbbd3864a6816d698cd591defc7aa2153d7f9c4c04016c89f" # keccak256('Curation')
+        contractAddress: "${{Curation.address}}"
+      - fn: "setContractProxy"
+        id: "0x39605a6c26a173774ca666c67ef70cf491880e5d3d6d0ca66ec0a31034f15ea3" # keccak256('GNS')
+        contractAddress: "${{GNS.address}}"
+      - fn: "setContractProxy"
+        id: "0xf942813d07d17b56de9a9afc8de0ced6e8c053bbfdcc87b7badea4ddcf27c307" # keccak256('DisputeManager')
+        contractAddress: "${{DisputeManager.address}}"
+      - fn: "setContractProxy"
+        id: "0xc713c3df6d14cdf946460395d09af88993ee2b948b1a808161494e32c5f67063" # keccak256('EpochManager')
+        contractAddress: "${{EpochManager.address}}"
+      - fn: "setContractProxy"
+        id: "0x966f1e8d8d8014e05f6ec4a57138da9be1f7c5a7f802928a18072f7c53180761" # keccak256('RewardsManager')
+        contractAddress: "${{RewardsManager.address}}"
+      - fn: "setContractProxy"
+        id: "0x1df41cd916959d1163dc8f0671a666ea8a3e434c13e40faef527133b5d167034" # keccak256('Staking')
+        contractAddress: "${{Staking.address}}"
+      - fn: "setContractProxy"
+        id: "0x45fc200c7e4544e457d3c5709bfe0d520442c30bbcbdaede89e8d4a4bbc19247" # keccak256('GraphToken')
+        contractAddress: "${{GraphToken.address}}"
+      - fn: "setPauseGuardian"
+        pauseGuardian: *pauseGuardian
+      - fn: "transferOwnership"
+        owner: *governor
+  GraphProxyAdmin:
+    calls:
+      - fn: "transferOwnership"
+        owner: *governor
+  ServiceRegistry:
+    proxy: true
+    init:
+      controller: "${{Controller.address}}"
+  EpochManager:
+    proxy: true
+    init:
+      controller: "${{Controller.address}}"
+      lengthInBlocks: 554 # length in hours = lengthInBlocks*13/60/60 (~13 second blocks)
+  GraphToken:
+    init:
+      initialSupply: "10000000000000000000000000000" # in wei
+    calls:
+      - fn: "addMinter"
+        minter: "${{RewardsManager.address}}"
+      - fn: "renounceMinter"
+      - fn: "transferOwnership"
+        owner: *governor
+  Curation:
+    proxy: true
+    init:
+      controller: "${{Controller.address}}"
+      bondingCurve: "${{BancorFormula.address}}"
+      curationTokenMaster: "${{GraphCurationToken.address}}"
+      reserveRatio: 500000 # in parts per million
+      curationTaxPercentage: 10000 # in parts per million
+      minimumCurationDeposit: "1000000000000000000" # in wei
+  DisputeManager:
+    proxy: true
+    init:
+      controller: "${{Controller.address}}"
+      arbitrator: *arbitrator
+      minimumDeposit: "10000000000000000000000" # in wei
+      fishermanRewardPercentage: 500000 # in parts per million
+      idxSlashingPercentage: 25000 # in parts per million
+      qrySlashingPercentage: 25000 # in parts per million
+  GNS:
+    proxy: true
+    init:
+      controller: "${{Controller.address}}"
+      bondingCurve: "${{BancorFormula.address}}"
+      subgraphNFT: "${{SubgraphNFT.address}}"
+    calls:
+      - fn: "approveAll"
+  SubgraphNFT:
+    init:
+      governor: "${{Env.deployer}}"
+    calls:
+      - fn: "setTokenDescriptor"
+        tokenDescriptor: "${{SubgraphNFTDescriptor.address}}"
+      - fn: "setMinter"
+        minter: "${{GNS.address}}"
+      - fn: "transferOwnership"
+        owner: *governor
+  Staking:
+    proxy: true
+    init:
+      controller: "${{Controller.address}}"
+      minimumIndexerStake: "100000000000000000000000" # in wei
+      thawingPeriod: 6646 # in blocks
+      protocolPercentage: 10000 # in parts per million
+      curationPercentage: 100000 # in parts per million
+      channelDisputeEpochs: 2 # in epochs
+      maxAllocationEpochs: 4 # in epochs
+      delegationUnbondingPeriod: 12 # in epochs
+      delegationRatio: 16 # delegated stake to indexer stake multiplier
+      rebateAlphaNumerator: 77 # rebateAlphaNumerator / rebateAlphaDenominator
+      rebateAlphaDenominator: 100 # rebateAlphaNumerator / rebateAlphaDenominator
+    calls:
+      - fn: "setDelegationTaxPercentage"
+        delegationTaxPercentage: 5000 # parts per million
+      - fn: "setSlasher"
+        slasher: "${{DisputeManager.address}}"
+        allowed: true
+      - fn: "setAssetHolder"
+        assetHolder: "${{AllocationExchange.address}}"
+        allowed: true
+  RewardsManager:
+    proxy: true
+    init:
+      controller: "${{Controller.address}}"
+      issuanceRate: "1000000012184945188" # per block increase of total supply, blocks in a year = 365*60*60*24/13
+    calls:
+      - fn: "setSubgraphAvailabilityOracle"
+        subgraphAvailabilityOracle: *availabilityOracle
+  AllocationExchange:
+    init:
+      graphToken: "${{GraphToken.address}}"
+      staking: "${{Staking.address}}"
+      governor: *allocationExchangeOwner
+      authority: *authority
+    calls:
+      - fn: "approveAll"

config/graph.localhost.yml

@@ -2,6 +2,9 @@ general:
   arbitrator: &arbitrator "0xE1FDD398329C6b74C14cf19100316f0826a492d3" # Arbitration Council
   governor: &governor "0x48301Fe520f72994d32eAd72E2B6A8447873CF50" # Graph Council
   authority: &authority "0x982D10c56b8BBbD6e09048F5c5f01b43C65D5aE0" # Authority that signs payment vouchers
+  availabilityOracle: &availabilityOracle "0x5d3B6F98F1cCdF873Df0173CDE7335874a396c4d" # Subgraph Availability Oracle
+  pauseGuardian: &pauseGuardian "0x8290362Aba20D17c51995085369E001Bad99B21c" # Protocol pause guardian
+  allocationExchangeOwner: &allocationExchangeOwner "0x74Db79268e63302d3FC69FB5a7627F7454a41732" # Allocation Exchange owner
 
 contracts:
   Controller:

config/graph.mainnet.yml

@@ -0,0 +1,31 @@
+import { expect } from 'chai'
+import hre from 'hardhat'
+import { getItemValue } from '../../cli/config'
+
+describe('AllocationExchange deployment', () => {
+  const {
+    graphConfig,
+    contracts: { AllocationExchange, GraphToken, Staking },
+  } = hre.graph()
+
+  it('should be owned by allocationExchangeOwner', async function () {
+    const owner = await AllocationExchange.governor()
+    const allocationExchangeOwner = getItemValue(graphConfig, 'general/allocationExchangeOwner')
+    expect(owner).eq(allocationExchangeOwner)
+  })
+
+  it('should accept vouchers from authority', async function () {
+    const authorityAddress = getItemValue(graphConfig, 'general/authority')
+    const allowed = await AllocationExchange.authority(authorityAddress)
+    expect(allowed).eq(true)
+  })
+
+  // graphToken and staking are private variables so we can't verify
+  it.skip('graphToken should match the GraphToken deployment address')
+  it.skip('staking should match the Staking deployment address')
+
+  it('should allow Staking contract to spend MAX_UINT256 tokens on AllocationExchange behalf', async function () {
+    const allowance = await GraphToken.allowance(AllocationExchange.address, Staking.address)
+    expect(allowance).eq(hre.ethers.constants.MaxUint256)
+  })
+})

e2e/deployment/allocationExchange.test.ts

@@ -0,0 +1,45 @@
+import { expect } from 'chai'
+import hre, { ethers } from 'hardhat'
+import { getItemValue } from '../../cli/config'
+
+describe('Controller deployment', () => {
+  const { contracts, graphConfig } = hre.graph()
+  const { Controller } = contracts
+
+  const proxyContracts = [
+    'Curation',
+    'GNS',
+    'DisputeManager',
+    'EpochManager',
+    'RewardsManager',
+    'Staking',
+    'GraphToken',
+  ]
+
+  const proxyShouldMatchDeployed = async (contractName: string) => {
+    const curationAddress = await Controller.getContractProxy(
+      ethers.utils.solidityKeccak256(['string'], [contractName]),
+    )
+    expect(curationAddress).eq(contracts[contractName].address)
+  }
+
+  it('should be owned by governor', async function () {
+    const owner = await Controller.governor()
+    const governorAddress = getItemValue(graphConfig, 'general/governor')
+    expect(owner).eq(governorAddress)
+  })
+
+  it('pause guardian should be able to pause protocol', async function () {
+    const pauseGuardianAddress = getItemValue(graphConfig, 'general/pauseGuardian')
+    const pauseGuardian = await Controller.pauseGuardian()
+    expect(pauseGuardian).eq(pauseGuardianAddress)
+  })
+
+  describe('proxy contract', async function () {
+    for (const contract of proxyContracts) {
+      it(`${contract} should match deployed`, async function () {
+        await proxyShouldMatchDeployed(contract)
+      })
+    }
+  })
+})

e2e/deployment/controller.test.ts

@@ -0,0 +1,43 @@
+import { expect } from 'chai'
+import hre from 'hardhat'
+import { getItemValue } from '../../cli/config'
+
+describe('Curation deployment', () => {
+  const {
+    graphConfig,
+    contracts: { Controller, Curation, BancorFormula, GraphCurationToken },
+  } = hre.graph()
+
+  it('should be controlled by Controller', async function () {
+    const controller = await Curation.controller()
+    expect(controller).eq(Controller.address)
+  })
+
+  it('bondingCurve should match the BancorFormula deployment address', async function () {
+    const bondingCurve = await Curation.bondingCurve()
+    expect(bondingCurve).eq(BancorFormula.address)
+  })
+
+  it('curationTokenMaster should match the GraphCurationToken deployment address', async function () {
+    const bondingCurve = await Curation.curationTokenMaster()
+    expect(bondingCurve).eq(GraphCurationToken.address)
+  })
+
+  it('defaultReserveRatio should match "reserveRatio" in the config file', async function () {
+    const value = await Curation.defaultReserveRatio()
+    const expected = getItemValue(graphConfig, 'contracts/Curation/init/reserveRatio')
+    expect(value).eq(expected)
+  })
+
+  it('curationTaxPercentage should match "curationTaxPercentage" in the config file', async function () {
+    const value = await Curation.curationTaxPercentage()
+    const expected = getItemValue(graphConfig, 'contracts/Curation/init/curationTaxPercentage')
+    expect(value).eq(expected)
+  })
+
+  it('minimumCurationDeposit should match "minimumCurationDeposit" in the config file', async function () {
+    const value = await Curation.minimumCurationDeposit()
+    const expected = getItemValue(graphConfig, 'contracts/Curation/init/minimumCurationDeposit')
+    expect(value).eq(expected)
+  })
+})