feat: refactor deployment tooling, use task instead of script

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

Author: tmigone

packages/hardhat-graph-protocol/package.json

@@ -16,8 +16,8 @@
   "main": "./dist/src/index.js",
   "exports": {
     ".": {
-      "types": "./dist/src/index.d.ts",
-      "default": "./dist/src/index.js"
+      "types": "./src/types.ts",
+      "default": "./src/index.ts"
     },
     "./sdk": {
       "types": "./src/sdk/index.ts",
@@ -47,7 +47,9 @@
     "json5": "^2.2.3"
   },
   "devDependencies": {
+    "@nomicfoundation/hardhat-ignition": "^0.15.9",
     "@nomicfoundation/hardhat-verify": "^2.0.12",
+    "@nomicfoundation/ignition-core": "^0.15.9",
     "@types/chai": "^4.0.0",
     "@types/debug": "^4.1.12",
     "@types/mocha": "^10.0.9",

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

@@ -2,6 +2,7 @@ import path from 'path'
 
 import { getAddressBookPath } from './config'
 import { HardhatEthersProvider } from '@nomicfoundation/hardhat-ethers/internal/hardhat-ethers-provider'
+import { lazyFunction } from 'hardhat/plugins'
 import { logDebug } from './logger'
 
 import { GraphHorizonAddressBook } from './sdk/deployments/horizon'
@@ -28,7 +29,7 @@ export const greExtendConfig = (config: HardhatConfig, userConfig: Readonly<Hard
 }
 
 export const greExtendEnvironment = (hre: HardhatRuntimeEnvironment) => {
-  hre.graph = (opts: GraphRuntimeEnvironmentOptions = { deployments: {} }) => {
+  hre.graph = lazyFunction(() => (opts: GraphRuntimeEnvironmentOptions = { deployments: {} }) => {
     logDebug('*** Initializing Graph Runtime Environment (GRE) ***')
     logDebug(`Main network: ${hre.network.name}`)
     const chainId = hre.network.config.chainId
@@ -80,5 +81,5 @@ export const greExtendEnvironment = (hre: HardhatRuntimeEnvironment) => {
     assertGraphRuntimeEnvironment(gre)
     logDebug('GRE initialized successfully!')
     return gre
-  }
+  })
 }

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

@@ -13,8 +13,9 @@ export type AddressBookJson<
 
 export type AddressBookEntry = {
   address: string
-  proxy?: boolean
-  implementation?: AddressBookEntry
+  proxy?: 'graph' | 'transparent'
+  proxyAdmin?: string
+  implementation?: string
 }
 
 /**
@@ -24,8 +25,9 @@ export type AddressBookEntry = {
  *   "<CHAIN_ID>": {
  *     "<CONTRACT_NAME>": {
  *       "address": "<ADDRESS>",
- *       "proxy": true, // optional
- *       "implementation": { ... } // optional, nested contract structure
+ *       "proxy": "<graph|transparent>", // optional
+ *       "proxyAdmin": "<ADDRESS>", // optional
+ *       "implementation": "<ADDRESS>", // optional
  *     ...
  *    }
  * }
@@ -80,7 +82,7 @@ export abstract class AddressBook<
     // If it's empty, initialize it with an empty object
     const fileContents = JSON.parse(fs.readFileSync(this.file, 'utf8') || '{}')
     if (!fileContents[this.chainId]) {
-      fileContents[this.chainId] = {} as Record<ContractName, AddressBookEntry>
+      fileContents[this.chainId] = {}
     }
     this.assertAddressBookJson(fileContents)
     this.addressBook = fileContents
@@ -100,25 +102,29 @@ export abstract class AddressBook<
    * Get an entry from the address book
    *
    * @param name the name of the contract to get
+   * @param strict if true it will throw an error if the contract is not found
    * @returns the address book entry for the contract
    * Returns an empty address book entry if the contract is not found
    */
-  getEntry(name: ContractName): { address: string } {
-    const entry = this.addressBook[this.chainId][name]
-    // Handle both object and string formats
-    if (typeof entry === 'string') {
-      return { address: entry }
+  getEntry(name: string): AddressBookEntry {
+    if (!this.isContractName(name)) {
+      throw new Error(`Contract name ${name} is not a valid contract name`)
     }
+    const entry = this.addressBook[this.chainId][name]
+    this._assertAddressBookEntry(entry)
     return entry
   }
 
   /**
    * Save an entry to the address book
-   *
+   * Allows partial address book entries to be saved
    * @param name the name of the contract to save
    * @param entry the address book entry for the contract
    */
-  setEntry(name: ContractName, entry: AddressBookEntry): void {
+  setEntry(name: ContractName, entry: Partial<AddressBookEntry>): void {
+    if (entry.address === undefined) {
+      entry.address = '0x0000000000000000000000000000000000000000'
+    }
     this._assertAddressBookEntry(entry)
     this.addressBook[this.chainId][name] = entry
     try {
@@ -162,7 +168,8 @@ export abstract class AddressBook<
   ): ContractList<ContractName> {
     const contracts = {} as ContractList<ContractName>
     if (this.listEntries().length == 0) {
-      throw Error('No valid contracts found in address book')
+      logError('No valid contracts found in address book')
+      return contracts
     }
     for (const contractName of this.listEntries()) {
       const artifactPath = typeof artifactsPath === 'object' && !Array.isArray(artifactsPath)
@@ -214,18 +221,17 @@ export abstract class AddressBook<
   // Asserts the provided object is a valid address book entry
   _assertAddressBookEntry(
     entry: unknown,
-  ): asserts entry is { address: string } {
-    if (typeof entry === 'string') {
-      // If it's a string, treat it as an address
-      return
-    }
-
+  ): asserts entry is AddressBookEntry {
     assertObject(entry)
     if (!('address' in entry)) {
       throw new Error('Address book entry must have an address field')
     }
-    if (typeof entry.address !== 'string') {
-      throw new Error('Address book entry address must be a string')
+
+    const allowedFields = ['address', 'implementation', 'proxyAdmin', 'proxy']
+    const entryFields = Object.keys(entry)
+    const invalidFields = entryFields.filter(field => !allowedFields.includes(field))
+    if (invalidFields.length > 0) {
+      throw new Error(`Address book entry contains invalid fields: ${invalidFields.join(', ')}`)
     }
   }
 }

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

@@ -24,6 +24,7 @@ export const GraphHorizonContractNameList = [
   'RewardsManager',
   'L2GraphToken',
   'L2GraphTokenGateway',
+  'L2Curation',
 
   // @graphprotocol/horizon
   'HorizonStaking',
@@ -32,7 +33,7 @@ export const GraphHorizonContractNameList = [
   'GraphTallyCollector',
 ] 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 HORIZON_ARTIFACTS_PATH = path.resolve(root, 'node_modules', '@graphprotocol/horizon/build/contracts')
 
@@ -44,6 +45,7 @@ export const GraphHorizonArtifactsMap = {
   RewardsManager: CONTRACTS_ARTIFACTS_PATH,
   L2GraphToken: CONTRACTS_ARTIFACTS_PATH,
   L2GraphTokenGateway: CONTRACTS_ARTIFACTS_PATH,
+  L2Curation: CONTRACTS_ARTIFACTS_PATH,
 
   // @graphprotocol/horizon
   HorizonStaking: HORIZON_ARTIFACTS_PATH,

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

@@ -13,19 +13,6 @@ interface SecureAccountsOptions {
 const ARBITRUM_ONE_RPC = vars.get('ARBITRUM_ONE_RPC', 'https://arb1.arbitrum.io/rpc')
 const ARBITRUM_SEPOLIA_RPC = vars.get('ARBITRUM_SEPOLIA_RPC', 'https://sepolia-rollup.arbitrum.io/rpc')
 
-// Accounts
-const getTestnetAccounts = () => {
-  const accounts: string[] = []
-  if (vars.has('DEPLOYER_PRIVATE_KEY')) accounts.push(vars.get('DEPLOYER_PRIVATE_KEY'))
-  if (vars.has('GOVERNOR_PRIVATE_KEY')) accounts.push(vars.get('GOVERNOR_PRIVATE_KEY'))
-  return accounts
-}
-const getHardhatAccounts = () => {
-  return {
-    mnemonic: 'myth like bonus scare over problem client lizard pioneer submit female collect',
-  }
-}
-
 export const solidityUserConfig: SolidityUserConfig = {
   version: '0.8.27',
   settings: {
@@ -57,15 +44,19 @@ type BaseNetworksUserConfig = NetworksUserConfig &
 export const networksUserConfig: BaseNetworksUserConfig = {
   hardhat: {
     chainId: 31337,
-    accounts: getHardhatAccounts(),
+    accounts: {
+      mnemonic: 'myth like bonus scare over problem client lizard pioneer submit female collect',
+    },
     deployments: {
       horizon: require.resolve('@graphprotocol/horizon/addresses-local.json'),
     },
   },
   localhost: {
     chainId: 31337,
     url: 'http://localhost:8545',
-    accounts: getTestnetAccounts(),
+    secureAccounts: {
+      enabled: true,
+    },
     deployments: {
       horizon: require.resolve('@graphprotocol/horizon/addresses-local.json'),
     },

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

@@ -5,6 +5,7 @@ require('json5/lib/register')
 
 import fs from 'fs'
 import path from 'path'
+import { AddressBook } from '../address-book'
 
 export function loadConfig(configPath: string, prefix: string, networkName: string): any {
   const configFileCandidates = [
@@ -19,7 +20,7 @@ export function loadConfig(configPath: string, prefix: string, networkName: stri
     )
   }
 
-  return removeNFromBigInts(require(configFile))
+  return { config: removeNFromBigInts(require(configFile)), file: configFile }
 }
 
 export function patchConfig(jsonData: any, patches: Record<string, any>) {
@@ -55,40 +56,62 @@ export function mergeConfigs(obj1: any, obj2: any) {
   return merged
 }
 
-export function saveAddressBook(
+export function saveToAddressBook<ChainId extends number, ContractName extends string>(
   contracts: any,
   chainId: number | undefined,
-  addressBook = 'addresses.json',
-): Record<string, Record<string, string>> {
+  addressBook: AddressBook<ChainId, ContractName>,
+): AddressBook<ChainId, ContractName> {
   if (!chainId) {
     throw new Error('Chain ID is required')
   }
 
-  // Use different address book for local networks - this one can be gitignored
-  if ([1377, 31337].includes(chainId)) {
-    addressBook = 'addresses-local.json'
-  }
+  // Extract contract names and addresses
+  for (const [ignitionContractName, contract] of Object.entries(contracts)) {
+    // Proxy contracts
+    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)
+      addressBook.setEntry(contractName, {
+        ...entry,
+        address: (contract as any).target,
+        proxy,
+      })
+    }
 
-  const output = fs.existsSync(addressBook)
-    ? JSON.parse(fs.readFileSync(addressBook, 'utf8'))
-    : {}
+    // Proxy admin contracts
+    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)
+      addressBook.setEntry(contractName, {
+        ...entry,
+        proxy,
+        proxyAdmin: (contract as any).target,
+      })
+    }
 
-  output[chainId] = output[chainId] || {}
+    // Implementation contracts
+    if (ignitionContractName.startsWith('Implementation_')) {
+      const contractName = ignitionContractName.replace('Implementation_', '') as ContractName
+      const entry = addressBook.getEntry(contractName)
+      addressBook.setEntry(contractName, {
+        ...entry,
+        implementation: (contract as any).target,
+      })
+    }
 
-  // Extract contract names and addresses
-  Object.entries(contracts).forEach(([contractName, contract]: [string, any]) => {
-    output[chainId][contractName] = contract.target
-  })
-
-  // Write to output file
-  const outputDir = path.dirname(addressBook)
-  if (!fs.existsSync(outputDir)) {
-    fs.mkdirSync(outputDir, { recursive: true })
+    // Non proxied contracts
+    if (addressBook.isContractName(ignitionContractName)) {
+      const entry = addressBook.getEntry(ignitionContractName)
+      addressBook.setEntry(ignitionContractName, {
+        ...entry,
+        address: (contract as any).target,
+      })
+    }
   }
 
-  fs.writeFileSync(addressBook, JSON.stringify(output, null, 2))
-
-  return output as Record<string, Record<string, string>>
+  return addressBook
 }
 
 // Ignition requires "n" suffix for bigints, but not here

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

@@ -1,5 +1,5 @@
-import { loadConfig, mergeConfigs, patchConfig, saveAddressBook } from './ignition/ignition'
+import { loadConfig, mergeConfigs, patchConfig, saveToAddressBook } from './ignition/ignition'
 import { hardhatBaseConfig } from './hardhat.base.config'
 
-const IgnitionHelper = { saveAddressBook, loadConfig, patchConfig, mergeConfigs }
+const IgnitionHelper = { saveToAddressBook, loadConfig, patchConfig, mergeConfigs }
 export { hardhatBaseConfig, IgnitionHelper }

packages/horizon/hardhat.config.ts

@@ -8,6 +8,8 @@ import 'hardhat-storage-layout'
 import 'hardhat-contract-sizer'
 import 'hardhat-secure-accounts'
 
+import './tasks/deploy'
+
 // Skip importing hardhat-graph-protocol when building the project, it has circular dependency
 if (process.env.BUILD_RUN !== 'true') {
   require('hardhat-graph-protocol')

packages/horizon/ignition/modules/core/GraphPayments.ts

@@ -33,7 +33,7 @@ export default buildModule('GraphPayments', (m) => {
 
   m.call(GraphPaymentsProxyAdmin, 'transferOwnership', [governor], { after: [GraphPayments] })
 
-  return { GraphPayments, GraphPaymentsProxyAdmin }
+  return { GraphPayments, GraphPaymentsProxyAdmin, GraphPaymentsImplementation }
 })
 
 // Note that this module requires MigrateHorizonProxiesGovernorModule to be executed first
@@ -66,5 +66,5 @@ export const MigrateGraphPaymentsModule = buildModule('GraphPayments', (m) => {
 
   m.call(GraphPaymentsProxyAdmin, 'transferOwnership', [governor], { after: [GraphPayments] })
 
-  return { GraphPayments, GraphPaymentsProxyAdmin }
+  return { GraphPayments, GraphPaymentsProxyAdmin, GraphPaymentsImplementation }
 })

packages/horizon/ignition/modules/core/HorizonStaking.ts

@@ -43,7 +43,7 @@ export default buildModule('HorizonStaking', (m) => {
   })
   m.call(HorizonStaking, 'setMaxThawingPeriod', [maxThawingPeriod])
 
-  return { HorizonStaking }
+  return { HorizonStaking, HorizonStakingImplementation }
 })
 
 // Note that this module requires MigrateHorizonProxiesGovernorModule to be executed first
@@ -95,5 +95,5 @@ export const MigrateHorizonStakingGovernorModule = buildModule('HorizonStakingGo
   })
   m.call(HorizonStaking, 'setMaxThawingPeriod', [maxThawingPeriod])
 
-  return { HorizonStaking }
+  return { HorizonStaking, HorizonStakingImplementation }
 })