Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add scanned height #6440

Merged
merged 3 commits into from
Aug 1, 2024
Merged

feat: add scanned height #6440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8190655
cw add scanned height
SWvheerden Jul 30, 2024
e805a11
wip
SWvheerden Jul 31, 2024
f56d9de
add test
SWvheerden Jul 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion applications/minotari_console_wallet/src/ui/components/base_node.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ impl<B: Backend> Component<B> for BaseNode {
let base_node_state = app_state.get_base_node_state();
if let Some(ref metadata) = base_node_state.chain_metadata {
let tip = metadata.best_block_height();
let scanned_height = app_state.get_wallet_scanned_height();

let synced = base_node_state.is_synced.unwrap_or_default();
let (tip_color, sync_text) = if synced {
Expand Down Expand Up @@ -102,7 +103,7 @@ impl<B: Backend> Component<B> for BaseNode {
let mut tip_info = vec![
Span::styled("Chain Tip:", Style::default().fg(Color::Magenta)),
Span::raw(" "),
Span::styled(format!("#{}", tip), Style::default().fg(tip_color)),
Span::styled(format!("#{}({})", tip, scanned_height), Style::default().fg(tip_color)),
Span::raw(" "),
Span::styled(sync_text.to_string(), Style::default().fg(Color::White)),
Span::raw(" "),
Expand Down
16 changes: 16 additions & 0 deletions applications/minotari_console_wallet/src/ui/state/app_state.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ use minotari_wallet::{
storage::models::{CompletedTransaction, TxCancellationReason},
},
util::wallet_identity::WalletIdentity,
utxo_scanner_service::handle::UtxoScannerHandle,
WalletConfig,
WalletSqlite,
};
Expand Down Expand Up @@ -556,6 +557,10 @@ impl AppState {
&self.cached_data.base_node_state
}

pub fn get_wallet_scanned_height(&self) -> u64 {
self.cached_data.wallet_scanned_height
}

pub fn get_wallet_connectivity(&self) -> WalletConnectivityHandle {
self.wallet_connectivity.clone()
}
Expand Down Expand Up @@ -968,7 +973,12 @@ impl AppStateInner {
pub async fn refresh_base_node_peer(&mut self, peer: Peer) -> Result<(), UiError> {
self.data.base_node_selected = peer;
self.updated = true;
Ok(())
}

pub async fn trigger_wallet_scanned_height_update(&mut self, height: u64) -> Result<(), UiError> {
self.data.wallet_scanned_height = height;
self.updated = true;
Ok(())
}

Expand Down Expand Up @@ -996,6 +1006,10 @@ impl AppStateInner {
self.wallet.wallet_connectivity.clone()
}

pub fn get_wallet_utxo_scanner(&self) -> UtxoScannerHandle {
self.wallet.utxo_scanner_service.clone()
}

pub fn get_base_node_event_stream(&self) -> BaseNodeEventReceiver {
self.wallet.base_node_service.get_event_stream()
}
Expand Down Expand Up @@ -1221,6 +1235,7 @@ struct AppStateData {
all_events: VecDeque<EventListItem>,
notifications: Vec<(DateTime<Local>, String)>,
new_notification_count: u32,
wallet_scanned_height: u64,
}

#[derive(Clone)]
Expand Down Expand Up @@ -1299,6 +1314,7 @@ impl AppStateData {
all_events: VecDeque::new(),
notifications: Vec::new(),
new_notification_count: 0,
wallet_scanned_height: 0,
}
}
}
Expand Down
36 changes: 36 additions & 0 deletions applications/minotari_console_wallet/src/ui/state/wallet_event_monitor.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ use minotari_wallet::{
connectivity_service::WalletConnectivityInterface,
output_manager_service::handle::OutputManagerEvent,
transaction_service::handle::TransactionEvent,
utxo_scanner_service::handle::UtxoScannerEvent,
};
use tari_common_types::transaction::TxId;
use tari_comms::{connectivity::ConnectivityEvent, peer_manager::Peer};
Expand Down Expand Up @@ -76,6 +77,12 @@ impl WalletEventMonitor {
let mut base_node_events = self.app_state_inner.read().await.get_base_node_event_stream();

let mut contacts_liveness_events = self.app_state_inner.read().await.get_contacts_liveness_event_stream();
let mut utxo_scanner_events = self
.app_state_inner
.read()
.await
.get_wallet_utxo_scanner()
.get_event_receiver();

info!(target: LOG_TARGET, "Wallet Event Monitor starting");
loop {
Expand Down Expand Up @@ -213,6 +220,27 @@ impl WalletEventMonitor {
Err(broadcast::error::RecvError::Closed) => {}
}
},
result = utxo_scanner_events.recv() => match result {
Ok(event) => {
match event {
UtxoScannerEvent::Progress {
current_height,..
}=> {
self.trigger_wallet_scanned_height_update(current_height).await;
}
UtxoScannerEvent::Completed {
final_height,
..
}=> {
self.trigger_wallet_scanned_height_update(final_height).await;
},
_ => {}
}
},
Err(e) => {
warn!(target: LOG_TARGET, "Problem with utxo scanner: {}",e);
},
},
_ = base_node_changed.changed() => {
let peer = base_node_changed.borrow().as_ref().cloned();
if let Some(peer) = peer {
Expand Down Expand Up @@ -333,6 +361,14 @@ impl WalletEventMonitor {
}
}

async fn trigger_wallet_scanned_height_update(&mut self, height: u64) {
let mut inner = self.app_state_inner.write().await;

if let Err(e) = inner.trigger_wallet_scanned_height_update(height).await {
warn!(target: LOG_TARGET, "Error refresh app_state: {}", e);
}
}

async fn trigger_base_node_peer_refresh(&mut self, peer: Peer) {
let mut inner = self.app_state_inner.write().await;

Expand Down
43 changes: 43 additions & 0 deletions base_layer/wallet_ffi/src/callback_handler.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ use minotari_wallet::{
models::{CompletedTransaction, InboundTransaction},
},
},
utxo_scanner_service::handle::UtxoScannerEvent,
};
use tari_common_types::{tari_address::TariAddress, transaction::TxId, types::BlockHash};
use tari_comms_dht::event::{DhtEvent, DhtEventReceiver};
Expand Down Expand Up @@ -85,12 +86,14 @@ where TBackend: TransactionBackend + 'static
callback_transaction_validation_complete: unsafe extern "C" fn(u64, u64),
callback_saf_messages_received: unsafe extern "C" fn(),
callback_connectivity_status: unsafe extern "C" fn(u64),
callback_wallet_scanned_height: unsafe extern "C" fn(u64),
callback_base_node_state: unsafe extern "C" fn(*mut TariBaseNodeState),
db: TransactionDatabase<TBackend>,
base_node_service_event_stream: BaseNodeEventReceiver,
transaction_service_event_stream: TransactionEventReceiver,
output_manager_service_event_stream: OutputManagerEventReceiver,
output_manager_service: OutputManagerHandle,
utxo_scanner_service_events: broadcast::Receiver<UtxoScannerEvent>,
dht_event_stream: DhtEventReceiver,
shutdown_signal: Option<ShutdownSignal>,
comms_address: TariAddress,
Expand All @@ -109,6 +112,7 @@ where TBackend: TransactionBackend + 'static
transaction_service_event_stream: TransactionEventReceiver,
output_manager_service_event_stream: OutputManagerEventReceiver,
output_manager_service: OutputManagerHandle,
utxo_scanner_service_events: broadcast::Receiver<UtxoScannerEvent>,
dht_event_stream: DhtEventReceiver,
shutdown_signal: ShutdownSignal,
comms_address: TariAddress,
Expand All @@ -130,6 +134,7 @@ where TBackend: TransactionBackend + 'static
callback_transaction_validation_complete: unsafe extern "C" fn(u64, u64),
callback_saf_messages_received: unsafe extern "C" fn(),
callback_connectivity_status: unsafe extern "C" fn(u64),
callback_wallet_scanned_height: unsafe extern "C" fn(u64),
callback_base_node_state: unsafe extern "C" fn(*mut TariBaseNodeState),
) -> Self {
info!(
Expand Down Expand Up @@ -196,6 +201,10 @@ where TBackend: TransactionBackend + 'static
target: LOG_TARGET,
"ConnectivityStatusCallback -> Assigning Fn: {:?}", callback_connectivity_status
);
info!(
target: LOG_TARGET,
"WalletScannedHeight -> Assigning Fn: {:?}", callback_wallet_scanned_height
);

Self {
callback_received_transaction,
Expand All @@ -214,12 +223,14 @@ where TBackend: TransactionBackend + 'static
callback_transaction_validation_complete,
callback_saf_messages_received,
callback_connectivity_status,
callback_wallet_scanned_height,
callback_base_node_state,
db,
base_node_service_event_stream,
transaction_service_event_stream,
output_manager_service_event_stream,
output_manager_service,
utxo_scanner_service_events,
dht_event_stream,
shutdown_signal: Some(shutdown_signal),
comms_address,
Expand Down Expand Up @@ -334,6 +345,28 @@ where TBackend: TransactionBackend + 'static
}
},

result = self.utxo_scanner_service_events.recv() => match result {
Ok(event) => {
match event {
UtxoScannerEvent::Progress {
current_height,..
}=> {
self.scanned_height_changed(current_height);
}
UtxoScannerEvent::Completed {
final_height,
..
}=> {
self.scanned_height_changed(final_height);
},
_ => {}
}
},
Err(e) => {
error!(target: LOG_TARGET, "Problem with utxo scanner: {}",e);
},
},

result = self.dht_event_stream.recv() => {
match result {
Ok(msg) => {
Expand Down Expand Up @@ -652,6 +685,16 @@ where TBackend: TransactionBackend + 'static
}
}

fn scanned_height_changed(&mut self, height: u64) {
debug!(
target: LOG_TARGET,
"Calling Scanned height changed callback function"
);
unsafe {
(self.callback_wallet_scanned_height)(height);
}
}

// casting here is okay as we dont care about the super high latency
#[allow(clippy::cast_possible_truncation)]
fn base_node_state_changed(&mut self, state: BaseNodeState) {
Expand Down
32 changes: 32 additions & 0 deletions base_layer/wallet_ffi/src/callback_handler_tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ mod test {
sqlite_db::TransactionServiceSqliteDatabase,
},
},
utxo_scanner_service::handle::UtxoScannerEvent,
};
use once_cell::sync::Lazy;
use rand::{rngs::OsRng, RngCore};
Expand Down Expand Up @@ -92,6 +93,7 @@ mod test {
pub callback_transaction_validation_complete: u32,
pub saf_messages_received: bool,
pub connectivity_status_callback_called: u64,
pub wallet_scanner_height_callback_called: u64,
pub base_node_state_changed_callback_invoked: bool,
}

Expand Down Expand Up @@ -121,6 +123,7 @@ mod test {
tx_cancellation_callback_called_outbound: false,
saf_messages_received: false,
connectivity_status_callback_called: 0,
wallet_scanner_height_callback_called: 0,
base_node_state_changed_callback_invoked: false,
}
}
Expand Down Expand Up @@ -255,6 +258,12 @@ mod test {
drop(lock);
}

unsafe extern "C" fn wallet_scanner_height_callback(height: u64) {
let mut lock = CALLBACK_STATE.lock().unwrap();
lock.wallet_scanner_height_callback_called += height;
drop(lock);
}

unsafe extern "C" fn base_node_state_changed_callback(state: *mut TariBaseNodeState) {
let mut lock = CALLBACK_STATE.lock().unwrap();
lock.base_node_state_changed_callback_invoked = true;
Expand Down Expand Up @@ -466,6 +475,8 @@ mod test {
let (connectivity_tx, connectivity_rx) = watch::channel(OnlineStatus::Offline);
let (contacts_liveness_events_sender, _) = broadcast::channel(250);
let contacts_liveness_events = contacts_liveness_events_sender.subscribe();
let (utxo_scanner_events_sender, _) = broadcast::channel(250);
let utxo_scanner_events = utxo_scanner_events_sender.subscribe();
let comms_address = TariAddress::new_dual_address_with_default_features(
PublicKey::from_secret_key(&PrivateKey::random(&mut OsRng)),
PublicKey::from_secret_key(&PrivateKey::random(&mut OsRng)),
Expand All @@ -478,6 +489,7 @@ mod test {
transaction_event_receiver,
oms_event_receiver,
oms_handle,
utxo_scanner_events,
dht_event_receiver,
shutdown_signal.to_signal(),
comms_address,
Expand All @@ -499,6 +511,7 @@ mod test {
transaction_validation_complete_callback,
saf_messages_received_callback,
connectivity_status_callback,
wallet_scanner_height_callback,
base_node_state_changed_callback,
);

Expand Down Expand Up @@ -843,6 +856,24 @@ mod test {

thread::sleep(Duration::from_secs(10));

utxo_scanner_events_sender
.send(UtxoScannerEvent::Progress {
current_height: 500,
tip_height: 600,
})
.unwrap();

thread::sleep(Duration::from_secs(2));
utxo_scanner_events_sender
.send(UtxoScannerEvent::Completed {
final_height: 600,
num_recovered: 0,
value_recovered: 0.into(),
time_taken: Duration::from_secs(0),
})
.unwrap();

thread::sleep(Duration::from_secs(2));
let lock = CALLBACK_STATE.lock().unwrap();
assert!(lock.received_tx_callback_called);
assert!(lock.received_tx_reply_callback_called);
Expand All @@ -867,6 +898,7 @@ mod test {
assert_eq!(lock.callback_balance_updated, 7);
assert_eq!(lock.callback_transaction_validation_complete, 13);
assert_eq!(lock.connectivity_status_callback_called, 7);
assert_eq!(lock.wallet_scanner_height_callback_called, 1100);

drop(lock);
}
Expand Down
Loading
Loading