List of Changes / Release Notes for 3.1.0

[yeastplume]

3.1.0 is a minor version release, with several new feature additions, bug fixes, and improvements. It is an optional upgrade, however users are encouraged to upgrade so as to take advantage of the new features.

Command Line

• Two new commands export_proof and verify_proof are added, which allow users to export proofs that were created during a transaction and send them to others for verification. See the command line help and entries in the wallet guide for information on using these commands.
• An experimental interactive mode called 'cli mode' is added to the wallet. As opposed to the standard 'run a command and exit' mode, cli mode presents the user with a prompt via which wallet commands can be entered on an open instance of the wallet that remains running until the user exits. The commands for cli mode are the same as for regular mode (without needing to type grin-wallet in front of every command. cli mode can be invoked with grin-wallet cli
• In addition to the cli command, which starts the wallet in cli mode, the commands open, close and exit are added. These commands are only relevant in cli mode and will exit harmlessly if the wallet is operating in standard mode.
• When attempting to create a new wallet, the wallet checks for an existing configuration in the target directory before asking for a password/recovery phrase.
• Inconsistencies with the --top-level-dir switch have been fixed, and all commands should now correctly respect the value of this switch.
• .api_secret files are no longer written to the default wallet locations even if the wallet is located elsewhere.
• grin-wallet address now only shows the OnionV3 version of the wallet's address, and no longer displays the raw public key.
• When specifying payment proofs addresses manually on the command line during a send with the --proof_address command, users should now use the Onion V3 address rather than the raw public key.
• The output of a transaction's payment proof from a grin-wallet txs -i command now only displays the Onion V3 version of the address, and no longer displays the raw public key.
• A --backwards_from_tip , -b switch is added to the scan command, which allows users to specify the start block for the scan relative to the chain tip. e.g. grin-wallet scan -b 10000 will scan the last 10,000 blocks.

APIs

• JSON RPC ids in the request to the secure API can now be either an integer or a string (only integers were allowed previously)
• The ttl_blocks and payment_proof_recipient_address fields in the InitTxArgs struct are now optional (they were previously required to be present with a value of null even if not used)
• retrieve_payment_proof and verify_payment_proof are added to the Owner API, both of which use a new PaymentProof struct. See details in the rustdoc documentation.
• The create_wallet command will now fail properly if provided with an invalid mnemonic seed.
• An resource leak issue in the APIs potentially causing an unbounded number of threads to be used by the wallet listeners is addressed. See (Shutdown runtime after task is completed #331) and (grin-wallet owner_api creating large quantity of threads #330) for details.

Misc

• Communication with the node (i.e the 'node_client) is updated to use the node's V2 JSON-RPC API. This should not have any visible impact for users, however it should help alleviate issues users of larger wallets may have been having with the size of certain get` requests (see next point).
• A 'secret' environment variable, GRIN_OUTPUT_QUERY_SIZE is added, that limits the number of outputs the wallet will attempt to retrieve from the node in a single request during an update. This is less relevant now that the node client has been converted to use the node's V2 JSON-RPC API, however the option remains in place to allow for performance tuning.
• The default number of outputs the wallet will attempt to retrieve from the node in a single request is raised from 200 to 500 due to the query no longer having to fit into a single get url.

PRs

Payment Proof export + validation
Wallet Interactive Mode, Part 1
Add output query chunk size
Onion V3 address consistency
Secure API JSON RPC ID
Serde default specifier to send_tx args
Rework directory checks/setups at launch
Ensure create_wallet returns failure..
Add ability to specify scan height backwards from tip
Convert node client to use V2 Node API
Shutdown runtime after task is completed