chore: add flag to skip confirmation prompt on write actions (#635)

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

Author: tmigone

cli/cli.ts

@@ -27,6 +27,7 @@ yargs
   .option('m', cliOpts.mnemonic)
   .option('p', cliOpts.providerUrl)
   .option('n', cliOpts.accountNumber)
+  .option('s', cliOpts.skipConfirmation)
   .command(deployCommand)
   .command(migrateCommand)
   .command(proxyCommand)

cli/commands/airdrop.ts

@@ -149,6 +149,7 @@ const createBatches = (
 
 export const airdrop = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
   const graphToken = cli.contracts.GraphToken
+  const skipConfirmation = cliArgs.skipConfirmation
 
   // Load data
   const resumeList = loadResumeList(cliArgs.resumefile).map((r) => r.address)
@@ -179,7 +180,10 @@ export const airdrop = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<vo
   }
 
   // Confirmation
-  const sure = await confirm('Are you sure you want to proceed with the distribution?')
+  const sure = await confirm(
+    'Are you sure you want to proceed with the distribution?',
+    skipConfirmation,
+  )
   if (!sure) return
 
   // Approve

cli/commands/deploy.ts

@@ -16,9 +16,10 @@ export const deploy = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<voi
   const initArgs = cliArgs.init
   const deployType = cliArgs.type
   const buildAcceptProxyTx = cliArgs.buildTx
+  const skipConfirmation = cliArgs.skipConfirmation
 
   // Ensure action
-  const sure = await confirm(`Are you sure to deploy ${contractName}?`)
+  const sure = await confirm(`Are you sure to deploy ${contractName}?`, skipConfirmation)
   if (!sure) return
 
   // Deploy contract

cli/commands/migrate.ts

@@ -40,9 +40,10 @@ export const migrate = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<vo
   const force = cliArgs.force
   const contractName = cliArgs.contract
   const chainId = cli.chainId
+  const skipConfirmation = cliArgs.skipConfirmation
 
   // Ensure action
-  const sure = await confirm('Are you sure you want to migrate contracts?')
+  const sure = await confirm('Are you sure you want to migrate contracts?', skipConfirmation)
   if (!sure) return
 
   if (chainId == 1337) {

cli/commands/proxy/admin.ts

@@ -8,11 +8,12 @@ import { confirm } from '../../helpers'
 export const setProxyAdmin = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promise<void> => {
   const contractName = cliArgs.contract
   const adminAddress = cliArgs.admin
+  const skipConfirmation = cliArgs.skipConfirmation
 
   logger.info(`Set proxy admin for contract ${contractName} to ${adminAddress}`)
 
   // Warn about changing ownership
-  const sure = await confirm(`Are you sure to set the admin to ${adminAddress}?`)
+  const sure = await confirm(`Are you sure to set the admin to ${adminAddress}?`, skipConfirmation)
   if (!sure) return
 
   // Get address book info

cli/commands/proxy/upgrade.ts

@@ -10,9 +10,13 @@ export const upgradeProxy = async (cli: CLIEnvironment, cliArgs: CLIArgs): Promi
   const implAddress = cliArgs.impl
   const initArgs = cliArgs.init
   const buildAcceptProxyTx = cliArgs.buildTx
+  const skipConfirmation = cliArgs.skipConfirmation
 
   // Warn about upgrade
-  const sure = await confirm(`Are you sure you want to upgrade ${contractName} to ${implAddress}?`)
+  const sure = await confirm(
+    `Are you sure you want to upgrade ${contractName} to ${implAddress}?`,
+    skipConfirmation,
+  )
   if (!sure) return
 
   logger.info(`Upgrading contract ${contractName}...`)

cli/defaults.ts

@@ -56,4 +56,10 @@ export const cliOpts = {
     type: 'boolean',
     default: false,
   },
+  skipConfirmation: {
+    alias: 'skip-confirmation',
+    description: 'Skip confirmation prompt on write actions',
+    type: 'boolean',
+    default: false,
+  },
 } as { [key: string]: Options }

cli/helpers.ts

@@ -91,7 +91,8 @@ export const pinMetadataToIPFS = async (
   return IPFS.ipfsHashToBytes32(metaHash)
 }
 
-export const confirm = async (message: string): Promise<boolean> => {
+export const confirm = async (message: string, skip: boolean): Promise<boolean> => {
+  if (skip) return true
   const res = await inquirer.prompt({
     name: 'confirm',
     type: 'confirm',

tasks/deployment/config.ts

@@ -7,7 +7,7 @@ import YAML from 'yaml'
 import { Scalar, YAMLMap } from 'yaml/types'
 import { HardhatRuntimeEnvironment } from 'hardhat/types'
 import fs from 'fs'
-import inquirer from 'inquirer'
+import { confirm } from '../../cli/helpers'
 
 interface Contract {
   name: string
@@ -93,10 +93,12 @@ const generalParams: GeneralParam[] = [
 task('update-config', 'Update graph config parameters with onchain data')
   .addParam('graphConfig', cliOpts.graphConfig.description, cliOpts.graphConfig.default)
   .addFlag('dryRun', "Only print the changes, don't write them to the config file")
+  .addFlag('skipConfirmation', cliOpts.skipConfirmation.description)
   .setAction(async (taskArgs, hre) => {
     const networkName = hre.network.name
     const configFile = taskArgs.graphConfig
     const dryRun = taskArgs.dryRun
+    const skipConfirmation = taskArgs.skipConfirmation
 
     if (!fs.existsSync(configFile)) {
       throw new Error(`Could not find config file: ${configFile}`)
@@ -108,15 +110,11 @@ task('update-config', 'Update graph config parameters with onchain data')
 
     // Prompt to avoid accidentally overwriting the config file with data from another network
     if (!configFile.includes(networkName)) {
-      const res = await inquirer.prompt({
-        name: 'confirm',
-        type: 'confirm',
-        default: false,
-        message: `Config file ${configFile} doesn't match 'graph.<networkName>.yml'. Are you sure you want to continue?`,
-      })
-      if (!res.confirm) {
-        return
-      }
+      const sure = await confirm(
+        `Config file ${configFile} doesn't match 'graph.<networkName>.yml'. Are you sure you want to continue?`,
+        skipConfirmation,
+      )
+      if (!sure) return
     }
 
     const graphConfig = readConfig(configFile, true)

tasks/deployment/deploy.ts

@@ -9,6 +9,7 @@ import { migrate } from '../../cli/commands/migrate'
 task('migrate', 'Migrate contracts')
   .addParam('addressBook', cliOpts.addressBook.description, cliOpts.addressBook.default)
   .addParam('graphConfig', cliOpts.graphConfig.description, cliOpts.graphConfig.default)
+  .addFlag('skipConfirmation', cliOpts.skipConfirmation.description)
   .addFlag('force', cliOpts.force.description)
   .setAction(async (taskArgs, hre) => {
     const accounts = await hre.ethers.getSigners()