Add claim command (#95)

Author: Thoralf-M

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "cli-wallet"
-version = "1.0.0-alpha.1"
+version = "1.0.0-alpha.2"
 authors = [ "IOTA Stiftung" ]
 edition = "2021"
 homepage = "https://iota.org"

Cargo.toml

@@ -27,6 +27,16 @@ Prints the account balance.
 > Account "main": balance
 ```
 
+### `claim`
+
+Tries to claim outputs with storage deposit return, expiration or timelock unlock conditions.
+
+#### Example
+
+```sh
+> Account "main": claim
+```
+
 ### `clear`
 
 Clears the terminal.

documentation/docs/03_account.md

@@ -7,9 +7,9 @@ use iota_wallet::account::AccountHandle;
 
 use crate::{
     command::account::{
-        addresses_command, balance_command, consolidate_command, faucet_command, mint_native_token_command,
-        mint_nft_command, new_address_command, send_command, send_micro_command, send_native_token_command,
-        send_nft_command, sync_command, transactions_command, AccountCli, AccountCommand,
+        addresses_command, balance_command, claim_command, consolidate_command, faucet_command,
+        mint_native_token_command, mint_nft_command, new_address_command, send_command, send_micro_command,
+        send_native_token_command, send_nft_command, sync_command, transactions_command, AccountCli, AccountCommand,
     },
     error::Error,
 };
@@ -56,6 +56,7 @@ pub async fn account_prompt_internal(account_handle: AccountHandle) -> Result<bo
             if let Err(err) = match account_cli.command {
                 AccountCommand::NewAddress => new_address_command(&account_handle).await,
                 AccountCommand::Balance => balance_command(&account_handle).await,
+                AccountCommand::Claim => claim_command(&account_handle).await,
                 AccountCommand::Consolidate => consolidate_command(&account_handle).await,
                 AccountCommand::Exit => {
                     return Ok(true);

src/account.rs

@@ -7,7 +7,7 @@ use clap::{Parser, Subcommand};
 use iota_wallet::{
     account::{
         types::{AccountAddress, Transaction},
-        AccountHandle,
+        AccountHandle, OutputsToCollect,
     },
     iota_client::{
         bee_block::output::{NftId, TokenId},
@@ -33,6 +33,8 @@ pub enum AccountCommand {
     Addresses,
     /// Print the account balance.
     Balance,
+    /// Claim outputs with storage deposit return, expiration or timelock unlock conditions.
+    Claim,
     /// Consolidate all basic outputs into one address.
     Consolidate,
     /// Exit from the account prompt.
@@ -100,11 +102,28 @@ pub async fn balance_command(account_handle: &AccountHandle) -> Result<(), Error
     Ok(())
 }
 
+// `claim` command
+pub async fn claim_command(account_handle: &AccountHandle) -> Result<(), Error> {
+    log::info!("Claiming outputs.");
+
+    let claiming_txs = account_handle.try_collect_outputs(OutputsToCollect::All).await?;
+
+    for claim_tx in claiming_txs {
+        log::info!("Claim transaction sent: {claim_tx:?}");
+    }
+
+    Ok(())
+}
+
 // `consolidate` command
 pub async fn consolidate_command(account_handle: &AccountHandle) -> Result<(), Error> {
     log::info!("Consolidating outputs.");
 
-    account_handle.consolidate_outputs(true, None).await?;
+    let consolidation_txs = account_handle.consolidate_outputs(true, None).await?;
+
+    for consolidation_tx in consolidation_txs {
+        log::info!("Consolidation transaction sent: {consolidation_tx:?}");
+    }
 
     Ok(())
 }