Updates documentation #160

nkcr · 2022-07-20T15:30:32Z

No description provided.

coveralls · 2022-07-20T15:34:32Z

Pull Request Test Coverage Report for Build 2747335540

0 of 0 changed or added relevant lines in 0 files are covered.
13 unchanged lines in 1 file lost coverage.
Overall coverage decreased (-0.3%) to 62.271%

Files with Coverage Reduction	New Missed Lines	%
services/dkg/pedersen/handler.go	13	84.84%

Totals
Change from base Build 2661648017:	-0.3%
Covered Lines:	3088
Relevant Lines:	4959

💛 - Coveralls

- matches Github's font color for light themes

pierluca · 2022-07-26T09:30:12Z

README.md

+    <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


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

pierluca · 2022-07-26T09:31:28Z

README.md

+**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".


This paragraph is very confusing. It introduces many terms that a novice would not yet be familiar with.

pierluca · 2022-07-26T09:32:28Z

README.md

+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


"external" from what ? I'm being a bit picky here, but this could be clearer.

pierluca · 2022-07-26T09:35:46Z

README.md

+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.


Suggested change

authorizations. Admins use the web-frontend to perform update.

authorizations. Admins use the web-frontend to perform updates.

pierluca · 2022-07-26T09:37:59Z

README.md

+
+## 🧩 Global architecture
+
+The project has 4 main high-level components:


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.

pierluca · 2022-07-26T09:57:01Z

README.md

+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


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

pierluca · 2022-07-26T09:57:27Z

README.md

+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,


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,

pierluca · 2022-07-26T09:57:49Z

README.md

+
+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


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

pierluca · 2022-07-26T09:58:03Z

README.md

+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


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

pierluca · 2022-07-26T10:00:53Z

README.md

+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.


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.

sonarqubecloud · 2022-07-27T14:24:45Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

Fix French language: at most -> au plus

nkcr added 2 commits July 20, 2022 16:43

Updates the documentation

59f505e

Adds contributors and folders structure

Verified

This commit was created on github.com and signed with GitHub’s verified signature.

GPG key ID: B5690EEEBB952194

Verified
Learn about vigilant mode

373b08b

nkcr added the documentation label Jul 20, 2022

nkcr self-assigned this Jul 20, 2022

nkcr force-pushed the documentation-update branch 3 times, most recently from 671021e to 557b8b9 Compare July 21, 2022 13:09

Adds architecture and steps documentation

24b2b58

nkcr force-pushed the documentation-update branch from 557b8b9 to 24b2b58 Compare July 21, 2022 13:11

nkcr added 2 commits July 21, 2022 15:25

Updates dark icons

659077d

- matches Github's font color for light themes

Applies a self review

909c87f

nkcr requested a review from pierluca July 21, 2022 13:43

nkcr marked this pull request as ready for review July 21, 2022 13:43

pierluca requested changes Jul 26, 2022

View reviewed changes

Addresses Pierluca's comments

14e301e

nkcr force-pushed the documentation-update branch from 000e3ef to 14e301e Compare July 27, 2022 14:21

nkcr merged commit 8a82240 into main Jul 27, 2022

nkcr deleted the documentation-update branch July 27, 2022 14:35

ineiti pushed a commit that referenced this pull request Oct 10, 2024

Merge pull request #160 from c4dt/fix-french-language-at-most-au-plus

28ad738

Fix French language: at most -> au plus

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updates documentation #160

Updates documentation #160

nkcr commented Jul 20, 2022

coveralls commented Jul 20, 2022 •

edited

Loading

pierluca Jul 26, 2022

pierluca Jul 26, 2022

pierluca Jul 26, 2022

pierluca Jul 26, 2022

pierluca Jul 26, 2022

pierluca Jul 26, 2022

pierluca Jul 26, 2022

pierluca Jul 26, 2022

pierluca Jul 26, 2022

pierluca Jul 26, 2022

sonarqubecloud bot commented Jul 27, 2022

	No single point of failure The system is supported by a decentralized
	No single point of failure - The system is supported by a decentralized

	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:

		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

	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,

	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

	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

Updates documentation #160

Updates documentation #160

Conversation

nkcr commented Jul 20, 2022

coveralls commented Jul 20, 2022 • edited Loading

Pull Request Test Coverage Report for Build 2747335540

💛 - Coveralls

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Jul 27, 2022

coveralls commented Jul 20, 2022 •

edited

Loading