make scalar configurable

xaynetwork · Sep 4, 2020 · afe8e92 · afe8e92
1 parent 77a8ce6
commit afe8e92
Show file tree

Hide file tree

Showing 6 changed files with 57 additions and 42 deletions.
diff --git a/rust/examples/mobile-client.rs b/rust/examples/mobile-client.rs
@@ -4,7 +4,10 @@ extern crate tracing;
 use std::io::{stdin, stdout, Read, Write};
 use structopt::StructOpt;
 use tracing_subscriber::*;
-use xaynet_client::mobile_client::{participant::ParticipantSettings, MobileClient};
+use xaynet_client::mobile_client::{
+ participant::{AggregationConfig, ParticipantSettings},
+ MobileClient,
+};
 use xaynet_core::mask::{
  BoundType,
  DataType,
@@ -41,11 +44,14 @@ fn get_participant_settings() -> ParticipantSettings {
  let secret_key = MobileClient::create_participant_secret_key();
  ParticipantSettings {
  secret_key,
- mask_config: MaskConfig {
- group_type: GroupType::Prime,
- data_type: DataType::F32,
- bound_type: BoundType::B0,
- model_type: ModelType::M3,
+ aggregation_config: AggregationConfig {
+ mask: MaskConfig {
+ group_type: GroupType::Prime,
+ data_type: DataType::F32,
+ bound_type: BoundType::B0,
+ model_type: ModelType::M3,
+ },
+ scalar: 1_f64,
  },
  }
 }

diff --git a/rust/xaynet-client/src/mobile_client/client.rs b/rust/xaynet-client/src/mobile_client/client.rs
@@ -170,21 +170,15 @@ impl ClientState<Update> {
  .await
  .ok_or(ClientError::TooEarly("local model"))?;
 
- debug!("setting model scalar");
- let scalar = 1_f64; // TODO parametrise this!
-
  debug!("polling for sum dict");
  let sums = api
  .get_sums()
  .await?
  .ok_or(ClientError::TooEarly("sum dict"))?;
 
- let upd_msg = self.participant.compose_update_message(
- self.round_params.pk,
- &sums,
- scalar,
- local_model,
- );
+ let upd_msg =
+ self.participant
+ .compose_update_message(self.round_params.pk, &sums, local_model);
  let sealed_msg = self
  .participant
  .seal_message(&self.round_params.pk, &upd_msg);

diff --git a/rust/xaynet-client/src/mobile_client/participant/awaiting.rs b/rust/xaynet-client/src/mobile_client/participant/awaiting.rs
@@ -48,27 +48,30 @@ impl Participant<Awaiting> {
 #[cfg(test)]
 mod tests {
  use super::*;
+ use crate::mobile_client::participant::AggregationConfig;
  use sodiumoxide::randombytes::randombytes;
  use xaynet_core::{
  crypto::{ByteObject, SigningKeyPair},
  mask::{BoundType, DataType, GroupType, MaskConfig, ModelType},
- ParticipantPublicKey,
- ParticipantSecretKey,
+ ParticipantPublicKey, ParticipantSecretKey,
  };
 
  fn participant_state() -> ParticipantState {
  sodiumoxide::init().unwrap();
 
- let mask_config = MaskConfig {
- group_type: GroupType::Prime,
- data_type: DataType::F32,
- bound_type: BoundType::B0,
- model_type: ModelType::M3,
- };
+ let aggregation_config = AggregationConfig {
+ mask: MaskConfig {
+ group_type: GroupType::Prime,
+ data_type: DataType::F32,
+ bound_type: BoundType::B0,
+ model_type: ModelType::M3,
+ },
 
+ scalar: 1_f64,
+ };
  ParticipantState {
  keys: SigningKeyPair::generate(),
- mask_config,
+ aggregation_config,
  }
  }
 

diff --git a/rust/xaynet-client/src/mobile_client/participant/mod.rs b/rust/xaynet-client/src/mobile_client/participant/mod.rs
@@ -19,33 +19,39 @@ pub mod update;
 
 pub use self::{awaiting::Awaiting, sum::Sum, sum2::Sum2, update::Update};
 
+#[derive(Serialize, Deserialize)]
+pub struct AggregationConfig {
+ pub mask: MaskConfig,
+ pub scalar: f64,
+}
+
 #[derive(Serialize, Deserialize)]
 pub struct ParticipantState {
  // credentials
  pub keys: SigningKeyPair,
  // Mask config
- pub mask_config: MaskConfig,
+ pub aggregation_config: AggregationConfig,
 }
 
 #[derive(Serialize, Deserialize)]
 pub struct ParticipantSettings {
  pub secret_key: ParticipantSecretKey,
- pub mask_config: MaskConfig,
+ pub aggregation_config: AggregationConfig,
 }
 
 impl From<ParticipantSettings> for ParticipantState {
  fn from(
  ParticipantSettings {
  secret_key,
- mask_config,
+ aggregation_config,
  }: ParticipantSettings,
  ) -> ParticipantState {
  ParticipantState {
  keys: SigningKeyPair {
  public: secret_key.public_key(),
  secret: secret_key,
  },
- mask_config,
+ aggregation_config,
  }
  }
 }

diff --git a/rust/xaynet-client/src/mobile_client/participant/sum2.rs b/rust/xaynet-client/src/mobile_client/participant/sum2.rs
@@ -84,10 +84,11 @@ impl Participant<Sum2> {
  return Err(PetError::InvalidMask);
  }
 
- let mut model_mask_agg = Aggregation::new(self.state.mask_config, mask_len);
- let mut scalar_mask_agg = Aggregation::new(self.state.mask_config, 1);
+ let mut model_mask_agg = Aggregation::new(self.state.aggregation_config.mask, mask_len);
+ let mut scalar_mask_agg = Aggregation::new(self.state.aggregation_config.mask, 1);
  for seed in mask_seeds.into_iter() {
- let (model_mask, scalar_mask) = seed.derive_mask(mask_len, self.state.mask_config);
+ let (model_mask, scalar_mask) =
+ seed.derive_mask(mask_len, self.state.aggregation_config.mask);
 
  model_mask_agg
  .validate_aggregation(&model_mask)
@@ -106,6 +107,7 @@ impl Participant<Sum2> {
 #[cfg(test)]
 mod tests {
  use super::*;
+ use crate::mobile_client::participant::AggregationConfig;
  use sodiumoxide::randombytes::{randombytes, randombytes_uniform};
  use std::{collections::HashSet, iter};
  use xaynet_core::{
@@ -117,16 +119,19 @@ mod tests {
  fn participant_state() -> ParticipantState {
  sodiumoxide::init().unwrap();
 
- let mask_config = MaskConfig {
- group_type: GroupType::Prime,
- data_type: DataType::F32,
- bound_type: BoundType::B0,
- model_type: ModelType::M3,
- };
+ let aggregation_config = AggregationConfig {
+ mask: MaskConfig {
+ group_type: GroupType::Prime,
+ data_type: DataType::F32,
+ bound_type: BoundType::B0,
+ model_type: ModelType::M3,
+ },
 
+ scalar: 1_f64,
+ };
  ParticipantState {
  keys: SigningKeyPair::generate(),
- mask_config,
+ aggregation_config,
  }
  }
 

diff --git a/rust/xaynet-client/src/mobile_client/participant/update.rs b/rust/xaynet-client/src/mobile_client/participant/update.rs
@@ -34,10 +34,10 @@ impl Participant<Update> {
  &self,
  coordinator_pk: CoordinatorPublicKey,
  sum_dict: &SumDict,
- scalar: f64,
+
  local_model: Model,
  ) -> Message {
- let (mask_seed, masked_model, masked_scalar) = self.mask_model(scalar, local_model);
+ let (mask_seed, masked_model, masked_scalar) = self.mask_model(local_model);
  let local_seed_dict = Self::create_local_seed_dict(sum_dict, &mask_seed);
 
  Message {
@@ -56,8 +56,9 @@ impl Participant<Update> {
  }
 
  /// Generate a mask seed and mask a local model.
- fn mask_model(&self, scalar: f64, local_model: Model) -> (MaskSeed, MaskObject, MaskObject) {
- Masker::new(self.state.mask_config).mask(scalar, local_model)
+ fn mask_model(&self, local_model: Model) -> (MaskSeed, MaskObject, MaskObject) {
+ Masker::new(self.state.aggregation_config.mask)
+ .mask(self.state.aggregation_config.scalar, local_model)
  }
 
  // Create a local seed dictionary from a sum dictionary.