feat: refactor graph runtime environment hardhat extension (#636)

* feat: refactor graph runtime environment hardhat extension

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

Author: tmigone

.env.example

@@ -2,5 +2,5 @@ MNEMONIC=
 ETHERSCAN_API_KEY=
 INFURA_KEY=
 ADDRESS_BOOK="addresses.json"
-GRAPH_CONFIG=""config/graph.mainnet.yml""
+GRAPH_CONFIG="config/graph.mainnet.yml"
 PROVIDER_URL="http://localhost:8545"

cli/README.md

@@ -11,7 +11,7 @@ MNEMONIC=
 ETHERSCAN_API_KEY=
 INFURA_KEY=
 ADDRESS_BOOK="addresses.json"
-GRAPH_CONFIG=""config/graph.mainnet.yml""
+GRAPH_CONFIG="config/graph.mainnet.yml"
 PROVIDER_URL="http://localhost:8545"
 ```
 

tasks/deployment/config.ts

@@ -1,13 +1,12 @@
 import { task } from 'hardhat/config'
 import '@nomiclabs/hardhat-ethers'
 import { cliOpts } from '../../cli/defaults'
-import { readConfig, writeConfig } from '../../cli/config'
+import { writeConfig } from '../../cli/config'
 import YAML from 'yaml'
 
 import { Scalar, YAMLMap } from 'yaml/types'
-import { HardhatRuntimeEnvironment } from 'hardhat/types'
-import fs from 'fs'
 import { confirm } from '../../cli/helpers'
+import { NetworkContracts } from '../../cli/contracts'
 
 interface Contract {
   name: string
@@ -100,10 +99,6 @@ task('update-config', 'Update graph config parameters with onchain data')
     const dryRun = taskArgs.dryRun
     const skipConfirmation = taskArgs.skipConfirmation
 
-    if (!fs.existsSync(configFile)) {
-      throw new Error(`Could not find config file: ${configFile}`)
-    }
-
     console.log('## Update graph config ##')
     console.log(`Network: ${networkName}`)
     console.log(`Config file: ${configFile}\n`)
@@ -117,18 +112,18 @@ task('update-config', 'Update graph config parameters with onchain data')
       if (!sure) return
     }
 
-    const graphConfig = readConfig(configFile, true)
+    const { graphConfig, contracts } = hre.graph({ graphConfig: configFile })
 
     // general parameters
     console.log(`> General`)
     for (const param of generalParams) {
-      await updateGeneralParams(hre, param, graphConfig)
+      await updateGeneralParams(contracts, param, graphConfig)
     }
 
     // contracts parameters
     for (const contract of contractList) {
       console.log(`> ${contract.name}`)
-      await updateContractParams(hre, contract, graphConfig)
+      await updateContractParams(contracts, contract, graphConfig)
     }
 
     if (dryRun) {
@@ -140,24 +135,24 @@ task('update-config', 'Update graph config parameters with onchain data')
   })
 
 const updateGeneralParams = async (
-  hre: HardhatRuntimeEnvironment,
+  contracts: NetworkContracts,
   param: GeneralParam,
   config: YAML.Document.Parsed,
 ) => {
-  const value = await hre.contracts[param.contract][param.name]()
+  const value = await contracts[param.contract][param.name]()
   const updated = updateItem(config, `general/${param.name}`, value)
   if (updated) {
     console.log(`\t- Updated ${param.name} to ${value}`)
   }
 }
 
 const updateContractParams = async (
-  hre: HardhatRuntimeEnvironment,
+  contracts: NetworkContracts,
   contract: Contract,
   config: YAML.Document.Parsed,
 ) => {
   for (const param of contract.initParams) {
-    let value = await hre.contracts[contract.name][param.getter ?? param.name]()
+    let value = await contracts[contract.name][param.getter ?? param.name]()
     if (param.type === 'BigNumber') {
       if (param.format === 'number') {
         value = value.toNumber()

tasks/gre.ts

@@ -1,48 +1,34 @@
-import { Contract } from 'ethers'
 import { HardhatRuntimeEnvironment } from 'hardhat/types'
 import { extendEnvironment } from 'hardhat/config'
 import { lazyObject } from 'hardhat/plugins'
-import '@nomiclabs/hardhat-ethers'
 
-import { cliOpts } from '../cli/defaults'
 import { getAddressBook } from '../cli/address-book'
-import { loadContracts, NetworkContracts } from '../cli/contracts'
+import { loadContracts } from '../cli/contracts'
+import { readConfig } from '../cli/config'
+import { GREOptions } from './type-extensions'
+import fs from 'fs'
 
 // Graph Runtime Environment (GRE) extensions for the HRE
-
-declare module 'hardhat/types/runtime' {
-  export interface HardhatRuntimeEnvironment {
-    contracts: NetworkContracts
-  }
-}
-
-interface ConsoleNetworkContracts extends NetworkContracts {
-  connect: () => void
-}
-
 extendEnvironment((hre: HardhatRuntimeEnvironment) => {
-  hre['contracts'] = lazyObject(() => {
-    const chainId = hre.network.config.chainId.toString()
-    const provider = hre.ethers.provider
-    const addressBook = getAddressBook(cliOpts.addressBook.default, chainId)
-    const contracts = loadContracts(addressBook, provider) as ConsoleNetworkContracts
+  hre.graph = (opts: GREOptions = {}) => {
+    const chainId = hre.network.config.chainId?.toString() ?? '1337'
+    const addressBookPath = opts.addressBook ?? process.env.ADDRESS_BOOK
+    const graphConfigPath = opts.graphConfig ?? process.env.GRAPH_CONFIG
 
-    // Connect contracts to a signing account
-    contracts.connect = async function (n = 0) {
-      const accounts = await hre.ethers.getSigners()
-      const senderAccount = accounts[n]
-      console.log(`> Sender set to ${senderAccount.address}`)
-      for (const [k, contract] of Object.entries(contracts)) {
-        if (contract instanceof Contract) {
-          contracts[k] = contract.connect(senderAccount)
-        }
-      }
+    if (!fs.existsSync(addressBookPath)) {
+      throw new Error(`Address book not found: ${addressBookPath}`)
     }
 
-    return contracts
-  })
-  hre['provider'] = lazyObject(() => hre.ethers.provider)
-  hre['accounts'] = function () {
-    return hre.ethers.getSigners()
+    if (!fs.existsSync(graphConfigPath)) {
+      throw new Error(`Graph config not found: ${graphConfigPath}`)
+    }
+
+    return {
+      addressBook: lazyObject(() => getAddressBook(addressBookPath, chainId)),
+      graphConfig: lazyObject(() => readConfig(graphConfigPath, true)),
+      contracts: lazyObject(() =>
+        loadContracts(getAddressBook(addressBookPath, chainId), hre.ethers.provider),
+      ),
+    }
   }
 })

tasks/test-upgrade.ts

@@ -1,5 +1,4 @@
 import fs from 'fs'
-
 import { task } from 'hardhat/config'
 
 function saveProxyAddresses(data) {

tasks/type-extensions.d.ts

@@ -0,0 +1,17 @@
+import { AddressBook } from '../cli/address-book'
+import { NetworkContracts } from '../cli/contracts'
+
+interface GREOptions {
+  addressBook?: string
+  graphConfig?: string
+}
+
+declare module 'hardhat/types/runtime' {
+  export interface HardhatRuntimeEnvironment {
+    graph: (opts?: GREOptions) => {
+      contracts: NetworkContracts
+      graphConfig: any
+      addressBook: AddressBook
+    }
+  }
+}

tasks/verify/verify.ts

@@ -5,13 +5,11 @@ import { isFullyQualifiedName, parseFullyQualifiedName } from 'hardhat/utils/con
 import { TASK_COMPILE } from 'hardhat/builtin-tasks/task-names'
 import { loadEnv } from '../../cli/env'
 import { cliOpts } from '../../cli/defaults'
-import { getAddressBook } from '../../cli/address-book'
-import { getContractConfig, readConfig } from '../../cli/config'
+import { getContractConfig } from '../../cli/config'
 import { Wallet } from 'ethers'
-import { NomicLabsHardhatPluginError } from 'hardhat/plugins'
 import fs from 'fs'
 import path from 'path'
-import { HardhatRuntimeEnvironment } from 'hardhat/types'
+import { HardhatRuntimeEnvironment } from 'hardhat/types/runtime'
 
 task('sourcify', 'Verifies contract on sourcify')
   .addPositionalParam('address', 'Address of the smart contract to verify', undefined, types.string)
@@ -46,7 +44,7 @@ task('sourcifyAll', 'Verifies all contracts on sourcify')
       throw new Error('Cannot verify contracts without a network')
     }
     console.log(`> Verifying all contracts on chain ${chainName}[${chainId}]...`)
-    const addressBook = getAddressBook(cliOpts.addressBook.default, chainId.toString())
+    const { addressBook } = hre.graph({ addressBook: _args.addressBook })
 
     for (const contractName of addressBook.listEntries()) {
       console.log(`\n> Verifying contract ${contractName}...`)
@@ -86,8 +84,10 @@ task('verifyAll', 'Verifies all contracts on etherscan')
     }
 
     console.log(`> Verifying all contracts on chain ${chainName}[${chainId}]...`)
-    const addressBook = getAddressBook(args.addressBook, chainId.toString())
-    const graphConfig = readConfig(args.graphConfig)
+    const { addressBook, graphConfig } = hre.graph({
+      addressBook: args.addressBook,
+      graphConfig: args.graphConfig,
+    })
 
     const accounts = await hre.ethers.getSigners()
     const env = await loadEnv(args, accounts[0] as unknown as Wallet)

tsconfig.json

@@ -8,15 +8,5 @@
     "resolveJsonModule": true,
     "esModuleInterop": true
   },
-  "exclude": ["dist", "node_modules"],
-  "files": [
-    "./hardhat.config.ts",
-    "./scripts/**/*.ts",
-    "./test/**/*.ts",
-    "node_modules/@nomiclabs/hardhat-ethers/internal/type-extensions.d.ts",
-    "node_modules/@nomiclabs/hardhat-etherscan/dist/src/type-extensions.d.ts",
-    "node_modules/@nomiclabs/hardhat-waffle/dist/src/type-extensions.d.ts",
-    "node_modules/@typechain/hardhat/dist/type-extensions.d.ts",
-    "./index.d.ts"
-  ]
+  "include": ["hardhat.config.ts", "index.d.ts", "scripts/**/*.ts", "test/**/*.ts", "tasks/**/*.ts"]
 }