test: add ffi cucumber wallet balance test (#7189)

Description
---
- Added cucumber test to verify wallet balance with recovery into FFI
wallet.
- Fixed broken `As a client I want to be able to restore my ffi wallet
from seed words` cucumber test.

Motivation and Context
---
Trying to solve various balance query inconsistencies.

How Has This Been Tested?
---
Cucumber test: `As a client I want to be able to check my balance from
restored wallets`

What process can a PR reviewer use to test or verify this change?
---
Code review

<!-- Checklist -->
<!-- 1. Is the title of your PR in the form that would make nice release
notes? The title, excluding the conventional commit
tag, will be included exactly as is in the CHANGELOG, so please think
about it carefully. -->


Breaking Changes
---

- [x] None
- [ ] Requires data directory on base node to be deleted
- [ ] Requires hard fork
- [ ] Other - Please specify

<!-- Does this include a breaking change? If so, include this line as a
footer -->
<!-- BREAKING CHANGE: Description what the user should do, e.g. delete a
database, resync the chain -->


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Added the ability to restore FFI wallets from seed words and verify
balances in integration tests.
- Introduced support for storing and checking wallet balances within the
test environment.
- Enhanced wallet CLI test steps to support wallet recovery from seed
words and view/spend key export/import.
- Added detailed logging for transaction errors in the wallet gRPC
server.
- Extended wallet process and world state with new fields for base node
association, peer seeds, balances, and keys.

- **Bug Fixes**
- Improved type handling when collecting seed words during wallet
recovery.

- **Tests**
- Added critical scenarios to test wallet restoration and balance
checking for FFI wallets.
- Introduced new test steps for remembering and verifying wallet
balances.
- Updated test scenarios and steps to explicitly specify one-sided and
interactive transaction types for clarity.
  - Added logging support for cucumber test steps.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: SW van Heerden <swvheerden@gmail.com>

Author: hansieodendaal

Cargo.lock

@@ -830,7 +830,10 @@ impl wallet_server::Wallet for WalletGrpcServer {
                         .get_any_transaction(tx_id)
                         .await
                         .map_err(|e| Status::internal(format!("{:?}", e)))?
-                        .ok_or_else(|| Status::not_found("Transaction not found".to_string()))?;
+                        .ok_or_else(|| {
+                            error!(target: LOG_TARGET, "Transaction {} not found", tx_id);
+                            Status::not_found(format!("Transaction {} not found", tx_id))
+                        })?;
                     let final_tx = convert_wallet_transaction_into_transaction_info(
                         wallet_tx,
                         &wallet_address,

applications/minotari_console_wallet/src/grpc/wallet_grpc_server.rs

@@ -40,6 +40,7 @@ pub use cli::{
     CoinSplitArgs,
     DiscoverPeerArgs,
     ExportUtxosArgs,
+    ExportViewKeyAndSpendKeyArgs,
     MakeItRainArgs,
     SendMinotariArgs,
     SetBaseNodeArgs,

applications/minotari_console_wallet/src/lib.rs

@@ -17,6 +17,7 @@ tari_common_sqlite = { path = "../common_sqlite" }
 tari_common_types = { path = "../base_layer/common_types" }
 tari_comms = { path = "../comms/core" }
 tari_comms_dht = { path = "../comms/dht" }
+tari_key_manager = { path = "../base_layer/key_manager" }
 minotari_console_wallet = { path = "../applications/minotari_console_wallet", features = ["grpc"] }
 tari_core = { path = "../base_layer/core" }
 minotari_merge_mining_proxy = { path = "../applications/minotari_merge_mining_proxy" }

integration_tests/Cargo.toml

@@ -201,7 +201,12 @@ extern "C" {
     ) -> *mut TariSeedWords;
     pub fn seed_words_get_length(seed_words: *const TariSeedWords, error_out: *mut c_int) -> c_uint;
     pub fn seed_words_get_at(seed_words: *mut TariSeedWords, position: c_uint, error_out: *mut c_int) -> *mut c_char;
-    pub fn seed_words_push_word(seed_words: *mut TariSeedWords, word: *const c_char, error_out: *mut c_int) -> c_uchar;
+    pub fn seed_words_push_word(
+        seed_words: *mut TariSeedWords,
+        word: *const c_char,
+        passphrase: *const c_char,
+        error_out: *mut c_int,
+    ) -> c_uchar;
     pub fn seed_words_destroy(seed_words: *mut TariSeedWords);
     pub fn contact_create(
         alias: *const c_char,
@@ -412,7 +417,7 @@ extern "C" {
         context: *mut c_void,
         config: *mut TariCommsConfig,
         log_path: *const c_char,
-        log_level: c_int,
+        log_verbosity: c_int,
         num_rolling_log_files: c_uint,
         size_per_log_file_bytes: c_uint,
         passphrase: *const c_char,
@@ -422,6 +427,7 @@ extern "C" {
         dns_seeds_str: *const c_char,
         dns_seed_name_servers_str: *const c_char,
         use_dns_sec: bool,
+
         callback_received_transaction: unsafe extern "C" fn(context: *mut c_void, *mut TariPendingInboundTransaction),
         callback_received_transaction_reply: unsafe extern "C" fn(context: *mut c_void, *mut TariCompletedTransaction),
         callback_received_finalized_transaction: unsafe extern "C" fn(
@@ -461,7 +467,7 @@ extern "C" {
         callback_saf_messages_received: unsafe extern "C" fn(context: *mut c_void),
         callback_connectivity_status: unsafe extern "C" fn(context: *mut c_void, u64),
         callback_wallet_scanned_height: unsafe extern "C" fn(context: *mut c_void, u64),
-        callback_base_node_state_updated: unsafe extern "C" fn(context: *mut c_void, *mut TariBaseNodeState),
+        callback_base_node_state: unsafe extern "C" fn(context: *mut c_void, *mut TariBaseNodeState),
         recovery_in_progress: *mut bool,
         error_out: *mut c_int,
     ) -> *mut TariWallet;

integration_tests/src/ffi/ffi_import.rs

@@ -20,14 +20,15 @@
 //   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 //   USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-use std::{ffi::CString, ptr::null_mut};
+use std::{ffi::CString, ptr, ptr::null_mut};
 
-use libc::c_void;
+use libc::{c_char, c_void};
 
 use super::{ffi_import, FFIString};
+use crate::ffi::ffi_import::TariSeedWords;
 
 pub struct SeedWords {
-    ptr: *mut c_void,
+    ptr: *mut TariSeedWords,
 }
 
 impl Drop for SeedWords {
@@ -38,7 +39,7 @@ impl Drop for SeedWords {
 }
 
 impl SeedWords {
-    pub fn create() -> Self {
+    pub fn create_empty_seed_words() -> Self {
         let ptr;
         unsafe {
             ptr = ffi_import::seed_words_create();
@@ -96,7 +97,9 @@ impl SeedWords {
         let mut error = 0;
         let result;
         unsafe {
-            result = ffi_import::seed_words_push_word(self.ptr, CString::new(word).unwrap().into_raw(), &mut error);
+            let w = CString::new(word).unwrap();
+            let w_str: *const c_char = CString::into_raw(w) as *const c_char;
+            result = ffi_import::seed_words_push_word(self.ptr, w_str, ptr::null(), &mut error);
             if error > 0 {
                 println!("seed_words_push_word error {}", error);
                 panic!("seed_words_push_word error");

integration_tests/src/ffi/seed_words.rs

@@ -226,7 +226,7 @@ pub fn create_contact(alias: String, address: String) -> ffi::Contact {
 }
 
 pub fn create_seed_words(words: Vec<&str>) -> ffi::SeedWords {
-    let seed_words = ffi::SeedWords::create();
+    let seed_words = ffi::SeedWords::create_empty_seed_words();
     for word in words {
         seed_words.push_word(word.to_string());
     }

integration_tests/src/wallet_ffi.rs

@@ -49,6 +49,8 @@ pub struct WalletProcess {
     pub name: String,
     pub port: u64,
     pub temp_dir_path: PathBuf,
+    pub base_node_name: Option<String>,
+    pub peer_seeds: Vec<String>,
 }
 
 impl Drop for WalletProcess {
@@ -99,7 +101,7 @@ pub async fn spawn_wallet(
             .base_node_monitor_max_refresh_interval = Duration::from_secs(5);
     };
 
-    let base_node = base_node_name.map(|name| {
+    let base_node = base_node_name.clone().map(|name| {
         let pubkey = world.base_nodes.get(&name).unwrap().identity.public_key().clone();
         let port = world.base_nodes.get(&name).unwrap().port;
         let set_base_node_request = SetBaseNodeRequest {
@@ -192,7 +194,9 @@ pub async fn spawn_wallet(
         port,
         grpc_port,
         temp_dir_path: temp_dir,
+        base_node_name,
         kill_signal: shutdown,
+        peer_seeds,
     });
 
     tokio::time::sleep(Duration::from_secs(5)).await;

integration_tests/src/wallet_process.rs

@@ -28,6 +28,7 @@ use std::{
 
 use cucumber::gherkin::{Feature, Scenario};
 use indexmap::IndexMap;
+use minotari_app_grpc::tari_rpc::GetBalanceResponse;
 use rand::rngs::OsRng;
 use serde_json::Value;
 use tari_common::configuration::Network;
@@ -86,6 +87,8 @@ pub struct TariWorld {
     pub miners: IndexMap<String, MinerProcess>,
     pub ffi_wallets: IndexMap<String, WalletFFI>,
     pub wallets: IndexMap<String, WalletProcess>,
+    pub balance: IndexMap<String, GetBalanceResponse>,
+    pub view_and_spend_keys: IndexMap<String, PathBuf>,
     pub merge_mining_proxies: IndexMap<String, MergeMiningProxyProcess>,
     pub transactions: IndexMap<String, Transaction>,
     pub wallet_addresses: IndexMap<String, String>, // values are strings representing tari addresses
@@ -128,6 +131,8 @@ impl Default for TariWorld {
             miners: Default::default(),
             ffi_wallets: Default::default(),
             wallets: Default::default(),
+            balance: Default::default(),
+            view_and_spend_keys: Default::default(),
             merge_mining_proxies: Default::default(),
             transactions: Default::default(),
             wallet_addresses: Default::default(),

integration_tests/src/world.rs

@@ -85,18 +85,18 @@ Scenario: Verify UTXO and kernel MMR size in header
         When I wait for wallet WALLET_11 to have at least 18462050000 uT
         When I wait for wallet WALLET_12 to have at least 18462050000 uT
 
-        Then I send 18462000000 uT from wallet WALLET_01 to wallet WALLET_DEFAULT at fee 1
-        Then I send 18462000000 uT from wallet WALLET_02 to wallet WALLET_DEFAULT at fee 1
-        Then I send 18462000000 uT from wallet WALLET_03 to wallet WALLET_DEFAULT at fee 1
-        Then I send 18462000000 uT from wallet WALLET_04 to wallet WALLET_DEFAULT at fee 1
-        Then I send 18462000000 uT from wallet WALLET_05 to wallet WALLET_DEFAULT at fee 1
-        Then I send 18462000000 uT from wallet WALLET_06 to wallet WALLET_DEFAULT at fee 1
-        Then I send 18462000000 uT from wallet WALLET_07 to wallet WALLET_DEFAULT at fee 1
-        Then I send 18462000000 uT from wallet WALLET_08 to wallet WALLET_DEFAULT at fee 1
-        Then I send 18462000000 uT from wallet WALLET_09 to wallet WALLET_DEFAULT at fee 1
-        Then I send 18462000000 uT from wallet WALLET_10 to wallet WALLET_DEFAULT at fee 1
-        Then I send 18462000000 uT from wallet WALLET_11 to wallet WALLET_DEFAULT at fee 1
-        Then I send 18462000000 uT from wallet WALLET_12 to wallet WALLET_DEFAULT at fee 1
+        Then I send a one-sided transaction of 18462000000 uT from wallet WALLET_01 to wallet WALLET_DEFAULT at fee 1
+        Then I send a one-sided transaction of 18462000000 uT from wallet WALLET_02 to wallet WALLET_DEFAULT at fee 1
+        Then I send a one-sided transaction of 18462000000 uT from wallet WALLET_03 to wallet WALLET_DEFAULT at fee 1
+        Then I send a one-sided transaction of 18462000000 uT from wallet WALLET_04 to wallet WALLET_DEFAULT at fee 1
+        Then I send a one-sided transaction of 18462000000 uT from wallet WALLET_05 to wallet WALLET_DEFAULT at fee 1
+        Then I send a one-sided transaction of 18462000000 uT from wallet WALLET_06 to wallet WALLET_DEFAULT at fee 1
+        Then I send a one-sided transaction of 18462000000 uT from wallet WALLET_07 to wallet WALLET_DEFAULT at fee 1
+        Then I send a one-sided transaction of 18462000000 uT from wallet WALLET_08 to wallet WALLET_DEFAULT at fee 1
+        Then I send a one-sided transaction of 18462000000 uT from wallet WALLET_09 to wallet WALLET_DEFAULT at fee 1
+        Then I send a one-sided transaction of 18462000000 uT from wallet WALLET_10 to wallet WALLET_DEFAULT at fee 1
+        Then I send a one-sided transaction of 18462000000 uT from wallet WALLET_11 to wallet WALLET_DEFAULT at fee 1
+        Then I send a one-sided transaction of 18462000000 uT from wallet WALLET_12 to wallet WALLET_DEFAULT at fee 1
 
         # Mempool now has 12 transactions, each with 1000 coinbases as inputs, so we can create a big block
         Then I generate a block BLOCK_18 with 1000 coinbases from node NODE_01 for wallet WALLET_DEFAULT