feat: refactor to make adding coins easier

application.fam

@@ -17,6 +17,6 @@ App(
     fap_category="Tools",
     fap_author="Struan Clark (xtruan)",
     fap_weburl="https://github.com/xtruan/FlipBIP",
-    fap_version=(1, 17),
+    fap_version=(1, 18),
     fap_description="Crypto wallet for Flipper",
 )

flipbip.c

@@ -131,7 +131,7 @@ FlipBip* flipbip_app_alloc() {
     app->passphrase = FlipBipPassphraseOff;
 
     // Main menu
-    app->bip44_coin = FlipBipCoinBTC0; // 0 (BTC)
+    app->coin_type = FlipBipCoinBTC0; // 0 (BTC)
     app->overwrite_saved_seed = 0;
     app->import_from_mnemonic = 0;
     app->mnemonic_menu_text = MNEMONIC_MENU_DEFAULT;

flipbip.h

@@ -15,13 +15,9 @@
 #include "scenes/flipbip_scene.h"
 #include "views/flipbip_scene_1.h"
 
-#define FLIPBIP_VERSION "v1.17"
-
-#define COIN_BTC  0
-#define COIN_DOGE 3
-#define COIN_ETH  60
-#define COIN_ZEC  133
+#include "flipbip_coins.h"
 
+#define FLIPBIP_VERSION "v1.18"
 #define TEXT_BUFFER_SIZE 256
 
 typedef struct {
@@ -39,7 +35,7 @@ typedef struct {
     int bip39_strength;
     int passphrase;
     // Main menu options
-    int bip44_coin;
+    int coin_type;
     int overwrite_saved_seed;
     int import_from_mnemonic;
     // Text input
@@ -71,13 +67,6 @@ typedef enum {
     FlipBipPassphraseOn,
 } FlipBipPassphraseState;
 
-typedef enum {
-    FlipBipCoinBTC0,
-    FlipBipCoinETH60,
-    FlipBipCoinDOGE3,
-    FlipBipCoinZEC133,
-} FlipBipCoin;
-
 typedef enum {
     FlipBipTextInputDefault,
     FlipBipTextInputPassphrase,
@@ -93,11 +82,7 @@ typedef enum {
 } FlipBipStatus;
 
 typedef enum {
-    SubmenuIndexScene1BTC = 10,
-    SubmenuIndexScene1ETH,
-    SubmenuIndexScene1DOGE,
-    SubmenuIndexScene1ZEC,
-    SubmenuIndexScene1New,
+    SubmenuIndexScene1New = NUM_COINS + 1,
     SubmenuIndexScene1Renew,
     SubmenuIndexScene1Import,
     SubmenuIndexSettings,

flipbip_coins.c

@@ -0,0 +1,16 @@
+#include <flipbip_coins.h>
+
+// bip44_coin, xprv_version, xpub_version, addr_version, wif_version, addr_format
+const uint32_t COIN_INFO_ARRAY[NUM_COINS][COIN_INFO_SIZE] = {
+    {0, 0x0488ade4, 0x0488b21e, 0x00, 0x80, FlipBipCoinBTC0},
+    {60, 0x0488ade4, 0x0488b21e, 0x00, 0x80, FlipBipCoinETH60},
+    {3, 0x02fac398, 0x02facafd, 0x1e, 0x9e, FlipBipCoinBTC0},
+    {133, 0x0488ade4, 0x0488b21e, 0x1cb8, 0x80, FlipBipCoinZEC133},
+};
+
+// coin_name, derivation_path, coin name
+const char* COIN_TEXT_ARRAY[NUM_COINS][COIN_TEXT_SIZE] = {
+    {"BTC", "m/44'/0'/0'/0", "bitcoin:"},
+    {"ETH", "m/44'/60'/0'/0", "ethereum:"},
+    {"DOGE", "m/44'/3'/0'/0", "dogecoin:"},
+    {"ZEC", "m/44'/133'/0'/0", "zcash:"}};

flipbip_coins.h

@@ -0,0 +1,30 @@
+#pragma once
+#include <stdint.h>
+
+#define NUM_COINS 4
+
+#define COIN_INFO_SIZE       6
+#define COIN_INFO_BIP44_COIN 0
+#define COIN_INFO_XPRV_VERS  1
+#define COIN_INFO_XPUB_VERS  2
+#define COIN_INFO_ADDR_VERS  3
+#define COIN_INFO_WIF_VERS   4
+#define COIN_INFO_ADDR_FMT   5
+
+#define COIN_TEXT_SIZE  3
+#define COIN_TEXT_LABEL 0
+#define COIN_TEXT_DERIV 1
+#define COIN_TEXT_NAME  2
+
+typedef enum {
+    FlipBipCoinBTC0,
+    FlipBipCoinETH60,
+    FlipBipCoinDOGE3,
+    FlipBipCoinZEC133,
+} FlipBipCoin;
+
+// bip44_coin, xprv_version, xpub_version, addr_version, wif_version, addr_format
+extern const uint32_t COIN_INFO_ARRAY[NUM_COINS][COIN_INFO_SIZE];
+
+// coin_name, derivation_path
+extern const char* COIN_TEXT_ARRAY[NUM_COINS][COIN_TEXT_SIZE];

scenes/flipbip_scene_menu.c

@@ -22,30 +22,18 @@ void flipbip_scene_menu_on_enter(void* context) {
 
     if(flipbip_has_file(FlipBipFileKey, NULL, false) &&
        flipbip_has_file(FlipBipFileDat, NULL, false)) {
-        submenu_add_item(
-            app->submenu,
-            "View BTC wallet",
-            SubmenuIndexScene1BTC,
-            flipbip_scene_menu_submenu_callback,
-            app);
-        submenu_add_item(
-            app->submenu,
-            "View ETH wallet",
-            SubmenuIndexScene1ETH,
-            flipbip_scene_menu_submenu_callback,
-            app);
-        submenu_add_item(
-            app->submenu,
-            "View DOGE wallet",
-            SubmenuIndexScene1DOGE,
-            flipbip_scene_menu_submenu_callback,
-            app);
-        submenu_add_item(
-            app->submenu,
-            "View ZEC (t-addr) wallet",
-            SubmenuIndexScene1ZEC,
-            flipbip_scene_menu_submenu_callback,
-            app);
+
+        for(size_t coin_type = 0; coin_type < NUM_COINS; coin_type++) {
+            char wallet_menu_item[17] = "View      wallet";
+            strcpy(wallet_menu_item + 5, COIN_TEXT_ARRAY[coin_type][COIN_TEXT_LABEL]);
+            submenu_add_item(
+                app->submenu,
+                wallet_menu_item,
+                coin_type,
+                flipbip_scene_menu_submenu_callback,
+                app);
+        }
+        
         submenu_add_item(
             app->submenu,
             "Regenerate wallet",
@@ -85,36 +73,12 @@ bool flipbip_scene_menu_on_event(void* context, SceneManagerEvent event) {
         view_dispatcher_stop(app->view_dispatcher);
         return true;
     } else if(event.type == SceneManagerEventTypeCustom) {
-        if(event.event == SubmenuIndexScene1BTC) {
-            app->overwrite_saved_seed = 0;
-            app->import_from_mnemonic = 0;
-            app->bip44_coin = FlipBipCoinBTC0;
-            scene_manager_set_scene_state(
-                app->scene_manager, FlipBipSceneMenu, SubmenuIndexScene1BTC);
-            scene_manager_next_scene(app->scene_manager, FlipBipSceneScene_1);
-            return true;
-        } else if(event.event == SubmenuIndexScene1ETH) {
-            app->overwrite_saved_seed = 0;
-            app->import_from_mnemonic = 0;
-            app->bip44_coin = FlipBipCoinETH60;
-            scene_manager_set_scene_state(
-                app->scene_manager, FlipBipSceneMenu, SubmenuIndexScene1ETH);
-            scene_manager_next_scene(app->scene_manager, FlipBipSceneScene_1);
-            return true;
-        } else if(event.event == SubmenuIndexScene1DOGE) {
-            app->overwrite_saved_seed = 0;
-            app->import_from_mnemonic = 0;
-            app->bip44_coin = FlipBipCoinDOGE3;
-            scene_manager_set_scene_state(
-                app->scene_manager, FlipBipSceneMenu, SubmenuIndexScene1DOGE);
-            scene_manager_next_scene(app->scene_manager, FlipBipSceneScene_1);
-            return true;
-        } else if(event.event == SubmenuIndexScene1ZEC) {
+        if(event.event < SubmenuIndexScene1New) {
             app->overwrite_saved_seed = 0;
             app->import_from_mnemonic = 0;
-            app->bip44_coin = FlipBipCoinZEC133;
+            app->coin_type = event.event; // FlipBipCoin
             scene_manager_set_scene_state(
-                app->scene_manager, FlipBipSceneMenu, SubmenuIndexScene1ZEC);
+                app->scene_manager, FlipBipSceneMenu, event.event); // FlipBipCoin
             scene_manager_next_scene(app->scene_manager, FlipBipSceneScene_1);
             return true;
         } else if(event.event == SubmenuIndexScene1New) {

views/flipbip_scene_1.c

@@ -51,21 +51,6 @@ const char* TEXT_INFO = "-Scroll pages with up/down-"
 // #define TEXT_SAVE_QR "Save QR"
 #define TEXT_QRFILE_EXT ".qrcode" // 7 chars + 1 null
 
-// bip44_coin, xprv_version, xpub_version, addr_version, wif_version, addr_format
-const uint32_t COIN_INFO_ARRAY[4][6] = {
-    {COIN_BTC, 0x0488ade4, 0x0488b21e, 0x00, 0x80, FlipBipCoinBTC0},
-    {COIN_ETH, 0x0488ade4, 0x0488b21e, 0x00, 0x80, FlipBipCoinETH60},
-    {COIN_DOGE, 0x02fac398, 0x02facafd, 0x1e, 0x9e, FlipBipCoinBTC0},
-    {COIN_ZEC, 0x0488ade4, 0x0488b21e, 0x1cb8, 0x80, FlipBipCoinZEC133},
-};
-
-// coin_name, derivation_path
-const char* COIN_TEXT_ARRAY[4][3] = {
-    {"BTC", "m/44'/0'/0'/0", "bitcoin:"},
-    {"ETH", "m/44'/60'/0'/0", "ethereum:"},
-    {"DOGE", "m/44'/3'/0'/0", "dogecoin:"},
-    {"ZEC", "m/44'/133'/0'/0", "zcash:"}};
-
 struct FlipBipScene1 {
     View* view;
     FlipBipScene1Callback callback;
@@ -74,7 +59,7 @@ struct FlipBipScene1 {
 typedef struct {
     int page;
     int strength;
-    uint32_t coin;
+    uint32_t coin_type;
     bool overwrite;
     bool mnemonic_only;
     CONFIDENTIAL const char* mnemonic;
@@ -135,21 +120,14 @@ static void flipbip_scene_1_init_address(
     hdnode_private_ckd(s_addr_node, addr_index);
     hdnode_fill_public_key(s_addr_node);
 
-    // coin info
-    // bip44_coin, xprv_version, xpub_version, addr_version, wif_version, addr_format
-    uint32_t coin_info[6] = {0};
-    for(size_t i = 0; i < 6; i++) {
-        coin_info[i] = COIN_INFO_ARRAY[coin_type][i];
-    }
-
-    if(coin_info[5] == FlipBipCoinBTC0) { // BTC / DOGE style address
+    if(COIN_INFO_ARRAY[coin_type][COIN_INFO_ADDR_FMT] == FlipBipCoinBTC0) { // BTC / DOGE style address
         // BTC / DOGE style address
         ecdsa_get_address(
-            s_addr_node->public_key, coin_info[3], HASHER_SHA2_RIPEMD, HASHER_SHA2D, buf, buflen);
+            s_addr_node->public_key, COIN_INFO_ARRAY[coin_type][COIN_INFO_ADDR_VERS], HASHER_SHA2_RIPEMD, HASHER_SHA2D, buf, buflen);
         strcpy(addr_text, buf);
         //ecdsa_get_wif(addr_node->private_key, WIF_VERSION, HASHER_SHA2D, buf, buflen);
 
-    } else if(coin_info[5] == FlipBipCoinETH60) { // ETH
+    } else if(COIN_INFO_ARRAY[coin_type][COIN_INFO_ADDR_FMT] == FlipBipCoinETH60) { // ETH
         // ETH style address
         hdnode_get_ethereum_pubkeyhash(s_addr_node, (uint8_t*)buf);
         addr_text[0] = '0';
@@ -157,9 +135,9 @@ static void flipbip_scene_1_init_address(
         // Convert the hash to a hex string
         flipbip_btox((uint8_t*)buf, 20, addr_text + 2);
 
-    } else if(coin_info[5] == FlipBipCoinZEC133) { // ZEC
+    } else if(COIN_INFO_ARRAY[coin_type][COIN_INFO_ADDR_FMT] == FlipBipCoinZEC133) { // ZEC
         ecdsa_get_address(
-            s_addr_node->public_key, coin_info[3], HASHER_SHA2_RIPEMD, HASHER_SHA2D, buf, buflen);
+            s_addr_node->public_key, COIN_INFO_ARRAY[coin_type][COIN_INFO_ADDR_VERS], HASHER_SHA2_RIPEMD, HASHER_SHA2D, buf, buflen);
         addr_text[0] = 't';
         strcpy(addr_text, buf);
     }
@@ -305,7 +283,7 @@ void flipbip_scene_1_draw(Canvas* canvas, FlipBipScene1Model* model) {
         flipbip_scene_1_draw_generic(model->xpub_extended, 20, false);
     } else if(model->page >= PAGE_ADDR_BEGIN && model->page <= PAGE_ADDR_END) {
         size_t line_len = 12;
-        if(model->coin == FlipBipCoinETH60) {
+        if(model->coin_type == FlipBipCoinETH60) {
             line_len = 14;
         }
         flipbip_scene_1_draw_generic(
@@ -327,7 +305,7 @@ void flipbip_scene_1_draw(Canvas* canvas, FlipBipScene1Model* model) {
         // draw address header
         canvas_set_font(canvas, FontSecondary);
         // coin_name, derivation_path
-        const char* receive_text = COIN_TEXT_ARRAY[model->coin][0];
+        const char* receive_text = COIN_TEXT_ARRAY[model->coin_type][COIN_TEXT_LABEL];
         if(receive_text == NULL) {
             receive_text = TEXT_DEFAULT_COIN;
         }
@@ -345,7 +323,7 @@ void flipbip_scene_1_draw(Canvas* canvas, FlipBipScene1Model* model) {
 
         // draw QR code file path
         char addr_name_text[14] = {0};
-        strcpy(addr_name_text, COIN_TEXT_ARRAY[model->coin][0]);
+        strcpy(addr_name_text, COIN_TEXT_ARRAY[model->coin_type][COIN_TEXT_LABEL]);
         flipbip_btox(addr_num, 1, addr_name_text + strlen(addr_name_text));
         strcpy(addr_name_text + strlen(addr_name_text), TEXT_QRFILE_EXT);
         //elements_button_right(canvas, addr_name_text);
@@ -371,13 +349,13 @@ void flipbip_scene_1_draw(Canvas* canvas, FlipBipScene1Model* model) {
 static int flipbip_scene_1_model_init(
     FlipBipScene1Model* const model,
     const int strength,
-    const uint32_t coin,
+    const uint32_t coin_type,
     const bool overwrite,
     const char* passphrase_text) {
     model->page = PAGE_LOADING;
     model->mnemonic_only = false;
     model->strength = strength;
-    model->coin = coin;
+    model->coin_type = coin_type;
     model->overwrite = overwrite;
 
     // Allocate memory for mnemonic
@@ -435,16 +413,9 @@ static int flipbip_scene_1_model_init(
     const size_t buflen = 128;
     char buf[128 + 1] = {0};
 
-    // coin info
-    // bip44_coin, xprv_version, xpub_version, addr_version, wif_version, addr_format
-    uint32_t coin_info[6] = {0};
-    for(size_t i = 0; i < 6; i++) {
-        coin_info[i] = COIN_INFO_ARRAY[coin][i];
-    }
-
     // root
     uint32_t fingerprint = 0;
-    hdnode_serialize_private(root, fingerprint, coin_info[1], buf, buflen);
+    hdnode_serialize_private(root, fingerprint, COIN_INFO_ARRAY[coin_type][COIN_INFO_XPRV_VERS], buf, buflen);
     char* xprv_root = malloc(buflen + 1);
     strncpy(xprv_root, buf, buflen);
     model->xprv_root = xprv_root;
@@ -457,18 +428,18 @@ static int flipbip_scene_1_model_init(
 
     // coin m/44'/0' or m/44'/60'
     fingerprint = hdnode_fingerprint(node);
-    hdnode_private_ckd_prime(node, coin_info[0]); // coin
+    hdnode_private_ckd_prime(node, COIN_INFO_ARRAY[coin_type][COIN_INFO_BIP44_COIN]); // coin
 
     // account m/44'/0'/0' or m/44'/60'/0'
     fingerprint = hdnode_fingerprint(node);
     hdnode_private_ckd_prime(node, DERIV_ACCOUNT); // account
 
-    hdnode_serialize_private(node, fingerprint, coin_info[1], buf, buflen);
+    hdnode_serialize_private(node, fingerprint, COIN_INFO_ARRAY[coin_type][COIN_INFO_XPRV_VERS], buf, buflen);
     char* xprv_acc = malloc(buflen + 1);
     strncpy(xprv_acc, buf, buflen);
     model->xprv_account = xprv_acc;
 
-    hdnode_serialize_public(node, fingerprint, coin_info[2], buf, buflen);
+    hdnode_serialize_public(node, fingerprint, COIN_INFO_ARRAY[coin_type][COIN_INFO_XPUB_VERS], buf, buflen);
     char* xpub_acc = malloc(buflen + 1);
     strncpy(xpub_acc, buf, buflen);
     model->xpub_account = xpub_acc;
@@ -477,12 +448,12 @@ static int flipbip_scene_1_model_init(
     fingerprint = hdnode_fingerprint(node);
     hdnode_private_ckd(node, DERIV_CHANGE); // external/internal (change)
 
-    hdnode_serialize_private(node, fingerprint, coin_info[1], buf, buflen);
+    hdnode_serialize_private(node, fingerprint, COIN_INFO_ARRAY[coin_type][COIN_INFO_XPRV_VERS], buf, buflen);
     char* xprv_ext = malloc(buflen + 1);
     strncpy(xprv_ext, buf, buflen);
     model->xprv_extended = xprv_ext;
 
-    hdnode_serialize_public(node, fingerprint, coin_info[2], buf, buflen);
+    hdnode_serialize_public(node, fingerprint, COIN_INFO_ARRAY[coin_type][COIN_INFO_XPUB_VERS], buf, buflen);
     char* xpub_ext = malloc(buflen + 1);
     strncpy(xpub_ext, buf, buflen);
     model->xpub_extended = xpub_ext;
@@ -493,15 +464,15 @@ static int flipbip_scene_1_model_init(
     for(uint8_t a = 0; a < NUM_ADDRS; a++) {
         model->recv_addresses[a] = malloc(MAX_ADDR_BUF);
         memzero(model->recv_addresses[a], MAX_ADDR_BUF);
-        flipbip_scene_1_init_address(model->recv_addresses[a], node, coin, a);
+        flipbip_scene_1_init_address(model->recv_addresses[a], node, coin_type, a);
 
         // Save QR code file
         memzero(buf, buflen);
-        strcpy(buf, COIN_TEXT_ARRAY[coin][0]);
+        strcpy(buf, COIN_TEXT_ARRAY[coin_type][COIN_TEXT_LABEL]);
         const unsigned char addr_num[1] = {a};
         flipbip_btox(addr_num, 1, buf + strlen(buf));
         strcpy(buf + strlen(buf), TEXT_QRFILE_EXT);
-        flipbip_save_qrfile(COIN_TEXT_ARRAY[coin][2], model->recv_addresses[a], buf);
+        flipbip_save_qrfile(COIN_TEXT_ARRAY[coin_type][COIN_TEXT_NAME], model->recv_addresses[a], buf);
         memzero(buf, buflen);
     }
 
@@ -597,7 +568,7 @@ void flipbip_scene_1_exit(void* context) {
         {
             model->page = PAGE_LOADING;
             model->strength = FlipBipStrength256;
-            model->coin = FlipBipCoinBTC0;
+            model->coin_type = FlipBipCoinBTC0;
             memzero(model->seed, 64);
             // if mnemonic_only is true, then we don't need to free the data here
             if(!model->mnemonic_only) {
@@ -650,9 +621,9 @@ void flipbip_scene_1_enter(void* context) {
     }
 
     // BIP44 Coin setting
-    const uint32_t coin = app->bip44_coin;
+    const uint32_t coin_type = app->coin_type;
     // coin_name, derivation_path
-    s_derivation_text = COIN_TEXT_ARRAY[coin][1];
+    s_derivation_text = COIN_TEXT_ARRAY[coin_type][COIN_TEXT_DERIV];
 
     // Overwrite the saved seed with a new one setting
     bool overwrite = app->overwrite_saved_seed != 0;
@@ -674,7 +645,7 @@ void flipbip_scene_1_enter(void* context) {
             // s_busy = true;
 
             const int status =
-                flipbip_scene_1_model_init(model, strength, coin, overwrite, passphrase_text);
+                flipbip_scene_1_model_init(model, strength, coin_type, overwrite, passphrase_text);
 
             // nonzero status, free the mnemonic
             if(status != FlipBipStatusSuccess) {