Merged
Conversation
Pull Request Test Coverage Report for Build 2747335540
💛 - Coveralls |
nkcr
force-pushed
the
documentation-update
branch
3 times, most recently
from
671021e to
557b8b9
Compare
nkcr
force-pushed
the
documentation-update
branch
from
557b8b9 to
24b2b58
Compare
- matches Github's font color for light themes
pierluca
requested changes
Jul 26, 2022
README.md
Outdated
| <img height="45px" src="docs/assets/spof-white.png#gh-dark-mode-only"> | ||
| </div> | ||
|
|
||
| **No single point of failure** The system is supported by a decentralized |
Contributor
There was a problem hiding this comment.
Here and elsewhere, this would help readability:
Suggested change
| **No single point of failure** The system is supported by a decentralized | |
| **No single point of failure -** The system is supported by a decentralized |
README.md
Outdated
Comment on lines
114
to
120
| **Blockchain node** A blockchain node is the wide definition of the program that | ||
| runs on a host and participate in the election logic. The blockchain node is | ||
| built on top of Dela with an additional d-voting smart contract, proxy, and two | ||
| services: DKG and verifiable Shuffling. The blockchain node is more accurately a | ||
| subsystem, as it wraps many other components. Blockchain nodes communicate | ||
| through gRPC with the [minogrpc][minogrpc] network overlay. We sometimes refer | ||
| to the blockchain node simply as a "node". |
Contributor
There was a problem hiding this comment.
This paragraph is very confusing. It introduces many terms that a novice would not yet be familiar with.
README.md
Outdated
| through gRPC with the [minogrpc][minogrpc] network overlay. We sometimes refer | ||
| to the blockchain node simply as a "node". | ||
|
|
||
| **Proxy** A proxy enables external interactions on a blockchain node. It is a |
Contributor
There was a problem hiding this comment.
"external" from what ? I'm being a bit picky here, but this could be clearer.
README.md
Outdated
| the web-backend. The web backend checks the requests and signs messages before | ||
| relaying them to the blockchain node, which trusts the web-backend. The | ||
| web-backend has a local database to store configuration data such as | ||
| authorizations. Admins use the web-frontend to perform update. |
Contributor
There was a problem hiding this comment.
Suggested change
| authorizations. Admins use the web-frontend to perform update. | |
| authorizations. Admins use the web-frontend to perform updates. |
|
|
||
| ## 🧩 Global architecture | ||
|
|
||
| The project has 4 main high-level components: |
Contributor
There was a problem hiding this comment.
I was wondering if it'd make it easier to follow by starting with the web interface (that everyone understands), then moving on to the web backend, the proxy (as the interface between non-blockchain and blockchain environments) and finally introducing the blockchain node itself.
README.md
Outdated
Comment on lines
250
to
251
| The shuffling service ensures that encrypted votes can not be linked to their | ||
| voters. Once the service is setup, each node can perform what we call a |
Contributor
There was a problem hiding this comment.
Suggested change
| The shuffling service ensures that encrypted votes can not be linked to their | |
| voters. Once the service is setup, each node can perform what we call a | |
| The shuffling service ensures that encrypted ballots can not be linked to the user who cast them. | |
| Once the service is setup, each node can perform what we call a |
| The shuffling service ensures that encrypted votes can not be linked to their | ||
| voters. Once the service is setup, each node can perform what we call a | ||
| "shuffling step". A shuffling step re-orders an array of elements such that | ||
| integrity of the elements is guarantee (i.e no elements have been modified, |
Contributor
There was a problem hiding this comment.
Suggested change
| integrity of the elements is guarantee (i.e no elements have been modified, | |
| the integrity of the elements is guaranteed (i.e no elements have been modified, |
README.md
Outdated
|
|
||
| In D-Voting we use the Neff [[2]] implementation of verifiable shuffling. Once | ||
| an election is closed, an admin can trigger the shuffling steps from the nodes. | ||
| During this phase, every node perform a shuffling on the current list of |
Contributor
There was a problem hiding this comment.
Suggested change
| During this phase, every node perform a shuffling on the current list of | |
| During this phase, every node performs a shuffling on the current list of |
README.md
Outdated
| In D-Voting we use the Neff [[2]] implementation of verifiable shuffling. Once | ||
| an election is closed, an admin can trigger the shuffling steps from the nodes. | ||
| During this phase, every node perform a shuffling on the current list of | ||
| encrypted ballots and try to submit it to the D-Voting smart contract. The smart |
Contributor
There was a problem hiding this comment.
Suggested change
| encrypted ballots and try to submit it to the D-Voting smart contract. The smart | |
| encrypted ballots and tries to submit it to the D-Voting smart contract. The smart |
README.md
Outdated
Comment on lines
260
to
262
| contract will accept only one shuffling step per block, and nodes repeat their | ||
| shuffling step with the latest shuffled list until their shuffling step has been | ||
| accepted or a threshold of nodes successfully submitted their shuffling steps. |
Contributor
There was a problem hiding this comment.
Suggested change
| contract will accept only one shuffling step per block, and nodes repeat their | |
| shuffling step with the latest shuffled list until their shuffling step has been | |
| accepted or a threshold of nodes successfully submitted their shuffling steps. | |
| contract will accept only one shuffling operation per block in the blockchain, | |
| and nodes re-try to shuffle the ballots, using the latest shuffled list in the blockchain, until the result of their shuffling has been committed to the blockchain or a threshold of nodes successfully submitted their own shuffling results. |
nkcr
force-pushed
the
documentation-update
branch
from
000e3ef to
14e301e
Compare
|
Kudos, SonarCloud Quality Gate passed!
|
ineiti
pushed a commit
that referenced
this pull request
Oct 10, 2024
Fix French language: at most -> au plus
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.