simplewallet: hide ignored ring_size in FCMP++ help

Author: jeetrex17

src/simplewallet/simplewallet.cpp

@@ -706,6 +706,57 @@ namespace
     return description;
   }
 
+  std::string get_transfer_usage(bool legacy_ring_ux)
+  {
+    if (legacy_ring_ux)
+      return tr("transfer [index=<N1>[,<N2>,...]] [<priority>] [<ring_size>] (<URI> | <address> <amount>) [subtractfeefrom=<D0>[,<D1>,all,...]] [<payment_id>]");
+    return tr("transfer [index=<N1>[,<N2>,...]] [<priority>] (<URI> | <address> <amount>) [subtractfeefrom=<D0>[,<D1>,all,...]] [<payment_id>]");
+  }
+
+  std::string get_sweep_all_usage(bool legacy_ring_ux)
+  {
+    if (legacy_ring_ux)
+      return tr("sweep_all [index=<N1>[,<N2>,...] | index=all] [<priority>] [<ring_size>] [outputs=<N>] <address> [<payment_id (obsolete)>]");
+    return tr("sweep_all [index=<N1>[,<N2>,...] | index=all] [<priority>] [outputs=<N>] <address> [<payment_id (obsolete)>]");
+  }
+
+  std::string get_sweep_account_usage(bool legacy_ring_ux)
+  {
+    if (legacy_ring_ux)
+      return tr("sweep_account <account> [index=<N1>[,<N2>,...] | index=all] [<priority>] [<ring_size>] [outputs=<N>] <address> [<payment_id (obsolete)>]");
+    return tr("sweep_account <account> [index=<N1>[,<N2>,...] | index=all] [<priority>] [outputs=<N>] <address> [<payment_id (obsolete)>]");
+  }
+
+  std::string get_sweep_below_usage(bool legacy_ring_ux)
+  {
+    if (legacy_ring_ux)
+      return tr("sweep_below <amount_threshold> [index=<N1>[,<N2>,...]] [<priority>] [<ring_size>] <address> [<payment_id (obsolete)>]");
+    return tr("sweep_below <amount_threshold> [index=<N1>[,<N2>,...]] [<priority>] <address> [<payment_id (obsolete)>]");
+  }
+
+  std::string get_sweep_single_usage(bool legacy_ring_ux)
+  {
+    if (legacy_ring_ux)
+      return tr("sweep_single [<priority>] [<ring_size>] [outputs=<N>] <key_image> <address> [<payment_id (obsolete)>]");
+    return tr("sweep_single [<priority>] [outputs=<N>] <key_image> <address> [<payment_id (obsolete)>]");
+  }
+
+  std::string get_donate_usage(bool legacy_ring_ux)
+  {
+    if (legacy_ring_ux)
+      return tr("donate [index=<N1>[,<N2>,...]] [<priority>] [<ring_size>] <amount> [<payment_id (obsolete)>]");
+    return tr("donate [index=<N1>[,<N2>,...]] [<priority>] <amount> [<payment_id (obsolete)>]");
+  }
+
+  std::string get_transfer_description(bool legacy_ring_ux)
+  {
+    std::string desc = tr("Transfer <amount> <address>. If the parameter \"index=<N1>[,<N2>,...]\" is specified, the wallet uses outputs received by addresses of those indices. If omitted, the wallet randomly chooses address indices to be used. In any case, it tries its best not to combine outputs across multiple addresses. <priority> is the priority of the transaction. The higher the priority, the higher the transaction fee. Valid values in priority order (from lowest to highest) are: unimportant, normal, elevated, priority, max. If omitted, the default value (see the command \"set priority\") is used. ");
+    if (legacy_ring_ux)
+      desc += tr("<ring_size> is the number of inputs to include for untraceability. ");
+    desc += tr("Multiple payments can be made at once by adding URI_2 or <address_2> <amount_2> etcetera (before the payment ID, if it's included). The \"subtractfeefrom=\" list allows you to choose which destinations to fund the tx fee from instead of the change output. The fee will be split across the chosen destinations proportionally equally. For example, to make 3 transfers where the fee is taken from the first and third destinations, one could do: \"transfer <addr1> 3 <addr2> 0.5 <addr3> 1 subtractfeefrom=0,2\". Let's say the tx fee is 0.1. The balance would drop by exactly 4.5 XMR including fees, and addr1 & addr3 would receive 2.925 & 0.975 XMR, respectively. Use \"subtractfeefrom=all\" to spread the fee across all destinations.");
+    return desc;
+  }
+
   bool get_fake_outs_count(const std::unique_ptr<tools::wallet2> &w2, std::vector<std::string> &local_args, size_t &fake_outs_count)
   {
     const size_t min_ring_size = w2->get_min_ring_size();
@@ -926,10 +977,14 @@ std::string simple_wallet::get_commands_str()
 {
   std::stringstream ss;
   ss << tr("Commands: ") << ENDL;
-  std::string usage = m_cmd_binder.get_usage();
-  boost::replace_all(usage, "\n", "\n  ");
-  usage.insert(0, "  ");
-  ss << usage << ENDL;
+  const std::vector<std::string> all_commands = m_cmd_binder.get_command_list();
+  for (const auto &command : all_commands)
+  {
+    const std::vector<std::string> cmd{command};
+    const auto documentation = get_command_documentation(cmd);
+    if (!documentation.first.empty())
+      ss << "  " << documentation.first << ENDL;
+  }
   return ss.str();
 }
 
@@ -939,8 +994,27 @@ std::pair<std::string, std::string> simple_wallet::get_command_documentation(con
   if (documentation.first.empty())
     return documentation;
 
-  if (args.size() == 1 && args.front() == "set" && !uses_legacy_ring_signature_ux(m_wallet.get()))
-    documentation.second = get_set_variable_description(false);
+  if (args.size() == 1 && !uses_legacy_ring_signature_ux(m_wallet.get()))
+  {
+    const std::string &cmd = args.front();
+    if (cmd == "set")
+      documentation.second = get_set_variable_description(false);
+    else if (cmd == "transfer")
+    {
+      documentation.first = get_transfer_usage(false);
+      documentation.second = get_transfer_description(false);
+    }
+    else if (cmd == "sweep_all")
+      documentation.first = get_sweep_all_usage(false);
+    else if (cmd == "sweep_account")
+      documentation.first = get_sweep_account_usage(false);
+    else if (cmd == "sweep_below")
+      documentation.first = get_sweep_below_usage(false);
+    else if (cmd == "sweep_single")
+      documentation.first = get_sweep_single_usage(false);
+    else if (cmd == "donate")
+      documentation.first = get_donate_usage(false);
+  }
 
   return documentation;
 }
@@ -6919,7 +6993,7 @@ bool simple_wallet::transfer(const std::vector<std::string> &args_)
   CHECK_IF_BACKGROUND_SYNCING("cannot transfer");
   if (args_.size() < 1)
   {
-    PRINT_USAGE(USAGE_TRANSFER);
+    PRINT_USAGE(get_transfer_usage(uses_legacy_ring_signature_ux(m_wallet.get())).c_str());
     return true;
   }
   transfer_main(args_, false);
@@ -7042,17 +7116,18 @@ bool simple_wallet::sweep_main(uint32_t account, uint64_t below, const std::vect
   CHECK_IF_BACKGROUND_SYNCING("cannot sweep");
   auto print_usage = [this, account, below]()
   {
+    const bool legacy_ring_ux = uses_legacy_ring_signature_ux(m_wallet.get());
     if (below)
     {
-      PRINT_USAGE(USAGE_SWEEP_BELOW);
+      PRINT_USAGE(get_sweep_below_usage(legacy_ring_ux).c_str());
     }
     else if (account == m_current_subaddress_account)
     {
-      PRINT_USAGE(USAGE_SWEEP_ALL);
+      PRINT_USAGE(get_sweep_all_usage(legacy_ring_ux).c_str());
     }
     else
     {
-      PRINT_USAGE(USAGE_SWEEP_ACCOUNT);
+      PRINT_USAGE(get_sweep_account_usage(legacy_ring_ux).c_str());
     }
   };
   if (args_.size() == 0)
@@ -7359,7 +7434,7 @@ bool simple_wallet::sweep_single(const std::vector<std::string> &args_)
 
   if (local_args.size() != 2)
   {
-    PRINT_USAGE(USAGE_SWEEP_SINGLE);
+    PRINT_USAGE(get_sweep_single_usage(uses_legacy_ring_signature_ux(m_wallet.get())).c_str());
     return true;
   }
 
@@ -7519,7 +7594,7 @@ bool simple_wallet::sweep_account(const std::vector<std::string> &args_)
   auto local_args = args_;
   if (local_args.empty())
   {
-    PRINT_USAGE(USAGE_SWEEP_ACCOUNT);
+    PRINT_USAGE(get_sweep_account_usage(uses_legacy_ring_signature_ux(m_wallet.get())).c_str());
     return true;
   }
   uint32_t account = 0;
@@ -7541,7 +7616,7 @@ bool simple_wallet::sweep_below(const std::vector<std::string> &args_)
   if (args_.size() < 1)
   {
     fail_msg_writer() << tr("missing threshold amount");
-    PRINT_USAGE(USAGE_SWEEP_BELOW);
+    PRINT_USAGE(get_sweep_below_usage(uses_legacy_ring_signature_ux(m_wallet.get())).c_str());
     return true;
   }
   if (!cryptonote::parse_amount(below, args_[0]))
@@ -7559,7 +7634,7 @@ bool simple_wallet::donate(const std::vector<std::string> &args_)
   std::vector<std::string> local_args = args_;
   if(local_args.empty() || local_args.size() > 5)
   {
-     PRINT_USAGE(USAGE_DONATE);
+     PRINT_USAGE(get_donate_usage(uses_legacy_ring_signature_ux(m_wallet.get())).c_str());
      return true;
   }
   std::string amount_str;