fix(BIP85): use Seed object instead of seed_num for storing parent relation

Author: Chaitanya-Keyal

src/seedsigner/controller.py

@@ -225,7 +225,7 @@ def get_seed(self, seed_num: int) -> Seed:
 
     def discard_seed(self, seed_num: int):
         if seed_num < len(self.storage.seeds):
-            self.storage.discard_seed(seed_num)
+            self.storage.discard_seed(self.storage.seeds[seed_num])
         else:
             raise Exception(f"There is no seed_num {seed_num}; only {len(self.storage.seeds)} in memory.")
 

src/seedsigner/models/seed.py

@@ -269,8 +269,8 @@ class BIP85GrandchildNotAllowedException(Exception):
 
 
 class BIP85ChildSeed(Seed):
-    def __init__(self, parent_seed_num: int, child_index: int, num_words: int, **kwargs):
-        self.parent_seed_num = parent_seed_num
+    def __init__(self, parent_seed: Seed, child_index: int, num_words: int, **kwargs):
+        self.parent_seed = parent_seed
         self.child_index = child_index
         self.num_words = num_words
         super().__init__(**kwargs)

src/seedsigner/models/seed_storage.py

@@ -28,8 +28,8 @@ def finalize_pending_seed(self) -> int:
             if isinstance(self.pending_seed, BIP85ChildSeed):
                 # Insert child seeds adjacent to parent, sorted by child index, then by number of words
                 # Required to list seeds in a presentable order
-                existing_siblings = self.get_bip85_child_seeds(self.pending_seed.parent_seed_num)
-                index = self.pending_seed.parent_seed_num + 1
+                existing_siblings = self.get_bip85_child_seeds(self.pending_seed.parent_seed)
+                index = self.seeds.index(self.pending_seed.parent_seed) + 1
                 for sibling in existing_siblings:
                     if (sibling.child_index, sibling.num_words) < (self.pending_seed.child_index, self.pending_seed.num_words):
                         index += 1
@@ -43,10 +43,10 @@ def finalize_pending_seed(self) -> int:
         return index
 
 
-    def discard_seed(self, seed_num: int):
-        bip85_child_seeds = self.get_bip85_child_seeds(seed_num)
+    def discard_seed(self, seed: Seed):
+        bip85_child_seeds = self.get_bip85_child_seeds(seed)
 
-        del self.seeds[seed_num]
+        self.seeds.remove(seed)
 
         for child_seed in bip85_child_seeds:
             self.seeds.remove(child_seed)
@@ -126,6 +126,6 @@ def discard_pending_mnemonic(self):
         self._pending_is_electrum = False
 
 
-    def get_bip85_child_seeds(self, seed_num: int) -> list[BIP85ChildSeed]:
+    def get_bip85_child_seeds(self, parent_seed: Seed) -> list[BIP85ChildSeed]:
         """Returns the list of BIP-85 child seeds derived from the specified seed."""
-        return [seed for seed in self.seeds if isinstance(seed, BIP85ChildSeed) and seed.parent_seed_num == seed_num]
+        return [seed for seed in self.seeds if isinstance(seed, BIP85ChildSeed) and seed.parent_seed == parent_seed]

src/seedsigner/views/seed_views.py

@@ -1195,9 +1195,10 @@ def run(self):
             )
 
         child_index = int(ret)
-        child_mnemonic = self.controller.get_seed(self.seed_num).get_bip85_child_mnemonic(child_index, self.num_words, self.settings.get_value(SettingsConstants.SETTING__NETWORK)).split()
+        parent_seed = self.controller.get_seed(self.seed_num)
+        child_mnemonic = parent_seed.get_bip85_child_mnemonic(child_index, self.num_words, self.settings.get_value(SettingsConstants.SETTING__NETWORK)).split()
         child_seed = BIP85ChildSeed(
-                parent_seed_num=self.seed_num,
+                parent_seed=parent_seed,
                 child_index=child_index,
                 num_words=self.num_words,
                 mnemonic=child_mnemonic,
@@ -1270,7 +1271,7 @@ def run(self):
 
         if selected_menu_num == RET_CODE__BACK_BUTTON or button_data[selected_menu_num] == self.DONE:
             self.controller.storage.clear_pending_seed()
-            return Destination(SeedOptionsView, view_args=dict(seed_num=self.seed.parent_seed_num), clear_history=True)
+            return Destination(SeedOptionsView, view_args=dict(seed_num=self.controller.storage.seeds.index(self.seed.parent_seed)), clear_history=True)
 
         if button_data[selected_menu_num] == self.VIEW_MNEMONIC:
             return Destination(SeedWordsWarningView, view_args=dict(seed_num=None))

tests/screenshot_generator/generator.py

@@ -105,7 +105,7 @@ def add_op_return_to_psbt(psbt: PSBT, raw_payload_data: bytes):
 seed_12 = Seed(mnemonic=mnemonic_12, passphrase="cap*BRACKET3stove", wordlist_language_code=SettingsConstants.WORDLIST_LANGUAGE__ENGLISH)
 seed_24 = Seed(mnemonic=mnemonic_24, passphrase="some-PASS*phrase9", wordlist_language_code=SettingsConstants.WORDLIST_LANGUAGE__ENGLISH)
 seed_24_w_passphrase = Seed(mnemonic=mnemonic_24, passphrase="some-PASS*phrase9", wordlist_language_code=SettingsConstants.WORDLIST_LANGUAGE__ENGLISH)
-bip85_child_seed = BIP85ChildSeed(parent_seed_num=2, child_index=0, num_words=12, mnemonic=seed_24.get_bip85_child_mnemonic(0, 12).split())
+bip85_child_seed = BIP85ChildSeed(parent_seed=seed_24, child_index=0, num_words=12, mnemonic=seed_24.get_bip85_child_mnemonic(0, 12).split())
 MULTISIG_WALLET_DESCRIPTOR = """wsh(sortedmulti(1,[22bde1a9/48h/1h/0h/2h]tpubDFfsBrmpj226ZYiRszYi2qK6iGvh2vkkghfGB2YiRUVY4rqqedHCFEgw12FwDkm7rUoVtq9wLTKc6BN2sxswvQeQgp7m8st4FP8WtP8go76/{0,1}/*,[73c5da0a/48h/1h/0h/2h]tpubDFH9dgzveyD8zTbPUFuLrGmCydNvxehyNdUXKJAQN8x4aZ4j6UZqGfnqFrD4NqyaTVGKbvEW54tsvPTK2UoSbCC1PJY8iCNiwTL3RWZEheQ/{0,1}/*))#3jhtf6yx"""
 
 

tests/test_seed_storage.py

@@ -43,10 +43,9 @@ def test_finalize_pending_seed(self, children_specs):
 
         for parent_idx, child_idx, num_words in children_specs:
             parent_seed = parent_seeds[parent_idx]
-            parent_position = storage.seeds.index(parent_seed)  # Position of 2nd parent might change as we add children
 
             child_seed = BIP85ChildSeed(
-                parent_seed_num=parent_position,
+                parent_seed=parent_seed,
                 child_index=child_idx,
                 num_words=num_words,
                 mnemonic=parent_seed.get_bip85_child_mnemonic(child_idx, num_words).split(),
@@ -90,12 +89,12 @@ def test_discard_seed(self, child_indices):
         # Add child seeds to storage
         for child_index in child_indices:
             child_seed = BIP85ChildSeed(
-                parent_seed_num=0,
+                parent_seed=parent_seed,
                 child_index=child_index,
                 num_words=12,
                 mnemonic=parent_seed.get_bip85_child_mnemonic(child_index, 12).split(),
             )
             storage.seeds.append(child_seed)
 
-        storage.discard_seed(0)
+        storage.discard_seed(parent_seed)
         assert len(storage.seeds) == 1  # Only the second seed should remain