Add new useAccount helper an upgrade commands (#5311)

* Add new helper to select a user account

* Upgrade commands to use useAccount

Author: NullSoldier

ironfish-cli/src/commands/wallet/assets.ts

@@ -9,11 +9,11 @@ import {
   PUBLIC_ADDRESS_LENGTH,
 } from '@ironfish/rust-nodejs'
 import { BufferUtils } from '@ironfish/sdk'
-import { Args, Flags } from '@oclif/core'
+import { Flags } from '@oclif/core'
 import { IronfishCommand } from '../../command'
 import { RemoteFlags } from '../../flags'
 import { table, TableFlags } from '../../ui'
-import { renderAssetWithVerificationStatus } from '../../utils'
+import { renderAssetWithVerificationStatus, useAccount } from '../../utils'
 import { TableCols } from '../../utils/table'
 
 const MAX_ASSET_METADATA_COLUMN_WIDTH = ASSET_METADATA_LENGTH + 1
@@ -25,13 +25,6 @@ const MIN_ASSET_NAME_COLUMN_WIDTH = ASSET_NAME_LENGTH / 2 + 1
 export class AssetsCommand extends IronfishCommand {
   static description = `list the account's assets`
 
-  static args = {
-    account: Args.string({
-      required: false,
-      description: 'Name of the account. DEPRECATED: use --account flag',
-    }),
-  }
-
   static flags = {
     ...RemoteFlags,
     ...TableFlags,
@@ -42,11 +35,12 @@ export class AssetsCommand extends IronfishCommand {
   }
 
   async start(): Promise<void> {
-    const { flags, args } = await this.parse(AssetsCommand)
-    // TODO: remove account arg
-    const account = flags.account ? flags.account : args.account
+    const { flags } = await this.parse(AssetsCommand)
 
     const client = await this.connectRpc()
+
+    const account = await useAccount(client, flags.account)
+
     const response = client.wallet.getAssets({
       account,
     })

ironfish-cli/src/commands/wallet/balance.ts

@@ -2,11 +2,11 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
 import { CurrencyUtils, GetBalanceResponse, isNativeIdentifier, RpcAsset } from '@ironfish/sdk'
-import { Args, Flags } from '@oclif/core'
+import { Flags } from '@oclif/core'
 import { IronfishCommand } from '../../command'
 import { RemoteFlags } from '../../flags'
 import * as ui from '../../ui'
-import { renderAssetWithVerificationStatus } from '../../utils'
+import { renderAssetWithVerificationStatus, useAccount } from '../../utils'
 
 export class BalanceCommand extends IronfishCommand {
   static description = `show the account's balance for an asset
@@ -27,13 +27,6 @@ Balance is your coins from all of your transactions, even if they are on forks o
     },
   ]
 
-  static args = {
-    account: Args.string({
-      required: false,
-      description: 'Name of the account to get balance for. DEPRECATED: use --account flag',
-    }),
-  }
-
   static flags = {
     ...RemoteFlags,
     account: Flags.string({
@@ -59,12 +52,12 @@ Balance is your coins from all of your transactions, even if they are on forks o
   }
 
   async start(): Promise<void> {
-    const { flags, args } = await this.parse(BalanceCommand)
-    // TODO: remove account arg
-    const account = flags.account ? flags.account : args.account
+    const { flags } = await this.parse(BalanceCommand)
 
     const client = await this.connectRpc()
 
+    const account = await useAccount(client, flags.account)
+
     const response = await client.wallet.getAccountBalance({
       account,
       assetId: flags.assetId,

ironfish-cli/src/commands/wallet/balances.ts

@@ -2,24 +2,17 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
 import { BufferUtils, CurrencyUtils, GetBalancesResponse, RpcAsset } from '@ironfish/sdk'
-import { Args, Flags } from '@oclif/core'
+import { Flags } from '@oclif/core'
 import { IronfishCommand } from '../../command'
 import { RemoteFlags } from '../../flags'
 import { table, TableColumns, TableFlags } from '../../ui'
-import { compareAssets, renderAssetWithVerificationStatus } from '../../utils'
+import { compareAssets, renderAssetWithVerificationStatus, useAccount } from '../../utils'
 
 type AssetBalancePairs = { asset: RpcAsset; balance: GetBalancesResponse['balances'][number] }
 
 export class BalancesCommand extends IronfishCommand {
   static description = `show the account's balance for all assets`
 
-  static args = {
-    account: Args.string({
-      required: false,
-      description: 'Name of the account to get balances for. DEPRECATED: use --account flag',
-    }),
-  }
-
   static flags = {
     ...RemoteFlags,
     ...TableFlags,
@@ -38,11 +31,11 @@ export class BalancesCommand extends IronfishCommand {
   }
 
   async start(): Promise<void> {
-    const { flags, args } = await this.parse(BalancesCommand)
+    const { flags } = await this.parse(BalancesCommand)
     const client = await this.connectRpc()
 
-    // TODO: remove account arg
-    const account = flags.account ? flags.account : args.account
+    const account = await useAccount(client, flags.account)
+
     const response = await client.wallet.getAccountBalances({
       account,
       confirmations: flags.confirmations,

ironfish-cli/src/commands/wallet/burn.ts

@@ -14,6 +14,7 @@ import { Flags, ux } from '@oclif/core'
 import { IronfishCommand } from '../../command'
 import { IronFlag, RemoteFlags, ValueFlag } from '../../flags'
 import * as ui from '../../ui'
+import { useAccount } from '../../utils'
 import { promptCurrency } from '../../utils/currency'
 import { promptExpiration } from '../../utils/expiration'
 import { getExplorer } from '../../utils/explorer'
@@ -108,19 +109,7 @@ This will destroy tokens and decrease supply for a given asset.`
       }
     }
 
-    let account = flags.account
-    if (!account) {
-      const response = await client.wallet.getDefaultAccount()
-
-      if (!response.content.account) {
-        this.error(
-          `No account is currently active.
-           Use ironfish wallet:create <name> to first create an account`,
-        )
-      }
-
-      account = response.content.account.name
-    }
+    const account = await useAccount(client, flags.account)
 
     let assetId = flags.assetId
 

ironfish-cli/src/commands/wallet/export.ts

@@ -2,27 +2,25 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
 import { AccountFormat, ErrorUtils, LanguageUtils } from '@ironfish/sdk'
-import { Args, Flags } from '@oclif/core'
+import { Flags } from '@oclif/core'
 import fs from 'fs'
 import path from 'path'
 import { IronfishCommand } from '../../command'
 import { EnumLanguageKeyFlag, JsonFlags, RemoteFlags } from '../../flags'
 import { confirmOrQuit } from '../../ui'
+import { useAccount } from '../../utils'
 
 export class ExportCommand extends IronfishCommand {
   static description = `export an account`
   static enableJsonFlag = true
 
-  static args = {
-    account: Args.string({
-      required: false,
-      description: 'Name of the account to export',
-    }),
-  }
-
   static flags = {
     ...RemoteFlags,
     ...JsonFlags,
+    account: Flags.string({
+      char: 'a',
+      description: 'Name of the account to export',
+    }),
     local: Flags.boolean({
       default: false,
       description: 'Export an account without an online node',
@@ -47,9 +45,8 @@ export class ExportCommand extends IronfishCommand {
   }
 
   async start(): Promise<unknown> {
-    const { flags, args } = await this.parse(ExportCommand)
+    const { flags } = await this.parse(ExportCommand)
     const { local, path: exportPath, viewonly: viewOnly } = flags
-    const { account } = args
 
     if (flags.language) {
       flags.mnemonic = true
@@ -62,6 +59,9 @@ export class ExportCommand extends IronfishCommand {
       : AccountFormat.Base64Json
 
     const client = await this.connectRpc(local)
+
+    const account = await useAccount(client, flags.account)
+
     const response = await client.wallet.exportAccount({
       account,
       viewOnly,

ironfish-cli/src/commands/wallet/mint.ts

@@ -18,6 +18,7 @@ import { Flags, ux } from '@oclif/core'
 import { IronfishCommand } from '../../command'
 import { IronFlag, RemoteFlags, ValueFlag } from '../../flags'
 import * as ui from '../../ui'
+import { useAccount } from '../../utils'
 import { promptCurrency } from '../../utils/currency'
 import { promptExpiration } from '../../utils/expiration'
 import { getExplorer } from '../../utils/explorer'
@@ -129,19 +130,7 @@ This will create tokens and increase supply for a given asset.`
       }
     }
 
-    let account = flags.account
-    if (!account) {
-      const response = await client.wallet.getDefaultAccount()
-
-      if (!response.content.account) {
-        this.error(
-          `No account is currently active.
-           Use ironfish wallet:create <name> to first create an account`,
-        )
-      }
-
-      account = response.content.account.name
-    }
+    const account = await useAccount(client, flags.account)
 
     const publicKeyResponse = await client.wallet.getAccountPublicKey({ account })
     const accountPublicKey = publicKeyResponse.content.publicKey

ironfish-cli/src/commands/wallet/notes/index.ts

@@ -2,23 +2,17 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
 import { CurrencyUtils, RpcAsset } from '@ironfish/sdk'
-import { Args, Flags } from '@oclif/core'
+import { Flags } from '@oclif/core'
 import { IronfishCommand } from '../../../command'
 import { RemoteFlags } from '../../../flags'
 import { table, TableFlags } from '../../../ui'
+import { useAccount } from '../../../utils'
 import { TableCols } from '../../../utils/table'
 
 const { sort: _, ...tableFlags } = TableFlags
 export class NotesCommand extends IronfishCommand {
   static description = `list the account's notes`
 
-  static args = {
-    account: Args.string({
-      required: false,
-      description: 'Name of the account to get notes for. DEPRECATED: use --account flag',
-    }),
-  }
-
   static flags = {
     ...RemoteFlags,
     ...tableFlags,
@@ -29,14 +23,14 @@ export class NotesCommand extends IronfishCommand {
   }
 
   async start(): Promise<void> {
-    const { flags, args } = await this.parse(NotesCommand)
-    // TODO: remove account arg
-    const account = flags.account ? flags.account : args.account
+    const { flags } = await this.parse(NotesCommand)
 
     const assetLookup: Map<string, RpcAsset> = new Map()
 
     const client = await this.connectRpc()
 
+    const account = await useAccount(client, flags.account)
+
     const response = client.wallet.getAccountNotesStream({ account })
 
     let showHeader = !flags['no-header']

ironfish-cli/src/commands/wallet/reset.ts

@@ -2,23 +2,21 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
 
-import { Args, Flags } from '@oclif/core'
+import { Flags } from '@oclif/core'
 import { IronfishCommand } from '../../command'
 import { RemoteFlags } from '../../flags'
 import { confirmOrQuit } from '../../ui'
+import { useAccount } from '../../utils'
 
 export class ResetCommand extends IronfishCommand {
   static description = `resets an account's balance and rescans`
 
-  static args = {
-    account: Args.string({
-      required: true,
-      description: 'Name of the account to reset',
-    }),
-  }
-
   static flags = {
     ...RemoteFlags,
+    account: Flags.string({
+      char: 'a',
+      description: 'Name of the account to reset',
+    }),
     resetCreated: Flags.boolean({
       default: false,
       description: 'Reset the accounts birthday',
@@ -34,8 +32,11 @@ export class ResetCommand extends IronfishCommand {
   }
 
   async start(): Promise<void> {
-    const { args, flags } = await this.parse(ResetCommand)
-    const { account } = args
+    const { flags } = await this.parse(ResetCommand)
+
+    const client = await this.connectRpc()
+
+    const account = await useAccount(client, flags.account)
 
     await confirmOrQuit(
       `Are you sure you want to reset the account '${account}'?` +
@@ -45,8 +46,6 @@ export class ResetCommand extends IronfishCommand {
       flags.confirm,
     )
 
-    const client = await this.connectRpc()
-
     await client.wallet.resetAccount({
       account,
       resetCreatedAt: flags.resetCreated,

ironfish-cli/src/commands/wallet/send.ts

@@ -16,6 +16,7 @@ import { Flags } from '@oclif/core'
 import { IronfishCommand } from '../../command'
 import { HexFlag, IronFlag, RemoteFlags, ValueFlag } from '../../flags'
 import * as ui from '../../ui'
+import { useAccount } from '../../utils'
 import { promptCurrency } from '../../utils/currency'
 import { promptExpiration } from '../../utils/expiration'
 import { getExplorer } from '../../utils/explorer'
@@ -121,7 +122,6 @@ export class Send extends IronfishCommand {
     const { flags } = await this.parse(Send)
     let assetId = flags.assetId
     let to = flags.to
-    let from = flags.account
 
     const client = await this.connectRpc()
 
@@ -135,6 +135,8 @@ export class Send extends IronfishCommand {
       }
     }
 
+    const from = await useAccount(client, flags.account, 'Select an account to send from')
+
     if (assetId == null) {
       const asset = await ui.assetPrompt(client, from, {
         action: 'send',
@@ -190,19 +192,6 @@ export class Send extends IronfishCommand {
       })
     }
 
-    if (!from) {
-      const response = await client.wallet.getDefaultAccount()
-
-      if (!response.content.account) {
-        this.error(
-          `No account is currently active.
-           Use ironfish wallet:create <name> to first create an account`,
-        )
-      }
-
-      from = response.content.account.name
-    }
-
     if (!to) {
       to = await ui.inputPrompt('Enter the public address of the recipient', true)
     }