add comment

Author: julyawang

protos/solution/acv/acv.proto

@@ -66,6 +66,7 @@ message VoteStorage {
   repeated CandidateBallot voted_ballot = 4;
 }
 
+// system parameters
 message CandidateList {
   repeated string candidate = 1;
 }
@@ -75,6 +76,8 @@ message SystemParametersStorage {
   CandidateList candidates = 2;
 }
 
+
+// proofs
 message BallotProof {
   bytes format_proof = 1;
 }

solution/anonymous_ciphertext_voting/src/coordinator.rs

@@ -15,7 +15,7 @@ use wedpr_s_protos::generated::acv::{
     StringToCountingPartPair, SystemParametersStorage,
 };
 
-/// Makes system parameters by candidate list and counter storage messages.
+/// Makes system parameters containing public key and candidates list using counter storage messages.
 pub fn make_system_parameters(
     candidates: &CandidateList,
     counter_storage: &CounterSystemParametersStorage,
@@ -30,7 +30,7 @@ pub fn make_system_parameters(
     Ok(storage)
 }
 
-/// Certifies ballot value which voter can vote to all candidates.
+/// Certifies voter's weight which indicates the maximum value that the voter can vote totally.
 pub fn certify_bounded_voter(
     secret_key: &[u8],
     value: u32,
@@ -64,7 +64,7 @@ pub fn certify_bounded_voter(
     Ok(response)
 }
 
-/// Decrypts counters' .
+/// Aggregates the decrypted results of all counters, ?
 pub fn aggregate_decrypted_part_sum(
     param: &SystemParametersStorage,
     decrypted_result_part_storage: &DecryptedResultPartStorage,

solution/anonymous_ciphertext_voting/src/counter.rs

@@ -16,6 +16,7 @@ use wedpr_s_protos::generated::acv::{
     SystemParametersStorage, VoteResultStorage, VoteStorage,
 };
 
+/// Generates a random number as secret key used for making system parameter and counting.
 pub fn make_counter_secret() -> CounterSecret {
     let secret_share = get_random_scalar();
     CounterSecret {
@@ -25,6 +26,8 @@ pub fn make_counter_secret() -> CounterSecret {
     }
 }
 
+/// Makes share of system parameter using secret key,
+/// where system parameter here means global public key.
 pub fn make_system_parameters_share(
     counter_id: &str,
     counter_secret: &CounterSecret,
@@ -40,6 +43,13 @@ pub fn make_system_parameters_share(
     })
 }
 
+
+/// Generates intermediate values and zero-knowledge proof for final count,
+/// where the intermediate values is the share of ballots received by each candidate,
+/// the zero-knowledge proof is equality relationship proof used to prove that
+/// counter's count process is correct, specifically refers to that
+/// the secret key counter used in counting is equal to the secret key generated
+/// for making system parameter.
 pub fn count(
     counter_id: &str,
     secret: &CounterSecret,
@@ -88,9 +98,7 @@ pub fn count(
     Ok(request)
 }
 
-// In this function, everyone can check anonymousvoting result by c1 - c2r_sum,
-// because we already know v and candidates, by using c1 - c2r_sum, we can check
-// whether vG_1 =? c1 - c2r_sum. pub fn verify_counter(result_pb:
+/// Count the value of ballots received by each candidate.
 pub fn finalize_vote_result(
     param: &SystemParametersStorage,
     vote_sum: &VoteStorage,

solution/anonymous_ciphertext_voting/src/verifier.rs

@@ -24,6 +24,8 @@ use wedpr_l_protos::{
 };
 use wedpr_l_utils::traits::{Hash, Signature};
 
+/// Verifies whether each ballot of voters is correct,
+/// specifically refers to the format, the accounting balance and the numerical range of each ballot.
 pub fn verify_bounded_vote_request(
     param: &SystemParametersStorage,
     request: &VoteRequest,
@@ -105,6 +107,7 @@ pub fn verify_bounded_vote_request(
     Ok(true)
 }
 
+/// ? 
 pub fn aggregate_vote_sum_response(
     param: &SystemParametersStorage,
     vote_storage_part: &VoteStorage,
@@ -187,6 +190,8 @@ pub fn aggregate_vote_sum_response(
     Ok(true)
 }
 
+/// Verifies whether the counting process is correct,
+/// specifically refers to that whether each counter used correct secret key when counting.
 pub fn verify_count_request(
     param: &SystemParametersStorage,
     encrypted_vote_sum: &VoteStorage,
@@ -244,9 +249,7 @@ pub fn verify_count_request(
     Ok(true)
 }
 
-// In this function, everyone can check anonymousvoting result by c1 - c2r_sum,
-// because we already know v and candidates, by using c1 - c2r_sum, we can check
-// whether vG_1 =? c1 - c2r_sum. pub fn verify_counter(result_pb:
+/// Verifies whether the final score of each candidate is correct.
 pub fn verify_vote_result(
     param: &SystemParametersStorage,
     vote_sum: &VoteStorage,

solution/anonymous_ciphertext_voting/src/voter.rs

@@ -21,6 +21,7 @@ use wedpr_s_protos::generated::acv::{
     VoteChoices, VoteRequest, VoterSecret,
 };
 
+/// Generates a random number as secret number for applying blank ballot.
 pub fn make_voter_secret() -> VoterSecret {
     let vote_secret = get_random_scalar();
     VoterSecret {
@@ -30,6 +31,7 @@ pub fn make_voter_secret() -> VoterSecret {
     }
 }
 
+/// Applys to the coordinator for blank ballot using own weight and secret number.
 pub fn make_bounded_registration_request(
     secret: &VoterSecret,
     param: &SystemParametersStorage,
@@ -48,6 +50,8 @@ pub fn make_bounded_registration_request(
     Ok(request)
 }
 
+/// Verifies blank ballot issued by coordinator
+/// by recalculating and comparing whether it is consistent.
 pub fn verify_blank_ballot(
     request: &RegistrationRequest,
     response: &RegistrationResponse,
@@ -72,6 +76,13 @@ pub fn verify_blank_ballot(
         && request_ciphertext2 == response_ciphertext2)
 }
 
+/// Generate a vote request containing ballots for selected candidates, rest ballot
+/// and a group of zero-knowledge proofs to prove that ballots is correct,
+/// where zero-knowledge proofs contains format proof, balance proof and range proof.
+/// The format proof is used to prove that the format of ballots is correct
+/// so that it can be counted in the total number of votes when counting,
+/// the balance proof is used to prove that poll ballots + the rest ballot = the blank ballot,
+/// the range proof is used to prove that the value of ballot is non-negative.
 pub fn vote_bounded(
     secret: &VoterSecret,
     choices: &VoteChoices,

solution/verifiable_confidential_ledger/src/main.rs

@@ -6,6 +6,7 @@ use colored::*;
 use std;
 use wedpr_l_crypto_zkp_utils::point_to_bytes;
 use wedpr_s_verifiable_confidential_ledger::vcl;
+use protobuf::Message;
 
 fn main() {
     print_highlight2(