Merge pull request #4 from newtonick/nick_test_flows

add psbt scan to sign flow happy path
2026-10-06 15:38:25 +00:00 · 2023-07-07 08:18:37 -05:00
parent 9b3959050c 69ab92dbf7
commit bf920be843
2 changed files with 136 additions and 61 deletions
@@ -11,9 +11,8 @@ from seedsigner.models.encode_qr import EncodeQR
 from seedsigner.models.psbt_parser import PSBTParser
 from seedsigner.models.qr_type import QRType
 from seedsigner.models.settings import SettingsConstants
-from seedsigner.gui.screens import psbt_screens
-from seedsigner.gui.screens.screen import (RET_CODE__BACK_BUTTON, ButtonListScreen, DireWarningScreen,
-    LoadingScreenThread, QRDisplayScreen, WarningScreen)
+from seedsigner.gui.screens.psbt_screens import PSBTOverviewScreen, PSBTMathScreen, PSBTAddressDetailsScreen, PSBTChangeDetailsScreen, PSBTFinalizeScreen
+from seedsigner.gui.screens.screen import (RET_CODE__BACK_BUTTON, ButtonListScreen, DireWarningScreen, QRDisplayScreen, WarningScreen)

 from .view import BackStackView, MainMenuView, NotYetImplementedView, View, Destination

@@ -22,6 +21,11 @@ logger = logging.getLogger(__name__)


 class PSBTSelectSeedView(View):
+    SCAN_SEED = ("Scan a seed", FontAwesomeIconConstants.QRCODE)
+    TYPE_12WORD = ("Enter 12-word seed", FontAwesomeIconConstants.KEYBOARD)
+    TYPE_24WORD = ("Enter 24-word seed", FontAwesomeIconConstants.KEYBOARD)
+    button_data = []
+    
    def run(self):
        # Note: we can't just autoroute to the PSBT Overview because we might have a
        # multisig where we want to sign with more than one key on this device.
@@ -31,32 +35,29 @@ class PSBTSelectSeedView(View):
        
        seeds = self.controller.storage.seeds

-        SCAN_SEED = ("Scan a seed", FontAwesomeIconConstants.QRCODE)
-        TYPE_12WORD = ("Enter 12-word seed", FontAwesomeIconConstants.KEYBOARD)
-        TYPE_24WORD = ("Enter 24-word seed", FontAwesomeIconConstants.KEYBOARD)
-        button_data = []
        for seed in seeds:
            button_str = seed.get_fingerprint(self.settings.get_value(SettingsConstants.SETTING__NETWORK))
            if not PSBTParser.has_matching_input_fingerprint(psbt=self.controller.psbt, seed=seed, network=self.settings.get_value(SettingsConstants.SETTING__NETWORK)):
                # Doesn't look like this seed can sign the current PSBT
                button_str += " (?)"

-            button_data.append((button_str, SeedSignerCustomIconConstants.FINGERPRINT, "blue"))
+            self.button_data.append((button_str, SeedSignerCustomIconConstants.FINGERPRINT, "blue"))

-        button_data.append(SCAN_SEED)
-        button_data.append(TYPE_12WORD)
-        button_data.append(TYPE_24WORD)
+        self.button_data.append(self.SCAN_SEED)
+        self.button_data.append(self.TYPE_12WORD)
+        self.button_data.append(self.TYPE_24WORD)

        if self.controller.psbt_seed:
             if PSBTParser.has_matching_input_fingerprint(psbt=self.controller.psbt, seed=self.controller.psbt_seed, network=self.settings.get_value(SettingsConstants.SETTING__NETWORK)):
                 # skip the seed prompt if a seed was previous selected and has matching input fingerprint
                 return Destination(PSBTOverviewView)

-        selected_menu_num = ButtonListScreen(
+        selected_menu_num = self.run_screen(
+            ButtonListScreen,
            title="Select Signer",
            is_button_text_centered=False,
-            button_data=button_data
-        ).display()
+            button_data=self.button_data
+        )

        if selected_menu_num == RET_CODE__BACK_BUTTON:
            return Destination(BackStackView)
@@ -69,13 +70,13 @@ class PSBTSelectSeedView(View):
        # The remaining flows are a sub-flow; resume PSBT flow once the seed is loaded.
        self.controller.resume_main_flow = Controller.FLOW__PSBT

-        if button_data[selected_menu_num] == SCAN_SEED:
+        if self.button_data[selected_menu_num] == self.SCAN_SEED:
            from seedsigner.views.scan_views import ScanView
            return Destination(ScanView)

-        elif button_data[selected_menu_num] in [TYPE_12WORD, TYPE_24WORD]:
+        elif button_data[selected_menu_num] in [self.TYPE_12WORD, self.TYPE_24WORD]:
            from seedsigner.views.seed_views import SeedMnemonicEntryView
-            if button_data[selected_menu_num] == TYPE_12WORD:
+            if button_data[selected_menu_num] == self.TYPE_12WORD:
                self.controller.storage.init_pending_mnemonic(num_words=12)
            else:
                self.controller.storage.init_pending_mnemonic(num_words=24)
@@ -92,8 +93,10 @@ class PSBTOverviewView(View):
        if not self.controller.psbt_parser or self.controller.psbt_parser.seed != self.controller.psbt_seed:
            # The PSBTParser takes a while to read the PSBT. Run the loading screen while
            # we wait.
+            from seedsigner.gui.screens.screen import LoadingScreenThread
            self.loading_screen = LoadingScreenThread(text="Parsing PSBT...")
            self.loading_screen.start()
+                
            try:
                self.controller.psbt_parser = PSBTParser(
                    self.controller.psbt,
@@ -128,22 +131,27 @@ class PSBTOverviewView(View):
            else:
                num_self_transfer_outputs += 1

-        screen = psbt_screens.PSBTOverviewScreen(
-            spend_amount=psbt_parser.spend_amount,
-            change_amount=psbt_parser.change_amount,
-            fee_amount=psbt_parser.fee_amount,
-            num_inputs=psbt_parser.num_inputs,
-            num_self_transfer_outputs=num_self_transfer_outputs,
-            num_change_outputs=num_change_outputs,
-            destination_addresses=psbt_parser.destination_addresses,
-        )
+        spend_amount = psbt_parser.spend_amount
+        change_amount = psbt_parser.change_amount
+        fee_amount = psbt_parser.fee_amount
+        num_inputs = psbt_parser.num_inputs
+        destination_addresses = psbt_parser.destination_addresses

        # Everything is set. Stop the loading screen
        if self.loading_screen:
            self.loading_screen.stop()

        # Run the overview screen
-        selected_menu_num = screen.display()
+        selected_menu_num = self.run_screen(
+            PSBTOverviewScreen,
+            spend_amount=spend_amount,
+            change_amount=change_amount,
+            fee_amount=fee_amount,
+            num_inputs=num_inputs,
+            num_self_transfer_outputs=num_self_transfer_outputs,
+            num_change_outputs=num_change_outputs,
+            destination_addresses=destination_addresses
+        )

        if selected_menu_num == RET_CODE__BACK_BUTTON:
            self.controller.psbt_seed = None
@@ -214,14 +222,15 @@ class PSBTMathView(View):
            # Should not be able to get here
            return Destination(MainMenuView)
        
-        selected_menu_num = psbt_screens.PSBTMathScreen(
+        selected_menu_num = self.run_screen(
+            PSBTMathScreen,
            input_amount=psbt_parser.input_amount,
            num_inputs=psbt_parser.num_inputs,
            spend_amount=psbt_parser.spend_amount,
            num_recipients=psbt_parser.num_destinations,
            fee_amount=psbt_parser.fee_amount,
            change_amount=psbt_parser.change_amount,
-        ).display()
+        )

        if selected_menu_num == RET_CODE__BACK_BUTTON:
            return Destination(BackStackView)
@@ -238,7 +247,10 @@ class PSBTAddressDetailsView(View):
    """
        Shows the recipient's address and amount they will receive
    """
-    def __init__(self, address_num, is_change=False):
+    NEXT = "Next"
+    button_data = []
+    
+    def __init__(self, address_num):
        super().__init__()
        self.address_num = address_num

@@ -254,23 +266,27 @@ class PSBTAddressDetailsView(View):
        if psbt_parser.num_destinations > 1:
            title += f" (#{self.address_num + 1})"

-        button_data = []
        if self.address_num < psbt_parser.num_destinations - 1:
-            button_data.append("Next Recipient")
+            self.NEXT = "Next Recipient"
        else:
-            button_data.append("Next")
+            self.NEXT = "Next"
+        self.button_data.append(self.NEXT)

-        selected_menu_num = psbt_screens.PSBTAddressDetailsScreen(
+        selected_menu_num = self.run_screen(
+            PSBTAddressDetailsScreen,
            title=title,
-            button_data=button_data,
+            button_data=self.button_data,
            address=psbt_parser.destination_addresses[self.address_num],
            amount=psbt_parser.destination_amounts[self.address_num],
-        ).display()
+        )
+        
+        if selected_menu_num == RET_CODE__BACK_BUTTON:
+            return Destination(BackStackView)

-        if selected_menu_num == 0:
+        if self.button_data[selected_menu_num] == self.NEXT:
            if self.address_num < len(psbt_parser.destination_addresses) - 1:
                # Show the next receive addr
-                return Destination(PSBTAddressDetailsView, view_args={"address_num": self.address_num + 1, "is_change": False})
+                return Destination(PSBTAddressDetailsView, view_args={"address_num": self.address_num + 1})

            elif psbt_parser.change_amount > 0:
                # Move on to display change
@@ -280,14 +296,13 @@ class PSBTAddressDetailsView(View):
                # There's no change output to verify. Move on to sign the PSBT.
                return Destination(PSBTFinalizeView)

-        if selected_menu_num == RET_CODE__BACK_BUTTON:
-            return Destination(BackStackView)
-


 class PSBTChangeDetailsView(View):
-    """
-    """
+    NEXT = "Next"
+    VERIFY_MULTISIG = "Verify Multisig Change"
+    button_data = [NEXT]
+    
    def __init__(self, change_address_num):
        super().__init__()
        self.change_address_num = change_address_num
@@ -327,14 +342,12 @@ class PSBTChangeDetailsView(View):
        is_change_derivation_path = int(derivation_path.split("/")[-2]) == 1
        derivation_path_addr_index = int(derivation_path.split("/")[-1])

-        NEXT = "Next"
-
        if is_change_derivation_path:
            title = "Your Change"
-            VERIFY_MULTISIG = "Verify Multisig Change"
+            self.VERIFY_MULTISIG = "Verify Multisig Change"
        else:
            title = "Self-Transfer"
-            VERIFY_MULTISIG = "Verify Multisig Addr"
+            self.VERIFY_MULTISIG = "Verify Multisig Addr"
        # if psbt_parser.num_change_outputs > 1:
        #     title += f" (#{self.change_address_num + 1})"

@@ -343,11 +356,11 @@ class PSBTChangeDetailsView(View):
            # if the known-good multisig descriptor is already onboard:
            if self.controller.multisig_wallet_descriptor:
                is_change_addr_verified = psbt_parser.verify_multisig_output(self.controller.multisig_wallet_descriptor, change_num=self.change_address_num)
-                button_data = [NEXT]
+                self.button_data = [self.NEXT]

            else:
                # Have the Screen offer to load in the multisig descriptor.            
-                button_data = [VERIFY_MULTISIG, NEXT]
+                self.button_data = [self.VERIFY_MULTISIG, self.NEXT]

        else:
            # Single sig
@@ -356,6 +369,7 @@ class PSBTChangeDetailsView(View):
                    loading_screen_text = "Verifying Change..."
                else:
                    loading_screen_text = "Verifying Self-Transfer..."
+                from seedsigner.gui.screens.screen import LoadingScreenThread
                loading_screen = LoadingScreenThread(text=loading_screen_text)
                loading_screen.start()

@@ -389,7 +403,7 @@ class PSBTChangeDetailsView(View):

                if change_data["address"] == calc_address:
                    is_change_addr_verified = True
-                    button_data = [NEXT]
+                    self.button_data = [self.NEXT]

            finally:
                loading_screen.stop()
@@ -397,9 +411,10 @@ class PSBTChangeDetailsView(View):
        if is_change_addr_verified == False and (not psbt_parser.is_multisig or self.controller.multisig_wallet_descriptor is not None):
            return Destination(PSBTAddressVerificationFailedView, view_args=dict(is_change=is_change_derivation_path, is_multisig=psbt_parser.is_multisig), clear_history=True)

-        selected_menu_num = psbt_screens.PSBTChangeDetailsScreen(
+        selected_menu_num = self.run_screen(
+            PSBTChangeDetailsScreen,
            title=title,
-            button_data=button_data,
+            button_data=self.button_data,
            address=change_data.get("address"),
            amount=change_data.get("amount"),
            is_multisig=psbt_parser.is_multisig,
@@ -408,19 +423,19 @@ class PSBTChangeDetailsView(View):
            is_change_derivation_path=is_change_derivation_path,
            derivation_path_addr_index=derivation_path_addr_index,
            is_change_addr_verified=is_change_addr_verified,
-        ).display()
+        )

        if selected_menu_num == RET_CODE__BACK_BUTTON:
            return Destination(BackStackView)

-        elif button_data[selected_menu_num] == NEXT:
+        elif self.button_data[selected_menu_num] == self.NEXT:
            if self.change_address_num < psbt_parser.num_change_outputs - 1:
                return Destination(PSBTChangeDetailsView, view_args={"change_address_num": self.change_address_num + 1})
            else:
                # There's no more change to verify. Move on to sign the PSBT.
                return Destination(PSBTFinalizeView)
            
-        elif button_data[selected_menu_num] == VERIFY_MULTISIG:
+        elif self.button_data[selected_menu_num] == self.VERIFY_MULTISIG:
            from seedsigner.views.seed_views import LoadMultisigWalletDescriptorView
            self.controller.resume_main_flow = Controller.FLOW__PSBT
            return Destination(LoadMultisigWalletDescriptorView)
@@ -459,6 +474,9 @@ class PSBTAddressVerificationFailedView(View):
 class PSBTFinalizeView(View):
    """
    """
+    APPROVE_PSBT = "Approve PSBT"
+    button_data = [APPROVE_PSBT]
+    
    def run(self):
        psbt_parser: PSBTParser = self.controller.psbt_parser
        psbt: PSBT = self.controller.psbt
@@ -466,12 +484,13 @@ class PSBTFinalizeView(View):
        if not psbt_parser:
            # Should not be able to get here
            return Destination(MainMenuView)
+            
+        selected_menu_num = self.run_screen(
+            PSBTFinalizeScreen,
+            button_data=self.button_data
+        )

-        selected_menu_num = psbt_screens.PSBTFinalizeScreen(
-            button_data=["Approve PSBT"]
-        ).display()
-
-        if selected_menu_num == 0:
+        if self.button_data[selected_menu_num] == self.APPROVE_PSBT:
            # Sign PSBT
            sig_cnt = PSBTParser.sig_count(psbt)
            psbt.sign_with(psbt_parser.root)
@@ -500,7 +519,7 @@ class PSBTSignedQRDisplayView(View):
            qr_density=self.settings.get_value(SettingsConstants.SETTING__QR_DENSITY),
            wordlist_language_code=self.settings.get_value(SettingsConstants.SETTING__WORDLIST_LANGUAGE),
        )
-        QRDisplayScreen(qr_encoder=qr_encoder).display()
+        self.run_screen(QRDisplayScreen, qr_encoder=qr_encoder)

        # We're done with this PSBT. Route back to MainMenuView which always
        #   clears all ephemeral data (except in-memory seeds).
@@ -0,0 +1,56 @@
+from base import FlowTest, FlowStep
+
+from seedsigner.controller import Controller, StopFlowBasedTest
+from seedsigner.views.view import MainMenuView
+from seedsigner.views import scan_views, seed_views, psbt_views
+
+class TestPSBTFlows(FlowTest):
+
+	def test_scan_psbt_first_then_correct_seedqr_flow(self):
+		"""
+			Selecting "Scan" from the MainMenuView and scanning a PSBT should enter the PSBTSelectSeedView flow
+			when Scan a Seed is selected from PSBTSelectSeedView it should enter the ScanView flow
+			when a SeedQR is scanned it should enter the PSBTOverviewView flow
+			since the PSBT has change no warning is displayed and it should enter the PSBTMathView flow
+			since the PSBT is not a self transfer it should enter the PSBTAddressDetailsView flow
+		"""
+		def load_psbt_into_decoder(view: scan_views.ScanView):
+			"""
+				PSBT Tx and Wallet Details
+				- Single Sig Wallet P2WPKH (Native Segwit) with no passphrase
+				- Regtest c751dc07 m/84'/1'/0' tpubDDZBrnxMxbVzqt8EoEiABPxeKzFWma5pra5UEbg3Wst1hrwr6feuvcy7Sov7cpuYx94ypuy1PQ9NDNoQagFs37wGALzLb5Ei3FvyJWPPPKZ
+				- 2 Inputs
+					- 56,522,834 sats
+					- 1,990,245,069 sats
+				- 4 Outputs
+					- 1 Output to another wallet (bcrt1q7cw0wzy8g6mq5qvkpvhnk5gsps5ncy3srp0n2j) of 123,456 sats
+					- 3 Outputs change
+						- 3 outputs to emulate a fake mix to increase privacy
+						- Change addresses are index 1/7, 1/8, 1/9
+						- 1/7 address bcrt1q53j0xwuskuf5gnvynadh0hlazyy8srydlucrhg with amount 123,456 sats
+						- 1/8 address bcrt1q5gtw3zfp4cx67yk5q42q6j6rfza8aqcwpyyslv with amount 1,990,121,477 sats
+						- 1/9 address bcrt1q9rrg7399m43cn0yg4tz0v0ate89jgf2d6kpz7v with amount 56,399,242 sats
+					- Fee 272 sats
+			"""
+			view.decoder.add_data("cHNidP8BANgCAAAAAsTXZs3fz/dmGb6M80+jjvJZdYya+cw5bT/dGuhZFdSlAAAAAAD9////qo6xg/UZAvUkcbse1F+C9zbP/FeZNjThx7SCIn6eMCgBAAAAAP3///8EQOIBAAAAAAAWABSkZPM7kLcTRE2En1t33/0RCHgMjQXYnnYAAAAAFgAUKMaPRKXdY4m8iKrE9j+rycskJU1A4gEAAAAAABYAFPYc9wiHRrYKAZYLLztREAwpPBIwipVcAwAAAAAWABSiFuiJIa4NrxLUBVQNS0NIun6DDtoRAABPAQQ1h88DBcQGZIAAAAA+0J+jlNL3dpWwlnBi8Dx+Ipg4e6uvB3HdjzFPX7r9CAOOlAIxgII+/xCcj+XoEenKH7wj5s5wlu7Q7CCZWFLGLhA5Su0UVAAAgAEAAIAAAACAAAEA7QIAAAAEE6njX/fnvn7hbkKIRcxzNYFOSfbCdNeWnd7Fe/1UcQ0BAAAAAP3///8TqeNf9+e+fuFuQohFzHM1gU5J9sJ015ad3sV7/VRxDQMAAAAA/f///xOp41/3575+4W5CiEXMczWBTkn2wnTXlp3exXv9VHENBAAAAAD9////E6njX/fnvn7hbkKIRcxzNYFOSfbCdNeWnd7Fe/1UcQ0GAAAAAP3///8CUnheAwAAAAAWABRCfygPJ+Fjsx4BknYvvm3A3qKn2xJ/XQcAAAAAF6kU1I4TAst5nAj15ey7vwe5cM3OFq+HlhEAAAEBH1J4XgMAAAAAFgAUQn8oDyfhY7MeAZJ2L75twN6ip9sBAwQBAAAAIgYCo7sfm78RQY3B5n0ac/QF8VtMAzFnci+h5D1MtpgRY7oYOUrtFFQAAIABAACAAAAAgAEAAAAGAAAAAAEAcQIAAAABxY7wh0nsfJQfzWrD/9rN9BYsM+iOmPaO6I0ANFgO/PcAAAAAAP3///8CptiUAAAAAAAWABRIm4HhQY/TzOjeWSPRrbuJo9MlW826oHYAAAAAFgAU0z+0L2QSLGtyQTn8FhbCpcI7jbliAQAAAQEfzbqgdgAAAAAWABTTP7QvZBIsa3JBOfwWFsKlwjuNuQEDBAEAAAAiBgITHmebEANk81CraV4xZIpqkNjjw0tIvezl1Ism1NRH3Rg5Su0UVAAAgAEAAIAAAACAAQAAAAAAAAAAIgICuTT7WnuiUTpObjWnZFHzIeEvW9PTB+1LLVFNQJVFeIIYOUrtFFQAAIABAACAAAAAgAEAAAAHAAAAACICAk8f3hpc5C35chgSg+Pe2zZ9IhHREd4aKW2+yAMRIFeqGDlK7RRUAACAAQAAgAAAAIABAAAACQAAAAAAIgIDjt1CjvrnMMnjbmTNKUAYoKEDRbmKjNjbq+6Ppqj3bqQYOUrtFFQAAIABAACAAAAAgAEAAAAIAAAAAA==")
+
+		def load_seed_into_decoder(view: scan_views.ScanView):
+			view.decoder.add_data("080115060387063104071857067618681125136207731354")
+	
+		self.run_sequence([
+			FlowStep(MainMenuView, button_data_selection=MainMenuView.SCAN),
+			FlowStep(scan_views.ScanView, before_run=load_psbt_into_decoder),  # simulate read PSBT; ret val is ignored
+			FlowStep(psbt_views.PSBTSelectSeedView, button_data_selection=psbt_views.PSBTSelectSeedView.SCAN_SEED),
+			FlowStep(scan_views.ScanView, before_run=load_seed_into_decoder),
+			FlowStep(seed_views.SeedFinalizeView, button_data_selection=seed_views.SeedFinalizeView.FINALIZE),
+			FlowStep(seed_views.SeedOptionsView, is_redirect=True),
+			FlowStep(psbt_views.PSBTOverviewView),
+			FlowStep(psbt_views.PSBTMathView),
+			FlowStep(psbt_views.PSBTAddressDetailsView, button_data_selection=psbt_views.PSBTAddressDetailsView.NEXT),
+			FlowStep(psbt_views.PSBTChangeDetailsView, button_data_selection=psbt_views.PSBTChangeDetailsView.NEXT),
+			FlowStep(psbt_views.PSBTChangeDetailsView, button_data_selection=psbt_views.PSBTChangeDetailsView.NEXT),
+			FlowStep(psbt_views.PSBTChangeDetailsView, button_data_selection=psbt_views.PSBTChangeDetailsView.NEXT),
+			FlowStep(psbt_views.PSBTFinalizeView, button_data_selection=psbt_views.PSBTFinalizeView.APPROVE_PSBT),
+			FlowStep(psbt_views.PSBTSignedQRDisplayView),
+			FlowStep(MainMenuView)
+		])