feat: create migration scripts for subgraph service

tmigone · tmigone · commit fbdb3f1ec86a · 2025-01-28T17:18:52.000-03:00
Signed-off-by: Tomás Migone &lt;tomas@edgeandnode.com&gt;
diff --git a/packages/hardhat-graph-protocol/src/sdk/hardhat.base.config.ts b/packages/hardhat-graph-protocol/src/sdk/hardhat.base.config.ts
@@ -96,9 +96,8 @@ export const hardhatBaseConfig: HardhatUserConfig & { etherscan: Partial<Ethersc
   networks: networksUserConfig,
   graph: {
     deployments: {
-      horizon: {
-        addressBook: 'addresses.json',
-      },
+      horizon: require.resolve('@graphprotocol/horizon/addresses.json'),
+      subgraphService: require.resolve('@graphprotocol/subgraph-service/addresses.json'),
     },
   },
   etherscan: etherscanUserConfig,
diff --git a/packages/hardhat-graph-protocol/src/sdk/ignition/ignition.ts b/packages/hardhat-graph-protocol/src/sdk/ignition/ignition.ts
@@ -1,3 +1,5 @@
+/* eslint-disable no-prototype-builtins */
+/* eslint-disable @typescript-eslint/no-unsafe-return */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 require('json5/lib/register')
 
@@ -20,6 +22,39 @@ export function loadConfig(configPath: string, prefix: string, networkName: stri
   return removeNFromBigInts(require(configFile))
 }
 
+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]
+        } else {
+          recursivePatch(obj[key])
+        }
+      }
+    }
+  }
+
+  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
+}
+
 export function saveAddressBook(
   contracts: any,
   chainId: number | undefined,
diff --git a/packages/hardhat-graph-protocol/src/sdk/index.ts b/packages/hardhat-graph-protocol/src/sdk/index.ts
@@ -1,5 +1,5 @@
-import { loadConfig, saveAddressBook } from './ignition/ignition'
+import { loadConfig, mergeConfigs, patchConfig, saveAddressBook } from './ignition/ignition'
 import { hardhatBaseConfig } from './hardhat.base.config'
 
-const IgnitionHelper = { saveAddressBook, loadConfig }
+const IgnitionHelper = { saveAddressBook, loadConfig, patchConfig, mergeConfigs }
 export { hardhatBaseConfig, IgnitionHelper }
diff --git a/packages/horizon/addresses.json b/packages/horizon/addresses.json
@@ -0,0 +1 @@
+{}
diff --git a/packages/horizon/ignition/modules/core/GraphPayments.ts b/packages/horizon/ignition/modules/core/GraphPayments.ts
@@ -1,6 +1,6 @@
 import { buildModule } from '@nomicfoundation/hardhat-ignition/modules'
 import { deployImplementation } from '../proxy/implementation'
-import { upgradeTransparentUpgradeableProxyNoLoad } from '../proxy/TransparentUpgradeableProxy'
+import { upgradeTransparentUpgradeableProxy } from '../proxy/TransparentUpgradeableProxy'
 
 import GraphPeripheryModule, { MigratePeripheryModule } from '../periphery/periphery'
 import HorizonProxiesModule, { MigrateHorizonProxiesDeployerModule } from './HorizonProxies'
@@ -22,7 +22,7 @@ export default buildModule('GraphPayments', (m) => {
   }, { after: [GraphPeripheryModule, HorizonProxiesModule] })
 
   // Upgrade proxy to implementation contract
-  const GraphPayments = upgradeTransparentUpgradeableProxyNoLoad(m,
+  const GraphPayments = upgradeTransparentUpgradeableProxy(m,
     GraphPaymentsProxyAdmin,
     GraphPaymentsProxy,
     GraphPaymentsImplementation, {
@@ -55,7 +55,7 @@ export const MigrateGraphPaymentsModule = buildModule('GraphPayments', (m) => {
   })
 
   // Upgrade proxy to implementation contract
-  const GraphPayments = upgradeTransparentUpgradeableProxyNoLoad(m,
+  const GraphPayments = upgradeTransparentUpgradeableProxy(m,
     GraphPaymentsProxyAdmin,
     GraphPaymentsProxy,
     GraphPaymentsImplementation, {
diff --git a/packages/horizon/ignition/modules/core/PaymentsEscrow.ts b/packages/horizon/ignition/modules/core/PaymentsEscrow.ts
@@ -1,6 +1,6 @@
 import { buildModule } from '@nomicfoundation/hardhat-ignition/modules'
 import { deployImplementation } from '../proxy/implementation'
-import { upgradeTransparentUpgradeableProxyNoLoad } from '../proxy/TransparentUpgradeableProxy'
+import { upgradeTransparentUpgradeableProxy } from '../proxy/TransparentUpgradeableProxy'
 
 import GraphPeripheryModule, { MigratePeripheryModule } from '../periphery/periphery'
 import HorizonProxiesModule, { MigrateHorizonProxiesDeployerModule } from './HorizonProxies'
@@ -22,7 +22,7 @@ export default buildModule('PaymentsEscrow', (m) => {
   }, { after: [GraphPeripheryModule, HorizonProxiesModule] })
 
   // Upgrade proxy to implementation contract
-  const PaymentsEscrow = upgradeTransparentUpgradeableProxyNoLoad(m,
+  const PaymentsEscrow = upgradeTransparentUpgradeableProxy(m,
     PaymentsEscrowProxyAdmin,
     PaymentsEscrowProxy,
     PaymentsEscrowImplementation, {
@@ -55,7 +55,7 @@ export const MigratePaymentsEscrowModule = buildModule('PaymentsEscrow', (m) =>
   })
 
   // Upgrade proxy to implementation contract
-  const PaymentsEscrow = upgradeTransparentUpgradeableProxyNoLoad(m,
+  const PaymentsEscrow = upgradeTransparentUpgradeableProxy(m,
     PaymentsEscrowProxyAdmin,
     PaymentsEscrowProxy,
     PaymentsEscrowImplementation, {
diff --git a/packages/horizon/ignition/modules/migrate/migrate-2.ts b/packages/horizon/ignition/modules/migrate/migrate-2.ts
@@ -5,5 +5,5 @@ import { MigrateHorizonProxiesGovernorModule } from '../core/HorizonProxies'
 export default buildModule('GraphHorizon_Migrate_2', (m) => {
   m.useModule(MigrateHorizonProxiesGovernorModule)
 
-  return { }
+  return {}
 })
diff --git a/packages/horizon/ignition/modules/proxy/TransparentUpgradeableProxy.ts b/packages/horizon/ignition/modules/proxy/TransparentUpgradeableProxy.ts
@@ -45,7 +45,7 @@ export function deployTransparentUpgradeableProxy(
   }
 }
 
-export function upgradeTransparentUpgradeableProxyNoLoad(
+export function upgradeTransparentUpgradeableProxy(
   m: IgnitionModuleBuilder,
   proxyAdmin: CallableContractFuture<string>,
   proxy: CallableContractFuture<string>,
diff --git a/packages/subgraph-service/hardhat.config.ts b/packages/subgraph-service/hardhat.config.ts
@@ -1,54 +1,16 @@
+import { hardhatBaseConfig } from 'hardhat-graph-protocol/sdk'
+
+// Hardhat plugins
 import '@nomicfoundation/hardhat-foundry'
-import '@nomicfoundation/hardhat-ignition-ethers'
 import '@nomicfoundation/hardhat-toolbox'
-import 'hardhat-contract-sizer'
+import '@nomicfoundation/hardhat-ignition-ethers'
 import 'hardhat-storage-layout'
+import 'hardhat-contract-sizer'
 import 'hardhat-secure-accounts'
 import 'solidity-docgen'
 
-import { HardhatUserConfig } from 'hardhat/config'
-
 if (process.env.BUILD_RUN !== 'true') {
   require('hardhat-graph-protocol')
 }
 
-const config: HardhatUserConfig = {
-  solidity: {
-    version: '0.8.27',
-    settings: {
-      optimizer: {
-        enabled: true,
-        runs: 1,
-      },
-    },
-  },
-  paths: {
-    artifacts: './build/contracts',
-    sources: './contracts',
-  },
-  secureAccounts: {
-    enabled: true,
-  },
-  networks: {
-    hardhat: {
-      secureAccounts: {
-        enabled: false,
-      },
-      accounts: {
-        mnemonic: 'myth like bonus scare over problem client lizard pioneer submit female collect',
-      },
-    },
-    arbitrumSepolia: {
-      chainId: 421614,
-      url: 'https://sepolia-rollup.arbitrum.io/rpc',
-    },
-  },
-  graph: {
-    deployments: {
-      horizon: require.resolve('@graphprotocol/horizon/addresses.json'),
-      subgraphService: 'addresses.json',
-    },
-  },
-}
-
-export default config
+export default hardhatBaseConfig
diff --git a/packages/subgraph-service/ignition/configs/subgraph-service-migrate.default.json5 b/packages/subgraph-service/ignition/configs/subgraph-service-migrate.default.json5
@@ -0,0 +1,29 @@
+{
+  "$global": {
+    // Accounts
+    "governor": "0x72ee30d43Fb5A90B3FE983156C5d2fBE6F6d07B3",
+    "arbitrator": "0xFFcf8FDEE72ac11b5c542428B35EEF5769C409f0",
+
+    // Addresses for contracts deployed in the original Graph Protocol
+    "controllerAddress": "0x9DB3ee191681f092607035d9BDA6e59FbEaCa695",
+    "curationAddress": "0xDe761f075200E75485F4358978FB4d1dC8644FD5",
+    "tapCollectorAddress": "0x0000000000000000000000000000000000000000",
+
+    // Must be set for step 2 of the migration
+    "disputeManagerAddress": "0x0000000000000000000000000000000000000000",
+    "disputeManagerProxyAdminAddress": "0x0000000000000000000000000000000000000000",
+    "subgraphServiceAddress": "0x0000000000000000000000000000000000000000",
+    "subgraphServiceProxyAdminAddress": "0x0000000000000000000000000000000000000000"
+  },
+  "DisputeManager": {
+    "disputePeriod": 2419200,
+    "disputeDeposit": "10000000000000000000000n",
+    "fishermanRewardCut": 500000,
+    "maxSlashingCut": 1000000
+  },
+  "SubgraphService": {
+    "minimumProvisionTokens": "100000000000000000000000n",
+    "maximumDelegationRatio": 16,
+    "stakeToFeesRatio": 2
+  }
+}
diff --git a/packages/subgraph-service/ignition/configs/subgraph-service.default.json5 b/packages/subgraph-service/ignition/configs/subgraph-service.default.json5
diff --git a/packages/subgraph-service/ignition/modules/DisputeManager.ts b/packages/subgraph-service/ignition/modules/DisputeManager.ts
@@ -1,36 +1,46 @@
 import { buildModule } from '@nomicfoundation/hardhat-ignition/modules'
+import { deployImplementation } from '@graphprotocol/horizon/ignition/modules/proxy/implementation'
+import { upgradeTransparentUpgradeableProxy } from '@graphprotocol/horizon/ignition/modules/proxy/TransparentUpgradeableProxy'
 
 import ProxyAdminArtifact from '@openzeppelin/contracts/build/contracts/ProxyAdmin.json'
+import TransparentUpgradeableProxyArtifact from '@openzeppelin/contracts/build/contracts/TransparentUpgradeableProxy.json'
 
-// TODO: transfer ownership of ProxyAdmin???
 export default buildModule('DisputeManager', (m) => {
-  // Parameters - dynamically plugged in by the deploy script
+  const governor = m.getParameter('governor')
   const controllerAddress = m.getParameter('controllerAddress')
-  const disputeManagerProxyAddress = m.getParameter('disputeManagerProxyAddress')
+  const disputeManagerAddress = m.getParameter('disputeManagerAddress')
   const disputeManagerProxyAdminAddress = m.getParameter('disputeManagerProxyAdminAddress')
-
-  // Parameters - config file
   const arbitrator = m.getParameter('arbitrator')
   const disputePeriod = m.getParameter('disputePeriod')
   const disputeDeposit = m.getParameter('disputeDeposit')
   const fishermanRewardCut = m.getParameter('fishermanRewardCut')
   const maxSlashingCut = m.getParameter('maxSlashingCut')
 
+  const DisputeManagerProxyAdmin = m.contractAt('ProxyAdmin', ProxyAdminArtifact, disputeManagerProxyAdminAddress)
+  const DisputeManagerProxy = m.contractAt('DisputeManager', TransparentUpgradeableProxyArtifact, disputeManagerAddress)
+
   // Deploy implementation
-  const DisputeManagerImplementation = m.contract('DisputeManager', [controllerAddress])
+  const DisputeManagerImplementation = deployImplementation(m, {
+    name: 'DisputeManager',
+    constructorArgs: [controllerAddress],
+  })
 
   // Upgrade implementation
-  const DisputeManagerProxyAdmin = m.contractAt('ProxyAdmin', ProxyAdminArtifact, disputeManagerProxyAdminAddress)
-  const encodedCall = m.encodeFunctionCall(DisputeManagerImplementation, 'initialize', [
-    arbitrator,
-    disputePeriod,
-    disputeDeposit,
-    fishermanRewardCut,
-    maxSlashingCut,
-  ])
-  m.call(DisputeManagerProxyAdmin, 'upgradeAndCall', [disputeManagerProxyAddress, DisputeManagerImplementation, encodedCall])
+  const DisputeManager = upgradeTransparentUpgradeableProxy(m,
+    DisputeManagerProxyAdmin,
+    DisputeManagerProxy,
+    DisputeManagerImplementation, {
+      name: 'DisputeManager',
+      initArgs: [
+        arbitrator,
+        disputePeriod,
+        disputeDeposit,
+        fishermanRewardCut,
+        maxSlashingCut,
+      ],
+    })
 
-  const DisputeManager = m.contractAt('DisputeManager', disputeManagerProxyAddress, { id: 'DisputeManager_Instance' })
+  m.call(DisputeManagerProxyAdmin, 'transferOwnership', [governor], { after: [DisputeManager] })
 
   return { DisputeManager, DisputeManagerImplementation }
 })
diff --git a/packages/subgraph-service/ignition/modules/Proxies.ts b/packages/subgraph-service/ignition/modules/Proxies.ts
@@ -1,10 +1,30 @@
 import { buildModule } from '@nomicfoundation/hardhat-ignition/modules'
-import { deployWithOZProxy } from '@graphprotocol/horizon/ignition/modules/proxy/TransparentUpgradeableProxy'
+import { deployTransparentUpgradeableProxy } from '@graphprotocol/horizon/ignition/modules/proxy/TransparentUpgradeableProxy'
+
+import DisputeManagerArtifact from '../../build/contracts/contracts/DisputeManager.sol/DisputeManager.json'
+import SubgraphServiceArtifact from '../../build/contracts/contracts/SubgraphService.sol/SubgraphService.json'
 
 export default buildModule('SubgraphServiceProxies', (m) => {
   // Deploy proxies contracts using OZ TransparentUpgradeableProxy
-  const { Proxy: DisputeManagerProxy, ProxyAdmin: DisputeManagerProxyAdmin } = deployWithOZProxy(m, 'DisputeManager')
-  const { Proxy: SubgraphServiceProxy, ProxyAdmin: SubgraphServiceProxyAdmin } = deployWithOZProxy(m, 'SubgraphService')
+  const {
+    Proxy: DisputeManagerProxy,
+    ProxyAdmin: DisputeManagerProxyAdmin,
+  } = deployTransparentUpgradeableProxy(m, {
+    name: 'DisputeManager',
+    artifact: DisputeManagerArtifact,
+  })
+  const {
+    Proxy: SubgraphServiceProxy,
+    ProxyAdmin: SubgraphServiceProxyAdmin,
+  } = deployTransparentUpgradeableProxy(m, {
+    name: 'SubgraphService',
+    artifact: SubgraphServiceArtifact,
+  })
 
-  return { DisputeManagerProxy, DisputeManagerProxyAdmin, SubgraphServiceProxy, SubgraphServiceProxyAdmin }
+  return {
+    DisputeManagerProxy,
+    DisputeManagerProxyAdmin,
+    SubgraphServiceProxy,
+    SubgraphServiceProxyAdmin,
+  }
 })
diff --git a/packages/subgraph-service/ignition/modules/SubgraphService.ts b/packages/subgraph-service/ignition/modules/SubgraphService.ts
@@ -1,36 +1,45 @@
-/* eslint-disable no-secrets/no-secrets */
 import { buildModule } from '@nomicfoundation/hardhat-ignition/modules'
+import { deployImplementation } from '@graphprotocol/horizon/ignition/modules/proxy/implementation'
+import { upgradeTransparentUpgradeableProxy } from '@graphprotocol/horizon/ignition/modules/proxy/TransparentUpgradeableProxy'
 
 import ProxyAdminArtifact from '@openzeppelin/contracts/build/contracts/ProxyAdmin.json'
+import TransparentUpgradeableProxyArtifact from '@openzeppelin/contracts/build/contracts/TransparentUpgradeableProxy.json'
 
-// TODO: transfer ownership of ProxyAdmin???
 export default buildModule('SubgraphService', (m) => {
-  // Parameters - dynamically plugged in by the deploy script
+  const governor = m.getParameter('governor')
   const controllerAddress = m.getParameter('controllerAddress')
   const subgraphServiceProxyAddress = m.getParameter('subgraphServiceProxyAddress')
   const subgraphServiceProxyAdminAddress = m.getParameter('subgraphServiceProxyAdminAddress')
   const disputeManagerAddress = m.getParameter('disputeManagerAddress')
   const tapCollectorAddress = m.getParameter('tapCollectorAddress')
   const curationAddress = m.getParameter('curationAddress')
-
-  // Parameters - config file
   const minimumProvisionTokens = m.getParameter('minimumProvisionTokens')
   const maximumDelegationRatio = m.getParameter('maximumDelegationRatio')
   const stakeToFeesRatio = m.getParameter('stakeToFeesRatio')
 
+  const SubgraphServiceProxyAdmin = m.contractAt('ProxyAdmin', ProxyAdminArtifact, subgraphServiceProxyAdminAddress)
+  const SubgraphServiceProxy = m.contractAt('SubgraphService', TransparentUpgradeableProxyArtifact, subgraphServiceProxyAddress)
+
   // Deploy implementation
-  const SubgraphServiceImplementation = m.contract('SubgraphService', [controllerAddress, disputeManagerAddress, tapCollectorAddress, curationAddress])
+  const SubgraphServiceImplementation = deployImplementation(m, {
+    name: 'SubgraphService',
+    constructorArgs: [controllerAddress, disputeManagerAddress, tapCollectorAddress, curationAddress],
+  })
 
   // Upgrade implementation
-  const SubgraphServiceProxyAdmin = m.contractAt('ProxyAdmin', ProxyAdminArtifact, subgraphServiceProxyAdminAddress)
-  const encodedCall = m.encodeFunctionCall(SubgraphServiceImplementation, 'initialize', [
-    minimumProvisionTokens,
-    maximumDelegationRatio,
-    stakeToFeesRatio,
-  ])
-  m.call(SubgraphServiceProxyAdmin, 'upgradeAndCall', [subgraphServiceProxyAddress, SubgraphServiceImplementation, encodedCall])
+  const SubgraphService = upgradeTransparentUpgradeableProxy(m,
+    SubgraphServiceProxyAdmin,
+    SubgraphServiceProxy,
+    SubgraphServiceImplementation, {
+      name: 'SubgraphService',
+      initArgs: [
+        minimumProvisionTokens,
+        maximumDelegationRatio,
+        stakeToFeesRatio,
+      ],
+    })
 
-  const SubgraphService = m.contractAt('SubgraphService', subgraphServiceProxyAddress, { id: 'SubgraphService_Instance' })
+  m.call(SubgraphServiceProxyAdmin, 'transferOwnership', [governor], { after: [SubgraphService] })
 
   return { SubgraphService, SubgraphServiceImplementation }
 })
diff --git a/packages/subgraph-service/ignition/modules/migrate/migrate-1.ts b/packages/subgraph-service/ignition/modules/migrate/migrate-1.ts
diff --git a/packages/subgraph-service/ignition/modules/migrate/migrate-2.ts b/packages/subgraph-service/ignition/modules/migrate/migrate-2.ts
diff --git a/packages/subgraph-service/scripts/deploy.ts b/packages/subgraph-service/scripts/deploy.ts
diff --git a/packages/subgraph-service/scripts/migrate.ts b/packages/subgraph-service/scripts/migrate.ts
diff --git a/packages/subgraph-service/tsconfig.json b/packages/subgraph-service/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ export function deployTransparentUpgradeableProxy(`
`45`	`45`	`}`
`46`	`46`	`}`
`47`	`47`
`48`		`-export function upgradeTransparentUpgradeableProxyNoLoad(`
	`48`	`+export function upgradeTransparentUpgradeableProxy(`
`49`	`49`	`m: IgnitionModuleBuilder,`
`50`	`50`	`proxyAdmin: CallableContractFuture<string>,`
`51`	`51`	`proxy: CallableContractFuture<string>,`