v1.5 revise

Author: qyan-dev

.github/workflows/vcl.yml renamed to .github/workflows/default_test.yml

@@ -1,4 +1,4 @@
-name: Rust
+name: Default-Test
 
 on:
   push:
@@ -14,6 +14,6 @@ jobs:
       - name: Nightly default
         run: rustup default nightly
       - name: Build
-        run: cargo build --verbose
+        run: cargo build --all --all-targets --verbose
       - name: Run tests
         run: cargo test --verbose

.rustfmt.toml

@@ -5,7 +5,7 @@ format_strings = true
 indent_style = "Block"
 match_block_trailing_comma = true
 max_width = 80
-merge_imports = true
+imports_granularity = "Crate"
 normalize_comments = true
 normalize_doc_attributes = true
 overflow_delimited_expr = true

ffi/ffi_c/ffi_c_ktb/Cargo.toml

@@ -16,11 +16,9 @@ protobuf = "2.22.1"
 wedpr_ffi_common = "1.0.0"
 wedpr_ffi_macros = "1.0.0"
 wedpr_l_macros = "1.0.0"
-
-
-# This is required to generate C/C++ header files.
 wedpr_s_hierarchical_deterministic_key = "1.3.0"
 wedpr_s_protos = "1.3.0"
 
+# This is required to generate C/C++ header files.
 [build-dependencies]
 cbindgen = "0.9.0"

ffi/ffi_c/ffi_c_scd/Cargo.toml

@@ -16,10 +16,9 @@ protobuf = "2.22.1"
 wedpr_ffi_common = "1.0.0"
 wedpr_ffi_macros = "1.0.0"
 wedpr_l_macros = "1.0.0"
-
-# This is required to generate C/C++ header files.
 wedpr_s_protos = "1.3.0"
 wedpr_s_selective_certificate_disclosure = "1.3.0"
 
+# This is required to generate C/C++ header files.
 [build-dependencies]
 cbindgen = "0.9.0"

ffi/ffi_c/ffi_c_vcl/Cargo.toml

@@ -16,11 +16,10 @@ protobuf = "2.22.1"
 wedpr_ffi_common = "1.0.0"
 wedpr_ffi_macros = "1.1.0"
 wedpr_l_macros = "1.0.0"
-
-# This is required to generate C/C++ header files.
 wedpr_l_protos = "1.1.0"
 wedpr_s_protos = { path = "../../../protos" }
 wedpr_s_verifiable_confidential_ledger = { path = "../../../solution/verifiable_confidential_ledger" }
 
+# This is required to generate C/C++ header files.
 [build-dependencies]
 cbindgen = "0.9.0"

ffi/ffi_java/ffi_java_ktb/Cargo.toml

@@ -18,6 +18,7 @@ wedpr_ffi_macros = "1.1.0"
 wedpr_s_hierarchical_deterministic_key = "1.3.0"
 wedpr_s_protos = "1.3.0"
 
+# This is required to generate C/C++ header files.
 [build-dependencies]
 cbindgen = "0.9.0"
 

ffi/ffi_java/ffi_java_scd/Cargo.toml

@@ -19,6 +19,7 @@ wedpr_l_protos = "1.0.0"
 wedpr_s_protos = "1.3.0"
 wedpr_s_selective_certificate_disclosure = "1.3.0"
 
+# This is required to generate C/C++ header files.
 [build-dependencies]
 cbindgen = "0.9.0"
 

ffi/ffi_java/ffi_java_vcl/Cargo.toml

@@ -20,6 +20,7 @@ wedpr_l_protos = "1.1.0"
 wedpr_s_protos = { path = "../../../protos" }
 wedpr_s_verifiable_confidential_ledger = { path = "../../../solution/verifiable_confidential_ledger" }
 
+# This is required to generate C/C++ header files.
 [build-dependencies]
 cbindgen = "0.9.0"
 

protos/solution/acv/acv.proto

@@ -1,4 +1,4 @@
-// Copyright 2020 WeDPR Lab Project Authors. Licensed under Apache-2.0.
+// Copyright 2021 WeDPR Lab Project Authors. Licensed under Apache-2.0.
 
 syntax = "proto3";
 
@@ -11,34 +11,34 @@ message CandidateList {
   repeated string candidate = 1;
 }
 
-// System parameters.
-message SystemParametersStorage {
+// Shared system parameters to initialize a poll.
+message PollParametersStorage {
   bytes poll_point = 1;
   CandidateList candidates = 2;
 }
 
-// Counter's secret value.
+// Secret of a counter.
 message CounterSecret {
   bytes poll_secret_share = 1;
 }
 
-// Voter's secret value.
+// Secret of a voter.
 message VoterSecret {
   bytes voter_secret = 1;
 }
 
-// Request of voter's registration.
+// Request of registering a voter.
 message RegistrationRequest {
   RegistrationBlindingPoint weight_point = 1;
 }
 
-// delete?
+// Blinding points for a voter registration.
 message RegistrationBlindingPoint {
   bytes blinding_poll_point = 1;
   bytes blinding_basepoint_g2 = 2;
 }
 
-// Response of coordinator for voter's registration.
+// Response of voter registration.
 message RegistrationResponse {
   uint32 voter_weight = 1;
   Ballot ballot = 2;
@@ -51,30 +51,29 @@ message Ballot {
   bytes ciphertext2 = 2;
 }
 
-
-// Request of generating system parameter from a counter.
-message CounterSystemParametersShareRequest {
+// Request of aggregating a part of system parameters from a counter.
+message CounterParametersShareRequest {
   string counter_id = 1;
   bytes poll_point_share = 2;
 }
 
-// Requests of generating system parameter from all counters.
-message CounterSystemParametersStorage {
-  repeated CounterSystemParametersShareRequest counter_parameters_request = 1;
+// Shared system parameters to initialize a group of counters.
+message CounterParametersStorage {
+  repeated CounterParametersShareRequest counter_parameters_share = 1;
 }
 
-// Choice of ballot casting for each candidate.
+// Vote choice for a candidate.
 message VoteChoice {
   string candidate = 1;
   uint32 value = 2;
 }
 
-// Choices for all candidate.
+// Choice list for all candidates.
 message VoteChoices {
   repeated VoteChoice choice = 1;
 }
 
-// Ciphertext ballot for each candidate.
+// Ciphertext ballot for a candidate.
 message CandidateBallot {
   string candidate = 1;
   Ballot ballot = 2;
@@ -85,55 +84,54 @@ message BallotProof {
   bytes format_proof = 1;
 }
 
-// Pair of candidate index and the ballot proof he received.
-message StringToCandidateBallotProofPair {
+// Pair of string (candidate id) and BallotProof.
+message StringToBallotProofPair {
   string key = 1;
   BallotProof value = 2;
 }
 
-// Do not use Map, cause unordered in blockchain
-// Request of polling for all candidates.
+// Request of voting for all candidates.
 message VoteRequest {
   VoteStorage vote = 1;
-  repeated StringToCandidateBallotProofPair ballot_proof = 2;
+  repeated StringToBallotProofPair ballot_proof = 2;
   bytes range_proof = 3;
   bytes sum_balance_proof = 4;
 }
 
-// Polling for each candidates.
+// Ciphertext ballot for all candidates.
 message VoteStorage {
   bytes signature = 1;
   Ballot blank_ballot = 2;
   Ballot rest_ballot = 3;
   repeated CandidateBallot voted_ballot = 4;
 }
 
-// Decrypted ballot and ZKP data to verify the process of counting of each counter.
+// Partially decrypted ballot and associated ZKP data for a candidate.
 message CountingPart {
   string counter_id = 1;
   bytes blinding_c2 = 2;
   bytes equality_proof = 3;
 }
 
-// Pair of candidate index and the decrypted ballot he received.
+// Pair of string (candidate id) and CountingPart.
 message StringToCountingPartPair {
   string key = 1;
   CountingPart value = 2;
 }
 
-// Decrypted ballot and ZKP data to verify the process of counting of all counters.
+// Partially decrypted ballots and associated ZKP data for a poll.
 message DecryptedResultPartStorage {
   CountingPart blank_part = 1;
   repeated StringToCountingPartPair candidate_part = 2;
 }
 
-// Final result of all candidates.
+// Fully decrypted result of a poll.
 message VoteResultStorage {
   repeated StringToInt64Pair result = 1;
 }
 
-// Final result of each candidate.
+// Pair of string (candidate id) and number.
 message StringToInt64Pair {
   string key = 1;
   int64 value = 2;
-}
+}