Voting dapp

Une dapp pour un contrat de vote en solidiy, par Guilhain Averlant & Pierre-Olivier Mauguet.

Déploiement sur voting-dapp-sage.vercel.app.

Vidéo de démonstration.

Table des matières

• Installation et déploiement
• Sécurité et optimisation
• Documentation technique

Installation et déploiement

Le code de ce repository utilise un template issu de la box Truffle officielle pour React (référénce).

Installation

git clone https://github.com/pom421/VotingDapp.git
cd VotingDapp
npm install

Lancement du smart contract via truffle

1. En local, lancer un client Ethereum sur le port 8545 (ex: ganache)
2. npm run truffle:migrate

Lancement du client React

npm run client:start

MetaMask

• importer une clé privéede Ganache dans MetaMask
• aller sur localhost:8080
• connecter le compte dans MetaMask

Déploiement du contrat sur un testnet

Pour l'exemple, nous allons déployer le contrat sur Sepolia (mais il existe les mêmes scripts pour déployer sur goerli et mumbai).

Cloner le fichier .env.dist en .env dans le répertoire truffle et remplir les variables d'environnement.

npm run truffle:migrate:sepolia

Le fichier .env doit être correctement configuré (i. e. avoir la mnémonique d'un wallet fourni en ETH sepolia).

Pour d'autres réseaux, ajouter la configuration dans truffle-config.js et le script dans package.json.

Configuration sur Vercel

Afin que le front se déploie bien sur Vercel, nous avons dû procéder à de légère customisation dans le dashboard.

Dashboard Vercel

Déploiement du client vers le contrat sur Sepolia

1. npm run truffle:migrate:sepolia.
2. Faire un commit du client car les fichiers .json dans contracts ont changé avec le networkd et l'adresse du contrat Voting puis un git push.
3. Vercel va déployer automatiquement le client React vers le contrat sur Sepolia.

FAQ

Comment récupérer des eth sur Sepolia ?

Aller sur https://sepolia-faucet.pk910.de/.

Sécurité et optimisations

Sécurité

La faille

Pour des raisons de sécurité, nous avons supprimé la function tallyVotes car elle présentait une faille de sécurité de type DOS GAS LIMIT. Puisque si un attaquant publie un nombre important de proposals, la boucle qui calcule les résultats du vote peut atteindre la limite de gas autorisée par le réseau.

La solution

Pour combler cette faille de sécurité, il a été décidé de déplacer le calcul de la proposal victorieuse dans la fonction setVote. Ainsi à chaque fois qu'un votant vote, la variable winningProposalID est mise à jour en comparant la valeur voteCount stockée dans la struct Proposal.

Les propsitions écartées et pourquoi

• Nous avons écarté la méthode de la pagination car trop coûteuse en gas et peu efficace dans la mesure où le décompte peut se faire dans une autre fonction (en l'occurence ici setVote).
• la méthode de la limitation du nombre de Proposal ne nous parait pas pertinente, car rien ne justifie sur une application de vote de limiter le nombre de candidatures.

Optimisations

Les optimisations suite à la suprression de TallyVotes La suppression de la fonction tallyVotes invite à faire certaines modifications.

• L'étape VotesTallied de l'enum WorkflowStatus n'a plus de sens, elle a donc été supprimée.
• Pour des raisons d'économie de gas, nous avons stocké les Proposal dans un mapping plutôt que dans un array. Du coup on est obligé en contre partie d'ajouter une variable de type uint proposalID pour stocker l'identifiant de chaque proposal (utile également dans les require utilisés dans les fonction setVote et getOneProposal).

Quid : propsoal GENESIS ?

On a gardé la notion de proposal GENESIS tel qu'implémenté dans la version initiale du code.

Et la consomation en gas ?

Vous trouverez ci-dessous les rapports de consomations de gas des sessions de tests de Voting.sol :

• Avant la correction de la faille de sécurité.
• Aprés la correction de faille mais en gardant le stockage des proposals dans un array
• Aprés la correction de la faille mais en stockant les proposals dans un mapping
• Après la correction de la faille et stockage des proposals dans un mapping et conversion des uint256 en uint64

Avant la correction de la faille

Après la correction de la faille et stockage des proposals dans un array

Après la correction de la faille et stockage des proposals dans un mapping

On observe que le stockage dans un mapping consomme moins de gas dans sa globalité.

Après la correction de la faille et stockage des proposals dans un mapping et conversion des uint256 en uint64

Il a fallu créer une variable uint proposalID pour stocker les identifiants de Proposal. Par conséquent, nous avons deux variables uint, ce qui rend possible une petite optimisation en gas en restreignant la taille des uint (par défaut uint256) en uint64, ce qui techniquement restreint le nombre de proposal à (2^64)-1 soit 18446744073709551615 proposals, ce qui nous semble raisonnable.

Voici le résultat des tests en gas

Nous observons une sur-consomation en gas cette option ne sera pas retenue.

Conclusion des optimisations

• un stockage en mapping des proposals est optimal.
• la conversion des uint en uint64 a un impact négatif sur la consommation du gas du smart contract.

Documentation technique

Documentation générée à partir des commentaires NatSpec du code Solidity.0

For NatSpec see smart contract Voting.sol This is a smart contract for conducting a voting process using blockchain technology. It allows voters to register, submit proposals, and vote on proposals. The voting process has multiple stages that are controlled by the contract owner. Voters can only vote once and can only vote on proposals that have been registered. The winning proposal is the one with the highest number of votes.

Contract Information

• SPDX-License-Identifier: MIT
• pragma solidity ^0.8.17
• Import: "../node_modules/@openzeppelin/contracts/access/Ownable.sol"

Contract Variables

Structs

• Voter: contains information about a voter, including registration status, vote status, and voted proposal ID.
• isRegistered: bool, indicating whether the voter is registered.
• hasVoted: bool, indicating whether the voter has voted.
• votedProposalId: uint, indicating the ID of the proposal that the voter has voted for.
• Proposal: contains information about a proposal, including its description and vote count.
• description: string, representing the proposal's description.
• voteCount: uint, indicating the number of votes the proposal has received.

Enums

• WorkflowStatus: indicates the current stage of the voting process.
• RegisteringVoters: the contract is currently registering voters.
• ProposalsRegistrationStarted: the contract is currently accepting proposal submissions.
• ProposalsRegistrationEnded: the contract has stopped accepting proposal submissions.
• VotingSessionStarted: the contract is currently accepting votes.
• VotingSessionEnded: the contract has stopped accepting votes.

Public Variables

• winningProposalID: uint, indicating the ID of the proposal with the highest number of votes.
• proposalID: uint, indicating the current number of proposals.

Mappings

• proposalsMapping: maps proposal IDs to Proposal structs.
• voters: maps voter addresses to Voter structs.

Contract Events

• VoterRegistered: emitted when a new voter is registered.
• WorkflowStatusChange: emitted when the workflow status changes.
• ProposalRegistered: emitted when a new proposal is added.
• Voted: emitted when a voter casts a vote.

Contract Functions

Getters

• getVoter(address _addr): returns the voter information for a given address.
• getOneProposal(uint _id): returns a single proposal from the proposalsMapping based on its ID.

Registration

• addVoter(address _addr): registers a new voter by adding their address to the list of voters.
• addProposal(string calldata _desc): adds a new proposal to the proposalsMapping.

Vote

setVote(uint _id): allows a registered voter to vote for a proposal with a given ID.

State

• startProposalsRegistering(): allows the owner to start the proposals registration process.
• endProposalsRegistering(): ends the proposals registration period.
• startVotingSession(): starts the voting session.
• endVotingSession(): ends the voting session and updates the workflow status to VotingSessionEnded.