ui.h

Go to the documentation of this file.

/*
 * SPDX-License-Identifier: LGPL-3.0-or-later
 * Copyright (c) 2026 Cryptnox SA
 */

 
#ifndef UI_H
#define UI_H
 
/******************************************************************
 * 1. Included files
 ******************************************************************/
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
 
#include "net.h"   /* net_wifi_ap_t for the network picker */
 
#ifdef __cplusplus
extern "C" {
#endif
 
/******************************************************************
 * 2. Types
 ******************************************************************/

typedef enum {
    UI_SCREEN_SPLASH,      
    UI_SCREEN_AMOUNT,      
    UI_SCREEN_CONFIRM,     
    UI_SCREEN_PIN,         
    UI_SCREEN_WIFI_LIST,   
    UI_SCREEN_WIFI_PASS,   
    UI_SCREEN_WIFI_CONNECTING, 
    UI_SCREEN_SETTINGS,    
    UI_SCREEN_TX_STATUS,   
    UI_SCREEN_BOOT_ERROR,  
    UI_SCREEN_ADMIN_SET,   
    UI_SCREEN_ADMIN_UNLOCK,
    UI_SCREEN_WELCOME,     
    UI_SCREEN_PROV,        
    UI_SCREEN_CARD_WAIT,   
    UI_SCREEN_TOUCH_CAL,   
} ui_screen_t;

typedef enum {
    UI_EVENT_AMOUNT_CONFIRMED,  
    UI_EVENT_CONFIRM_OK,        
    UI_EVENT_CONFIRM_CANCEL,    
    UI_EVENT_PIN_ENTERED,       
    UI_EVENT_WIFI_SCAN,         
    UI_EVENT_WIFI_TRY,          
    UI_EVENT_TX_RETRY,          
    UI_EVENT_ADMIN_SET,         
    UI_EVENT_WELCOME_DONE,      
    UI_EVENT_PROV_AUTH,         
    UI_EVENT_PROV_VALUE,        
    UI_EVENT_PROV_VALUE_SET,    
    UI_EVENT_PROV_VALUE_NO,     
    UI_EVENT_PROV_CARD,         
    UI_EVENT_PROV_SCAN,         
    UI_EVENT_PROV_NEXT,         
    UI_EVENT_PROV_FINISH,       
    UI_EVENT_CARD_PIN,          
    UI_EVENT_OTA_STAGED,        
    UI_EVENT_TX_RECHECK,        
    UI_EVENT_PROV_STOP,         
} ui_event_t;

typedef enum {
    UI_TX_STATE_PLACE_CARD,  
    UI_TX_STATE_PROCESSING,  
    UI_TX_STATE_SIGNING,     
    UI_TX_STATE_SENDING,     
    UI_TX_STATE_CONFIRMING,  
    UI_TX_STATE_DONE,        
    UI_TX_STATE_FAILED,      
    UI_TX_STATE_UNCONFIRMED, 
} ui_tx_state_t;

typedef enum {
    UI_BOOT_ERR_NFC,      
    UI_BOOT_ERR_WALLET,   
    UI_BOOT_ERR_CONFIG,   
} ui_boot_err_t;

typedef void (*ui_event_cb_t)(ui_event_t event, uint64_t payload);
 
/******************************************************************
 * 3. Public API
 ******************************************************************/

void ui_init(ui_event_cb_t cb);

void ui_show_splash(void);

void ui_show_amount_entry(void);

void ui_show_confirm(uint64_t amount_units, const char *dest_addr,
                     const char *fee);

void ui_show_tx_status(ui_tx_state_t state, const char *info);

void ui_set_tx_info(const char *info);

size_t ui_take_pin(char *out, size_t n);

void ui_show_wifi_list(const net_wifi_ap_t *aps, uint16_t n, const char *note);

void ui_show_boot_error(ui_boot_err_t kind, const char *detail);

void ui_set_addresses(const char *token_contract, const char *dest_addr);

void ui_refresh_addresses(void);

void ui_refresh_addresses_for(uint8_t chain);

void ui_show_wifi_connecting(const char *ssid);

void ui_set_boot_status(const char *step);

void ui_fees_changed(void);

void ui_clock_changed(void);

void ui_show_welcome(const char *sub);

void ui_show_admin_set(void);

size_t ui_take_wifi_creds(char *ssid, size_t ssid_n, char *pass, size_t pass_n);

void ui_stage_wifi_creds(const char *ssid, const char *pass);

void ui_show_prov(int step);

void ui_show_prov_confirm(void);

void ui_show_prov_auth(void);

void ui_show_card_pin(void);

void ui_set_prov_note(const char *msg);

void ui_show_card_wait(const char *note);

void ui_show_ota_confirm(void);
 
#ifdef __cplusplus
}
#endif
 
#endif // UI_H