fix: add burn funds command to console wallet (see issue #4547) (#4655)

Description --- Adds command to burn funds on Tari console wallet. Motivation and Context --- Tackle issue #4547. How Has This Been Tested? --- Proper unit tests.
tari-project · Sep 14, 2022 · 0242b1d · 0242b1d
1 parent 0a396c2
commit 0242b1d
Show file tree

Hide file tree

Showing 5 changed files with 65 additions and 1 deletion.
diff --git a/applications/tari_console_wallet/src/automation/commands.rs b/applications/tari_console_wallet/src/automation/commands.rs
@@ -127,6 +127,18 @@ pub async fn send_tari(
         .map_err(CommandError::TransactionServiceError)
 }
 
+pub async fn burn_tari(
+    mut wallet_transaction_service: TransactionServiceHandle,
+    fee_per_gram: u64,
+    amount: MicroTari,
+    message: String,
+) -> Result<TxId, CommandError> {
+    wallet_transaction_service
+        .burn_tari(amount, UtxoSelectionCriteria::default(), fee_per_gram * uT, message)
+        .await
+        .map_err(CommandError::TransactionServiceError)
+}
+
 /// publishes a tari-SHA atomic swap HTLC transaction
 pub async fn init_sha_atomic_swap(
     mut wallet_transaction_service: TransactionServiceHandle,
@@ -609,6 +621,22 @@ pub async fn command_runner(
                     eprintln!("DiscoverPeer error! {}", e);
                 }
             },
+            BurnTari(args) => {
+                match burn_tari(
+                    transaction_service.clone(),
+                    config.fee_per_gram,
+                    args.amount,
+                    args.message,
+                )
+                .await
+                {
+                    Ok(tx_id) => {
+                        debug!(target: LOG_TARGET, "burn tari concluded with tx_id {}", tx_id);
+                        tx_ids.push(tx_id);
+                    },
+                    Err(e) => eprintln!("BurnTari error! {}", e),
+                }
+            },
             SendTari(args) => {
                 match send_tari(
                     transaction_service.clone(),

diff --git a/applications/tari_console_wallet/src/cli.rs b/applications/tari_console_wallet/src/cli.rs
@@ -115,6 +115,7 @@ impl ConfigOverrideProvider for Cli {
 pub enum CliCommands {
     GetBalance,
     SendTari(SendTariArgs),
+    BurnTari(BurnTariArgs),
     SendOneSided(SendTariArgs),
     SendOneSidedToStealthAddress(SendTariArgs),
     MakeItRain(MakeItRainArgs),
@@ -147,6 +148,13 @@ pub struct SendTariArgs {
     pub message: String,
 }
 
+#[derive(Debug, Args, Clone)]
+pub struct BurnTariArgs {
+    pub amount: MicroTari,
+    #[clap(short, long, default_value = "Burn funds")]
+    pub message: String,
+}
+
 #[derive(Debug, Args, Clone)]
 pub struct MakeItRainArgs {
     pub destination: UniPublicKey,

diff --git a/applications/tari_console_wallet/src/wallet_modes.rs b/applications/tari_console_wallet/src/wallet_modes.rs
@@ -426,6 +426,8 @@ mod test {
             discover-peer f6b2ca781342a3ebe30ee1643655c96f1d7c14f4d49f077695395de98ae73665
 
             send-tari --message Our_secret! 125T 5c4f2a4b3f3f84e047333218a84fd24f581a9d7e4f23b78e3714e9d174427d61
+            
+            burn-tari --message Ups_these_funds_will_be_burned! 100T
 
             coin-split --message Make_many_dust_UTXOs! --fee-per-gram 2 0.001T 499
 
@@ -441,6 +443,7 @@ mod test {
 
         let mut get_balance = false;
         let mut send_tari = false;
+        let mut burn_tari = false;
         let mut make_it_rain = false;
         let mut coin_split = false;
         let mut discover_peer = false;
@@ -449,6 +452,7 @@ mod test {
             match command {
                 CliCommands::GetBalance => get_balance = true,
                 CliCommands::SendTari(_) => send_tari = true,
+                CliCommands::BurnTari(_) => burn_tari = true,
                 CliCommands::SendOneSided(_) => {},
                 CliCommands::SendOneSidedToStealthAddress(_) => {},
                 CliCommands::MakeItRain(_) => make_it_rain = true,
@@ -468,6 +472,6 @@ mod test {
                 CliCommands::HashGrpcPassword(_) => {},
             }
         }
-        assert!(get_balance && send_tari && make_it_rain && coin_split && discover_peer && whois);
+        assert!(get_balance && send_tari && burn_tari && make_it_rain && coin_split && discover_peer && whois);
     }
 }
diff --git a/integration_tests/features/WalletCli.feature b/integration_tests/features/WalletCli.feature
@@ -53,6 +53,21 @@ Feature: Wallet CLI
         And mining node MINE mines 5 blocks
         Then I wait for wallet RECEIVER to have at least 1000000 uT
 
+
+    Scenario: As a user I want to burn tari via command line
+        Given I have a seed node SEED
+        And I have a base node BASE connected to seed SEED
+        And I have wallet WALLET_A connected to base node BASE
+        And I have wallet WALLET_B connected to base node BASE
+        And I have mining node MINER_A connected to base node BASE and wallet WALLET_A
+        And I have mining node MINER_B connected to base node BASE and wallet WALLET_B
+        And mining node MINER_A mines 15 blocks
+        Then all nodes are at height 15
+        When I wait for wallet WALLET_A to have at least 55000000000 uT
+        When I create a burn transaction of 45000000000 uT from WALLET_A via command line
+        Then I have mining node MINER_B mines 10 blocks
+        Then I get balance of wallet WALLET_A is at least 10000000000 uT via command line
+
     @long-running
     Scenario: As a user I want to send one-sided via command line
         Given I have a seed node SEED

diff --git a/integration_tests/features/support/wallet_cli_steps.js b/integration_tests/features/support/wallet_cli_steps.js
@@ -118,6 +118,15 @@ When(
   }
 );
 
+When(
+  "I create a burn transaction of {int} uT from {word} via command line",
+  { timeout: 180 * 1000 },
+  async function (amount, name) {
+    let wallet = this.getWallet(name);
+    await wallet_run_command(wallet, `burn-tari ${amount}`, 180);
+  }
+);
+
 When(
   "I send one-sided {int} uT from {word} to {word} via command line",
   { timeout: 180 * 1000 },