Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

concealwallet Command Improvements #262

Merged
merged 4 commits into from
Jan 31, 2022

Conversation

cartoon-face
Copy link
Contributor

@cartoon-face cartoon-face commented Jan 28, 2022

Improved help Command

Over the years of development to client wallet, there have been many useful commands implemented. When a user types help, there could be a lot to make a new user scared because of the shear amount of commands there is. I've split all the commands into two menu's, help and ext_help.

Improved save_keys Command

The command save_keys has now been improved to be able to save multiple backups without overwriting the previous.

In example: If I've made multiple wallets in concealwallet and decided to back each one up, we would end up with only one set of keys being back as each backup would overwrite the last.

Now this function has been changed so it includes the wallet filename within the filename of the backed up keys. This also covers 1 SonarCloud code smell by making use of args in this command

Command Usage and Output

Help Improvements

Command: help

                Conceal Wallet Menu
  
  [ ] = Optional arg
  "address"                     - Shows wallet address.
  "balance"                     - Shows wallet balance.
  "bc_height"                   - Shows current blockchain height.
  "exit"                        - Safely exits the wallet application.
  "export_keys"                 - Displays backup keys.
  "help" | "ext_help"           - Shows this help dialog or extended help dialog.
  "list_transfers"              - Show all known transfers, optionally from a certain height. | <block_height>
  "reset"                       - Reset cached blockchain data and starts synchronizing from block 0.
  "transfer <address> <amount>" - Transfers <amount> to <address>. | [-p<payment_id>] [<amount_2>]...[<amount_N>] [<address_2>]...[<address_n>]
  "save"                        - Save wallet synchronized blockchain data.
  "save_keys"                   - Saves wallet private keys to "<wallet_name>_conceal_backup.txt".

Command: ext_help

                Conceal Wallet Extended Menu
  
  [ ] = Optional arg
  "create_integrated <payment_id>"                   - Create an integrated address with a payment ID.
  "get_tx_proof <txid> <address>"                    - Generate a signature to prove payment | [<txkey>]
  "get_reserve_proof <amount>"                       - Generate a signature proving that you own at least <amount> | [<message>]
  "incoming_transfers"                               - Show incoming transfers.
  "optimize"                                         - Combine many available outputs into a few by sending a transaction to self.
  "optimize_all"                                     - Optimize your wallet several times so you can send large transactions.
  "outputs"                                          - Show the number of unlocked outputs available for a transaction.
  "payments <payment_id>"                            - Show payments from payment ID. | [<payment_id_2> ... <payment_id_N>]
  "set_log <level>"                                  - Change current log level, default = 3, <level> is a number 0-4.
  "sign_message <message>"                           - Sign a message with your wallet keys.
  "show_dust"                                        - Show the number of unmixable dust outputs.
  "verify_signature <message> <address> <signature>" - Verify a signed message.

Save Keys Improvements

Command: save_keys

Wallet keys have been saved to the current folder where "concealwallet" is located as "test_conceal_backup.txt".

Filename: test_conceal_backup.txt (wallet name is test)
File Contents:

		Conceal Keys Backup

Wallet file name: test
Private spend key: d547d93d9adf9d7efb70e48c74ea4721a06d9240e4ddfd2bc73adf7608532505
Private view key: 44abea068ccfeb671215743171343f6d934b080653ab22fa2b8924801a48cf02
Mnemonic seed: apply memoir shrugged negative alkaline melting awful calamity pyramid nimbly serving ungainly ornament hexagon ounce agnostic daytime guarded afloat godfather spud succeed knee lexicon pyramid

Above keys are strictly for testing purposes

cartoon-face and others added 4 commits January 28, 2022 19:43
Over the years of development to client wallet, there have been many commands implemented. When a user types "help", there could be a lot to make a new user scared because of the shear amount of commands there is. I've split all the commands into two menu's, "help" and "ext_help".

The command "save_keys" has now been improved to be able to save multiple backups without overwriting the previous. In example: If I've made multiple wallets in concealwallet and decided to back each one up, we would end up with only one set of keys being back as each backup would overwrite the last. Now this function has been changed so it includes the wallet filename within the filename of the backed up keys. This also covers 1 SonarCloud code smell by making use of "args" in this command
Make `get_commands_str` a boolean, false = help and true = ext_help
Also removes unused miner functions
Copy link
Member

@krypt0x krypt0x left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all good. thanks

@krypt0x krypt0x requested a review from AxVultis January 31, 2022 17:45
@krypt0x krypt0x added the enhancement New feature or request label Jan 31, 2022
@krypt0x krypt0x merged commit 9586e87 into ConcealNetwork:development Jan 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants