Docs

akoshelev · Nov 20, 2024 · 36d18a2 · 36d18a2
1 parent 22ba17d
commit 36d18a2
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/ipa-core/src/helpers/gateway/mod.rs b/ipa-core/src/helpers/gateway/mod.rs
@@ -122,6 +122,7 @@ impl ShardConfiguration for &Gateway {
     }
 
     fn shard_count(&self) -> ShardIndex {
+        // total number of shards include this instance and all its peers, so we add 1.
         ShardIndex::from(self.transports.shard.peer_count() + 1)
     }
 }

diff --git a/ipa-core/src/query/runner/sharded_shuffle.rs b/ipa-core/src/query/runner/sharded_shuffle.rs
@@ -18,6 +18,9 @@ use crate::{
     sync::Arc,
 };
 
+/// This executes the sharded shuffle protocol that consists of only one step:
+/// permute the private inputs using a permutation that is not known to any helper
+/// and client.
 pub async fn execute_sharded_shuffle<'a>(
     prss: &'a PrssEndpoint,
     gateway: &'a Gateway,
-Original file line number
+Diff line change
@@ Expand Up / @@ -122,6 +122,7 @@ impl ShardConfiguration for &Gateway { @@
         }
         fn shard_count(&self) -> ShardIndex {
+            // total number of shards include this instance and all its peers, so we add 1.
             ShardIndex::from(self.transports.shard.peer_count() + 1)
         }
     }
@@ Expand Down @@