From 8e738aacaecc9971e6a956d49ad6f57222989f03 Mon Sep 17 00:00:00 2001 From: Muskan Kumari Date: Sun, 1 Nov 2026 09:58:02 +0530 Subject: [PATCH] feat(views): enable passphrase addition and editing from seed options menu (fixes #1031) --- src/seedsigner/views/seed_views.py | 50 ++++++++++++++----- tests/test_flows_seed.py | 80 ++++++++++++++++++++++++++++++ 2 files changed, 117 insertions(+), 13 deletions(-) diff --git a/src/seedsigner/views/seed_views.py b/src/seedsigner/views/seed_views.py index 93738afb13..6dcc875ce4 100644 --- a/src/seedsigner/views/seed_views.py +++ b/src/seedsigner/views/seed_views.py @@ -349,10 +349,14 @@ class SeedAddPassphraseView(View): """ initial_keyboard: used by the screenshot generator to render each different keyboard layout. """ - def __init__(self, initial_keyboard: str = seed_screens.SeedAddPassphraseScreen.KEYBOARD__LOWERCASE_BUTTON_TEXT): + def __init__(self, seed: Seed = None, original_passphrase: str = None, initial_keyboard: str = seed_screens.SeedAddPassphraseScreen.KEYBOARD__LOWERCASE_BUTTON_TEXT): super().__init__() self.initial_keyboard = initial_keyboard - self.seed = self.controller.storage.get_pending_seed() + self.seed = seed if seed is not None else self.controller.storage.get_pending_seed() + if original_passphrase is not None: + self.original_passphrase = original_passphrase + else: + self.original_passphrase = self.seed.passphrase def run(self): @@ -368,10 +372,10 @@ def run(self): self.seed.set_passphrase(ret_dict["passphrase"]) if "is_back_button" in ret_dict or len(self.seed.passphrase) == 0: - return Destination(SeedAddPassphraseExitDialogView) + return Destination(SeedAddPassphraseExitDialogView, view_args={"seed": self.seed, "original_passphrase": self.original_passphrase}) else: - return Destination(SeedReviewPassphraseView) + return Destination(SeedReviewPassphraseView, view_args={"seed": self.seed, "original_passphrase": self.original_passphrase}) @@ -380,9 +384,10 @@ class SeedAddPassphraseExitDialogView(View): DISCARD = ButtonOption("Discard passphrase", button_label_color="red") SKIP = ButtonOption("Skip passphrase") # NOT red since we're not throwing anything away - def __init__(self): + def __init__(self, seed: Seed = None, original_passphrase: str = None): super().__init__() - self.seed = self.controller.storage.get_pending_seed() + self.seed = seed if seed is not None else self.controller.storage.get_pending_seed() + self.original_passphrase = original_passphrase def run(self): @@ -405,11 +410,18 @@ def run(self): ) if button_data[selected_menu_num] == self.EDIT: - return Destination(SeedAddPassphraseView) + return Destination(SeedAddPassphraseView, view_args={"seed": self.seed, "original_passphrase": self.original_passphrase}) elif button_data[selected_menu_num] in [self.DISCARD, self.SKIP]: - self.seed.set_passphrase("") - return Destination(SeedFinalizeView) + if self.controller.storage.get_pending_seed() is not None: + self.seed.set_passphrase("") + return Destination(SeedFinalizeView) + else: + if button_data[selected_menu_num] == self.DISCARD and self.original_passphrase is not None: + self.seed.set_passphrase(self.original_passphrase) + else: + self.seed.set_passphrase("") + return Destination(SeedOptionsView, view_args={"seed": self.seed}) @@ -420,9 +432,10 @@ class SeedReviewPassphraseView(View): EDIT = ButtonOption("Edit passphrase") DONE = ButtonOption("Done") - def __init__(self): + def __init__(self, seed: Seed = None, original_passphrase: str = None): super().__init__() - self.seed = self.controller.storage.get_pending_seed() + self.seed = seed if seed is not None else self.controller.storage.get_pending_seed() + self.original_passphrase = original_passphrase def run(self): @@ -448,10 +461,13 @@ def run(self): ) if button_data[selected_menu_num] == self.EDIT: - return Destination(SeedAddPassphraseView) + return Destination(SeedAddPassphraseView, view_args={"seed": self.seed, "original_passphrase": self.original_passphrase}) elif button_data[selected_menu_num] == self.DONE: - seed = self.controller.storage.finalize_pending_seed() + if self.controller.storage.get_pending_seed() is not None: + seed = self.controller.storage.finalize_pending_seed() + else: + seed = self.seed return Destination(SeedOptionsView, view_args={"seed": seed}, clear_history=True) @@ -531,6 +547,7 @@ class SeedOptionsView(View): EXPLORER = ButtonOption("Address explorer") SIGN_MESSAGE = ButtonOption("Sign message") BACKUP = ButtonOption("Backup seed", right_icon_name=SeedSignerIconConstants.CHEVRON_RIGHT) + PASSPHRASE = ButtonOption("Passphrase") BIP85_CHILD_SEED = ButtonOption("BIP-85 child seed") DISCARD = ButtonOption("Discard seed", button_label_color="red") @@ -580,6 +597,10 @@ def run(self): if self.settings.get_value(SettingsConstants.SETTING__MESSAGE_SIGNING) == SettingsConstants.OPTION__ENABLED: button_data.append(self.SIGN_MESSAGE) + + if self.settings.get_value(SettingsConstants.SETTING__PASSPHRASE) != SettingsConstants.OPTION__DISABLED: + self.PASSPHRASE.button_label = self.seed.passphrase_label + button_data.append(self.PASSPHRASE) if self.settings.get_value(SettingsConstants.SETTING__BIP85_CHILD_SEEDS) == SettingsConstants.OPTION__ENABLED and self.seed.bip85_supported: button_data.append(self.BIP85_CHILD_SEED) @@ -617,6 +638,9 @@ def run(self): elif button_data[selected_menu_num] == self.BACKUP: return Destination(SeedBackupView, view_args=dict(seed=self.seed)) + elif button_data[selected_menu_num] == self.PASSPHRASE: + return Destination(SeedAddPassphraseView, view_args={"seed": self.seed}) + elif button_data[selected_menu_num] == self.BIP85_CHILD_SEED: return Destination(SeedBIP85SelectNumWordsView, view_args={"seed": self.seed}) diff --git a/tests/test_flows_seed.py b/tests/test_flows_seed.py index 5e979fa4d5..f97d44a62d 100644 --- a/tests/test_flows_seed.py +++ b/tests/test_flows_seed.py @@ -824,4 +824,84 @@ def expect_unsupported_derivation(load_message: Callable): self.settings.set_value(SettingsConstants.SETTING__NETWORK, SettingsConstants.MAINNET) expect_unsupported_derivation(self.load_custom_derivation_into_decoder) + def test_seed_options_add_and_edit_passphrase_flow(self): + """ + Users should be able to add, edit, or remove a passphrase directly + from the SeedOptionsView on an active loaded seed without discarding it. + """ + seed = Seed(mnemonic="blush twice taste dawn feed second opinion lazy thumb play neglect impact".split()) + self.controller.storage.set_pending_seed(seed) + self.controller.storage.finalize_pending_seed() + + initial_fingerprint = seed.get_fingerprint(network=SettingsConstants.MAINNET) + assert not seed.has_passphrase + + # Ensure passphrase setting is enabled + self.settings.set_value(SettingsConstants.SETTING__PASSPHRASE, SettingsConstants.OPTION__ENABLED) + + # 1. Add a passphrase from SeedOptionsView + self.run_sequence( + initial_destination_view_args=dict(seed=seed), + sequence=[ + FlowStep(seed_views.SeedOptionsView, button_data_selection=seed_views.SeedOptionsView.PASSPHRASE), + FlowStep(seed_views.SeedAddPassphraseView, screen_return_value=dict(passphrase="mysecretpassphrase")), + FlowStep(seed_views.SeedReviewPassphraseView, button_data_selection=seed_views.SeedReviewPassphraseView.DONE), + FlowStep(seed_views.SeedOptionsView), + ] + ) + + assert seed.passphrase == "mysecretpassphrase" + assert seed.has_passphrase is True + passphrase_fingerprint = seed.get_fingerprint(network=SettingsConstants.MAINNET) + assert passphrase_fingerprint != initial_fingerprint + + # 2. Start editing passphrase but hit Back and DISCARD; should revert to original passphrase + self.run_sequence( + initial_destination_view_args=dict(seed=seed), + sequence=[ + FlowStep(seed_views.SeedOptionsView, button_data_selection=seed_views.SeedOptionsView.PASSPHRASE), + FlowStep(seed_views.SeedAddPassphraseView, screen_return_value=dict(passphrase="abortedit", is_back_button=True)), + FlowStep(seed_views.SeedAddPassphraseExitDialogView, button_data_selection=seed_views.SeedAddPassphraseExitDialogView.DISCARD), + FlowStep(seed_views.SeedOptionsView), + ] + ) + + assert seed.passphrase == "mysecretpassphrase" + assert seed.get_fingerprint(network=SettingsConstants.MAINNET) == passphrase_fingerprint + + # 3. Remove passphrase by submitting empty and choosing SKIP + self.run_sequence( + initial_destination_view_args=dict(seed=seed), + sequence=[ + FlowStep(seed_views.SeedOptionsView, button_data_selection=seed_views.SeedOptionsView.PASSPHRASE), + FlowStep(seed_views.SeedAddPassphraseView, screen_return_value=dict(passphrase="")), + FlowStep(seed_views.SeedAddPassphraseExitDialogView, button_data_selection=seed_views.SeedAddPassphraseExitDialogView.SKIP), + FlowStep(seed_views.SeedOptionsView), + ] + ) + + assert seed.passphrase == "" + assert seed.has_passphrase is False + assert seed.get_fingerprint(network=SettingsConstants.MAINNET) == initial_fingerprint + + + def test_seed_options_passphrase_button_hidden_when_disabled(self): + """ + When the passphrase feature is set to Disabled in Settings, + the Passphrase button should not be present in SeedOptionsView. + """ + seed = Seed(mnemonic="blush twice taste dawn feed second opinion lazy thumb play neglect impact".split()) + self.controller.storage.set_pending_seed(seed) + self.controller.storage.finalize_pending_seed() + + self.settings.set_value(SettingsConstants.SETTING__PASSPHRASE, SettingsConstants.OPTION__DISABLED) + + with pytest.raises(FlowTestInvalidButtonDataSelectionException): + self.run_sequence( + initial_destination_view_args=dict(seed=seed), + sequence=[ + FlowStep(seed_views.SeedOptionsView, button_data_selection=seed_views.SeedOptionsView.PASSPHRASE), + ] + ) +