Suffragium is a voting system that leverages zero-knowledge (zk) proofs and Fully Homomorphic Encryption (FHE) to preserve all essential properties of a secure voting system. It utilizes sp1-dkim to generate a zk proof, verifying that a registered user is eligible to vote after having completed the KYC. Additionally, it employs FHE (thanks to zama) to prevent bribery and blackmail by ensuring that votes remain private and confidential. This voting system aims to simulate and enhance the current voting process by ensuring that users are properly authenticated while maintaining privacy and security. The system is currently still under development, with ongoing improvements to enhance its security and functionality.
Install docker
Install pnpm
Before being able to run any command, you need to create a .env
file and set a BIP-39 compatible mnemonic as an
environment variable. You can follow the example in .env.example
and start with the following command:
cp .env.example .env
If you don't already have a mnemonic, you can use this website to generate one.
Then, proceed with installing dependencies - please make sure to use Node v20 or more recent or this will fail:
pnpm install
During installation (see previous section) we recommend you for easier setup to not change the default .env
: simply
copy the original .env.example
file to a new .env
file in the root of the repo.
Then, start a local fhEVM docker compose that inlcudes everything needed to deploy FHE encrypted smart contracts using:
# In one terminal, keep it opened
# The node logs are printed
pnpm fhevm:start
Previous command will take 2 to 3 minutes to do the whole initial setup - wait until the blockchain logs appear to make sure setup is complete (we are working on making initial deployment faster).
You can then run the tests simply in a new terminal via :
pnpm test
Once your done with your tests, to stop the node:
pnpm fhevm:stop
Compile the smart contracts with Hardhat:
pnpm compile
Compile the smart contracts and generate TypeChain bindings:
pnpm typechain
From the mnemonic in .env file, list all the derived Ethereum adresses:
pnpm task:accounts
In order to interact with the blockchain, one need some coins. This command will give coins to the first 5 addresses derived from the mnemonic in .env file.
pnpm fhevm:faucet
To get the first derived address from mnemonic
pnpm task:getEthereumAddress
Run the tests with Hardhat:
pnpm test
Lint the Solidity code:
pnpm lint:sol
Lint the TypeScript code:
pnpm lint:ts
See the gas usage per unit test and average gas per method call:
REPORT_GAS=true pnpm test
Delete the smart contract artifacts, the coverage reports and the Hardhat cache:
pnpm clean
The mocked mode allows faster testing and the ability to analyze coverage of the tests. In this mocked version, encrypted types are not really encrypted, and the tests are run on the original version of the EVM, on a local hardhat network instance. To run the tests in mocked mode, you can use directly the following command:
pnpm test:mock
To analyze the coverage of the tests (in mocked mode necessarily, as this cannot be done on the real fhEVM node), you can use this command :
pnpm coverage:mock
Then open the file coverage/index.html
. You can see there which line or branch for each contract which has been
covered or missed by your test suite. This allows increased security by pointing out missing branches not covered yet by
the current tests.
Note
Due to intrinsic limitations of the original EVM, the mocked version differ in few corner cases from the real fhEVM, the main difference is the difference in gas prices for the FHE operations. This means that before deploying to production, developers still need to run the tests with the original fhEVM node, as a final check in non-mocked mode, with pnpm test
.
If you use VSCode, you can get Solidity syntax highlighting with the hardhat-solidity extension.
This project is licensed under MIT.