From d3b905212ac33a206cbc2ed031f4b2bab63d1d35 Mon Sep 17 00:00:00 2001 From: renjiez Date: Tue, 21 Nov 2023 21:40:25 +0000 Subject: [PATCH] Update comments. --- .../api/v2alpha/protocol_config.proto | 8 +++-- .../requisition_fulfillment_service.proto | 35 ++++++++++++------- 2 files changed, 28 insertions(+), 15 deletions(-) diff --git a/src/main/proto/wfa/measurement/api/v2alpha/protocol_config.proto b/src/main/proto/wfa/measurement/api/v2alpha/protocol_config.proto index 88fc16be2..4016e39d8 100644 --- a/src/main/proto/wfa/measurement/api/v2alpha/protocol_config.proto +++ b/src/main/proto/wfa/measurement/api/v2alpha/protocol_config.proto @@ -285,7 +285,9 @@ message ShareShuffleSketchParams { // The number of registers in the sketch. int64 register_count = 1; - // Length of each item in bytes. #_EDPs * max_frequency should be no more than - // 2^(bytes_per_item*8). - int32 bytes_per_item = 2; + // Length of each register in bytes. + // + // The product of `maximum_frequency` and the `nonce_hashes` count from the + // `MeasurementSpec` should be no more than 2 ^ (`bytes_per_register` * 8). + int32 bytes_per_register = 2; } diff --git a/src/main/proto/wfa/measurement/api/v2alpha/requisition_fulfillment_service.proto b/src/main/proto/wfa/measurement/api/v2alpha/requisition_fulfillment_service.proto index 6c71c23fc..42a3dfbec 100644 --- a/src/main/proto/wfa/measurement/api/v2alpha/requisition_fulfillment_service.proto +++ b/src/main/proto/wfa/measurement/api/v2alpha/requisition_fulfillment_service.proto @@ -60,16 +60,20 @@ message FulfillRequisitionRequest { // The protocol config of the Computation. This is used to validate that // EDPs and the MPC are using the same protocol config. // - // NOT required for LiquidLegionV2 protocols. + // Required for HonestMajorityShareShuffle protocol. LiquidLegionsV2 + // protocols will require this field in the future. ProtocolConfig protocol_config = 4; - // Requisitions of HonestMajorityShareShuffle protocol is fulfilled by - // either a blob or a seed. + // Protocol specified values for HonestMajorityShareShuffle. + // + // A Requisition of HonestMajorityShareShuffle protocol is fulfilled by + // either a seed or a blob of `BodyChunk`s. message HonestMajorityShareShuffle { - // The seed can be expanded into a deterministic blob using the same PRNG. + // The seed is sampled by the DataProvider and can be expanded into a + // deterministic blob using the same PRNG function. // - // If the seed is not specified or empty, it means the requisition is - // fulfilled by a blob of chunks. + // If the seed is not specified, it means the requisition is + // fulfilled by a blob of `BodyChunk`s. bytes seed = 1; } // Protocol specified values. @@ -84,12 +88,19 @@ message FulfillRequisitionRequest { message BodyChunk { // The portion of the data for this `BodyChunk`. // - // The format of the data depends on the corresponding `MeasurementSpec`. If - // the `Requisition` is for an encrypted sketch, this is the register - // data as documented in the `Sketch` message (sketch.proto) encrypted using - // the combined `Duchy` ElGamal public keys. The only alignment requirement - // is by bytes: a chunk might begin or end in the middle of a single - // register. + // The format of the data depends on the corresponding `MeasurementSpec` and + // `ProtocolConfig`. + // + // If the `Requisition` is for an encrypted sketch for LiquidLegionV2 + // protocols, this is the register data as documented in the `Sketch` + // message (sketch.proto) encrypted using the combined `Duchy` ElGamal + // public keys. + // + // If the `Requisition` is a sketch for HonestMajorityShareShuffle protocol, + // this is an array of counts as registers. + // + // The only alignment requirement is by bytes: a chunk might begin or end in + // the middle of a single register. // // The optimal size of this field is one that would result in the // `FulfillRequisitionRequest` message being between 16KiB and 64KiB.