gm-tui 0.0.1

TUI-based Ethereum wallet
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
use std::{
    io,
    str::FromStr,
    sync::{atomic::AtomicBool, mpsc, Arc, RwLock, RwLockWriteGuard},
};

use alloy::primitives::Address;
use crossterm::event::{KeyCode, KeyEventKind, KeyModifiers};
use pages::{
    config::ConfigPage,
    dev_key_capture::DevKeyCapturePage,
    main_menu::{MainMenuItem, MainMenuPage},
    text::TextPage,
    trade::TradePage,
    Page,
};
use ratatui::{
    buffer::Buffer,
    layout::{Constraint, Layout, Rect},
    widgets::{Block, Widget},
    DefaultTerminal,
};
use widgets::{footer::Footer, form::Form, text_popup::TextPopup, title::Title};

use super::{
    events::{self, Event},
    traits::{Component, HandleResult, RectUtil},
};
use crate::{
    disk::{Config, DiskInterface},
    error::FmtError,
    tui::{app::widgets::invite_popup::InvitePopup, events::helios::helios_thread},
    utils::assets::Asset,
};
use crate::{
    tui::theme::{Theme, ThemeName},
    utils::assets::AssetManager,
};

pub mod pages;
pub mod widgets;

// TODO update focus to have title bar, footer
#[allow(dead_code)]
#[derive(Debug, PartialEq)]
pub enum Focus {
    Main,
    Sidebar,
}

pub struct SharedState {
    pub online: Option<bool>,
    pub asset_manager: Arc<RwLock<AssetManager>>,
    pub recent_addresses: Option<Vec<Address>>,
    pub testnet_mode: bool,
    pub developer_mode: bool,
    current_account: Option<Address>,
    pub alchemy_api_key_available: bool,
    pub eth_price: Option<String>,
    pub theme: Theme,
}

impl SharedState {
    pub fn assets_read(&self) -> crate::Result<Option<Vec<Asset>>> {
        let Some(current_account) = self.current_account else {
            return Ok(None);
        };

        Ok(self
            .asset_manager
            .read()
            .map_err(|e| format!("poison error - please restart gm - {e}"))?
            .get_assets(&current_account)
            .cloned())
    }

    pub fn assets_mut(&mut self) -> crate::Result<RwLockWriteGuard<'_, AssetManager>> {
        Ok(self
            .asset_manager
            .write()
            .map_err(|e| format!("poison error - please restart gm - {e}"))?)
    }

    pub fn try_current_account(&self) -> crate::Result<Address> {
        self.current_account
            .ok_or_else(|| crate::Error::CurrentAccountNotSet)
    }
}

pub struct App {
    pub context: Vec<Page>,
    pub preview_page: Option<Page>,

    pub exit: bool,
    pub fatal_error_popup: TextPopup,

    pub shared_state: SharedState,

    pub invite_popup: InvitePopup,

    pub input_thread: Option<std::thread::JoinHandle<()>>,
    pub eth_price_thread: Option<tokio::task::JoinHandle<()>>,
    pub assets_thread: Option<tokio::task::JoinHandle<()>>,
    pub recent_addresses_thread: Option<tokio::task::JoinHandle<()>>,
    pub helios_thread: Option<tokio::task::JoinHandle<()>>,
}

impl App {
    pub fn new() -> crate::Result<Self> {
        let config = Config::load()?;
        let theme_name = ThemeName::from_str(&config.theme_name)?;
        let theme = Theme::new(theme_name);
        Ok(Self {
            context: vec![Page::MainMenu(MainMenuPage::new(config.developer_mode)?)],
            preview_page: None,

            exit: false,
            // fatal_error: None,
            fatal_error_popup: TextPopup::new("Fatal Error"),
            shared_state: SharedState {
                asset_manager: Arc::new(RwLock::new(AssetManager::default())),
                recent_addresses: None,
                current_account: config.current_account,
                developer_mode: config.developer_mode,
                alchemy_api_key_available: config.alchemy_api_key.is_some(),
                online: None,
                eth_price: None,
                testnet_mode: config.testnet_mode,
                theme,
            },

            invite_popup: InvitePopup::default(),

            input_thread: None,
            eth_price_thread: None,
            assets_thread: None,
            recent_addresses_thread: None,
            helios_thread: None,
        })
    }

    pub fn cli_args(&mut self, args: Vec<String>) -> crate::Result<()> {
        if args.len() == 1 {
            // TODO support for wallet connect URI
            if args[0].ends_with("invite") {
                self.invite_popup.set_invite_code(&args[0]);
                self.invite_popup.open();
            }
        } else if args.len() > 1 {
            self.fatal_error_popup.set_text(format!(
                "Too many arguments provided to gm on the cli: {args:?}. Expected 0 or 1.",
            ));
        }

        Ok(())
    }
}

impl App {
    pub fn draw(&self, terminal: &mut DefaultTerminal) -> io::Result<Rect> {
        let completed_frame = terminal.draw(|frame| {
            frame.render_widget(self, frame.area());
        })?;
        Ok(completed_frame.area)
    }

    pub fn init_threads(&mut self, tr: &mpsc::Sender<Event>, sd: &Arc<AtomicBool>) {
        let tr_input = tr.clone();
        let shutdown_signal = sd.clone();
        self.input_thread = Some(std::thread::spawn(move || {
            events::input::watch_input_events(tr_input, shutdown_signal);
        }));

        let tr_eth_price = tr.clone();
        let shutdown_signal = sd.clone();
        self.eth_price_thread = Some(tokio::spawn(async move {
            events::eth_price::watch_eth_price_change(tr_eth_price, shutdown_signal).await
        }));
    }

    fn start_other_threads(&mut self, tr: &mpsc::Sender<Event>, sd: &Arc<AtomicBool>) {
        if self.assets_thread.is_none() {
            let tr_assets = tr.clone();
            let shutdown_signal = sd.clone();
            self.assets_thread = Some(tokio::spawn(async move {
                events::assets::watch_assets(tr_assets, shutdown_signal).await
            }));
        }

        // TODO enable disabling helios through config
        if self.helios_thread.is_none() {
            let tr = tr.clone();
            let assets_manager = Arc::clone(&self.shared_state.asset_manager);
            self.helios_thread = Some(tokio::spawn(async move {
                if let Err(e) = helios_thread(&tr, assets_manager).await {
                    let _ = tr.send(Event::HeliosError(e.fmt_err("HeliosError")));
                }
            }));
        }

        if self.recent_addresses_thread.is_none() {
            let tr_recent_addresses = tr.clone();
            let shutdown_signal = sd.clone();
            self.recent_addresses_thread = Some(tokio::spawn(async move {
                events::recent_addresses::watch_recent_addresses(
                    tr_recent_addresses,
                    shutdown_signal,
                )
                .await
            }));
        }
    }

    async fn stop_other_threads(&mut self) {
        if let Some(thread) = self.assets_thread.take() {
            thread.abort();
            let _ = thread.await;
        }

        if let Some(thread) = self.recent_addresses_thread.take() {
            thread.abort();
            let _ = thread.await;
        }
    }

    fn set_online(&mut self, tr: &mpsc::Sender<Event>, sd: &Arc<AtomicBool>) {
        self.start_other_threads(tr, sd);

        self.shared_state.online = Some(true);
    }

    async fn set_offline(&mut self) {
        self.shared_state.online = Some(false);

        self.stop_other_threads().await;
    }

    pub async fn exit_threads(&mut self) {
        if let Some(thread) = self.input_thread.take() {
            thread.join().unwrap();
        }
        if let Some(thread) = self.eth_price_thread.take() {
            thread.await.unwrap();
        }
        if let Some(thread) = self.assets_thread.take() {
            thread.await.unwrap();
        }

        for page in &mut self.context {
            page.exit_threads().await;
        }
    }

    pub fn reload(&mut self) -> crate::Result<()> {
        let config = Config::load()?;
        self.shared_state.testnet_mode = config.testnet_mode;
        self.shared_state.alchemy_api_key_available = config.alchemy_api_key.is_some();
        self.shared_state.current_account = config.current_account;
        self.shared_state.developer_mode = config.developer_mode;
        let theme_name = ThemeName::from_str(&config.theme_name)?;
        let theme = Theme::new(theme_name);
        self.shared_state.theme = theme;
        for page in &mut self.context {
            page.reload(&self.shared_state)?;
        }

        Ok(())
    }

    async fn process_result(
        &mut self,
        result: crate::Result<HandleResult>,
    ) -> crate::Result<usize> {
        let result = match result {
            Ok(res) => res,
            Err(error) => {
                self.fatal_error_popup.set_text(format!("{error:#?}"));
                return Err(error);
            }
        };
        for _ in 0..result.page_pops {
            self.context.pop();
        }
        if result.reload {
            self.reload()?;
            if let Some(page) = self.context.last_mut() {
                page.reload(&self.shared_state)?;
            }
        }
        if result.refresh_assets {
            // TODO restart the assets thread to avoid the delay
            if let Some(account) = Config::current_account()? {
                self.shared_state.assets_mut()?.clear_data_for(account);
            }
        }
        self.context.extend(result.page_inserts);
        Ok(result.esc_ignores)
    }

    pub async fn handle_event(
        &mut self,
        event: super::events::Event,
        area: Rect,
        tr: &mpsc::Sender<Event>,
        sd: &Arc<AtomicBool>,
    ) -> crate::Result<()> {
        let [_, body_area, _] = self.get_areas(area);

        let result = if self.fatal_error_popup.is_shown() {
            self.fatal_error_popup.handle_event(&event, area)
        } else if self.invite_popup.is_open() {
            self.invite_popup.handle_event(&event, tr)
        } else if self.context.last().is_some() {
            let page = self.context.last_mut().unwrap();
            page.handle_event(&event, body_area.block_inner(), tr, sd, &self.shared_state)
        } else {
            Ok(HandleResult::default())
        };

        let esc_ignores = self.process_result(result).await?;

        if self.context.is_empty() {
            self.exit = true;
        }

        match event {
            Event::Input(key_event) => {
                // check if we should exit on 'q' press
                if key_event.kind == KeyEventKind::Press {
                    #[allow(clippy::single_match)]
                    match key_event.code {
                        KeyCode::Char(char) => {
                            // TODO can we quit using q as well?
                            // if char == 'q' && self.navigation.text_input().is_none() {
                            //     self.exit = true;
                            // }
                            if char == 'c' && key_event.modifiers == KeyModifiers::CONTROL {
                                self.exit = true;
                            }
                            if char == 'r' && key_event.modifiers == KeyModifiers::CONTROL {
                                self.fatal_error_popup.set_text("test error".to_string());
                            }
                            if char == 't' && key_event.modifiers == KeyModifiers::CONTROL {
                                self.context.push(Page::Trade(TradePage::default()));
                            }
                        }
                        KeyCode::Esc => {
                            if self.fatal_error_popup.is_shown() {
                                self.fatal_error_popup.clear();
                            } else if esc_ignores == 0 {
                                let page = self.context.pop();
                                if let Some(mut page) = page {
                                    page.exit_threads().await;
                                }
                                if self.context.is_empty() {
                                    self.exit = true;
                                }
                            }
                        }
                        _ => {}
                    }
                }
            }

            Event::AccountChange(address) => {
                self.shared_state.current_account = Some(address);
            }

            Event::ConfigUpdate => {
                self.reload()?;
            }

            // ETH Price API
            Event::EthPriceUpdate(eth_price) => {
                self.shared_state.eth_price = Some(eth_price);
                self.set_online(tr, sd);
            }
            Event::EthPriceError(error) => {
                if error.is_connect() {
                    // ETH Price is the main API for understanding if we are connected to internet
                    self.set_offline().await;
                } else {
                    self.fatal_error_popup
                        .set_text(error.fmt_err("EthPriceError"));
                }
            }

            // Assets API
            Event::AssetsUpdate(wallet_address, assets) => {
                self.shared_state
                    .assets_mut()?
                    .update_assets(wallet_address, assets)?;
            }
            Event::AssetsUpdateError(error, silence_error) => {
                if !silence_error {
                    self.fatal_error_popup.set_text(error);
                }
            }

            Event::HeliosUpdate {
                account,
                network,
                token_address,
                status,
            } => {
                self.shared_state
                    .asset_manager
                    .write()
                    .map_err(|err| format!("poison error - please restart gm - {err}"))?
                    .update_light_client_verification(account, network, token_address, status);
            }
            Event::HeliosError(error) => {
                self.fatal_error_popup.set_text(error);
            }

            Event::RecentAddressesUpdate(addresses) => {
                self.shared_state.recent_addresses = Some(addresses);
            }
            Event::RecentAddressesUpdateError(error) => {
                self.fatal_error_popup.set_text(error);
            }

            // Candles API
            Event::CandlesUpdateError(error) => {
                self.fatal_error_popup
                    .set_text(error.fmt_err("CandlesUpdateError"));
            }

            // Transaction API
            Event::TxError(error) => self.fatal_error_popup.set_text(error),

            Event::WalletConnectError(_, error) => {
                self.fatal_error_popup.set_text(error);
            }

            _ => {}
        };

        Ok(())
    }

    fn current_page(&self) -> Option<&Page> {
        self.context.last()
    }

    // TODO using this triggers rust borrow checks, as we are not able to do
    // immutable borrows once self is borrowed mutably
    #[allow(dead_code)]
    fn current_page_mut(&mut self) -> Option<&mut Page> {
        self.context.last_mut()
    }

    fn get_areas(&self, area: Rect) -> [Rect; 3] {
        let [title_area, body_area, footer_area] = Layout::vertical([
            Constraint::Length(1),
            Constraint::Min(3),
            Constraint::Length(1),
        ])
        .areas(area);
        [title_area, body_area, footer_area]
    }
}

impl Widget for &App {
    fn render(self, area: Rect, buf: &mut Buffer)
    where
        Self: Sized,
    {
        let [title_area, body_area, footer_area] = self.get_areas(area);

        Title.render_component(title_area, buf, &self.shared_state);

        if let Some(page) = self.current_page() {
            // Render Body
            if page.is_main_menu() && page.main_menu_focused_item().is_some() {
                let main_menu_item = page.main_menu_focused_item().unwrap();
                let [left_area, gap_area, right_area] = Layout::horizontal([
                    Constraint::Length(13),
                    Constraint::Length(1),
                    Constraint::Min(2),
                ])
                .areas(body_area.block_inner());

                // Render border of the canvas
                Block::bordered()
                    .border_type(self.shared_state.theme.border_type)
                    .render(body_area, buf);

                // Render the Middle stick
                let height_inner = gap_area.height;
                let mut gap_area = gap_area.expand_vertical(1);
                "".render(gap_area, buf);
                for _ in 0..height_inner {
                    gap_area = gap_area.consume_height(1).expect("should not fail");
                    "".render(gap_area, buf);
                }
                gap_area = gap_area.consume_height(1).expect("should not fail");
                "".render(gap_area, buf);

                // Render Main Menu on the Left side
                page.render_component(left_area, buf, &self.shared_state);

                // Render the preview of selection on the Right side
                let dummy_page = match main_menu_item {
                    MainMenuItem::Portfolio => {
                        let mut preview_page = main_menu_item
                            .get_page()
                            .expect("main_menu_item.get_page() failed");
                        preview_page.set_focus(false);
                        preview_page
                    }
                    MainMenuItem::Config => Page::Config(ConfigPage {
                        form: Form::init(|form| {
                            form.show_everything_empty(true);
                            Ok(())
                        })
                        .unwrap(),
                    }),
                    MainMenuItem::CompleteSetup => Page::Text(TextPage::new(
                        "Setup some of the essential stuff to get the most out of gm".to_string(),
                    )),
                    MainMenuItem::Accounts => {
                        Page::Text(TextPage::new("Create or load accounts".to_string()))
                    }
                    MainMenuItem::AddressBook => {
                        Page::Text(TextPage::new("Manage familiar addresses".to_string()))
                    }
                    MainMenuItem::Networks => {
                        Page::Text(TextPage::new("Manage networks and tokens".to_string()))
                    }
                    MainMenuItem::WalletConnect => {
                        let mut preview_page = main_menu_item
                            .get_page()
                            .expect("main_menu_item.get_page() failed");
                        preview_page.set_focus(false);
                        preview_page
                    }
                    MainMenuItem::SignMessage => Page::Text(TextPage::new(
                        "Sign a message and prove ownership to somebody".to_string(),
                    )),
                    MainMenuItem::SendMessage => {
                        Page::Text(TextPage::new("Send onchain message to someone".to_string()))
                    }
                    MainMenuItem::DevKeyInput => Page::DevKeyCapture(DevKeyCapturePage::default()),
                };

                dummy_page.render_component(right_area, buf, &self.shared_state);
            } else {
                page.render_component_with_block(
                    body_area,
                    buf,
                    Block::bordered().border_type(self.shared_state.theme.border_type),
                    &self.shared_state,
                );
            }

            Footer {
                exit: &self.exit,
                is_main_menu: &page.is_main_menu(),
            }
            .render(footer_area, buf, &self.shared_state.theme);
        }

        self.invite_popup.render(area, buf, &self.shared_state);

        self.fatal_error_popup
            .render(area, buf, &self.shared_state.theme.error_popup());
    }
}