build: update migrate config to avoid conflict and improve logging (#257)

Author: abarmat

graph.config.yml

@@ -4,32 +4,38 @@ general:
 
 contracts:
   Curation:
-    token: "${{GraphToken.address}}"
-    reserveRatio: 500000 # 50% bonding curve reserve ratio parameter
-    minimumCurationStake: "100000000000000000000" # 100 GRT
-    __proxy: true
-    __calls:
+    init:
+      token: "${{GraphToken.address}}"
+      reserveRatio: 500000 # 50% bonding curve reserve ratio parameter
+      minimumCurationStake: "100000000000000000000" # 100 GRT
+    proxy: true
+    calls:
       - fn: "setWithdrawalFeePercentage"
         withdrawalFeePercentage: 50000 # 5% fee for redeeming signal
   DisputeManager:
-    arbitrator: *arbitrator
-    token: "${{GraphToken.address}}"
-    staking: "${{Staking.address}}"
-    minimumDeposit: "100000000000000000000" # 100 GRT
-    fishermanRewardPercentage: 100000 # in basis points
-    slashingPercentage: 50000 # in basis points
+    init:
+      arbitrator: *arbitrator
+      token: "${{GraphToken.address}}"
+      staking: "${{Staking.address}}"
+      minimumDeposit: "100000000000000000000" # 100 GRT
+      fishermanRewardPercentage: 100000 # in basis points
+      slashingPercentage: 50000 # in basis points
   EpochManager:
-    lengthInBlocks: 5760 # One day in blocks
-    __proxy: true
+    init:
+      lengthInBlocks: 5760 # One day in blocks
+    proxy: true
   GNS:
-    didRegistry: "0xdca7ef03e98e0dc2b855be647c39abe984fcf21b"
+    init:
+      didRegistry: "0xdca7ef03e98e0dc2b855be647c39abe984fcf21b"
   GraphToken:
-    initialSupply: "10000000000000000000000000" # 10000000 GRT
+    init:
+      initialSupply: "10000000000000000000000000" # 10000000 GRT
   Staking:
-    token: "${{GraphToken.address}}"
-    epochManager: "${{EpochManager.address}}"
-    __proxy: true
-    __calls:
+    init:
+      token: "${{GraphToken.address}}"
+      epochManager: "${{EpochManager.address}}"
+    proxy: true
+    calls:
       - fn: "setCuration"
         curation: "${{Curation.address}}"
       - fn: "setChannelDisputeEpochs"
@@ -39,9 +45,10 @@ contracts:
       - fn: "setThawingPeriod"
         thawingPeriod: 20 # in blocks
   MinimumViableMultisig:
-    node: *nodeSignerAddress
-    staking: "${{Staking.address}}"
-    CTDT: "${{IndexerCTDT.address}}"
-    singleAssetInterpreter: "${{IndexerSingleAssetInterpreter.address}}"
-    multiAssetInterpreter: "${{IndexerMultiAssetInterpreter.address}}"
-    withdrawInterpreter: "${{IndexerWithdrawInterpreter.address}}"
+    init:
+      node: *nodeSignerAddress
+      staking: "${{Staking.address}}"
+      CTDT: "${{IndexerCTDT.address}}"
+      singleAssetInterpreter: "${{IndexerSingleAssetInterpreter.address}}"
+      multiAssetInterpreter: "${{IndexerMultiAssetInterpreter.address}}"
+      withdrawInterpreter: "${{IndexerWithdrawInterpreter.address}}"

scripts/cli/commands/deploy.ts

@@ -12,7 +12,7 @@ export const deploy = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<voi
   const contractName = cliArgs.contract
   const initArgs = cliArgs.init
 
-  logger.info(`Deploying contract ${contractName}...`)
+  logger.log(`Deploying contract ${contractName}...`)
 
   // Deploy contract
   const contractArgs = initArgs ? initArgs.split(',') : []

scripts/cli/commands/migrate.ts

@@ -39,7 +39,7 @@ export const migrate = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<vo
   const force = cliArgs.force
   const contractName = cliArgs.contract
 
-  logger.info(`Migrating contracts...`)
+  logger.log(`>>> Migrating contracts <<<\n`)
 
   const graphConfig = readConfig(graphConfigPath)
 
@@ -54,13 +54,13 @@ export const migrate = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<vo
   const deployContracts = contractName ? [contractName] : allContracts
   const pendingContractCalls = []
 
-  logger.log(`== Contracts deployment\n`)
+  logger.log(`>>> Contracts deployment\n`)
   for (const name of deployContracts) {
     // Get address book info
     const addressEntry = cli.addressBook.getEntry(name)
     const savedAddress = addressEntry && addressEntry.address
 
-    logger.info(`Deploying ${name}...`)
+    logger.info(`[Deploying ${name}]`)
 
     // Check if contract already deployed
     const isDeployed = await isContractDeployed(
@@ -70,7 +70,7 @@ export const migrate = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<vo
       cli.wallet.provider,
     )
     if (!force && isDeployed) {
-      logger.info(`${name} is up to date, no action required`)
+      logger.log(`${name} is up to date, no action required`)
       logger.log(`Address: ${savedAddress}\n`)
       continue
     }
@@ -98,12 +98,12 @@ export const migrate = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<vo
   // Run contracts calls
 
   logger.log('')
-  logger.log(`== Contracts calls\n`)
+  logger.log(`>>> Contracts calls\n`)
   if (pendingContractCalls.length > 0) {
     for (const entry of pendingContractCalls) {
       if (entry.calls.length == 0) continue
 
-      logger.info(`Configuring ${entry.name}...`)
+      logger.info(`[Configuring ${entry.name}]`)
       for (const call of entry.calls) {
         await sendTransaction(cli.wallet, entry.contract, call.fn, ...call.params)
       }
@@ -116,7 +116,7 @@ export const migrate = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<vo
   ////////////////////////////////////////
   // Print summary
   logger.log('')
-  logger.log(`== Summary\n`)
+  logger.log(`>>> Summary\n`)
   logger.success('All done!')
   const spent = formatEther(cli.balance.sub(await cli.wallet.getBalance()))
   const nTx = (await cli.wallet.getTransactionCount()) - cli.nonce

scripts/cli/commands/upgrade.ts

@@ -13,7 +13,7 @@ export const upgrade = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<vo
   const implAddress = cliArgs.impl
   const initArgs = cliArgs.init
 
-  logger.info(`Upgrading contract ${contractName}...`)
+  logger.log(`Upgrading contract ${contractName}...`)
 
   // Get address book info
   const addressEntry = cli.addressBook.getEntry(contractName)

scripts/cli/commands/verify.ts

@@ -24,7 +24,7 @@ const coreContracts = [
 const logger = consola.create({})
 
 export const verify = async (cli: CLIEnvironment): Promise<void> => {
-  logger.info(`Verifying contracts for chainId ${cli.chainId}...`)
+  logger.log(`Verifying contracts for chainId ${cli.chainId}...`)
 
   for (const contractName of coreContracts) {
     const contract = cli.addressBook.getEntry(contractName)

scripts/cli/config.ts

@@ -47,10 +47,23 @@ export function getContractConfig(
   const contractCalls: ContractCalls = []
   let proxy = false
 
-  for (const [name, value] of Object.entries(contractConfig) as Array<Array<string>>) {
+  const optsList = Object.entries(contractConfig) as Array<Array<string>>
+  for (const [name, value] of optsList) {
+    // Process constructor params
+    if (name.startsWith('init')) {
+      const initList = Object.entries(contractConfig.init) as Array<Array<string>>
+      for (const [initName, initValue] of initList) {
+        contractParams.push({ name: initName, value: parseConfigValue(initValue, addressBook) } as {
+          name: string
+          value: string
+        })
+      }
+      continue
+    }
+
     // Process contract calls
-    if (name.startsWith('__calls')) {
-      for (const entry of contractConfig.__calls) {
+    if (name.startsWith('calls')) {
+      for (const entry of contractConfig.calls) {
         const fn = entry['fn']
         const params = Object.entries(entry)
           .slice(1) // skip fn
@@ -61,16 +74,10 @@ export function getContractConfig(
     }
 
     // Process proxy
-    if (name.startsWith('__proxy')) {
+    if (name.startsWith('proxy')) {
       proxy = Boolean(value)
       continue
     }
-
-    // Process constructor params
-    contractParams.push({ name, value: parseConfigValue(value, addressBook) } as {
-      name: string
-      value: string
-    })
   }
 
   return {