Rename shares to retrieved_shares in RecipientPickCtx

Scille · Jan 15, 2025 · 5eeac66 · 5eeac66
1 parent 969f3b3
commit 5eeac66
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 17 deletions.
diff --git a/libparsec/crates/client/src/invite/claimer.rs b/libparsec/crates/client/src/invite/claimer.rs
@@ -285,7 +285,7 @@ pub async fn claimer_retrieve_info(
                     shamir_recovery_created_on,
                     recipients,
                     threshold,
-                    shares: HashMap::new(),
+                    retrieved_shares: HashMap::new(),
                     time_provider,
                 },
             )),
@@ -335,7 +335,7 @@ pub struct ShamirRecoveryClaimPickRecipientCtx {
     shamir_recovery_created_on: DateTime,
     recipients: Vec<ShamirRecoveryRecipient>,
     threshold: NonZeroU8,
-    shares: HashMap<UserID, Vec<ShamirShare>>,
+    retrieved_shares: HashMap<UserID, Vec<ShamirShare>>,
     time_provider: TimeProvider,
 }
 
@@ -369,8 +369,8 @@ impl ShamirRecoveryClaimPickRecipientCtx {
             >= self.threshold.get()
     }
 
-    pub fn shares(&self) -> HashMap<UserID, NonZeroU8> {
-        self.shares
+    pub fn retrieved_shares(&self) -> HashMap<UserID, NonZeroU8> {
+        self.retrieved_shares
             .iter()
             .filter_map(|(k, v)| {
                 u8::try_from(v.len())
@@ -398,7 +398,7 @@ impl ShamirRecoveryClaimPickRecipientCtx {
         let greeter_user_id = recipient.user_id;
         let greeter_human_handle = recipient.human_handle.clone();
 
-        if self.shares.contains_key(&greeter_user_id) {
+        if self.retrieved_shares.contains_key(&greeter_user_id) {
             return Err(ShamirRecoveryClaimPickRecipientError::RecipientAlreadyPicked);
         }
 
@@ -415,7 +415,7 @@ impl ShamirRecoveryClaimPickRecipientCtx {
         self,
         share_ctx: ShamirRecoveryClaimShare,
     ) -> Result<ShamirRecoveryClaimMaybeRecoverDeviceCtx, ShamirRecoveryClaimAddShareError> {
-        let mut shares = self.shares;
+        let mut retrieved_shares = self.retrieved_shares;
 
         self.recipients
             .iter()
@@ -425,13 +425,16 @@ impl ShamirRecoveryClaimPickRecipientCtx {
         // Note that we do not check if the share is already present
         // This is to avoid handling an extra error that has no real value,
         // since adding shares can be seen as an idempotent operation.
-        shares.insert(share_ctx.recipient, share_ctx.weighted_share);
-        if shares.values().map(|shares| shares.len()).sum::<usize>()
+        retrieved_shares.insert(share_ctx.recipient, share_ctx.weighted_share);
+        if retrieved_shares
+            .values()
+            .map(|shares| shares.len())
+            .sum::<usize>()
             >= self.threshold.get() as usize
         {
             let secret = ShamirRecoverySecret::decrypt_and_load_from_shares(
                 self.threshold,
-                shares.values().flatten(),
+                retrieved_shares.values().flatten(),
             )
             .map_err(ShamirRecoveryClaimAddShareError::CorruptedSecret)?;
             Ok(ShamirRecoveryClaimMaybeRecoverDeviceCtx::RecoverDevice(
@@ -446,7 +449,10 @@ impl ShamirRecoveryClaimPickRecipientCtx {
             ))
         } else {
             Ok(ShamirRecoveryClaimMaybeRecoverDeviceCtx::PickRecipient(
-                Self { shares, ..self },
+                Self {
+                    retrieved_shares,
+                    ..self
+                },
             ))
         }
     }

diff --git a/libparsec/crates/client/tests/unit/invite/shamir.rs b/libparsec/crates/client/tests/unit/invite/shamir.rs
@@ -95,7 +95,7 @@ async fn shamir_full_greeting(tmp_path: TmpPath, env: &TestbedEnv) {
                 ]
             );
             p_assert_eq!(alice_ctx.threshold(), 2.try_into().unwrap());
-            p_assert_eq!(alice_ctx.shares(), HashMap::new());
+            p_assert_eq!(alice_ctx.retrieved_shares(), HashMap::new());
             assert!(alice_ctx.is_recoverable());
             alice_ctx
         }
@@ -154,7 +154,7 @@ async fn shamir_full_greeting(tmp_path: TmpPath, env: &TestbedEnv) {
             ShamirRecoveryClaimMaybeRecoverDeviceCtx::PickRecipient(ctx) => ctx,
             _ => panic!("Expected PickRecipient context"),
         };
-    p_assert_eq!(alice_recipient_pick_ctx.shares().len(), 1);
+    p_assert_eq!(alice_recipient_pick_ctx.retrieved_shares().len(), 1);
 
     // Continue with Bob
 
@@ -425,7 +425,7 @@ async fn unrecoverable_recovery(env: &TestbedEnv) {
                 ]
             );
             p_assert_eq!(alice_ctx.threshold(), 2.try_into().unwrap());
-            p_assert_eq!(alice_ctx.shares(), HashMap::new());
+            p_assert_eq!(alice_ctx.retrieved_shares(), HashMap::new());
             assert!(!alice_ctx.is_recoverable());
             alice_ctx
         }
@@ -546,7 +546,7 @@ async fn already_picked_recipient(env: &TestbedEnv) {
             ShamirRecoveryClaimMaybeRecoverDeviceCtx::PickRecipient(ctx) => ctx,
             _ => panic!("Expected PickRecipient context"),
         };
-    p_assert_eq!(alice_recipient_pick_ctx.shares().len(), 1);
+    p_assert_eq!(alice_recipient_pick_ctx.retrieved_shares().len(), 1);
 
     // Try to pick Mike again
 
@@ -724,7 +724,7 @@ async fn add_share_is_idempotent(env: &TestbedEnv) {
             ShamirRecoveryClaimMaybeRecoverDeviceCtx::PickRecipient(ctx) => ctx,
             _ => panic!("Expected PickRecipient context"),
         };
-    p_assert_eq!(alice_recipient_pick_ctx.shares().len(), 1);
+    p_assert_eq!(alice_recipient_pick_ctx.retrieved_shares().len(), 1);
 
     // Add the same share once again
 
@@ -735,5 +735,5 @@ async fn add_share_is_idempotent(env: &TestbedEnv) {
         ShamirRecoveryClaimMaybeRecoverDeviceCtx::PickRecipient(ctx) => ctx,
         _ => panic!("Expected PickRecipient context"),
     };
-    p_assert_eq!(alice_recipient_pick_ctx.shares().len(), 1);
+    p_assert_eq!(alice_recipient_pick_ctx.retrieved_shares().len(), 1);
 }
diff --git a/libparsec/src/invite.rs b/libparsec/src/invite.rs
@@ -938,7 +938,7 @@ pub fn claimer_shamir_recovery_add_share(
             let shamir_recovery_created_on = ctx.shamir_recovery_created_on().to_owned();
             let recipients = ctx.recipients().to_owned();
             let threshold = ctx.threshold().to_owned();
-            let recovered_shares = ctx.shares().to_owned();
+            let recovered_shares = ctx.retrieved_shares().to_owned();
             let is_recoverable = ctx.is_recoverable();
             let new_handle = register_handle(HandleItem::ShamirRecoveryClaimPickRecipient(ctx));
             Ok(ShamirRecoveryClaimMaybeRecoverDeviceInfo::PickRecipient {