feat: breakout ignition migration script by runner

tmigone · tmigone · commit 5711907bc701 · 2025-01-28T13:05:33.000-03:00
Signed-off-by: Tomás Migone &lt;tomas@edgeandnode.com&gt;
diff --git a/packages/horizon/ignition/configs/horizon-migrate.default.json5 b/packages/horizon/ignition/configs/horizon-migrate.default.json5
@@ -1,23 +1,22 @@
 {
   "$global": {
+    // Accounts
+    "governor": "0x72ee30d43Fb5A90B3FE983156C5d2fBE6F6d07B3",
+
     // Addresses for contracts deployed in the original Graph Protocol
     "graphProxyAdminAddress": "0x7474a6cc5fAeDEc620Db0fa8E4da6eD58477042C",
     "controllerAddress": "0x9DB3ee191681f092607035d9BDA6e59FbEaCa695",
     "horizonStakingAddress": "0x865365C425f3A593Ffe698D9c4E6707D14d51e08",
     "epochManagerAddress": "0x88b3C7f37253bAA1A9b95feAd69bD5320585826D",
     "graphTokenAddress": "0xf8c05dCF59E8B28BFD5eed176C562bEbcfc7Ac04",
     "graphTokenGatewayAddress": "0xB24Ce0f8c18c4DdDa584A7EeC132F49C966813bb",
+    "rewardsManagerAddress": "0x1F49caE7669086c8ba53CC35d1E9f80176d67E79",
+    "curationAddress": "0xDe761f075200E75485F4358978FB4d1dC8644FD5",
 
     // Placeholder address for a standalone Horizon deployment, see README.md for more details
     "subgraphServiceAddress": "0x0000000000000000000000000000000000000000"
   },
-  "RewardsManager": {
-    "rewardsManagerAddress": "0x1F49caE7669086c8ba53CC35d1E9f80176d67E79"
-  },
-  "L2Curation": {
-    "curationAddress": "0xDe761f075200E75485F4358978FB4d1dC8644FD5"
-  },
-  "HorizonStaking": {
+  "HorizonStakingGovernor": {
     "maxThawingPeriod": 2419200
   },
   "GraphPayments": {
diff --git a/packages/horizon/ignition/modules/core/GraphPayments.ts b/packages/horizon/ignition/modules/core/GraphPayments.ts
@@ -3,7 +3,7 @@ import { deployImplementation } from '../proxy/implementation'
 import { upgradeTransparentUpgradeableProxyNoLoad } from '../proxy/TransparentUpgradeableProxy'
 
 import GraphPeripheryModule, { MigratePeripheryModule } from '../periphery/periphery'
-import HorizonProxiesModule, { MigrateHorizonProxiesModule } from './HorizonProxies'
+import HorizonProxiesModule, { MigrateHorizonProxiesDeployerModule } from './HorizonProxies'
 
 import GraphPaymentsArtifact from '../../../build/contracts/contracts/payments/GraphPayments.sol/GraphPayments.json'
 
@@ -36,19 +36,23 @@ export default buildModule('GraphPayments', (m) => {
   return { GraphPayments, GraphPaymentsProxyAdmin }
 })
 
+// Note that this module requires MigrateHorizonProxiesGovernorModule to be executed first
+// The dependency is not made explicit to support the production workflow where the governor is a
+// multisig owned by the Graph Council.
+// For testnet, the dependency can be made explicit by having a parent module establish it.
 export const MigrateGraphPaymentsModule = buildModule('GraphPayments', (m) => {
-  const { GraphPaymentsProxyAdmin, GraphPaymentsProxy } = m.useModule(MigrateHorizonProxiesModule)
+  const { GraphPaymentsProxyAdmin, GraphPaymentsProxy } = m.useModule(MigrateHorizonProxiesDeployerModule)
   const { Controller } = m.useModule(MigratePeripheryModule)
 
-  const governor = m.getAccount(1)
+  const governor = m.getParameter('governor')
   const protocolPaymentCut = m.getParameter('protocolPaymentCut')
 
   // Deploy GraphPayments implementation
   const GraphPaymentsImplementation = deployImplementation(m, {
     name: 'GraphPayments',
     artifact: GraphPaymentsArtifact,
     constructorArgs: [Controller, protocolPaymentCut],
-  }, { after: [MigrateHorizonProxiesModule] })
+  })
 
   // Upgrade proxy to implementation contract
   const GraphPayments = upgradeTransparentUpgradeableProxyNoLoad(m,
diff --git a/packages/horizon/ignition/modules/core/HorizonProxies.ts b/packages/horizon/ignition/modules/core/HorizonProxies.ts
@@ -3,7 +3,8 @@ import { deployGraphProxy } from '../proxy/GraphProxy'
 import { deployTransparentUpgradeableProxy } from '../proxy/TransparentUpgradeableProxy'
 import { ethers } from 'ethers'
 
-import GraphPeripheryModule, { MigratePeripheryModule } from '../periphery/periphery'
+import GraphPeripheryModule from '../periphery/periphery'
+import { MigrateControllerGovernorModule } from '../periphery/Controller'
 
 import GraphPaymentsArtifact from '../../../build/contracts/contracts/payments/GraphPayments.sol/GraphPayments.json'
 import PaymentsEscrowArtifact from '../../../build/contracts/contracts/payments/PaymentsEscrow.sol/PaymentsEscrow.json'
@@ -43,26 +44,39 @@ export default buildModule('HorizonProxies', (m) => {
   return { HorizonStakingProxy, GraphPaymentsProxy, PaymentsEscrowProxy, GraphPaymentsProxyAdmin, PaymentsEscrowProxyAdmin }
 })
 
-export const MigrateHorizonProxiesModule = buildModule('HorizonProxies', (m) => {
-  const { Controller } = m.useModule(MigratePeripheryModule)
-
-  const governor = m.getAccount(1)
-
-  // Deploy and register GraphPayments proxy
+export const MigrateHorizonProxiesDeployerModule = buildModule('HorizonProxiesDeployer', (m) => {
+  // Deploy GraphPayments proxy
   const { Proxy: GraphPaymentsProxy, ProxyAdmin: GraphPaymentsProxyAdmin } = deployTransparentUpgradeableProxy(m, {
     name: 'GraphPayments',
     artifact: GraphPaymentsArtifact,
   })
-  m.call(Controller, 'setContractProxy',
-    [ethers.keccak256(ethers.toUtf8Bytes('GraphPayments')), GraphPaymentsProxy],
-    { id: 'setContractProxy_GraphPayments', from: governor },
-  )
 
-  // Deploy and registerPaymentsEscrow proxy
+  // Deploy PaymentsEscrow proxy
   const { Proxy: PaymentsEscrowProxy, ProxyAdmin: PaymentsEscrowProxyAdmin } = deployTransparentUpgradeableProxy(m, {
     name: 'PaymentsEscrow',
     artifact: PaymentsEscrowArtifact,
   })
+
+  return { GraphPaymentsProxy, PaymentsEscrowProxy, GraphPaymentsProxyAdmin, PaymentsEscrowProxyAdmin }
+})
+
+export const MigrateHorizonProxiesGovernorModule = buildModule('HorizonProxiesGovernor', (m) => {
+  const { Controller } = m.useModule(MigrateControllerGovernorModule)
+  const {
+    GraphPaymentsProxy,
+    PaymentsEscrowProxy,
+    GraphPaymentsProxyAdmin,
+    PaymentsEscrowProxyAdmin,
+  } = m.useModule(MigrateHorizonProxiesDeployerModule)
+
+  const governor = m.getAccount(1)
+
+  // Register proxies in controller
+  m.call(Controller, 'setContractProxy',
+    [ethers.keccak256(ethers.toUtf8Bytes('GraphPayments')), GraphPaymentsProxy],
+    { id: 'setContractProxy_GraphPayments', from: governor },
+  )
+
   m.call(Controller, 'setContractProxy',
     [ethers.keccak256(ethers.toUtf8Bytes('PaymentsEscrow')), PaymentsEscrowProxy],
     { id: 'setContractProxy_PaymentsEscrow', from: governor },
diff --git a/packages/horizon/ignition/modules/core/HorizonStaking.ts b/packages/horizon/ignition/modules/core/HorizonStaking.ts
@@ -1,9 +1,10 @@
 import { buildModule } from '@nomicfoundation/hardhat-ignition/modules'
 import { deployImplementation } from '../proxy/implementation'
-import { upgradeGraphProxyNoLoad } from '../proxy/GraphProxy'
+import { upgradeGraphProxy } from '../proxy/GraphProxy'
 
 import GraphPeripheryModule, { MigratePeripheryModule } from '../periphery/periphery'
-import HorizonProxiesModule, { MigrateHorizonProxiesModule } from './HorizonProxies'
+import HorizonProxiesModule from './HorizonProxies'
+import { MigrateGraphProxyAdminModule } from '../periphery/GraphProxyAdmin'
 
 import ExponentialRebatesArtifact from '../../../build/contracts/contracts/staking/libraries/ExponentialRebates.sol/ExponentialRebates.json'
 import GraphProxyArtifact from '@graphprotocol/contracts/build/contracts/contracts/upgrades/GraphProxy.sol/GraphProxy.json'
@@ -36,7 +37,7 @@ export default buildModule('HorizonStaking', (m) => {
   })
 
   // Upgrade proxy to implementation contract
-  const HorizonStaking = upgradeGraphProxyNoLoad(m, GraphProxyAdmin, HorizonStakingProxy, HorizonStakingImplementation, {
+  const HorizonStaking = upgradeGraphProxy(m, GraphProxyAdmin, HorizonStakingProxy, HorizonStakingImplementation, {
     name: 'HorizonStaking',
     artifact: HorizonStakingArtifact,
   })
@@ -45,12 +46,13 @@ export default buildModule('HorizonStaking', (m) => {
   return { HorizonStaking }
 })
 
-// HorizonStaking contract is owned by the governor
-export const MigrateHorizonStakingModule = buildModule('HorizonStaking', (m) => {
-  const { Controller, GraphProxyAdmin } = m.useModule(MigratePeripheryModule)
+// Note that this module requires MigrateHorizonProxiesGovernorModule to be executed first
+// The dependency is not made explicit to support the production workflow where the governor is a
+// multisig owned by the Graph Council.
+// For testnet, the dependency can be made explicit by having a parent module establish it.
+export const MigrateHorizonStakingDeployerModule = buildModule('HorizonStakingDeployer', (m) => {
+  const { Controller } = m.useModule(MigratePeripheryModule)
 
-  const governor = m.getAccount(1)
-  const maxThawingPeriod = m.getParameter('maxThawingPeriod')
   const subgraphServiceAddress = m.getParameter('subgraphServiceAddress')
   const horizonStakingAddress = m.getParameter('horizonStakingAddress')
 
@@ -64,7 +66,6 @@ export const MigrateHorizonStakingModule = buildModule('HorizonStaking', (m) =>
       libraries: {
         ExponentialRebates: ExponentialRebates,
       },
-      after: [MigrateHorizonProxiesModule],
     })
 
   // Deploy HorizonStaking implementation
@@ -74,8 +75,18 @@ export const MigrateHorizonStakingModule = buildModule('HorizonStaking', (m) =>
     constructorArgs: [Controller, HorizonStakingExtension, subgraphServiceAddress],
   })
 
+  return { HorizonStakingProxy, HorizonStakingImplementation }
+})
+
+export const MigrateHorizonStakingGovernorModule = buildModule('HorizonStakingGovernor', (m) => {
+  const { GraphProxyAdmin } = m.useModule(MigrateGraphProxyAdminModule)
+  const { HorizonStakingProxy, HorizonStakingImplementation } = m.useModule(MigrateHorizonStakingDeployerModule)
+
+  const governor = m.getAccount(1)
+  const maxThawingPeriod = m.getParameter('maxThawingPeriod')
+
   // Upgrade proxy to implementation contract
-  const HorizonStaking = upgradeGraphProxyNoLoad(m, GraphProxyAdmin, HorizonStakingProxy, HorizonStakingImplementation, {
+  const HorizonStaking = upgradeGraphProxy(m, GraphProxyAdmin, HorizonStakingProxy, HorizonStakingImplementation, {
     name: 'HorizonStaking',
     artifact: HorizonStakingArtifact,
   }, { from: governor })
diff --git a/packages/horizon/ignition/modules/core/PaymentsEscrow.ts b/packages/horizon/ignition/modules/core/PaymentsEscrow.ts
@@ -3,7 +3,7 @@ import { deployImplementation } from '../proxy/implementation'
 import { upgradeTransparentUpgradeableProxyNoLoad } from '../proxy/TransparentUpgradeableProxy'
 
 import GraphPeripheryModule, { MigratePeripheryModule } from '../periphery/periphery'
-import HorizonProxiesModule, { MigrateHorizonProxiesModule } from './HorizonProxies'
+import HorizonProxiesModule, { MigrateHorizonProxiesDeployerModule } from './HorizonProxies'
 
 import PaymentsEscrowArtifact from '../../../build/contracts/contracts/payments/PaymentsEscrow.sol/PaymentsEscrow.json'
 
@@ -36,8 +36,12 @@ export default buildModule('PaymentsEscrow', (m) => {
   return { PaymentsEscrow, PaymentsEscrowProxyAdmin }
 })
 
+// Note that this module requires MigrateHorizonProxiesGovernorModule to be executed first
+// The dependency is not made explicit to support the production workflow where the governor is a
+// multisig owned by the Graph Council.
+// For testnet, the dependency can be made explicit by having a parent module establish it.
 export const MigratePaymentsEscrowModule = buildModule('PaymentsEscrow', (m) => {
-  const { PaymentsEscrowProxyAdmin, PaymentsEscrowProxy } = m.useModule(MigrateHorizonProxiesModule)
+  const { PaymentsEscrowProxyAdmin, PaymentsEscrowProxy } = m.useModule(MigrateHorizonProxiesDeployerModule)
   const { Controller } = m.useModule(MigratePeripheryModule)
 
   const governor = m.getAccount(1)
@@ -48,7 +52,7 @@ export const MigratePaymentsEscrowModule = buildModule('PaymentsEscrow', (m) =>
     name: 'PaymentsEscrow',
     artifact: PaymentsEscrowArtifact,
     constructorArgs: [Controller, withdrawEscrowThawingPeriod],
-  }, { after: [MigrateHorizonProxiesModule] })
+  })
 
   // Upgrade proxy to implementation contract
   const PaymentsEscrow = upgradeTransparentUpgradeableProxyNoLoad(m,
diff --git a/packages/horizon/ignition/modules/core/TAPCollector.ts b/packages/horizon/ignition/modules/core/TAPCollector.ts
@@ -1,7 +1,7 @@
 import { buildModule } from '@nomicfoundation/hardhat-ignition/modules'
 
 import GraphPeripheryModule, { MigratePeripheryModule } from '../periphery/periphery'
-import HorizonProxiesModule, { MigrateHorizonProxiesModule } from './HorizonProxies'
+import HorizonProxiesModule from './HorizonProxies'
 
 import TAPCollectorArtifact from '../../../build/contracts/contracts/payments/collectors/TAPCollector.sol/TAPCollector.json'
 
@@ -22,6 +22,10 @@ export default buildModule('TAPCollector', (m) => {
   return { TAPCollector }
 })
 
+// Note that this module requires MigrateHorizonProxiesGovernorModule to be executed first
+// The dependency is not made explicit to support the production workflow where the governor is a
+// multisig owned by the Graph Council.
+// For testnet, the dependency can be made explicit by having a parent module establish it.
 export const MigrateTAPCollectorModule = buildModule('TAPCollector', (m) => {
   const { Controller } = m.useModule(MigratePeripheryModule)
 
@@ -33,7 +37,6 @@ export const MigrateTAPCollectorModule = buildModule('TAPCollector', (m) => {
     'TAPCollector',
     TAPCollectorArtifact,
     [name, version, Controller, revokeSignerThawingPeriod],
-    { after: [MigrateHorizonProxiesModule] },
   )
 
   return { TAPCollector }
diff --git a/packages/horizon/ignition/modules/core/core.ts b/packages/horizon/ignition/modules/core/core.ts
@@ -1,7 +1,7 @@
 import { buildModule } from '@nomicfoundation/hardhat-ignition/modules'
 
 import GraphPaymentsModule, { MigrateGraphPaymentsModule } from './GraphPayments'
-import HorizonStakingModule, { MigrateHorizonStakingModule } from './HorizonStaking'
+import HorizonStakingModule, { MigrateHorizonStakingDeployerModule } from './HorizonStaking'
 import PaymentsEscrowModule, { MigratePaymentsEscrowModule } from './PaymentsEscrow'
 import TAPCollectorModule, { MigrateTAPCollectorModule } from './TAPCollector'
 
@@ -15,7 +15,7 @@ export default buildModule('GraphHorizon_Core', (m) => {
 })
 
 export const MigrateHorizonCoreModule = buildModule('GraphHorizon_Core', (m) => {
-  const { HorizonStaking } = m.useModule(MigrateHorizonStakingModule)
+  const { HorizonStakingProxy: HorizonStaking } = m.useModule(MigrateHorizonStakingDeployerModule)
   const { GraphPayments } = m.useModule(MigrateGraphPaymentsModule)
   const { PaymentsEscrow } = m.useModule(MigratePaymentsEscrowModule)
   const { TAPCollector } = m.useModule(MigrateTAPCollectorModule)
diff --git a/packages/horizon/ignition/modules/migrate/migrate-1.ts b/packages/horizon/ignition/modules/migrate/migrate-1.ts
@@ -0,0 +1,19 @@
+import { buildModule } from '@nomicfoundation/hardhat-ignition/modules'
+
+import { MigrateHorizonProxiesDeployerModule } from '../core/HorizonProxies'
+
+export default buildModule('GraphHorizon_Migrate_1', (m) => {
+  const {
+    GraphPaymentsProxy,
+    PaymentsEscrowProxy,
+    GraphPaymentsProxyAdmin,
+    PaymentsEscrowProxyAdmin,
+  } = m.useModule(MigrateHorizonProxiesDeployerModule)
+
+  return {
+    GraphPaymentsProxy,
+    PaymentsEscrowProxy,
+    GraphPaymentsProxyAdmin,
+    PaymentsEscrowProxyAdmin,
+  }
+})
diff --git a/packages/horizon/ignition/modules/migrate/migrate-2.ts b/packages/horizon/ignition/modules/migrate/migrate-2.ts
@@ -0,0 +1,19 @@
+import { buildModule } from '@nomicfoundation/hardhat-ignition/modules'
+
+import { MigrateHorizonProxiesGovernorModule } from '../core/HorizonProxies'
+
+export default buildModule('GraphHorizon_Migrate_2', (m) => {
+  const {
+    GraphPaymentsProxy,
+    PaymentsEscrowProxy,
+    GraphPaymentsProxyAdmin,
+    PaymentsEscrowProxyAdmin,
+  } = m.useModule(MigrateHorizonProxiesGovernorModule)
+
+  return {
+    GraphPaymentsProxy,
+    PaymentsEscrowProxy,
+    GraphPaymentsProxyAdmin,
+    PaymentsEscrowProxyAdmin,
+  }
+})
diff --git a/packages/horizon/ignition/modules/migrate/migrate-3.ts b/packages/horizon/ignition/modules/migrate/migrate-3.ts
@@ -1,9 +1,9 @@
 import { buildModule } from '@nomicfoundation/hardhat-ignition/modules'
 
-import { MigrateHorizonCoreModule } from './core/core'
-import { MigratePeripheryModule } from './periphery/periphery'
+import { MigrateHorizonCoreModule } from '../core/core'
+import { MigratePeripheryModule } from '../periphery/periphery'
 
-export default buildModule('GraphHorizon_Migrate', (m) => {
+export default buildModule('GraphHorizon_Migrate_3', (m) => {
   const {
     L2Curation,
     RewardsManager,
diff --git a/packages/horizon/ignition/modules/migrate/migrate-4.ts b/packages/horizon/ignition/modules/migrate/migrate-4.ts
@@ -0,0 +1,25 @@
+import { buildModule } from '@nomicfoundation/hardhat-ignition/modules'
+
+import { MigrateCurationGovernorModule } from '../periphery/Curation'
+import { MigrateHorizonStakingGovernorModule } from '../core/HorizonStaking'
+import { MigrateRewardsManagerGovernorModule } from '../periphery/RewardsManager'
+
+export default buildModule('GraphHorizon_Migrate_4', (m) => {
+  const {
+    L2Curation,
+  } = m.useModule(MigrateCurationGovernorModule)
+
+  const {
+    RewardsManager,
+  } = m.useModule(MigrateRewardsManagerGovernorModule)
+
+  const {
+    HorizonStaking,
+  } = m.useModule(MigrateHorizonStakingGovernorModule)
+
+  return {
+    L2Curation,
+    RewardsManager,
+    HorizonStaking,
+  }
+})
diff --git a/packages/horizon/ignition/modules/periphery/Controller.ts b/packages/horizon/ignition/modules/periphery/Controller.ts
@@ -18,14 +18,19 @@ export default buildModule('Controller', (m) => {
   return { Controller }
 })
 
-export const MigrateControllerModule = buildModule('Controller', (m) => {
-  const { GraphProxyAdmin } = m.useModule(MigrateGraphProxyAdminModule)
-
-  const governor = m.getAccount(1)
+export const MigrateControllerDeployerModule = buildModule('ControllerDeployer', (m) => {
   const controllerAddress = m.getParameter('controllerAddress')
 
   const Controller = m.contractAt('Controller', ControllerArtifact, controllerAddress)
 
+  return { Controller }
+})
+
+export const MigrateControllerGovernorModule = buildModule('ControllerGovernor', (m) => {
+  const { GraphProxyAdmin } = m.useModule(MigrateGraphProxyAdminModule)
+  const { Controller } = m.useModule(MigrateControllerDeployerModule)
+  const governor = m.getAccount(1)
+
   // GraphProxyAdmin was not registered in the controller in the original protocol
   m.call(Controller, 'setContractProxy',
     [ethers.keccak256(ethers.toUtf8Bytes('GraphProxyAdmin')), GraphProxyAdmin],
diff --git a/packages/horizon/ignition/modules/periphery/Curation.ts b/packages/horizon/ignition/modules/periphery/Curation.ts
diff --git a/packages/horizon/ignition/modules/periphery/RewardsManager.ts b/packages/horizon/ignition/modules/periphery/RewardsManager.ts
diff --git a/packages/horizon/ignition/modules/periphery/periphery.ts b/packages/horizon/ignition/modules/periphery/periphery.ts
diff --git a/packages/horizon/ignition/modules/proxy/GraphProxy.ts b/packages/horizon/ignition/modules/proxy/GraphProxy.ts
diff --git a/packages/horizon/scripts/migrate.ts b/packages/horizon/scripts/migrate.ts
