feat: refactor deplyoment tooling for subgraph service

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

Author: tmigone

.gitignore

@@ -51,6 +51,7 @@ addresses-fork.json
 
 # Forge artifacts
 cache_forge
+
 # Graph client
 .graphclient
 
@@ -62,4 +63,6 @@ tx-builder-*.json
 **/chain-1377/
 **/horizon-localhost/
 **/horizon-hardhat/
+**/subgraph-service-localhost/
+**/subgraph-service-hardhat/
 !**/ignition/**/artifacts/

packages/hardhat-graph-protocol/src/config.ts

@@ -28,11 +28,7 @@ export function getAddressBookPath(
   }
 
   const normalizedAddressBookPath = normalizePath(addressBookPath, hre.config.paths.graph)
-  if (!fs.existsSync(normalizedAddressBookPath)) {
-    throw new GraphPluginError(`Address book not found: ${normalizedAddressBookPath}`)
-  }
-
-  logDebug(`Address book path found: ${normalizedAddressBookPath}`)
+  logDebug(`Address book path: ${normalizedAddressBookPath}`)
   return normalizedAddressBookPath
 }
 

packages/hardhat-graph-protocol/src/sdk/address-book.ts

@@ -76,11 +76,16 @@ export abstract class AddressBook<
     this.chainId = _chainId
 
     logDebug(`Loading address book from ${this.file}.`)
-    if (!fs.existsSync(this.file)) throw new Error(`Address book path provided does not exist!`)
+
+    // Create empty address book if file doesn't exist
+    if (!fs.existsSync(this.file)) {
+      const emptyAddressBook = { [this.chainId]: {} }
+      fs.writeFileSync(this.file, JSON.stringify(emptyAddressBook, null, 2))
+      logDebug(`Created new address book at ${this.file}`)
+    }
 
     // Load address book and validate its shape
-    // If it's empty, initialize it with an empty object
-    const fileContents = JSON.parse(fs.readFileSync(this.file, 'utf8') || '{}')
+    const fileContents = JSON.parse(fs.readFileSync(this.file, 'utf8'))
     if (!fileContents[this.chainId]) {
       fileContents[this.chainId] = {}
     }
@@ -98,6 +103,13 @@ export abstract class AddressBook<
     return this.validContracts
   }
 
+  entryExists(name: string): boolean {
+    if (!this.isContractName(name)) {
+      throw new Error(`Contract name ${name} is not a valid contract name`)
+    }
+    return this.addressBook[this.chainId][name] !== undefined
+  }
+
   /**
    * Get an entry from the address book
    *

packages/hardhat-graph-protocol/src/sdk/deployments/subgraph-service/contracts.ts

@@ -25,7 +25,7 @@ export const SubgraphServiceContractNameList = [
   'DisputeManager',
 ] as const
 
-const root = path.resolve(__dirname, '../../../../..') // hardhat-graph-protocol root
+const root = path.resolve(__dirname, '../../../..') // hardhat-graph-protocol root
 export const CONTRACTS_ARTIFACTS_PATH = path.resolve(root, 'node_modules', '@graphprotocol/contracts/build/contracts')
 export const SUBGRAPH_SERVICE_ARTIFACTS_PATH = path.resolve(root, 'node_modules', '@graphprotocol/subgraph-service/build/contracts')
 

packages/hardhat-graph-protocol/src/sdk/hardhat.base.config.ts

@@ -48,7 +48,8 @@ export const networksUserConfig: BaseNetworksUserConfig = {
       mnemonic: 'myth like bonus scare over problem client lizard pioneer submit female collect',
     },
     deployments: {
-      horizon: require.resolve('@graphprotocol/horizon/addresses-local.json'),
+      horizon: resolveLocalAddressBook('@graphprotocol/horizon/addresses.json'),
+      subgraphService: resolveLocalAddressBook('@graphprotocol/subgraph-service/addresses.json'),
     },
   },
   localhost: {
@@ -58,7 +59,8 @@ export const networksUserConfig: BaseNetworksUserConfig = {
       enabled: true,
     },
     deployments: {
-      horizon: require.resolve('@graphprotocol/horizon/addresses-local.json'),
+      horizon: resolveLocalAddressBook('@graphprotocol/horizon/addresses.json'),
+      subgraphService: resolveLocalAddressBook('@graphprotocol/subgraph-service/addresses.json'),
     },
   },
   arbitrumOne: {
@@ -77,6 +79,13 @@ export const networksUserConfig: BaseNetworksUserConfig = {
   },
 }
 
+// Local address books are not commited to GitHub so they might not exist
+// require.resolve will throw an error if the file does not exist, so we hack it a bit
+function resolveLocalAddressBook(path: string) {
+  const resolvedPath = require.resolve(path)
+  return resolvedPath.replace('addresses.json', 'addresses-local.json')
+}
+
 type BaseHardhatConfig = HardhatUserConfig &
   { etherscan: Partial<EtherscanConfig> } &
   { graph: GraphRuntimeEnvironmentOptions } &
@@ -91,6 +100,7 @@ export const hardhatBaseConfig: BaseHardhatConfig = {
   graph: {
     deployments: {
       horizon: require.resolve('@graphprotocol/horizon/addresses.json'),
+      subgraphService: require.resolve('@graphprotocol/subgraph-service/addresses.json'),
     },
   },
   etherscan: etherscanUserConfig,

packages/hardhat-graph-protocol/src/sdk/ignition/ignition.ts

@@ -5,7 +5,8 @@ require('json5/lib/register')
 
 import fs from 'fs'
 import path from 'path'
-import { AddressBook } from '../address-book'
+
+import type { AddressBook } from '../address-book'
 
 export function loadConfig(configPath: string, prefix: string, networkName: string): any {
   const configFileCandidates = [
@@ -24,36 +25,22 @@ export function loadConfig(configPath: string, prefix: string, networkName: stri
 }
 
 export function patchConfig(jsonData: any, patches: Record<string, any>) {
-  function recursivePatch(obj: any) {
-    if (typeof obj === 'object' && obj !== null) {
-      for (const key in obj) {
-        if (key in patches) {
-          obj[key] = patches[key]
+  function recursivePatch(obj: any, patchObj: any) {
+    if (typeof obj === 'object' && obj !== null && typeof patchObj === 'object' && patchObj !== null) {
+      for (const key in patchObj) {
+        if (obj.hasOwnProperty(key) && typeof obj[key] === 'object' && typeof patchObj[key] === 'object') {
+          // Both are objects, recursively merge
+          recursivePatch(obj[key], patchObj[key])
         } else {
-          recursivePatch(obj[key])
+          // Either not an object or new key, directly assign
+          obj[key] = patchObj[key]
         }
       }
     }
+    return obj
   }
 
-  recursivePatch(jsonData)
-  return jsonData
-}
-
-export function mergeConfigs(obj1: any, obj2: any) {
-  const merged = { ...obj1 }
-
-  for (const key in obj2) {
-    if (obj2.hasOwnProperty(key)) {
-      if (typeof obj2[key] === 'object' && obj2[key] !== null && obj1[key]) {
-        merged[key] = mergeConfigs(obj1[key], obj2[key])
-      } else {
-        merged[key] = obj2[key]
-      }
-    }
-  }
-
-  return merged
+  return recursivePatch(jsonData, patches)
 }
 
 export function saveToAddressBook<ChainId extends number, ContractName extends string>(
@@ -71,7 +58,7 @@ export function saveToAddressBook<ChainId extends number, ContractName extends s
     if (ignitionContractName.includes('_Proxy_')) {
       const contractName = ignitionContractName.replace(/(Transparent_Proxy_|Graph_Proxy_)/, '') as ContractName
       const proxy = ignitionContractName.includes('Transparent_Proxy_') ? 'transparent' : 'graph'
-      const entry = addressBook.getEntry(contractName)
+      const entry = addressBook.entryExists(contractName) ? addressBook.getEntry(contractName) : {}
       addressBook.setEntry(contractName, {
         ...entry,
         address: (contract as any).target,
@@ -83,7 +70,7 @@ export function saveToAddressBook<ChainId extends number, ContractName extends s
     if (ignitionContractName.includes('_ProxyAdmin_')) {
       const contractName = ignitionContractName.replace(/(Transparent_ProxyAdmin_|Graph_ProxyAdmin_)/, '') as ContractName
       const proxy = ignitionContractName.includes('Transparent_ProxyAdmin_') ? 'transparent' : 'graph'
-      const entry = addressBook.getEntry(contractName)
+      const entry = addressBook.entryExists(contractName) ? addressBook.getEntry(contractName) : {}
       addressBook.setEntry(contractName, {
         ...entry,
         proxy,
@@ -94,7 +81,7 @@ export function saveToAddressBook<ChainId extends number, ContractName extends s
     // Implementation contracts
     if (ignitionContractName.startsWith('Implementation_')) {
       const contractName = ignitionContractName.replace('Implementation_', '') as ContractName
-      const entry = addressBook.getEntry(contractName)
+      const entry = addressBook.entryExists(contractName) ? addressBook.getEntry(contractName) : {}
       addressBook.setEntry(contractName, {
         ...entry,
         implementation: (contract as any).target,
@@ -103,7 +90,7 @@ export function saveToAddressBook<ChainId extends number, ContractName extends s
 
     // Non proxied contracts
     if (addressBook.isContractName(ignitionContractName)) {
-      const entry = addressBook.getEntry(ignitionContractName)
+      const entry = addressBook.entryExists(ignitionContractName) ? addressBook.getEntry(ignitionContractName) : {}
       addressBook.setEntry(ignitionContractName, {
         ...entry,
         address: (contract as any).target,

packages/horizon/README.md

@@ -35,14 +35,17 @@ Note that this instructions will help you deploy Graph Horizon contracts, but no
 To deploy Graph Horizon from scratch run the following command:
 
 ```bash
-npx hardhat run scripts/deploy.ts --network hardhat
+npx hardhat deploy:protocol --network hardhat
 ```
 
 ### Upgrade deployment
-To upgrade an existing deployment of the original Graph Protocol to Graph Horizon, run the following command:
+Usually you would run this against a network (or a fork) where the original Graph Protocol was previously deployed. To upgrade an existing deployment of the original Graph Protocol to Graph Horizon, run the following commands. Note that each step might need to be run by different accounts (deployer vs governor):
 
 ```bash
-npx hardhat run scripts/migrate.ts --network localhost
+npx hardhat deploy:migrate --network hardhat --step 1
+npx hardhat deploy:migrate --network hardhat --step 2 # Optionally add --patch-config
+npx hardhat deploy:migrate --network hardhat --step 3
+npx hardhat deploy:migrate --network hardhat --step 4 # Optionally add --patch-config
 ```
 
-Usually you would run this against a network (or a fork) where the original Graph Protocol was previously deployed.
+Steps 2 and 4 require patching the configuration file with addresses from previous steps. The files are located in the `ignition/configs` directory and need to be manually edited. You can also pass `--patch-config` flag to the deploy command to automatically patch the configuration reading values from the address book. Note that this will NOT update the configuration file.

packages/horizon/ignition/configs/horizon-migrate.default.json5

@@ -14,12 +14,12 @@
     "curationAddress": "0xDe761f075200E75485F4358978FB4d1dC8644FD5",
 
     // Must be set for step 4 of the migration
-    "subgraphServiceAddress": "0x0000000000000000000000000000000000000000",
+    "subgraphServiceAddress": "",
 
     // Parameters
     "maxThawingPeriod": 2419200
   },
-    "GraphPayments": {
+  "GraphPayments": {
     "protocolPaymentCut": 10000
   },
   "PaymentsEscrow": {
@@ -31,20 +31,20 @@
     "revokeSignerThawingPeriod": 10000
   },
   "HorizonProxiesGovernor": {
-    // These addresses must be set for step 2 of the migration
-    "graphPaymentsAddress": "0x0000000000000000000000000000000000000000",
-    "paymentsEscrowAddress": "0x0000000000000000000000000000000000000000"
+    // Must be set for step 2 of the migration
+    "graphPaymentsAddress": "",
+    "paymentsEscrowAddress": ""
   },
   "HorizonStakingGovernor": {
     // Must be set for step 4 of the migration
-    "horizonStakingImplementationAddress": "0x0000000000000000000000000000000000000000"
+    "horizonStakingImplementationAddress": ""
   },
   "L2CurationGovernor": {
     // Must be set for step 4 of the migration
-    "curationImplementationAddress": "0x0000000000000000000000000000000000000000"
+    "curationImplementationAddress": ""
   },
   "RewardsManagerGovernor": {
     // Must be set for step 4 of the migration
-    "rewardsManagerImplementationAddress": "0x0000000000000000000000000000000000000000"
+    "rewardsManagerImplementationAddress": ""
   }
 }

packages/horizon/ignition/configs/horizon-migrate.horizon-virtualArbitrumOne.json5

@@ -16,6 +16,18 @@ task('deploy:protocol', 'Deploy a new version of the Graph Protocol Horizon cont
     const { config: HorizonConfig, file } = IgnitionHelper.loadConfig('./ignition/configs/', 'horizon', hre.network.name)
     console.log(`Loaded migration configuration from ${file}`)
 
+    // Display the deployer -- this also triggers the secure accounts prompt if being used
+    console.log('\n========== 🔑 Deployer account ==========')
+    const signers = await hre.ethers.getSigners()
+    const deployer = signers[0]
+    console.log('Using deployer account:', deployer.address)
+    const balance = await hre.ethers.provider.getBalance(deployer.address)
+    console.log('Deployer balance:', hre.ethers.formatEther(balance), 'ETH')
+    if (balance === 0n) {
+      console.error('Error: Deployer account has no ETH balance')
+      process.exit(1)
+    }
+
     // Deploy the contracts
     console.log(`\n========== 🚧 Deploy protocol ==========`)
     const deployment = await hre.ignition.deploy(DeployModule, {
@@ -27,10 +39,12 @@ task('deploy:protocol', 'Deploy a new version of the Graph Protocol Horizon cont
     console.log('\n========== 📖 Updating address book ==========')
     IgnitionHelper.saveToAddressBook(deployment, hre.network.config.chainId, graph.horizon!.addressBook)
     console.log(`Address book at ${graph.horizon!.addressBook.file} updated!`)
+
+    console.log('\n\n🎉 ✨ 🚀 ✅ Deployment complete! 🎉 ✨ 🚀 ✅')
   })
 
 task('deploy:migrate', 'Upgrade an existing version of the Graph Protocol v1 to Horizon - no data services deployed')
-  .addOptionalParam('step', 'Migration step to run (1, 2, 3 or 4) - runs all if not provided', undefined, types.int)
+  .addOptionalParam('step', 'Migration step to run (1, 2, 3 or 4)', undefined, types.int)
   .addFlag('patchConfig', 'Patch configuration file using address book values - does not save changes')
   .setAction(async (args, hre: HardhatRuntimeEnvironment) => {
     // Task parameters
@@ -42,7 +56,7 @@ task('deploy:migrate', 'Upgrade an existing version of the Graph Protocol v1 to
 
     // Migration step to run
     console.log('\n========== 🏗️ Migration steps ==========')
-    const validSteps = [0, 1, 2, 3, 4]
+    const validSteps = [1, 2, 3, 4]
     if (!validSteps.includes(step)) {
       console.error(`Error: Invalid migration step provided: ${step}`)
       console.error(`Valid steps are: ${validSteps.join(', ')}`)
@@ -83,7 +97,7 @@ task('deploy:migrate', 'Upgrade an existing version of the Graph Protocol v1 to
     IgnitionHelper.saveToAddressBook(deployment, hre.network.config.chainId, graph.horizon!.addressBook)
     console.log(`Address book at ${graph.horizon!.addressBook.file} updated!`)
 
-    console.log('\n\n🎉 ✨ 🚀 ✅ Migration successful! 🎉 ✨ 🚀 ✅')
+    console.log('\n\n🎉 ✨ 🚀 ✅ Migration complete! 🎉 ✨ 🚀 ✅')
   })
 
 // This function patches the Ignition configuration object using an address book to fill in the gaps