Skip to content

Commit

Permalink
refactor!: remove outdated wallet_ffi balance methods (#3528)
Browse files Browse the repository at this point in the history 
Description
Removed outdated balance methods in wallet_ffi
Updated wallet.h
Updated cucumber tests

Motivation and Context
Removal of outdated methods

Merge #3547 first.

How Has This Been Tested?
nvm use 12.22.6 &&  node_modules/.bin/cucumber-js --profile "ci"  --tags "not @long-running and not @broken and @wallet-ffi"
  • Loading branch information
@StriderDM
StriderDM committed Nov 9, 2021
1 parent 9064b83 commit 413757b
Show file tree
Hide file tree
Showing 9 changed files with 91 additions and 171 deletions.
2 changes: 1 addition & 1 deletion base_layer/wallet/src/wallet.rs
View file
Expand Up @@ -266,7 +266,7 @@ where
/// This method consumes the wallet so that the handles are dropped which will result in the services async loops
/// exiting.
pub async fn wait_until_shutdown(self) {
self.comms.clone().wait_until_shutdown().await;
self.comms.to_owned().wait_until_shutdown().await;
}

/// This function will set the base node that the wallet uses to broadcast transactions, monitor outputs, and
Expand Down
6 changes: 6 additions & 0 deletions base_layer/wallet_ffi/src/error.rs
View file
Expand Up @@ -54,6 +54,8 @@ pub enum InterfaceError {
InvalidEmojiId,
#[error("An error has occurred due to an invalid argument: `{0}`")]
InvalidArgument(String),
#[error("Balance Unavailable")]
BalanceError,
}

/// This struct is meant to hold an error for use by FFI client applications. The error has an integer code and string
Expand Down Expand Up @@ -96,6 +98,10 @@ impl From<InterfaceError> for LibWalletError {
code: 7,
message: format!("{:?}", v),
},
InterfaceError::BalanceError => Self {
code: 8,
message: "Balance Unavailable".to_string(),
},
}
}
}
Expand Down
146 changes: 33 additions & 113 deletions base_layer/wallet_ffi/src/lib.rs
View file
Expand Up @@ -3050,6 +3050,39 @@ pub unsafe extern "C" fn wallet_create(
}
}

/// Retrieves the balance from a wallet
///
/// ## Arguments
/// `wallet` - The TariWallet pointer.
/// `error_out` - Pointer to an int which will be modified to an error code should one occur, may not be null. Functions
/// as an out parameter.
/// ## Returns
/// `*mut Balance` - Returns the pointer to the TariBalance or null if error occurs
///
/// # Safety
/// The ```balance_destroy``` method must be called when finished with a TariBalance to prevent a memory leak
#[no_mangle]
pub unsafe extern "C" fn wallet_get_balance(wallet: *mut TariWallet, error_out: *mut c_int) -> *mut TariBalance {
let mut error = 0;
ptr::swap(error_out, &mut error as *mut c_int);
if wallet.is_null() {
error = LibWalletError::from(InterfaceError::NullError("wallet".to_string())).code;
ptr::swap(error_out, &mut error as *mut c_int);
return ptr::null_mut();
}
let balance = (*wallet)
.runtime
.block_on((*wallet).wallet.output_manager_service.get_balance());
match balance {
Ok(balance) => Box::into_raw(Box::new(balance)),
Err(_) => {
error = LibWalletError::from(InterfaceError::BalanceError).code;
ptr::swap(error_out, &mut error as *mut c_int);
ptr::null_mut()
},
}
}

/// Signs a message using the public key of the TariWallet
///
/// ## Arguments
Expand Down Expand Up @@ -3457,119 +3490,6 @@ pub unsafe extern "C" fn balance_destroy(balance: *mut TariBalance) {
}
}

/// Gets the available balance from a TariWallet. This is the balance the user can spend.
///
/// ## Arguments
/// `wallet` - The TariWallet pointer
/// `error_out` - Pointer to an int which will be modified to an error code should one occur, may not be null. Functions
/// as an out parameter.
///
/// ## Returns
/// `c_ulonglong` - The available balance, 0 if wallet is null
///
/// # Safety
/// None
#[no_mangle]
pub unsafe extern "C" fn wallet_get_available_balance(wallet: *mut TariWallet, error_out: *mut c_int) -> c_ulonglong {
let mut error = 0;
ptr::swap(error_out, &mut error as *mut c_int);
if wallet.is_null() {
error = LibWalletError::from(InterfaceError::NullError("wallet".to_string())).code;
ptr::swap(error_out, &mut error as *mut c_int);
return 0;
}

match (*wallet)
.runtime
.block_on((*wallet).wallet.output_manager_service.get_balance())
{
Ok(b) => c_ulonglong::from(b.available_balance),
Err(e) => {
error = LibWalletError::from(WalletError::OutputManagerError(e)).code;
ptr::swap(error_out, &mut error as *mut c_int);
0
},
}
}

/// Gets the incoming balance from a `TariWallet`. This is the uncleared balance of Tari that is
/// expected to come into the `TariWallet` but is not yet spendable.
///
/// ## Arguments
/// `wallet` - The TariWallet pointer
/// `error_out` - Pointer to an int which will be modified to an error code should one occur, may not be null. Functions
/// as an out parameter.
///
/// ## Returns
/// `c_ulonglong` - The incoming balance, 0 if wallet is null
///
/// # Safety
/// None
#[no_mangle]
pub unsafe extern "C" fn wallet_get_pending_incoming_balance(
wallet: *mut TariWallet,
error_out: *mut c_int,
) -> c_ulonglong {
let mut error = 0;
ptr::swap(error_out, &mut error as *mut c_int);
if wallet.is_null() {
error = LibWalletError::from(InterfaceError::NullError("wallet".to_string())).code;
ptr::swap(error_out, &mut error as *mut c_int);
return 0;
}

match (*wallet)
.runtime
.block_on((*wallet).wallet.output_manager_service.get_balance())
{
Ok(b) => c_ulonglong::from(b.pending_incoming_balance),
Err(e) => {
error = LibWalletError::from(WalletError::OutputManagerError(e)).code;
ptr::swap(error_out, &mut error as *mut c_int);
0
},
}
}

/// Gets the outgoing balance from a `TariWallet`. This is the uncleared balance of Tari that has
/// been spent
///
/// ## Arguments
/// `wallet` - The TariWallet pointer
/// `error_out` - Pointer to an int which will be modified to an error code should one occur, may not be null. Functions
/// as an out parameter.
///
/// ## Returns
/// `c_ulonglong` - The outgoing balance, 0 if wallet is null
///
/// # Safety
/// None
#[no_mangle]
pub unsafe extern "C" fn wallet_get_pending_outgoing_balance(
wallet: *mut TariWallet,
error_out: *mut c_int,
) -> c_ulonglong {
let mut error = 0;
ptr::swap(error_out, &mut error as *mut c_int);
if wallet.is_null() {
error = LibWalletError::from(InterfaceError::NullError("wallet".to_string())).code;
ptr::swap(error_out, &mut error as *mut c_int);
return 0;
}

match (*wallet)
.runtime
.block_on((*wallet).wallet.output_manager_service.get_balance())
{
Ok(b) => c_ulonglong::from(b.pending_outgoing_balance),
Err(e) => {
error = LibWalletError::from(WalletError::OutputManagerError(e)).code;
ptr::swap(error_out, &mut error as *mut c_int);
0
},
}
}

/// Sends a TariPendingOutboundTransaction
///
/// ## Arguments
Expand Down
12 changes: 3 additions & 9 deletions base_layer/wallet_ffi/wallet.h
View file
Expand Up @@ -477,6 +477,9 @@ struct TariWallet *wallet_create(struct TariCommsConfig *config,
bool *recovery_in_progress,
int *error_out);

// Gets the balance
struct TariBalance *wallet_get_balance(struct TariWallet *wallet, int *error_out);

// Signs a message
char *wallet_sign_message(struct TariWallet *wallet, const char *msg, int *error_out);

Expand Down Expand Up @@ -504,15 +507,6 @@ unsigned long long balance_get_pending_incoming(struct TariBalance *balance, int
// Gets the available balance from a TariBalance
unsigned long long balance_get_pending_outgoing(struct TariBalance *balance, int *error_out);

// Gets the available balance from a TariWallet
unsigned long long wallet_get_available_balance(struct TariWallet *wallet, int *error_out);

// Gets the incoming balance from a TariWallet
unsigned long long wallet_get_pending_incoming_balance(struct TariWallet *wallet, int *error_out);

// Gets the outgoing balance from a TariWallet
unsigned long long wallet_get_pending_outgoing_balance(struct TariWallet *wallet, int *error_out);

// Get a fee estimate from a TariWallet for a given amount
unsigned long long wallet_get_fee_estimate(struct TariWallet *wallet, unsigned long long amount, unsigned long long fee_per_gram, unsigned long long num_kernels, unsigned long long num_outputs, int *error_out);

Expand Down
2 changes: 1 addition & 1 deletion integration_tests/features/WalletFFI.feature
View file
Expand Up @@ -156,7 +156,7 @@ Feature: Wallet FFI
# Scenario: As a client I want feedback about my connection status to the specifed Base Node

# Scenario: As a client I want feedback about the wallet restoration process
# As a client I want to be able to restore my wallet from seed words
# It's a subtest of "As a client I want to be able to restore my wallet from seed words"

# Scenario: As a client I want feedback about TXO and TX validation processes
# It's a subtest of "As a client I want to retrieve a list of transactions I have made and received"
2 changes: 1 addition & 1 deletion integration_tests/features/support/ffi_steps.js
View file
Expand Up @@ -444,7 +444,7 @@ Then(
120
);

let balance = wallet.getBalance().available;
let balance = wallet.pollBalance().available;

if (!(balance >= amount)) {
console.log("Balance not adequate!");
Expand Down
38 changes: 8 additions & 30 deletions integration_tests/helpers/ffi/ffiInterface.js
View file
Expand Up @@ -294,6 +294,7 @@ class InterfaceFFI {
this.intPtr,
],
],
wallet_get_balance: [this.ptr, [this.ptr, this.intPtr]],
wallet_sign_message: [
this.stringPtr,
[this.ptr, this.string, this.intPtr],
Expand All @@ -312,15 +313,6 @@ class InterfaceFFI {
balance_get_time_locked: [this.ulonglong, [this.ptr, this.intPtr]],
balance_get_pending_incoming: [this.ulonglong, [this.ptr, this.intPtr]],
balance_get_pending_outgoing: [this.ulonglong, [this.ptr, this.intPtr]],
wallet_get_available_balance: [this.ulonglong, [this.ptr, this.intPtr]],
wallet_get_pending_incoming_balance: [
this.ulonglong,
[this.ptr, this.intPtr],
],
wallet_get_pending_outgoing_balance: [
this.ulonglong,
[this.ptr, this.intPtr],
],
wallet_get_fee_estimate: [
this.ulonglong,
[
Expand Down Expand Up @@ -1211,6 +1203,13 @@ class InterfaceFFI {
return result;
}

static walletGetBalance(ptr) {
let error = this.initError();
let result = this.fn.wallet_get_balance(ptr, error);
this.checkErrorResult(error, `walletGetBalance`);
return result;
}

static walletGetPublicKey(ptr) {
let error = this.initError();
let result = this.fn.wallet_get_public_key(ptr, error);
Expand Down Expand Up @@ -1292,27 +1291,6 @@ class InterfaceFFI {
return result;
}

static walletGetAvailableBalance(ptr) {
let error = this.initError();
let result = this.fn.wallet_get_available_balance(ptr, error);
this.checkErrorResult(error, `walletGetAvailableBalance`);
return result;
}

static walletGetPendingIncomingBalance(ptr) {
let error = this.initError();
let result = this.fn.wallet_get_pending_incoming_balance(ptr, error);
this.checkErrorResult(error, `walletGetPendingIncomingBalance`);
return result;
}

static walletGetPendingOutgoingBalance(ptr) {
let error = this.initError();
let result = this.fn.wallet_get_pending_outgoing_balance(ptr, error);
this.checkErrorResult(error, `walletGetPendingOutgoingBalance`);
return result;
}

static walletGetFeeEstimate(
ptr,
amount,
Expand Down
50 changes: 34 additions & 16 deletions integration_tests/helpers/ffi/wallet.js
View file
Expand Up @@ -10,8 +10,17 @@ const Contacts = require("./contacts");
const Balance = require("./balance");

const utf8 = require("utf8");

class WalletBalance {
available = 0;
timeLocked = 0;
pendingIn = 0;
pendingOut = 0;
}

class Wallet {
ptr;
balance = new WalletBalance();
log_path = "";
receivedTransaction = 0;
receivedTransactionReply = 0;
Expand Down Expand Up @@ -269,8 +278,16 @@ class Wallet {
onBalanceUpdated = (ptr) => {
let b = new Balance();
b.pointerAssign(ptr);
this.balance.available = b.getAvailable();
this.balance.timeLocked = b.getTimeLocked();
this.balance.pendingIn = b.getPendingIncoming();
this.balance.pendingOut = b.getPendingOutgoing();
console.log(
`${new Date().toISOString()} callbackBalanceUpdated: available = ${b.getAvailable()}, time locked = ${b.getTimeLocked()} pending incoming = ${b.getPendingIncoming()} pending outgoing = ${b.getPendingOutgoing()}`
`${new Date().toISOString()} callbackBalanceUpdated: available = ${
this.balance.available
}, time locked = ${this.balance.timeLocked} pending incoming = ${
this.balance.pendingIn
} pending outgoing = ${this.balance.pendingOut}`
);
b.destroy();
};
Expand Down Expand Up @@ -320,6 +337,22 @@ class Wallet {
return result;
}

getBalance() {
return this.balance;
}

pollBalance() {
let b = new Balance();
let ptr = InterfaceFFI.walletGetBalance(this.ptr);
b.pointerAssign(ptr);
this.balance.available = b.getAvailable();
this.balance.timeLocked = b.getTimeLocked();
this.balance.pendingIn = b.getPendingIncoming();
this.balance.pendingOut = b.getPendingOutgoing();
b.destroy();
return this.balance;
}

getEmojiId() {
let ptr = InterfaceFFI.walletGetPublicKey(this.ptr);
let pk = new PublicKey();
Expand All @@ -329,21 +362,6 @@ class Wallet {
return result;
}

getBalance() {
let available = InterfaceFFI.walletGetAvailableBalance(this.ptr);
let pendingIncoming = InterfaceFFI.walletGetPendingIncomingBalance(
this.ptr
);
let pendingOutgoing = InterfaceFFI.walletGetPendingOutgoingBalance(
this.ptr
);
return {
pendingIn: pendingIncoming,
pendingOut: pendingOutgoing,
available: available,
};
}

addBaseNodePeer(public_key_hex, address) {
let public_key = PublicKey.fromHexString(utf8.encode(public_key_hex));
let result = InterfaceFFI.walletAddBaseNodePeer(
Expand Down
4 changes: 4 additions & 0 deletions integration_tests/helpers/walletFFIClient.js
View file
Expand Up @@ -74,6 +74,10 @@ class WalletFFIClient {
return this.wallet.getBalance();
}

pollBalance() {
return this.wallet.pollBalance();
}

addBaseNodePeer(public_key_hex, address) {
return this.wallet.addBaseNodePeer(public_key_hex, address);
}
Expand Down

0 comments on commit 413757b

Please sign in to comment.