Update wallet command descriptions (#5277)

NullSoldier · web-flow · commit b92d6c150b3b · 2024-08-15T19:07:03.000Z
diff --git a/ironfish-cli/package.json b/ironfish-cli/package.json
@@ -100,9 +100,6 @@
       "@oclif/plugin-warn-if-update-available"
     ],
     "topics": {
-      "wallet:scanning": {
-        "description": "Turn on or off scanning for accounts"
-      },
       "chain": {
         "description": "commands for the blockchain"
       },
@@ -112,6 +109,9 @@
       "chain:assets": {
         "description": "commands to look at assets"
       },
+      "chain:transactions": {
+        "description": "commands to look at transactions"
+      },
       "rpc": {
         "description": "commands for the RPC server"
       },
@@ -124,6 +124,18 @@
       "wallet": {
         "description": "commands for the wallet"
       },
+      "wallet:multisig": {
+        "description": "commands for multisig accounts"
+      },
+      "wallet:notes": {
+        "description": "commands for account notes"
+      },
+      "wallet:scanning": {
+        "description": "commands for managing scanning"
+      },
+      "wallet:transactions": {
+        "description": "commands for account transactions"
+      },
       "workers": {
         "description": "commands for the worker pool"
       }
diff --git a/ironfish-cli/src/commands/wallet/address.ts b/ironfish-cli/src/commands/wallet/address.ts
@@ -6,7 +6,7 @@ import { IronfishCommand } from '../../command'
 import { RemoteFlags } from '../../flags'
 
 export class AddressCommand extends IronfishCommand {
-  static description = `Display your account address
+  static description = `show the account's public address
 
   The address for an account is the accounts public key, see more here: https://ironfish.network/docs/whitepaper/5_account`
 
diff --git a/ironfish-cli/src/commands/wallet/assets.ts b/ironfish-cli/src/commands/wallet/assets.ts
@@ -23,7 +23,7 @@ const MAX_ASSET_NAME_COLUMN_WIDTH = ASSET_NAME_LENGTH + 1
 const MIN_ASSET_NAME_COLUMN_WIDTH = ASSET_NAME_LENGTH / 2 + 1
 
 export class AssetsCommand extends IronfishCommand {
-  static description = `Display the wallet's assets`
+  static description = `list the account's assets`
 
   static args = {
     account: Args.string({
diff --git a/ironfish-cli/src/commands/wallet/balance.ts b/ironfish-cli/src/commands/wallet/balance.ts
@@ -9,11 +9,23 @@ import * as ui from '../../ui'
 import { renderAssetWithVerificationStatus } from '../../utils'
 
 export class BalanceCommand extends IronfishCommand {
-  static description =
-    'Display the account balance\n\
-  What is the difference between available to spend balance, and balance?\n\
-  Available to spend balance is your coins from transactions that have been mined on blocks on your main chain.\n\
-  Balance is your coins from all of your transactions, even if they are on forks or not yet included as part of a mined block.'
+  static description = `show the account's balance for an asset
+
+What is the difference between available to spend balance, and balance?\n\
+Available to spend balance is your coins from transactions that have been mined on blocks on your main chain.\n\
+Balance is your coins from all of your transactions, even if they are on forks or not yet included as part of a mined block.`
+
+  static examples = [
+    {
+      description: 'show the balance for $IRON asset',
+      command: 'ironfish wallet:balance',
+    },
+    {
+      description: 'show the balance for $IRON asset',
+      command:
+        'ironfish wallet:balance --assetId 51f33a2f14f92735e562dc658a5639279ddca3d5079a6d1242b2a588a9cbf44c',
+    },
+  ]
 
   static args = {
     account: Args.string({
diff --git a/ironfish-cli/src/commands/wallet/balances.ts b/ironfish-cli/src/commands/wallet/balances.ts
@@ -11,7 +11,7 @@ import { compareAssets, renderAssetWithVerificationStatus } from '../../utils'
 type AssetBalancePairs = { asset: RpcAsset; balance: GetBalancesResponse['balances'][number] }
 
 export class BalancesCommand extends IronfishCommand {
-  static description = `Display the account's balances for all assets`
+  static description = `show the account's balance for all assets`
 
   static args = {
     account: Args.string({
diff --git a/ironfish-cli/src/commands/wallet/burn.ts b/ironfish-cli/src/commands/wallet/burn.ts
@@ -22,7 +22,9 @@ import { selectFee } from '../../utils/fees'
 import { watchTransaction } from '../../utils/transaction'
 
 export class Burn extends IronfishCommand {
-  static description = 'Burn tokens and decrease supply for a given asset'
+  static description = `create a transaction to burn tokens
+
+This will destroy tokens and decrease supply for a given asset.`
 
   static examples = [
     '$ ironfish wallet:burn --assetId 618c098d8d008c9f78f6155947014901a019d9ec17160dc0f0d1bb1c764b29b4 --amount 1000',
diff --git a/ironfish-cli/src/commands/wallet/create.ts b/ironfish-cli/src/commands/wallet/create.ts
@@ -8,7 +8,7 @@ import { RemoteFlags } from '../../flags'
 import { inputPrompt } from '../../ui'
 
 export class CreateCommand extends IronfishCommand {
-  static description = `Create a new account for sending and receiving coins`
+  static description = `create a new account`
 
   static args = {
     name: Args.string({
diff --git a/ironfish-cli/src/commands/wallet/delete.ts b/ironfish-cli/src/commands/wallet/delete.ts
@@ -8,7 +8,7 @@ import { RemoteFlags } from '../../flags'
 import { inputPrompt } from '../../ui'
 
 export class DeleteCommand extends IronfishCommand {
-  static description = `Permanently delete an account`
+  static description = `delete an account`
 
   static args = {
     account: Args.string({
diff --git a/ironfish-cli/src/commands/wallet/export.ts b/ironfish-cli/src/commands/wallet/export.ts
@@ -10,7 +10,7 @@ import { EnumLanguageKeyFlag, JsonFlags, RemoteFlags } from '../../flags'
 import { confirmOrQuit } from '../../ui'
 
 export class ExportCommand extends IronfishCommand {
-  static description = `Export an account`
+  static description = `export an account`
   static enableJsonFlag = true
 
   static args = {
diff --git a/ironfish-cli/src/commands/wallet/import.ts b/ironfish-cli/src/commands/wallet/import.ts
@@ -15,7 +15,7 @@ import { importFile, importPipe, longPrompt } from '../../utils/input'
 import { Ledger } from '../../utils/ledger'
 
 export class ImportCommand extends IronfishCommand {
-  static description = `Import an account`
+  static description = `import an account`
 
   static args = {
     blob: Args.string({
diff --git a/ironfish-cli/src/commands/wallet/mint.ts b/ironfish-cli/src/commands/wallet/mint.ts
@@ -26,7 +26,9 @@ import { selectFee } from '../../utils/fees'
 import { watchTransaction } from '../../utils/transaction'
 
 export class Mint extends IronfishCommand {
-  static description = 'Mint tokens and increase supply for a given asset'
+  static description = `create a transaction to mint tokens
+
+This will create tokens and increase supply for a given asset.`
 
   static examples = [
     '$ ironfish wallet:mint --metadata "see more here" --name mycoin --amount 1000',
diff --git a/ironfish-cli/src/commands/wallet/notes/index.ts b/ironfish-cli/src/commands/wallet/notes/index.ts
@@ -10,7 +10,7 @@ import { TableCols } from '../../../utils/table'
 
 const { sort: _, ...tableFlags } = TableFlags
 export class NotesCommand extends IronfishCommand {
-  static description = `Display the account notes`
+  static description = `list the account's notes`
 
   static args = {
     account: Args.string({
diff --git a/ironfish-cli/src/commands/wallet/prune.ts b/ironfish-cli/src/commands/wallet/prune.ts
@@ -6,7 +6,7 @@ import { Flags, ux } from '@oclif/core'
 import { IronfishCommand } from '../../command'
 
 export default class PruneCommand extends IronfishCommand {
-  static description = 'Removes expired transactions from the wallet'
+  static description = `deletes expired transactions from the wallet`
 
   static flags = {
     dryrun: Flags.boolean({
diff --git a/ironfish-cli/src/commands/wallet/rename.ts b/ironfish-cli/src/commands/wallet/rename.ts
@@ -6,7 +6,7 @@ import { IronfishCommand } from '../../command'
 import { RemoteFlags } from '../../flags'
 
 export class RenameCommand extends IronfishCommand {
-  static description = 'Change the name of an account'
+  static description = 'rename the name of an account'
 
   static args = {
     account: Args.string({
diff --git a/ironfish-cli/src/commands/wallet/rescan.ts b/ironfish-cli/src/commands/wallet/rescan.ts
@@ -10,7 +10,7 @@ import { ProgressBar, ProgressBarPresets } from '../../ui'
 import { hasUserResponseError } from '../../utils'
 
 export class RescanCommand extends IronfishCommand {
-  static description = `Rescan the blockchain for transactions. Clears wallet disk caches before rescanning.`
+  static description = `resets all accounts balance and rescans`
 
   static flags = {
     ...RemoteFlags,
diff --git a/ironfish-cli/src/commands/wallet/reset.ts b/ironfish-cli/src/commands/wallet/reset.ts
@@ -8,7 +8,7 @@ import { RemoteFlags } from '../../flags'
 import { confirmOrQuit } from '../../ui'
 
 export class ResetCommand extends IronfishCommand {
-  static description = `Resets the transaction of an account but keeps all keys.`
+  static description = `resets an account's balance and rescans`
 
   static args = {
     account: Args.string({
diff --git a/ironfish-cli/src/commands/wallet/scanning/off.ts b/ironfish-cli/src/commands/wallet/scanning/off.ts
@@ -6,7 +6,9 @@ import { IronfishCommand } from '../../../command'
 import { RemoteFlags } from '../../../flags'
 
 export class ScanningOffCommand extends IronfishCommand {
-  static description = `Turn off scanning for an account. The wallet will no longer scan the blockchain for new account transactions.`
+  static description = `turn off scanning for an account
+
+The wallet will no longer scan the blockchain for new account transactions.`
 
   static args = {
     account: Args.string({
diff --git a/ironfish-cli/src/commands/wallet/scanning/on.ts b/ironfish-cli/src/commands/wallet/scanning/on.ts
@@ -6,7 +6,9 @@ import { IronfishCommand } from '../../../command'
 import { RemoteFlags } from '../../../flags'
 
 export class ScanningOnCommand extends IronfishCommand {
-  static description = `Turn on scanning for an account. Scanning is on by default. The wallet will scan the blockchain for new account transactions.`
+  static description = `turn on scanning for an account
+
+Scanning is on by default. The wallet will scan the blockchain for new account transactions.`
 
   static args = {
     account: Args.string({
diff --git a/ironfish-cli/src/commands/wallet/send.ts b/ironfish-cli/src/commands/wallet/send.ts
@@ -30,7 +30,7 @@ import {
 } from '../../utils/transaction'
 
 export class Send extends IronfishCommand {
-  static description = `Send coins to another account`
+  static description = `create a transaction to send coins`
 
   static examples = [
     '$ ironfish wallet:send --amount 2.003 --fee 0.00000001 --to 997c586852d1b12da499bcff53595ba37d04e4909dbdb1a75f3bfd90dd7212217a1c2c0da652d187fc52ed',
diff --git a/ironfish-cli/src/commands/wallet/status.ts b/ironfish-cli/src/commands/wallet/status.ts
@@ -7,7 +7,7 @@ import { JsonFlags, RemoteFlags } from '../../flags'
 import * as ui from '../../ui'
 
 export class StatusCommand extends IronfishCommand {
-  static description = `Get status of all accounts`
+  static description = `show wallet information`
   static enableJsonFlag = true
 
   static flags = {
diff --git a/ironfish-cli/src/commands/wallet/transactions.ts b/ironfish-cli/src/commands/wallet/transactions.ts
@@ -20,7 +20,7 @@ import { Format, TableCols } from '../../utils/table'
 
 const { sort: _, ...tableFlags } = TableFlags
 export class TransactionsCommand extends IronfishCommand {
-  static description = `Display the account transactions`
+  static description = `list the account's transactions`
 
   static args = {
     account: Args.string({
diff --git a/ironfish-cli/src/commands/wallet/transactions/decode.ts b/ironfish-cli/src/commands/wallet/transactions/decode.ts
@@ -21,7 +21,7 @@ import {
 } from '../../../utils/transaction'
 
 export class TransactionsDecodeCommand extends IronfishCommand {
-  static description = `View transaction details`
+  static description = `show an encoded transaction's details`
   static hiddenAliases = ['wallet:transaction:view']
 
   static flags = {
diff --git a/ironfish-cli/src/commands/wallet/transactions/import.ts b/ironfish-cli/src/commands/wallet/transactions/import.ts
@@ -7,7 +7,7 @@ import { RemoteFlags } from '../../../flags'
 import { importFile, importPipe, longPrompt } from '../../../utils/input'
 
 export class TransactionsImportCommand extends IronfishCommand {
-  static description = `Import a transaction into your wallet`
+  static description = `import a transaction into the wallet`
 
   static hiddenAliases = ['wallet:transaction:add', 'wallet:transaction:import']
 
diff --git a/ironfish-cli/src/commands/wallet/transactions/info.ts b/ironfish-cli/src/commands/wallet/transactions/info.ts
@@ -22,7 +22,7 @@ import {
 import { getExplorer } from '../../../utils/explorer'
 
 export class TransactionInfoCommand extends IronfishCommand {
-  static description = `Display an account transaction`
+  static description = `show an account transaction's info`
 
   static hiddenAliases = ['wallet:transaction']
 
diff --git a/ironfish-cli/src/commands/wallet/transactions/post.ts b/ironfish-cli/src/commands/wallet/transactions/post.ts
@@ -10,7 +10,7 @@ import { longPrompt } from '../../../utils/input'
 import { renderRawTransactionDetails } from '../../../utils/transaction'
 
 export class TransactionsPostCommand extends IronfishCommand {
-  static summary = 'Post a raw transaction'
+  static summary = 'post a raw transaction'
 
   static description = `Use this command to post a raw transaction.
    The output is a finalized posted transaction.`
diff --git a/ironfish-cli/src/commands/wallet/transactions/sign.ts b/ironfish-cli/src/commands/wallet/transactions/sign.ts
@@ -11,7 +11,7 @@ import { Ledger } from '../../../utils/ledger'
 import { renderTransactionDetails, watchTransaction } from '../../../utils/transaction'
 
 export class TransactionsSignCommand extends IronfishCommand {
-  static description = `Sign an unsigned transaction`
+  static description = `sign an unsigned transaction`
 
   static hiddenAliases = ['wallet:sign']
 
diff --git a/ironfish-cli/src/commands/wallet/transactions/watch.ts b/ironfish-cli/src/commands/wallet/transactions/watch.ts
@@ -7,7 +7,7 @@ import { RemoteFlags } from '../../../flags'
 import { watchTransaction } from '../../../utils/transaction'
 
 export class TransactionsWatchCommand extends IronfishCommand {
-  static description = `Wait for the status of an account transaction to confirm or expire`
+  static description = `wait for an account transaction to confirm`
   static hiddenAliases = ['wallet:transaction:watch']
 
   static args = {
diff --git a/ironfish-cli/src/commands/wallet/use.ts b/ironfish-cli/src/commands/wallet/use.ts
@@ -6,7 +6,7 @@ import { IronfishCommand } from '../../command'
 import { RemoteFlags } from '../../flags'
 
 export class UseCommand extends IronfishCommand {
-  static description = 'Change the default account used by all commands'
+  static description = 'change the default wallet account'
 
   static args = {
     account: Args.string({
diff --git a/ironfish-cli/src/commands/wallet/which.ts b/ironfish-cli/src/commands/wallet/which.ts
@@ -6,7 +6,7 @@ import { IronfishCommand } from '../../command'
 import { RemoteFlags } from '../../flags'
 
 export class WhichCommand extends IronfishCommand {
-  static description = `Show the account currently used.
+  static description = `show the default wallet account
 
   By default all commands will use this account when deciding what
   keys to use. If no account is specified as the default, you must
